Класс FormData
Предоставляет интерфейс для создания тел сообщений в формате multipart/form-encoded.
Используется в Http\Client для загрузки данных POST/PUT и файлов.
- Cake\Network\Http\FormData реализует Countable
Краткое описание свойств
-
$_boundaryprotectedРазделитель.string -
$_hasComplexPartprotectedУказывает, содержит ли этот объект FormData сложную часть.boolean -
$_hasFileprotectedУказывает, содержит ли этот объект FormData прикреплённые файлы.boolean -
$_partsprotectedЧасти данных FormData.array
Краткое описание методов
- __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\Network\Http\FormData $name , mixed $value null )
Добавляет новую часть данных.
Значение части может быть строкой, массивом, целым числом, числом с плавающей точкой, дескриптором файла или объектом, реализующим __toString()
Если $value является массивом, будут добавлены несколько частей. Файлы будут считываться из текущей позиции и сохраняться в памяти.
Параметры
- строка|
Cake\Network\Http\FormData$name Имя части для добавления или объект данных части.
- смешанное
$valueнеобязательно null - Значение для части.
Возвращает
$this
addFile()source public
addFile( string $name , mixed $value )
Добавляет ссылку на файл (строка, начинающаяся с @) или дескриптор файла.
Параметры
- строка
$name - Используемое имя.
- смешанное
$value - Имя файла в виде строки или дескриптор файла.
Возвращает
Cake\Network\Http\FormData\PartaddMany()source public
addMany( array $data )
Добавляет сразу несколько частей.
Итерирует параметр и добавляет все пары ключ/значение.
Параметры
- массив
$data - Массив данных для добавления.
Возвращает
$this
addRecursive()source public
addRecursive( string $name , mixed $value )
Рекурсивно добавляет данные.
Параметры
- строка
$name - Используемое имя.
- смешанное
$value - Значение для добавления.
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\Network\Http\FormData\PartПодробное описание свойств
$_hasComplexPartsource
protected логическое значение
Указывает, содержит ли этот объект FormData сложную часть.
false
$_hasFilesource
protected логическое значение
Указывает, содержит ли этот объект FormData прикреплённые файлы.
false
© 2005–2016 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.
http://api.cakephp.org/3.2/class-Cake.Network.Http.FormData.html