Query

Query.php : 17 Copy path

Extends ValueObject

This class is used to perform a Content query.

Constants¶

SORT_ASC ¶

Query.php : 19 Copy path

public mixed SORT_ASC = 'ascending'

SORT_DESC ¶

Query.php : 20 Copy path

public mixed SORT_DESC = 'descending'

Properties¶

$aggregations ¶

Query.php : 73 Copy path

public array<string|int, Aggregation> $aggregations = []

$facetBuilders ¶

Query.php : 68 Copy path

An array of facet builders.

public array<string|int, FacetBuilder> $facetBuilders = []

Search engines may ignore any, or given facet builders they don't support and will just return search result facets supported by the engine. API consumer should dynamically iterate over returned facets for further use.

$filter ¶

Query.php : 38 Copy path

The Query filter.

public Criterion $filter

For the storage backend that supports it (Solr) filters the result set without influencing score. It also offers better performance as filter part of the Query can be cached.

In case when the backend does not distinguish between query and filter (Legacy Storage implementation), it will simply be combined with Query query using LogicalAnd criterion.

Can contain multiple criterion, as items of a logical one (by default AND)

$limit ¶

Query.php : 92 Copy path

Query limit.

public int $limit = 25

Limit for number of search hits to return. If value is 0, search query will not return any search hits, useful for doing a count.

$offset ¶

Query.php : 82 Copy path

Query offset.

public int $offset = 0

Sets the offset for search hits, used for paging the results.

$performCount ¶

Query.php : 104 Copy path

If true, search engine should perform count even if that means extra lookup.

public bool $performCount = true

$query ¶

Query.php : 51 Copy path

The Query query.

public Criterion $query

For the storage backend that supports it (Solr Storage) query will influence score of the search results.

Can contain multiple criterion, as items of a logical one (by default AND). Defaults to MatchAll.

$sortClauses ¶

Query.php : 58 Copy path

Query sorting clauses.

public array<string|int, SortClause> $sortClauses = []

$spellcheck ¶

Query.php : 97 Copy path

Spellcheck suggestions are returned.

public Spellcheck|null $spellcheck = null

Methods¶

__construct() ¶

ValueObject.php : 30 Copy path

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

getProperties() ¶

ValueObject.php : 50 Copy path

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>