CloudCastle Curl

Body
in package

FinalYes

Тело исходящего запроса.

Инкапсулирует полезную нагрузку и подразумеваемый заголовок Content-Type: сырые данные, JSON, форму application/x-www-form-urlencoded, multipart с файлами (CURLFile) или потоковую выгрузку файла с диска. Пустое тело представлено Body::none().

Table of Contents

Methods

contentType()  : string|null
Подразумеваемый `Content-Type`.
form()  : self
Тело формы `application/x-www-form-urlencoded`.
fromFile()  : self
Потоковая выгрузка файла с диска (`PUT`-подобная загрузка).
isMultipart()  : bool
Является ли тело multipart-формой.
json()  : self
Тело JSON.
multipart()  : self
Multipart-тело с полями и файлами.
none()  : self
Пустое тело.
postFields()  : string|array<string, string|CURLFile>|null
Значение для `CURLOPT_POSTFIELDS`.
preview()  : string
Безопасный предпросмотр тела для диагностики и экспорта команды.
raw()  : self
Сырое тело с произвольным содержимым.
size()  : int|null
Известный размер тела.
uploadFile()  : string|null
Путь к файлу потоковой выгрузки.

Methods

contentType()

Подразумеваемый `Content-Type`.

public contentType() : string|null
Return values
string|null —

значение заголовка или null

form()

Тело формы `application/x-www-form-urlencoded`.

public static form(array<string, scalar|array<string|int, scalar>> $fields) : self
Parameters
$fields : array<string, scalar|array<string|int, scalar>>

поля формы

Return values
self —

тело формы

fromFile()

Потоковая выгрузка файла с диска (`PUT`-подобная загрузка).

public static fromFile(string $path[, string|null $contentType = null ]) : self

Файл читается потоком, целиком в память не загружается.

Parameters
$path : string

путь к файлу

$contentType : string|null = null

значение Content-Type

Tags
throws
RequestException

если файл недоступен для чтения

Return values
self —

тело потоковой выгрузки

isMultipart()

Является ли тело multipart-формой.

public isMultipart() : bool
Return values
bool —

true, если полезная нагрузка — массив полей/файлов

json()

Тело JSON.

public static json(mixed $data[, int $flags = 0 ]) : self
Parameters
$data : mixed

кодируемые данные

$flags : int = 0

флаги json_encode

Tags
throws
JsonException

если данные не кодируются в JSON

Return values
self —

тело application/json

multipart()

Multipart-тело с полями и файлами.

public static multipart([array<string, string> $fields = [] ][, array<string, string> $files = [] ]) : self
Parameters
$fields : array<string, string> = []

текстовые поля формы

$files : array<string, string> = []

карта «имя поля → путь к файлу»

Tags
throws
RequestException

если файл недоступен для чтения

Return values
self —

тело multipart/form-data (границу задаёт cURL)

none()

Пустое тело.

public static none() : self
Return values
self —

тело без содержимого

postFields()

Значение для `CURLOPT_POSTFIELDS`.

public postFields() : string|array<string, string|CURLFile>|null
Return values
string|array<string, string|CURLFile>|null —

полезная нагрузка или null

preview()

Безопасный предпросмотр тела для диагностики и экспорта команды.

public preview([int $limit = 2048 ]) : string
Parameters
$limit : int = 2048

максимальная длина строкового предпросмотра

Return values
string —

человекочитаемое представление тела

raw()

Сырое тело с произвольным содержимым.

public static raw(string $content[, string|null $contentType = null ]) : self
Parameters
$content : string

содержимое тела

$contentType : string|null = null

значение Content-Type (по умолчанию не задаётся)

Return values
self —

сырое тело

size()

Известный размер тела.

public size() : int|null
Return values
int|null —

размер в байтах или null, если неизвестен

uploadFile()

Путь к файлу потоковой выгрузки.

public uploadFile() : string|null
Return values
string|null —

путь или null

On this page

Search results