Класс FormDataPart
Содержит данные и поведение для одной части в теле запроса Multipart FormData.
Добавляется в Cake\Http\Client\FormData при отправке данных на удаленный сервер.
Краткое описание свойств
- $_charset protected
string|nullАтрибут кодировки символов для полей заголовка Content-Disposition
- $_contentId protected
string|nullИдентификатор содержимого для части
- $_disposition protected
stringОтправлять способ
- $_filename protected
string|nullИмя файла для отправки, если используются файлы.
- $_name protected
stringИмя значения.
- $_transferEncoding protected
string|nullИспользуемая кодировка в этой части.
- $_type protected
string|nullТип содержимого для использования
- $_value protected
stringЗначение для отправки.
Краткое описание методов
-
__construct() public
Конструктор
-
__toString() public
Преобразование части в строку.
-
_headerParameterToString() protected
Получение строки для параметра заголовка.
-
contentId() public
Получение/установка contentId для части.
-
disposition() public
Получение/установка типа расположения.
-
filename() public
Получение/установка имени файла.
-
name() public
Получение имени части.
-
transferEncoding() public
Установка кодировки передачи для multipart.
-
type() public
Получение/установка типа содержимого.
-
value() public
Получение значения.
Подробное описание методов
__construct() public
__construct(string $name, string $value, string $disposition = 'form-data', string|null $charset = null)
Конструктор
Параметры
-
string$name Имя данных.
-
string$value Значение данных.
-
string$disposition optional Тип расположения для использования, по умолчанию form-data.
-
string|null$charset optional Кодировка символов данных.
__toString() public
__toString(): string
Преобразование части в строку.
Создаёт строку, подходящую для использования в HTTP-запросах.
Возвращаемое значение
string_headerParameterToString() protected
_headerParameterToString(string $name, string $value): string
Получение строки для параметра заголовка.
Если значение содержит не-ASCII символы, то будет установлен дополнительный заголовок, указывающий кодировку символов.
Параметры
-
string$name Имя параметра заголовка
-
string$value Значение параметра заголовка
Возвращаемое значение
stringcontentId() public
contentId(string|null $id = null): string|null
Получение/установка contentId для части.
Параметры
-
string|null$id optional Идентификатор содержимого.
Возвращаемое значение
string|nulldisposition() public
disposition(string|null $disposition = null): string
Получение/установка типа расположения.
Передав false можно отключить добавление заголовка расположения.
Параметры
-
string|null$disposition optional Используйте null для получения/строку для установки.
Возвращаемое значение
stringfilename() public
filename(string|null $filename = null): string|null
Получение/установка имени файла.
Установка имени файла в false исключит его из сгенерированного вывода.
Параметры
-
string|null$filename optional Используйте null для получения/строку для установки.
Возвращаемое значение
string|nullname() public
name(): string
Получение имени части.
Возвращаемое значение
stringtransferEncoding() public
transferEncoding(string|null $type): string|null
Установка кодировки передачи для multipart.
Полезно, когда тела содержимого находятся в кодировках, таких как base64.
Параметры
-
string|null$type Тип кодировки значения.
Возвращаемое значение
string|nulltype() public
type(string|null $type): string|null
Получение/установка типа содержимого.
Параметры
-
string|null$type Используйте null для получения/строку для установки.
Возвращаемое значение
string|nullvalue() public
value(): string
Получение значения.
Возвращаемое значение
stringПодробное описание свойств
$_charset protected
Атрибут кодировки символов для полей заголовков Content-Disposition.
Тип
string|null$_contentId protected
contentId для части.
Тип
string|null$_disposition protected
Расположение для отправки.
Тип
string$_filename protected
Имя файла для отправки, если используются файлы.
Тип
string|null$_name protected
Имя значения.
Тип
string$_transferEncoding protected
Кодировка, используемая в этой части.
Тип
string|null$_type protected
Тип содержимого для использования.
Тип
string|null$_value protected
Значение для отправки.
Тип
string
© 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/4.2/class-Cake.Http.Client.FormDataPart.html
