DefaultQueryBuilder
extends AbstractQueryBuilder
in package
implements
EndpointInterface
Class DefaultQueryBuilder
Tags
Table of Contents
Interfaces
- EndpointInterface
- Interface EndpointInterface
Properties
- $filterObject : FilterObjectInterface
- $config : array<string|int, mixed>
- $defaultArgs : array<string|int, mixed>
- $fields : array<string|int, mixed>
- $fieldsDefaultArgs : array<string|int, mixed>
- $include : array<string|int, mixed>
- $includeDefaultArgs : array<string|int, mixed>
- $language : array<string|int, mixed>
- $languageDefaultArgs : array<string|int, mixed>
- $pageDefaultArgs : array<string|int, mixed>
- $paging : array<string|int, mixed>
- $sort : array<string|int, mixed>
- $sortableDefaultArgs : array<string|int, mixed>
- $detailIds : array<string|int, mixed>
- $endpointId : string
Methods
- __construct() : mixed
- creates a new query.
- applyFields() : array<string|int, mixed>
- applyInclude() : array<string|int, mixed>
- applySection() : array<string|int, mixed>
- createFilterObject() : FilterObject
- filter() : FilterObject
- getArguments() : array<string|int, mixed>
- getConfig() : array<string|int, mixed>
- getConfiguration() : array<string|int, mixed>
- getDetailIds() : array<string|int, mixed>|null
- getEndpointId() : string|null
- getFields() : array<string|int, mixed>
- getInclude() : array<string|int, mixed>
- getLanguage() : array<string|int, mixed>
- getPaging() : array<string|int, mixed>
- getSort() : array<string|int, mixed>
- limit() : void
- offset() : void
- page() : void
- setConfiguration() : void
- setDetailIds() : void
- setEndpointId() : void
- setFields() : void
- setInclude() : void
- setLanguage() : void
- setPaging() : void
- setSort() : void
- sortByCreatedAt() : void
- sortByModifiedAt() : void
- sortByName() : void
- sortByProximityGeographic() : void
- sortByProximityInTime() : void
- sortByProximityOccurrence() : void
- sortByRandom() : void
- sortBySimilarity() : void
- take() : void
Properties
$filterObject
public
FilterObjectInterface
$filterObject
$config
protected
array<string|int, mixed>
$config
config
$defaultArgs
protected
static array<string|int, mixed>
$defaultArgs
= ['filter' => ['type' => 'value', 'valid' => ['ARRAY'], 'doc' => 'set filter for dataCycle API request. See FilterObject and dataCycle Docs for full specification.', 'default' => []]]
$fields
protected
array<string|int, mixed>
$fields
= []
fields
$fieldsDefaultArgs
protected
static array<string|int, mixed>
$fieldsDefaultArgs
= ['fields' => ['type' => 'value', 'valid' => ['Array'], 'doc' => 'set fields for dataCycle API request', 'fn' => [__CLASS__, 'setFields(array $fields)'], 'default' => []]]
$include
protected
array<string|int, mixed>
$include
= []
include
$includeDefaultArgs
protected
static array<string|int, mixed>
$includeDefaultArgs
= ['include' => ['type' => 'value', 'valid' => ['Array'], 'doc' => 'set include for dataCycle API request', 'fn' => [__CLASS__, 'setInclude(array $include)'], 'default' => []]]
$language
protected
array<string|int, mixed>
$language
= ['de']
language
$languageDefaultArgs
protected
static array<string|int, mixed>
$languageDefaultArgs
= ['language' => ['type' => 'value', 'valid' => ['Array'], 'doc' => 'set language for dataCycle API request', 'fn' => [__CLASS__, 'setLanguage(array $language)'], 'default' => ['de']]]
$pageDefaultArgs
protected
static array<string|int, mixed>
$pageDefaultArgs
= ['page' => ['size' => ['type' => 'value', 'valid' => ['Integer'], 'doc' => 'set page size dataCycle API request', 'fn' => [__CLASS__, 'take(int $pageSize)'], 'default' => []], 'number' => ['type' => 'value', 'valid' => ['Integer'], 'doc' => 'set page number dataCycle API request', 'fn' => [__CLASS__, 'page(int $pageNumber)'], 'default' => []]]]
$paging
protected
array<string|int, mixed>
$paging
= ['number' => 1, 'size' => 25]
$sort
protected
array<string|int, mixed>
$sort
= []
$sortableDefaultArgs
protected
static array<string|int, mixed>
$sortableDefaultArgs
= ['sort' => ['type' => 'value', 'valid' => ['Array'], 'doc' => 'set sort for dataCycle API request. See dataCycle Docs for full specification', 'fn' => [__CLASS__, 'sortByName(int $ordering = SORT_ASC)', 'sortByModifiedAt(int $ordering = SORT_ASC)', 'sortByCreatedAt(int $ordering = SORT_ASC)', 'sortByRandom(?float $seed = null)', 'sortBySimilarity()', 'sortByProximityInTime()', 'sortByProximityGeographic()', 'sortByProximityOccurrence()'], 'default' => []]]
$detailIds
private
array<string|int, mixed>
$detailIds
detailIds
$endpointId
private
string
$endpointId
endpointId
Methods
__construct()
creates a new query.
public
__construct([array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $args : array<string|int, mixed> = []
Tags
applyFields()
public
applyFields(array<string|int, mixed> $query) : array<string|int, mixed>
Parameters
- $query : array<string|int, mixed>
Return values
array<string|int, mixed>applyInclude()
public
applyInclude(array<string|int, mixed> $query) : array<string|int, mixed>
Parameters
- $query : array<string|int, mixed>
Return values
array<string|int, mixed>applySection()
public
applySection(array<string|int, mixed> $query) : array<string|int, mixed>
Parameters
- $query : array<string|int, mixed>
Return values
array<string|int, mixed>createFilterObject()
public
createFilterObject([array<string|int, mixed> $args = [] ]) : FilterObject
Parameters
- $args : array<string|int, mixed> = []
Return values
FilterObjectfilter()
public
filter() : FilterObject
Return values
FilterObjectgetArguments()
public
static getArguments() : array<string|int, mixed>
APIYes
Return values
array<string|int, mixed>getConfig()
public
getConfig() : array<string|int, mixed>
APIYes
Return values
array<string|int, mixed>getConfiguration()
public
getConfiguration() : array<string|int, mixed>
APIYes
Return values
array<string|int, mixed>getDetailIds()
public
getDetailIds() : array<string|int, mixed>|null
APIYes
Return values
array<string|int, mixed>|nullgetEndpointId()
public
getEndpointId() : string|null
APIYes
Return values
string|nullgetFields()
public
getFields() : array<string|int, mixed>
APIYes
Return values
array<string|int, mixed>getInclude()
public
getInclude() : array<string|int, mixed>
APIYes
Return values
array<string|int, mixed>getLanguage()
public
getLanguage() : array<string|int, mixed>
APIYes
Return values
array<string|int, mixed>getPaging()
public
getPaging() : array<string|int, mixed>
APIYes
Return values
array<string|int, mixed>getSort()
public
getSort() : array<string|int, mixed>
APIYes
Return values
array<string|int, mixed>limit()
public
limit(int $limit) : void
APIYes
Parameters
- $limit : int
offset()
public
offset(int $offset) : void
APIYes
Parameters
- $offset : int
page()
public
page(int $pageNumber) : void
APIYes
Parameters
- $pageNumber : int
setConfiguration()
public
setConfiguration(array<string|int, mixed> $configuration) : void
APIYes
Parameters
- $configuration : array<string|int, mixed>
setDetailIds()
public
setDetailIds(array<string|int, mixed> $uuids) : void
APIYes
Parameters
- $uuids : array<string|int, mixed>
setEndpointId()
public
setEndpointId(string $endpointId) : void
APIYes
Parameters
- $endpointId : string
setFields()
public
setFields(array<string|int, mixed> $fields) : void
APIYes
Parameters
- $fields : array<string|int, mixed>
setInclude()
public
setInclude(array<string|int, mixed> $include) : void
Parameters
- $include : array<string|int, mixed>
setLanguage()
public
setLanguage(array<string|int, mixed> $language) : void
Parameters
- $language : array<string|int, mixed>
setPaging()
public
setPaging(array<string|int, mixed> $page) : void
APIYes
Parameters
- $page : array<string|int, mixed>
setSort()
public
setSort(array<string|int, mixed> $sort) : void
APIYes
Parameters
- $sort : array<string|int, mixed>
sortByCreatedAt()
public
sortByCreatedAt([int $ordering = SORT_ASC ]) : void
APIYes
Parameters
- $ordering : int = SORT_ASC
sortByModifiedAt()
public
sortByModifiedAt([int $ordering = SORT_ASC ]) : void
APIYes
Parameters
- $ordering : int = SORT_ASC
sortByName()
public
sortByName([int $ordering = SORT_ASC ]) : void
APIYes
Parameters
- $ordering : int = SORT_ASC
sortByProximityGeographic()
public
sortByProximityGeographic([int $ordering = SORT_ASC ]) : void
APIYes
Parameters
- $ordering : int = SORT_ASC
sortByProximityInTime()
public
sortByProximityInTime() : void
APIYes
sortByProximityOccurrence()
public
sortByProximityOccurrence() : void
APIYes
sortByRandom()
public
sortByRandom([float|null $seed = null ]) : void
APIYes
Parameters
- $seed : float|null = null
sortBySimilarity()
public
sortBySimilarity() : void
APIYes
take()
public
take(int $pageSize) : void
APIYes
Parameters
- $pageSize : int