QueryBuilderInterface
extends
SortableInterface, FieldsInterface, IncludeInterface, LanguageInterface, PaginationInterface, FilterableInterface
in
Interface QueryBuilderInterface
Tags
Table of Contents
Methods
- createFilterObject() : FilterObjectInterface
- filter() : FilterObjectInterface
- getArguments() : array<string|int, mixed>
- getConfig() : array<string|int, mixed>
- getConfiguration() : array<string|int, mixed>
- 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
- setFields() : void
- setInclude() : void
- setLanguage() : void
- setPaging() : void
- setSort() : void
- sortByCreatedAt() : void
- sortByModifiedAt() : void
- take() : void
Methods
createFilterObject()
public
createFilterObject([array<string|int, mixed> $args = [] ]) : FilterObjectInterface
APIYes
Parameters
- $args : array<string|int, mixed> = []
Return values
FilterObjectInterfacefilter()
public
filter() : FilterObjectInterface
APIYes
Return values
FilterObjectInterfacegetArguments()
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>getFields()
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>
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
APIYes
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
take()
public
take(int $pageSize) : void
APIYes
Parameters
- $pageSize : int