СправочникClasses
QueryBuilder v1.0.0
Построитель query: page, filters, order, search, required fields.
Описание: Построитель query: page, filters, order, search, required fields.
Namespace: Devcraft\Webshare\Classes
Extends: AbstractBasicClass
С версии: 1.0.0
См. также:
Методы
withPageSize(): self
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$pageSize | int | Размер страницы. |
Возвращает: self
withPage(): self
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$page | int | Номер страницы (1-based). |
Возвращает: self
withStartingAfter(): self
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$startingAfter | string | Cursor-пагинация. |
Возвращает: self
withRequiredField(): self
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$field | string | Имя поля. |
Возвращает: self
withOptionalField(): self
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$field | string | Имя поля. |
Возвращает: self
withRequiredFields(): self
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$fields | array | Поля ordering или списки fields. |
Возвращает: self
withOptionalFields(): self
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$fields | array | Поля ordering или списки fields. |
Возвращает: self
withFilter(): self
Описание: Добавить фильтр WebShare API.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$field | string | Имя поля. |
$value | mixed | Значение. |
$operator | FilterOperator | Оператор фильтра. По умолчанию: FilterOperator::EQUAL. |
Возвращает: self
withOrderBy(): self
Описание: Сортировка; - для descending.
Возвращает: self
withSearch(): self
Описание: Текстовый search.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$term | string | Строка поиска. |
Возвращает: self
build(): string
Описание: Собрать query string; проверяет required fields.
Возвращает: string
getFields(): array
Возвращает: array