PHP Class eZ\Publish\Core\Search\Elasticsearch\Content\FacetBuilderVisitor

Exibir arquivo Open project: ezsystems/ezpublish-kernel Class Usage Examples

Public Methods

Method Description
canMap ( string $name ) : boolean Check if visitor is applicable to current facet result.
canVisit ( eZ\Publish\API\Repository\Values\Content\Query\FacetBuilder $facetBuilder ) : boolean Check if visitor is applicable to current facet builder.
map ( string $name, mixed $data ) : eZ\Publish\API\Repository\Values\Content\Search\Facet Map Elasticsearch facet result back to facet objects.
visit ( eZ\Publish\API\Repository\Values\Content\Query\FacetBuilder $facetBuilder ) : mixed Map facet builder to a proper Elasticsearch representation.

Protected Methods

Method Description
mapData ( mixed $data ) : array Map Elasticsearch return array into a sane hash map.

Method Details

canMap() abstract public method

Check if visitor is applicable to current facet result.
abstract public canMap ( string $name ) : boolean
$name string
return boolean

canVisit() abstract public method

Check if visitor is applicable to current facet builder.
abstract public canVisit ( eZ\Publish\API\Repository\Values\Content\Query\FacetBuilder $facetBuilder ) : boolean
$facetBuilder eZ\Publish\API\Repository\Values\Content\Query\FacetBuilder
return boolean

map() abstract public method

Map Elasticsearch facet result back to facet objects.
abstract public map ( string $name, mixed $data ) : eZ\Publish\API\Repository\Values\Content\Search\Facet
$name string
$data mixed
return eZ\Publish\API\Repository\Values\Content\Search\Facet

mapData() protected method

Map Elasticsearch return array into a sane hash map.
protected mapData ( mixed $data ) : array
$data mixed
return array

visit() abstract public method

Map facet builder to a proper Elasticsearch representation.
abstract public visit ( eZ\Publish\API\Repository\Values\Content\Query\FacetBuilder $facetBuilder ) : mixed
$facetBuilder eZ\Publish\API\Repository\Values\Content\Query\FacetBuilder
return mixed Hash representation of Elasticsearch aggregations