Класс 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
Проверяет, является ли текущий набор данных multipart.
-
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, string|resourcePsr\Http\Message\UploadedFileInterface $value): Cake\Http\Client\FormDataPart
Добавляет ссылку на файл (строку, начинающуюся с @) или дескриптор файла.
Параметры
-
string$name Используемое имя.
-
string|resourcePsr\Http\Message\UploadedFileInterface$value Имя файла (строка), дескриптор файла или экземпляр UploadedFileInterface.
Возвращаемое значение
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
Проверяет, является ли текущий набор данных multipart.
Набор данных станет multipart, когда вы добавите файлы или используете 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.4/class-Cake.Http.Client.FormData.html
