Класс FormData
Обеспечивает интерфейс для создания тел сообщений в формате multipart/form-encoded.
Используется в Http\Client для загрузки данных POST/PUT и файлов.
Краткое описание свойств
- $_boundary protected
stringМаркер разделителя.
- $_hasComplexPart protected
boolУказывает, содержит ли этот объект FormData сложную часть.
- $_hasFile protected
boolУказывает, содержит ли этот объект FormData прикреплённые файлы.
- $_parts protected
Cake\Http\Client\FormDataPart[]Части данных в формате form data.
Краткое описание методов
-
__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(stringCake\Http\Client\FormDataPart $name, mixed $value = null): $this
Добавляет новую часть данных.
Значение части может быть строкой, массивом, целым числом, числом с плавающей точкой, дескриптором файла или объектом, реализующим метод __toString()
Если $value является массивом, будут добавлены несколько частей. Файлы будут считаны из текущей позиции и сохранены в памяти.
Параметры
-
stringCake\Http\Client\FormDataPart$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
Части в данных формы.
Тип
Cake\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.2/class-Cake.Http.Client.FormData.html
