СправочникAbstracts
AbstractRequest v1.0.0
Базовый Request: endpoint, QueryBuilder, request() к Client.
Описание: Базовый Request: endpoint, QueryBuilder, request() к Client.
Namespace: Devcraft\Webshare\Abstracts
Extends: AbstractBasicClass
С версии: 1.0.0
См. также:
Методы
__construct(): void
Описание: Создать request с endpoint и полями QueryBuilder.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$endpoint | string | Относительный путь ресурса. |
$parameters | array | Разрешённые optional query-поля. |
$requiredFields | array | Обязательные query-поля. По умолчанию: []. |
Возвращает: void
query(): QueryBuilder
Описание: QueryBuilder этого request.
Возвращает: QueryBuilder
updateQuery(): void
Описание: Заменить QueryBuilder.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$queryBuilder | QueryBuilder | Экземпляр QueryBuilder. |
Возвращает: void
setEndpoint(): void
Описание: Изменить endpoint.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$endpoint | string | Относительный путь ресурса. |
Возвращает: void
withEndpoint(): self
Описание: Fluent смена endpoint.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$endpoint | string | Относительный путь ресурса. |
Возвращает: self
getEndpoint(): string
Описание: Текущий endpoint.
Возвращает: string
request(): string
Описание: Выполнить HTTP-запрос через Client.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$method | RequestMethod | HTTP-метод. По умолчанию: RequestMethod::GET. |
$additionalEndpoint | ?string | Суффикс к базовому endpoint. По умолчанию: NULL. |
$body | ?RequestBody | Тело запроса. По умолчанию: NULL. |
$apiVersion | ?string | Override версии API для этого вызова. По умолчанию: NULL. |
$forceRefresh | bool | Обойти кэш GET. По умолчанию: false. |
Возвращает: string
Исключения: \JsonException