Класс FormData
Предоставляет интерфейс для создания сообщений с кодировкой multipart/form-encoded.
Используется Http\Client для загрузки данных POST/PUT и файлов.
Краткое описание полей
- $_boundary protected
stringМаркер границы.
- $_hasComplexPart protected
boolСодержит ли этот объект FormData сложную часть.
- $_hasFile protected
boolСодержит ли этот объект FormData прикрепленные файлы.
- $_parts protected
arrayCake\Http\Client\FormDataPart>Части данных формы.
Краткое описание методов
-
__toString() public
Преобразует FormData и его части в строку, подходящую для использования в HTTP-запросе.
-
add() public
Добавить новую часть к данным.
-
addFile() public
Добавить ссылку на файл (строка, начинающаяся с @) или дескриптор файла.
-
addMany() public
Добавить несколько частей одновременно.
-
addRecursive() public
Рекурсивно добавить данные.
-
boundary() public
Получить маркер границы
-
contentType() public
Получить тип контента для этой полезной нагрузки.
-
count() public
Возвращает количество частей внутри этого объекта.
-
hasFile() public
Проверить, содержит ли текущая полезная нагрузка какие-либо файлы.
-
isMultipart() public
Проверить, является ли текущая полезная нагрузка составной.
-
newPart() public
Метод для создания новых экземпляров Part
Подробное описание методов
__toString() public
__toString(): string
Преобразует FormData и его части в строку, подходящую для использования в HTTP-запросе.
Возвращает
stringadd() public
add(Cake\Http\Client\FormDataPart|string $name, mixed $value = null): $this
Добавить новую часть к данным.
Значение части может быть строкой, массивом, целым числом, числом с плавающей точкой, дескриптором файла или объектом, реализующим __toString()
Если $value является массивом, будет добавлено несколько частей. Файлы будут считываться с их текущей позиции и сохраняться в памяти.
Параметры
-
Cake\Http\Client\FormDataPart|string$name Имя добавляемой части или объект данных части.
-
mixed$value optional Значение для части.
Возвращает
$thisaddFile() public
addFile(string $name, mixed $value): Cake\Http\Client\FormDataPart
Добавить ссылку на файл (строка, начинающаяся с @) или дескриптор файла.
Параметры
-
string$name Имя для использования.
-
mixed$value Имя файла или дескриптор файла.
Возвращает
Cake\Http\Client\FormDataPartaddMany() public
addMany(array $data): $this
Добавить несколько частей одновременно.
Итерирует параметр и добавляет все ключи/значения.
Параметры
-
array$data Массив данных для добавления.
Возвращает
$thisaddRecursive() public
addRecursive(string $name, mixed $value): void
Рекурсивно добавить данные.
Параметры
-
string$name Имя для использования.
-
mixed$value Значение для добавления.
Возвращает
voidboundary() public
boundary(): string
Получить маркер границы
Возвращает
stringcontentType() public
contentType(): string
Получить тип контента для этой полезной нагрузки.
Если этот объект содержит файлы, multipart/form-data будет использоваться, иначе application/x-www-form-urlencoded будет использоваться.
Возвращает
stringcount() public
count(): int
Возвращает количество частей внутри этого объекта.
Возвращает
inthasFile() public
hasFile(): bool
Проверить, содержит ли текущая полезная нагрузка какие-либо файлы.
Возвращает
boolisMultipart() public
isMultipart(): bool
Проверить, является ли текущая полезная нагрузка составной.
Полезная нагрузка станет составной, когда вы добавите файлы или используете add() с экземпляром Part.
Возвращает
boolnewPart() public
newPart(string $name, string $value): Cake\Http\Client\FormDataPart
Метод для создания новых экземпляров Part
Параметры
-
string$name Имя части.
-
string$value Значение для добавления.
Возвращает
Cake\Http\Client\FormDataPartПодробное описание полей
$_boundary protected
Маркер границы.
Тип
string$_hasComplexPart protected
Содержит ли этот объект formdata сложную часть.
Тип
bool$_hasFile protected
Содержит ли этот объект formdata прикрепленные файлы.
Тип
bool$_parts protected
Части данных формы.
Тип
arrayCake\Http\Client\FormDataPart>
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.3/class-Cake.Http.Client.FormData.html
