СправочникEntities
RequestBody v1.0.0
Тело запроса: JSON, form, multipart, raw body, headers.
Описание: Тело запроса: JSON, form, multipart, raw body, headers. За один запрос допускается только один тип тела (postData / formData / multipart).
Namespace: Devcraft\Webshare\Entities
Extends: Devcraft\Abstracts\AbstractReflection (dev-tools)
С версии: 1.0.0
См. также:
Public свойства
| Свойство | Тип | Описание |
|---|---|---|
$header | array | HTTP-заголовки тела. По умолчанию: []. |
$body | ?string | Raw body после build(). По умолчанию: NULL. |
$postData | array | JSON payload. По умолчанию: []. |
$formData | array | Form-urlencoded поля. По умолчанию: []. |
$multipart | array | Multipart части. По умолчанию: []. |
Методы
withPostData(): self
Описание: Добавить поле в JSON body.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$key | string | Имя поля. |
$value | mixed | Значение. |
Возвращает: self
withHeader(): self
Описание: Добавить HTTP-заголовок.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$key | string | Имя заголовка. |
$value | mixed | Значение. |
Возвращает: self
withFormData(): self
Описание: Добавить поле form-urlencoded тела.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$key | string | Имя поля. |
$value | mixed | Значение. |
Возвращает: self
withMultipart(): self
Описание: Добавить часть multipart тела.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$key | string | Имя части. |
$value | mixed | Содержимое. |
Возвращает: self
build(): self
Описание: Подготовить headers и raw body перед отправкой (Client::send вызывает автоматически).
Возвращает: self
Исключения: JsonException