eZPublishCommunityProject  2013.9
eZ\Publish\SPI\Persistence\Content\Search\Handler Interface Reference

The Content Search handler retrieves sets of of Content objects, based on a set of criteria. More...

+ Inheritance diagram for eZ\Publish\SPI\Persistence\Content\Search\Handler:

Public Member Functions

 deleteContent ($contentId, $versionId=null)
 Deletes a content object from the index. More...
 
 deleteLocation ($locationId)
 Deletes a location from the index. More...
 
 findContent (Query $query, array $fieldFilters=array())
 Finds content objects for the given query. More...
 
 findSingle (Criterion $criterion, array $fieldFilters=array())
 Performs a query for a single content object. More...
 
 indexContent (Content $content)
 Indexes a content object. More...
 
 suggest ($prefix, $fieldPaths=array(), $limit=10, Criterion $filter=null)
 Suggests a list of values for the given prefix. More...
 

Detailed Description

The Content Search handler retrieves sets of of Content objects, based on a set of criteria.

Member Function Documentation

eZ\Publish\SPI\Persistence\Content\Search\Handler::deleteContent (   $contentId,
  $versionId = null 
)
eZ\Publish\SPI\Persistence\Content\Search\Handler::deleteLocation (   $locationId)
eZ\Publish\SPI\Persistence\Content\Search\Handler::findContent ( Query  $query,
array  $fieldFilters = array() 
)

Finds content objects for the given query.

Todo:
define structs for the field filters
Exceptions
\eZ\Publish\API\Repository\Exceptions\InvalidArgumentExceptionif Query criterion is not applicable to its target
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>,..)).
Returns

Implemented in eZ\Publish\Core\Persistence\Solr\Content\Search\Handler, eZ\Publish\Core\Persistence\Legacy\Content\Search\Handler, eZ\Publish\Core\Persistence\InMemory\SearchHandler, and eZ\Publish\Core\Persistence\Cache\SearchHandler.

eZ\Publish\SPI\Persistence\Content\Search\Handler::findSingle ( Criterion  $criterion,
array  $fieldFilters = array() 
)

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 Criterion is not applicable to its target
\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>,..)).
Returns

Implemented in eZ\Publish\Core\Persistence\InMemory\SearchHandler, eZ\Publish\Core\Persistence\Solr\Content\Search\Handler, eZ\Publish\Core\Persistence\Legacy\Content\Search\Handler, and eZ\Publish\Core\Persistence\Cache\SearchHandler.

eZ\Publish\SPI\Persistence\Content\Search\Handler::indexContent ( Content  $content)
eZ\Publish\SPI\Persistence\Content\Search\Handler::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\Persistence\InMemory\SearchHandler, eZ\Publish\Core\Persistence\Solr\Content\Search\Handler, eZ\Publish\Core\Persistence\Legacy\Content\Search\Handler, and eZ\Publish\Core\Persistence\Cache\SearchHandler.


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