eZPublishCommunityProject  2012.12
eZ\Publish\API\Repository\SearchService Interface Reference
+ Inheritance diagram for eZ\Publish\API\Repository\SearchService:

Public Member Functions

 findContent (Query $query, array $fieldFilters=array(), $filterOnUserPermissions=true)
 Finds content objects for the given query. More...
 
 findSingle (Criterion $criterion, array $fieldFilters=array(), $filterOnUserPermissions=true)
 Performs a query for a single content object. More...
 
 suggest ($prefix, $fieldPaths=array(), $limit=10, Criterion $filter=null)
 Suggests a list of values for the given prefix. More...
 

Member Function Documentation

eZ\Publish\API\Repository\SearchService::findContent ( Query  $query,
array  $fieldFilters = array(),
  $filterOnUserPermissions = true 
)

Finds content objects for the given query.

Todo:
define structs for the field filters
Parameters
\eZ\Publish\API\Repository\Values\Content\Query$query
array$fieldFilters- a map of filters for the returned fields. Currently supported: array("languages" => array(<language1>,..)).
boolean$filterOnUserPermissionsif true only the objects which is the user allowed to read are returned.
Returns

Implemented in eZ\Publish\Core\Repository\SearchService, and eZ\Publish\Core\SignalSlot\SearchService.

eZ\Publish\API\Repository\SearchService::findSingle ( Criterion  $criterion,
array  $fieldFilters = array(),
  $filterOnUserPermissions = true 
)

Performs a query for a single content object.

Exceptions
\eZ\Publish\API\Repository\Exceptions\NotFoundExceptionif the object was not found by the query or due to permissions
\eZ\Publish\API\Repository\Exceptions\InvalidArgumentExceptionif there is more than than one result matching the criterions
Todo:
define structs for the field filters
Parameters
\eZ\Publish\API\Repository\Values\Content\Query\Criterion$criterion
array$fieldFilters- a map of filters for the returned fields. Currently supported: array("languages" => array(<language1>,..)).
boolean$filterOnUserPermissionsif true only the objects which is the user allowed to read are returned.
Returns

Implemented in eZ\Publish\Core\Repository\SearchService, and eZ\Publish\Core\SignalSlot\SearchService.

eZ\Publish\API\Repository\SearchService::suggest (   $prefix,
  $fieldPaths = array(),
  $limit = 10,
Criterion  $filter = null 
)

Suggests a list of values for the given prefix.

Parameters
string$prefix
string[]$fieldpath
int$limit
\eZ\Publish\API\Repository\Values\Content\Query\Criterion$filter

Implemented in eZ\Publish\Core\Repository\SearchService, and eZ\Publish\Core\SignalSlot\SearchService.


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