Copied!

DateRangeFacetBuilder

DateRangeFacetBuilder.php : 19
Extends FacetBuilder

Build a date range facet.

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

If provided the search service returns a DateRangeFacet depending on the provided type (PUBLISHED, CREATED, MODIFIED)

Tags
Deprecated

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

Constants

publicCREATED

DateRangeFacetBuilder.php : 22 
public mixed CREATED = 1

publicMODIFIED

DateRangeFacetBuilder.php : 23 
public mixed MODIFIED = 2

publicPUBLISHED

DateRangeFacetBuilder.php : 21 
public mixed PUBLISHED = 0

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

DateRangeFacetBuilder.php : 25 
public mixed $type = self::PUBLISHED

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> [] -

publicaddRange()

DateRangeFacetBuilder.php : 40

Adds a date range.

 
public abstract addRange(DateTime $from, DateTime $to) : mixed

Parameters

Name Type Default value Description
$from DateTime - -
$to DateTime - -

publicaddUnboundedFrom()

DateRangeFacetBuilder.php : 32

Adds a range entry with explicit to and unbounded from.

 
public abstract addUnboundedFrom(DateTime $to) : mixed

Parameters

Name Type Default value Description
$to DateTime - -

publicaddUnboundedTo()

DateRangeFacetBuilder.php : 47

Adds a range entry with explicit from and unbounded to.

 
public abstract addUnboundedTo(DateTime $from) : mixed

Parameters

Name Type Default value Description
$from DateTime - -

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>