Copied!

UserFacetBuilder

UserFacetBuilder.php : 20
Extends FacetBuilder

Build a user facet.

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

If provided the search service returns a UserFacet for the given type.

Tags
Deprecated

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

Constants

publicGROUP

UserFacetBuilder.php : 30

Owner user group.

 
public mixed GROUP = 'group'

publicMODIFIER

UserFacetBuilder.php : 35

Modifier.

 
public mixed MODIFIER = 'modifier'

publicOWNER

UserFacetBuilder.php : 25

Owner user.

 
public mixed OWNER = 'owner'

Properties

public $filter

FacetBuilder.php : 39

An additional facet filter that will further filter the documents the facet will be executed on.

 
public Criterion $filter = null

public $global

FacetBuilder.php : 32

If true the facet runs in a global mode not restricted by the query.

 
public bool $global = false

public $limit

FacetBuilder.php : 46

Number of facets (terms) returned.

 
public int $limit = 10

public $minCount

FacetBuilder.php : 53

Specifies the minimum count. Only facet groups with more or equal results are returned.

 
public int $minCount = 1

public $name

FacetBuilder.php : 25

The name of the facet.

 
public string $name

public $type

UserFacetBuilder.php : 42

The type of the user facet.

 
public string $type = self::OWNER

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>