PHP Class eZ\Publish\Core\SignalSlot\SearchService

Inheritance: implements eZ\Publish\API\Repository\SearchService
Show file Open project: ezsystems/ezpublish-kernel

Protected Properties

Property Type Description
$service eZ\Publish\API\Repository\SearchService Aggregated service.
$signalDispatcher SignalDispatcher SignalDispatcher.

Public Methods

Method Description
__construct ( eZ\Publish\API\Repository\SearchService $service, SignalDispatcher $signalDispatcher ) Constructor.
findContent ( eZ\Publish\API\Repository\Values\Content\Query $query, array $languageFilter = [], boolean $filterOnUserPermissions = true ) : eZ\Publish\API\Repository\Values\Content\Search\SearchResult Finds content objects for the given query.
findContentInfo ( eZ\Publish\API\Repository\Values\Content\Query $query, array $languageFilter = [], boolean $filterOnUserPermissions = true ) : eZ\Publish\API\Repository\Values\Content\Search\SearchResult Finds contentInfo objects for the given query.
findLocations ( eZ\Publish\API\Repository\Values\Content\LocationQuery $query, array $languageFilter = [], boolean $filterOnUserPermissions = true ) : eZ\Publish\API\Repository\Values\Content\Search\SearchResult Finds Locations for the given query.
findSingle ( eZ\Publish\API\Repository\Values\Content\Query\Criterion $filter, array $languageFilter = [], boolean $filterOnUserPermissions = true ) : eZ\Publish\API\Repository\Values\Content\Content Performs a query for a single content object.
suggest ( string $prefix, string[] $fieldPaths = [], integer $limit = 10, eZ\Publish\API\Repository\Values\Content\Query\Criterion $filter = null ) Suggests a list of values for the given prefix.

Method Details

__construct() public method

Construct service object from aggregated service and signal dispatcher
public __construct ( eZ\Publish\API\Repository\SearchService $service, SignalDispatcher $signalDispatcher )
$service eZ\Publish\API\Repository\SearchService
$signalDispatcher SignalDispatcher

findContent() public method

Finds content objects for the given query.
public findContent ( eZ\Publish\API\Repository\Values\Content\Query $query, array $languageFilter = [], boolean $filterOnUserPermissions = true ) : eZ\Publish\API\Repository\Values\Content\Search\SearchResult
$query eZ\Publish\API\Repository\Values\Content\Query
$languageFilter array Configuration for specifying prioritized languages query will be performed on. Currently supported: array("languages" => array(,..)).
$filterOnUserPermissions boolean if true only the objects which the user is allowed to read are returned.
return eZ\Publish\API\Repository\Values\Content\Search\SearchResult

findContentInfo() public method

Finds contentInfo objects for the given query.
See also: SearchServiceInterface::findContentInfo()
Since: 5.4.5
public findContentInfo ( eZ\Publish\API\Repository\Values\Content\Query $query, array $languageFilter = [], boolean $filterOnUserPermissions = true ) : eZ\Publish\API\Repository\Values\Content\Search\SearchResult
$query eZ\Publish\API\Repository\Values\Content\Query
$languageFilter array - a map of filters for the returned fields. Currently supports: array("languages" => array(,..), "useAlwaysAvailable" => bool) useAlwaysAvailable defaults to true to avoid exceptions on missing translations.
$filterOnUserPermissions boolean if true (default) only the objects which is the user allowed to read are returned.
return eZ\Publish\API\Repository\Values\Content\Search\SearchResult

findLocations() public method

Finds Locations for the given query.
public findLocations ( eZ\Publish\API\Repository\Values\Content\LocationQuery $query, array $languageFilter = [], boolean $filterOnUserPermissions = true ) : eZ\Publish\API\Repository\Values\Content\Search\SearchResult
$query eZ\Publish\API\Repository\Values\Content\LocationQuery
$languageFilter array Configuration for specifying prioritized languages query will be performed on. Currently supports: array("languages" => array(,..), "useAlwaysAvailable" => bool) useAlwaysAvailable defaults to true to avoid exceptions on missing translations
$filterOnUserPermissions boolean if true only the objects which is the user allowed to read are returned.
return eZ\Publish\API\Repository\Values\Content\Search\SearchResult

findSingle() public method

Performs a query for a single content object.
public findSingle ( eZ\Publish\API\Repository\Values\Content\Query\Criterion $filter, array $languageFilter = [], boolean $filterOnUserPermissions = true ) : eZ\Publish\API\Repository\Values\Content\Content
$filter eZ\Publish\API\Repository\Values\Content\Query\Criterion
$languageFilter array Configuration for specifying prioritized languages query will be performed on. Currently supported: array("languages" => array(,..)).
$filterOnUserPermissions boolean if true only the objects which is the user allowed to read are returned.
return eZ\Publish\API\Repository\Values\Content\Content

suggest() public method

Suggests a list of values for the given prefix.
public suggest ( string $prefix, string[] $fieldPaths = [], integer $limit = 10, eZ\Publish\API\Repository\Values\Content\Query\Criterion $filter = null )
$prefix string
$fieldPaths string[]
$limit integer
$filter eZ\Publish\API\Repository\Values\Content\Query\Criterion

Property Details

$service protected property

Aggregated service.
protected SearchService,eZ\Publish\API\Repository $service
return eZ\Publish\API\Repository\SearchService

$signalDispatcher protected property

SignalDispatcher.
protected SignalDispatcher,eZ\Publish\Core\SignalSlot $signalDispatcher
return SignalDispatcher