Back to index

d-push  2.0
Public Member Functions | Public Attributes
ISearchProvider Interface Reference
Inheritance diagram for ISearchProvider:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 SupportsType ($searchtype)
 Constructor.
 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 45 of file isearchprovider.php.


Member Function Documentation

Disconnects from the current search provider.

public

Returns:
boolean

Implemented in BackendZarafa, BackendSearchLDAP, and SearchProvider.

ISearchProvider::GetGALSearchResults ( searchquery,
searchrange 
)

Searches the GAL.

Parameters:
string$searchquery
string$searchrangepublic
Returns:
array
Exceptions:
StatusException

Implemented in BackendZarafa, BackendSearchLDAP, and SearchProvider.

Searches for the emails on the server.

Parameters:
ContentParameter$cpo
Returns:
array

Implemented in BackendZarafa, BackendSearchLDAP, and SearchProvider.

ISearchProvider::SupportsType ( searchtype)

Constructor.

Exceptions:
StatusException,FatalExceptionIndicates if a search type is supported by this SearchProvider Currently only the type SEARCH_GAL (Global Address List) is implemented
Parameters:
string$searchtypepublic
Returns:
boolean

Implemented in BackendZarafa, BackendSearchLDAP, and SearchProvider.

Terminates a search for a given PID.

Parameters:
int$pid
Returns:
boolean

Implemented in BackendZarafa, BackendSearchLDAP, and SearchProvider.


Member Data Documentation

const ISearchProvider::SEARCH_DOCUMENTLIBRARY = "DOCUMENTLIBRARY"

Definition at line 48 of file isearchprovider.php.

Definition at line 46 of file isearchprovider.php.

Definition at line 47 of file isearchprovider.php.


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