Back to index

d-push  2.0
Public Member Functions | Public Attributes
SearchProvider Class Reference
Inheritance diagram for SearchProvider:
Inheritance graph
[legend]
Collaboration diagram for SearchProvider:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 SearchProvider ()
 Constructor initializes the searchprovider to perform the search.
 SupportsType ($searchtype)
 Indicates if a search type is supported by this SearchProvider Currently only the type ISearchProvider::SEARCH_GAL (Global Address List) is implemented.
 GetGALSearchResults ($searchquery, $searchrange)
 Searches the GAL.
 GetMailboxSearchResults ($cpo)
 Searches for the emails on the server.
 TerminateSearch ($pid)
 Terminates a search for a given PID.
 Disconnect ()
 Disconnects from the current search provider.

Public Attributes

const SEARCH_GAL = "GAL"
const SEARCH_MAILBOX = "MAILBOX"
const SEARCH_DOCUMENTLIBRARY = "DOCUMENTLIBRARY"

Detailed Description

Definition at line 53 of file searchprovider.php.


Member Function Documentation

Disconnects from the current search provider.

public

Returns:
boolean

Implements ISearchProvider.

Definition at line 121 of file searchprovider.php.

                                 {
        return true;
    }
SearchProvider::GetGALSearchResults ( searchquery,
searchrange 
)

Searches the GAL.

Parameters:
string$searchquerystring to be searched for
string$searchrangespecified searchrange

public

Returns:
array search results
Exceptions:
StatusException

Implements ISearchProvider.

Definition at line 89 of file searchprovider.php.

                                                                    {
       return array();
    }

Searches for the emails on the server.

Parameters:
ContentParameter$cpo
Returns:
array

Implements ISearchProvider.

Definition at line 100 of file searchprovider.php.

                                                 {
        return array();
    }

Constructor initializes the searchprovider to perform the search.

public

Returns:
Exceptions:
StatusException,FatalException

Definition at line 63 of file searchprovider.php.

                                     {
    }
SearchProvider::SupportsType ( searchtype)

Indicates if a search type is supported by this SearchProvider Currently only the type ISearchProvider::SEARCH_GAL (Global Address List) is implemented.

Parameters:
string$searchtypepublic
Returns:
boolean

Implements ISearchProvider.

Definition at line 75 of file searchprovider.php.

                                              {
        return ($searchtype == ISearchProvider::SEARCH_GAL);
    }

Terminates a search for a given PID.

Parameters:
int$pid
Returns:
boolean

Implements ISearchProvider.

Definition at line 111 of file searchprovider.php.

                                          {
        return true;
    }

Member Data Documentation

const ISearchProvider::SEARCH_DOCUMENTLIBRARY = "DOCUMENTLIBRARY" [inherited]

Definition at line 48 of file isearchprovider.php.

const ISearchProvider::SEARCH_GAL = "GAL" [inherited]

Definition at line 46 of file isearchprovider.php.

const ISearchProvider::SEARCH_MAILBOX = "MAILBOX" [inherited]

Definition at line 47 of file isearchprovider.php.


The documentation for this class was generated from the following file: