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

Inheritance: extends eZ\Publish\Core\Search\Elasticsearch\Content\FacetBuilderVisitor
Show file Open project: ezsystems/ezpublish-kernel

Protected Properties

Property Type Description
$visitors eZ\Publish\Core\Search\Elasticsearch\Content\FacetBuilderVisitor[] Array of available visitors.

Public Methods

Method Description
__construct ( array $visitors = [] ) Construct from optional visitor array.
addVisitor ( FacetBuilderVisitor $visitor ) Adds visitor.
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.

Method Details

__construct() public method

Construct from optional visitor array.
public __construct ( array $visitors = [] )
$visitors array

addVisitor() public method

Adds visitor.
public addVisitor ( FacetBuilderVisitor $visitor )
$visitor eZ\Publish\Core\Search\Elasticsearch\Content\FacetBuilderVisitor

canMap() public method

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

canVisit() public method

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

map() public method

Map Elasticsearch facet result back to facet objects.
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

visit() public method

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

Property Details

$visitors protected property

Array of available visitors.
protected FacetBuilderVisitor[],eZ\Publish\Core\Search\Elasticsearch\Content $visitors
return eZ\Publish\Core\Search\Elasticsearch\Content\FacetBuilderVisitor[]