Класс 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.6/class-Cake.Http.Client.FormData.html