UploadFile
in package
Описание одного файла для multipart-загрузки.
Позволяет задать источник (файл на диске или содержимое в памяти), MIME-тип
части и «отправляемое имя файла» (filename в заголовке части). Строит
нативный дескриптор cURL: CURLFile для файла с диска или
CURLStringFile для данных из памяти.
Используется в Body::multipart() и PendingRequest::withMultipart() там, где нужен контроль над MIME-типом/именем или отправка нескольких файлов в одном поле. Простой путь к файлу (строка) по-прежнему принимается напрямую.
Table of Contents
Methods
- fromPath() : self
- Файл с диска.
- fromString() : self
- Файл из содержимого в памяти (без чтения с диска).
- toCurlFile() : CURLFile|CURLStringFile
- Построить нативный дескриптор cURL для части multipart.
Methods
fromPath()
Файл с диска.
public
static fromPath(string $path[, string|null $mimeType = null ][, string|null $fileName = null ]) : self
Parameters
- $path : string
-
путь к файлу
- $mimeType : string|null = null
-
MIME-тип части (по умолчанию определяет cURL)
- $fileName : string|null = null
-
отправляемое имя (по умолчанию — базовое имя файла)
Tags
Return values
self —описание файла с диска
fromString()
Файл из содержимого в памяти (без чтения с диска).
public
static fromString(string $contents, string $fileName[, string|null $mimeType = null ]) : self
Parameters
- $contents : string
-
содержимое файла
- $fileName : string
-
отправляемое имя файла
- $mimeType : string|null = null
-
MIME-тип части (по умолчанию
application/octet-stream)
Return values
self —описание файла из памяти
toCurlFile()
Построить нативный дескриптор cURL для части multipart.
public
toCurlFile() : CURLFile|CURLStringFile
Return values
CURLFile|CURLStringFile —дескриптор файла для CURLOPT_POSTFIELDS