class QueryBuilder

Methods

addAccessibleInstanceFilter()

Adds all accessible instances to the query.

addBlackListFilter()

Applies the instance blacklist config.

addDocumentUpdatedAtAfterFilter(int $createdSinceTimestamp)

Adds a filter to the query which only returns documents with an updated_at after the given timestamp.

addModuleGroupSecurityFilter()

Adds the accessible group security IDs to the query.

addQueryFilter(array $queryFilter)

No description

static string
escapeQuery(string $term, bool $allow_advanced_search = true)

Elastic Search has Reserved Characters which need escaping https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#_reserved_characters

array
getDocumentSearchQuery(string $searchterm, string|array $instance_id, int $post_type, array $limit, array $advanced_options, array $facetted_search, array $active_facets, array $query_conditions)

Returns an ElasticSearch Query Array based on the passed parameters and all search instance settings

array
getQuery()

No description

array
getSearchtermSuggestQuery(string $q)

No description

static QueryBuilder
getSimpleSearchBuilder(SearchController $mod, string $searchTerm)

Returns the QueryBuilder without instance and group access checks and without aggregations.

initSearchQuery(string $searchTerm)

Initialize minimal Search Query within builder

resetQuery()

No description

Details

at line 690
QueryBuilder addAccessibleInstanceFilter()

Adds all accessible instances to the query.

Return Value

QueryBuilder

Exceptions

Exception

at line 671
QueryBuilder addBlackListFilter()

Applies the instance blacklist config.

Return Value

QueryBuilder

at line 824
QueryBuilder addDocumentUpdatedAtAfterFilter(int $createdSinceTimestamp)

Adds a filter to the query which only returns documents with an updated_at after the given timestamp.

Parameters

int $createdSinceTimestamp

Return Value

QueryBuilder

at line 755
QueryBuilder addModuleGroupSecurityFilter()

Adds the accessible group security IDs to the query.

Return Value

QueryBuilder

at line 661
protected QueryBuilder addQueryFilter(array $queryFilter)

No description

Parameters

array $queryFilter

Return Value

QueryBuilder

at line 635
static string escapeQuery(string $term, bool $allow_advanced_search = true)

Parameters

string $term

Query Term (e.g. "my" + "search")

bool $allow_advanced_search

Return Value

string

Escaped Query Term (e.g. \"my\" + \"search\")

at line 49
array getDocumentSearchQuery(string $searchterm, string|array $instance_id, int $post_type, array $limit, array $advanced_options, array $facetted_search, array $active_facets, array $query_conditions)

Returns an ElasticSearch Query Array based on the passed parameters and all search instance settings

Parameters

string $searchterm
string|array $instance_id
int $post_type
array $limit

[ (int) $start, (int) $length ]

array $advanced_options
array $facetted_search
array $active_facets
array $query_conditions

Return Value

array

ES Search DSL

Exceptions

Exception

at line 814
array getQuery()

No description

Return Value

array

at line 607
array getSearchtermSuggestQuery(string $q)

No description

Parameters

string $q

Return Value

array

at line 72
static QueryBuilder getSimpleSearchBuilder(SearchController $mod, string $searchTerm)

Returns the QueryBuilder without instance and group access checks and without aggregations.

Parameters

SearchController $mod
string $searchTerm

Return Value

QueryBuilder

Exceptions

Exception

at line 85
QueryBuilder initSearchQuery(string $searchTerm)

Initialize minimal Search Query within builder

Parameters

string $searchTerm

Return Value

QueryBuilder

Exceptions

Exception

at line 809
QueryBuilder resetQuery()

No description

Return Value

QueryBuilder