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