Provides an interface for building multipart/form-encoded message bodies.
Used by Http\Client to upload POST/PUT data and files.
string
Boundary marker.
bool
Whether or not this formdata object has a complex part.
bool
Whether or not this formdata object has attached files.
\Cake\Http\Client\FormDataPart[]
The parts in the form data.
Converts the FormData and its parts into a string suitable for use in an HTTP request.
__toString()
Converts the FormData and its parts into a string suitable for use in an HTTP request.
string
add(mixed $name, mixed $value)
Add a new part to the data.
The value for a part can be a string, array, int, float, filehandle, or object implementing __toString()
If the $value is an array, multiple parts will be added. Files will be read from their current position and saved in memory.
string|\Cake\Http\Client\FormDataPart
$name The name of the part to add, or the part data object.
mixed
$value optional The value for the part.
$this
addFile(string $name, mixed $value)
Add either a file reference (string starting with @) or a file handle.
string
$name The name to use.
mixed
$value Either a string filename, or a filehandle.
\Cake\Http\Client\FormDataPart
addMany(array $data)
Add multiple parts at once.
Iterates the parameter and adds all the key/values.
array
$data Array of data to add.
$this
addRecursive(string $name, mixed $value)
Recursively add data.
string
$name The name to use.
mixed
$value The value to add.
boundary()
Get the boundary marker
string
contentType()
Get the content type for this payload.
If this object contains files, multipart/form-data
will be used, otherwise application/x-www-form-urlencoded
will be used.
string
count()
Returns the count of parts inside this object.
int
hasFile()
Check whether or not the current payload has any files.
bool
Whether or not there is a file in this payload.
isMultipart()
Check whether or not the current payload is multipart.
A payload will become multipart when you add files or use add() with a Part instance.
bool
Whether or not the payload is multipart.
newPart(string $name, string $value)
Method for creating new instances of Part
string
$name The name of the part.
string
$value The value to add.
\Cake\Http\Client\FormDataPart
Boundary marker.
string
Whether or not this formdata object has a complex part.
bool
Whether or not this formdata object has attached files.
bool
The parts in the form data.
\Cake\Http\Client\FormDataPart[]
© 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.1/class-Cake.Http.Client.FormData.html