Класс FormData
Предоставляет интерфейс для создания тел сообщений в формате multipart/form-encoded.
Используется классом Http\Client для загрузки данных POST/PUT и файлов.
- Cake\Network\Http\FormData реализует Countable
Подробное описание методов
__toStringисходный код public
__toString( )
Преобразует FormData и его части в строку, подходящую для использования в HTTP-запросе.
Возвращает
stringстрока
addисходный код public
add( string|Cake\Network\Http\FormData $name , mixed $value null )
Добавляет новую часть к данным.
Значение части может быть строкой, массивом, целым числом, числом с плавающей точкой, дескриптором файла или объектом, реализующим метод __toString()
Если $value является массивом, будут добавлены несколько частей. Файлы будут считываться из текущей позиции и сохраняться в памяти.
Параметры
- строка|
Cake\Network\Http\FormData$name - Имя добавляемой части или объект данных части.
- смешанный
$valueнеобязательно null - Значение части.
Возвращает
mixed$this
addFileисходный код public
addFile( string $name , mixed $value )
Добавляет ссылку на файл (строка, начинающаяся с @) или дескриптор файла.
Параметры
- строка
$name - Используемое имя.
- смешанный
$value - Имя файла или дескриптор файла.
Возвращает
Cake\Network\Http\FormData\Part\Cake\Network\Http\FormData\Part
addManyисходный код public
addMany( array $data )
Добавление сразу нескольких частей.
Перебирает параметр и добавляет все пары ключ/значение.
Параметры
- массив
$data - Массив данных для добавления.
Возвращает
mixed$this
addRecursiveисходный код public
addRecursive( string $name , mixed $value )
Рекурсивное добавление данных.
Параметры
- строка
$name - Используемое имя.
- смешанный
$value - Значение для добавления.
contentTypeисходный код public
contentType( )
Получить тип содержимого для этого полезного груза.
Если этот объект содержит файлы, multipart/form-data будет использован, в противном случае application/x-www-form-urlencoded будет использован.
Возвращает
stringстрока
countисходный код public
count( )
Возвращает количество частей внутри этого объекта.
Возвращает
integerцелое число
Реализация
Countable::count() hasFileисходный код public
hasFile( )
Проверяет, содержит ли текущая нагрузка файлы.
Возвращает
booleanСодержит ли нагрузка файл.
isMultipartисходный код public
isMultipart( )
Проверяет, является ли текущая нагрузка multipart.
Нагрузка станет multipart, когда вы добавите файлы или используете add() с объектом Part.
Возвращает
booleanЯвляется ли нагрузка multipart.
newPartисходный код public
newPart( string $name , string $value )
Метод для создания новых экземпляров Part
Параметры
- строка
$name - Имя части.
- строка
$value - Значение для добавления.
Возвращает
Cake\Network\Http\FormData\Part\Cake\Network\Http\FormData\Part
Краткое описание свойств
© 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.1/class-Cake.Network.Http.FormData.html