Class FormData

__toString()source public

__toString( )

Converts the FormData and its parts into a string suitable for use in an HTTP request.

Returns

string

add()source public

add( string|Cake\Http\Client\FormData $name , mixed $value null )

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.

Parameters

string|Cake\Http\Client\FormData $name

The name of the part to add, or the part data object.

mixed $value optional null

The value for the part.

Returns

$this

addFile()source public

addFile( string $name , mixed $value )

Add either a file reference (string starting with @) or a file handle.

Parameters

string $name

The name to use.

mixed $value

Either a string filename, or a filehandle.

Returns

Cake\Http\Client\FormDataPart

addMany()source public

addMany( array $data )

Add multiple parts at once.

Iterates the parameter and adds all the key/values.

Parameters

array $data

Array of data to add.

Returns

$this

addRecursive()source public

addRecursive( string $name , mixed $value )

Recursively add data.

Parameters

string $name

The name to use.

mixed $value

The value to add.

boundary()source public

boundary( )

Get the boundary marker

Returns

string

contentType()source public

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.

Returns

string

count()source public

count( )

Returns the count of parts inside this object.

Returns

integer

Implementation of

Countable::count()

hasFile()source public

hasFile( )

Check whether or not the current payload has any files.

Returns

boolean
Whether or not there is a file in this payload.

isMultipart()source public

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.

Returns

boolean
Whether or not the payload is multipart.

newPart()source public

newPart( string $name , string $value )

Method for creating new instances of Part

Parameters

string $name

The name of the part.

string $value

The value to add.

Returns

Cake\Http\Client\FormDataPart

false

false

[]