icewind/searchdav

sabre/dav plugin to implement rfc5323 SEARCH

SearchDAV

, _(*1)

A sabre/dav plugin to implement rfc5323 SEARCH, _(*2)

Usage

The plugin implements the DAV specific parts of the rfc but leaves the actual search implementation to the user of the plugin., _(*3)

This is done by implementing the \SearchDAV\Backend\ISearchBackend interface and passing it to the plugin during construction., _(*4)

Basic usage

$server = new \Sabre\DAV\Server();
$server->addPlugin(new \SearchDAV\DAV\SearchPlugin(new MySearchBackend()));

$server->exec();

Terms

The rfc uses the following terms to describe various part of search handling, _(*5)

• Search scope: the DAV resource that is being queries.

• Search arbiter: the end point to which the SEARCH request can be made., _(*6)

  Note that a single search arbiter can support searching in multiple scopes, _(*7)

• Search grammar: The type of search query that is supported by a scope, _(*8)

  rfc5323 requires any implementation to at least implement "basicsearch" which is also currently the only supported grammar in this plugin, _(*9)

• Search schema: Details on how to use a search grammar, such as the supported properties that can be searched for, _(*10)

ISearchBackend

The ISearchBackend defines the arbiter end point, which scopes are valid to query, the search schema that is supported and implements the actual search., _(*11)

For a full list of methods required and their description see ISearchBackend.php, _(*12)

Query

The Query class defines the query that was made by the client and consists of four parts:, _(*13)

• select: the properties are requested.
• from: the scope(s) in which the search should be made.
• where: the filter parameters for the search.
• orderBy: how the search results should be ordered.

For further information about these elements see Query.php, Scope.php, Operator.php and Order.php, _(*14)