eZPublishCommunityProject  2013.4
eZ\Publish\Core\SignalSlot\SearchService Class Reference
+ Inheritance diagram for eZ\Publish\Core\SignalSlot\SearchService:
+ Collaboration diagram for eZ\Publish\Core\SignalSlot\SearchService:

Public Member Functions

 __construct (SearchServiceInterface $service, SignalDispatcher $signalDispatcher)
 Constructor. More...
 
 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...
 

Protected Attributes

 $service
 
 $signalDispatcher
 

Constructor & Destructor Documentation

eZ\Publish\Core\SignalSlot\SearchService::__construct ( SearchServiceInterface  $service,
SignalDispatcher  $signalDispatcher 
)

Constructor.

Construct service object from aggregated service and signal dispatcher

Parameters
\eZ\Publish\API\Repository\SearchService$service
\eZ\Publish\Core\SignalSlot\SignalDispatcher$signalDispatcher

Member Function Documentation

eZ\Publish\Core\SignalSlot\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

Implements eZ\Publish\API\Repository\SearchService.

eZ\Publish\Core\SignalSlot\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

Implements eZ\Publish\API\Repository\SearchService.

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

Suggests a list of values for the given prefix.

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

Implements eZ\Publish\API\Repository\SearchService.

Member Data Documentation

eZ\Publish\Core\SignalSlot\SearchService::$service
protected
eZ\Publish\Core\SignalSlot\SearchService::$signalDispatcher
protected

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