Класс FormData

Предоставляет интерфейс для создания тел сообщений в формате multipart/form-encoded.

Используется Http\Client для загрузки данных POST/PUT и файлов.

Cake\Http\Client\FormData реализует Countable

Пространство имён: Cake\Http\Client
Расположение: Http/Client/FormData.php

Краткое описание свойств

$_boundary protected

string
Разделитель.
$_hasComplexPart protected

boolean
Признак наличия сложной части в этом объекте FormData.
$_hasFile protected

boolean
Признак наличия прикреплённых файлов в этом объекте FormData.
$_parts protected

Cake\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()source public

__toString( )

Преобразует FormData и его части в строку, подходящую для использования в HTTP-запросе.

Возвращает

строка

add()source public

add( string|Cake\Http\Client\FormData $name , mixed $value = null )

Добавляет новую часть данных.

Значение части может быть строкой, массивом, целым числом, числом с плавающей точкой, дескриптором файла или объектом, реализующим __toString()

Если $value является массивом, будут добавлены несколько частей. Файлы будут считываться из текущей позиции и сохранены в памяти.

Параметры

строка|Cake\Http\Client\FormData $name: Имя части для добавления или объект данных части.
смешанный $value необязательно null: Значение для части.

Возвращает

$this

addFile()source public

addFile( string $name , mixed $value )

Добавляет ссылку на файл (строка, начинающаяся с @) или дескриптор файла.

Параметры

строка $name: Используемое имя.
смешанный $value: Имя файла или дескриптор файла.

Возвращает

Cake\Http\Client\FormDataPart

addMany()source public

addMany( array $data )

Добавляет сразу несколько частей данных.

Перебирает параметр и добавляет все пары ключ/значение.

Параметры

массив $data: Массив данных для добавления.

Возвращает

$this

addRecursive()source public

addRecursive( string $name , mixed $value )

Рекурсивно добавляет данные.

Параметры

строка $name: Используемое имя.
смешанный $value: Значение для добавления.

boundary()source public

boundary( )

Возвращает разделитель.

Возвращает

строка

contentType()source public

contentType( )

Возвращает тип содержимого для этого набора данных.

Если в этом объекте есть файлы, multipart/form-data будет использоваться, в противном случае application/x-www-form-urlencoded будет использоваться.

Возвращает

строка

count()source public

count( )

Возвращает количество частей внутри этого объекта.

Возвращает

целое число

Реализация

Countable::count()

hasFile()source public

hasFile( )

Проверяет наличие файлов в текущем наборе данных.

Возвращает

логическое значение
Признак наличия файла в наборе данных.

isMultipart()source public

isMultipart( )

Проверяет, является ли текущий набор данных multipart.

Набор данных становится multipart, когда вы добавляете файлы или используете add() с объектом Part.

Возвращает

логическое значение
Признак того, является ли набор данных multipart.

newPart()source public

newPart( string $name , string $value )

Метод для создания новых экземпляров Part

Параметры

строка $name: Имя части.
строка $value: Значение для добавления.

Возвращает

Cake\Http\Client\FormDataPart

Подробное описание свойств

$_boundarysource

protected строка

Разделитель.

$_hasComplexPartsource

protected логическое значение

Признак наличия сложной части в этом объекте FormData.

false

$_hasFilesource

protected логическое значение

Признак наличия прикреплённых файлов в этом объекте FormData.

false

$_partssource

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/3.8/class-Cake.Http.Client.FormData.html