Copied!

FieldFacet

FieldFacet.php : 20
Extends Facet

This class represents a field facet which holds the collected terms for one or more fields.

since eZ Platform 3.2.0, to be removed in Ibexa 4.0.0.

Tags
Author

christianbacher

Deprecated

since eZ Platform 3.2.0, to be removed in Ibexa 4.0.0.

Properties

public $entries

FieldFacet.php : 48

An array of terms (key) and counts (value).

 
public array<string|int, mixed> $entries

public $missingCount

FieldFacet.php : 27

Number of documents not containing any terms in the queried fields.

 
public int $missingCount

public $name

Facet.php : 25

The name of the facet.

 
public string $name

public $otherCount

FieldFacet.php : 34

The number of terms which are not in the queried top list.

 
public int $otherCount

public $totalCount

FieldFacet.php : 41

The total count of terms found.

 
public int $totalCount

Methods

public__construct()

ValueObject.php : 30

Construct object optionally with a set of properties.

 
public __construct([array<string|int, mixed> $properties = [] ])

Readonly properties values must be set using $properties as they are not writable anymore after object has been created.

Parameters

Name Type Default value Description
$properties array<string|int, mixed> [] -

protectedgetProperties()

ValueObject.php : 50

Function where list of properties are returned.

 
protected getProperties([array<string|int, mixed> $dynamicProperties = [] ]) : array<string|int, mixed>

Used by attributes(), override to add dynamic properties

Parameters

Name Type Default value Description
$dynamicProperties array<string|int, mixed> []

Additional dynamic properties exposed on the object

Return values

array<string|int, mixed>