\GuzzleHttp\Command\Guzzle\RequestLocationFormParamLocation

Add form_params to a request

Summary

Methods
Properties
Constants
__construct()
visit()
after()
No public properties found
No constants found
prepareValue()
resolveRecursively()
$locationName
$contentType
$formParamsData
N/A
No private methods found
No private properties found
N/A

Properties

$locationName

$locationName : string

Type

string

$contentType

$contentType : string

Type

string

$formParamsData

$formParamsData : array

Type

array

Methods

__construct()

__construct(string  $locationName = 'formParam') : mixed

Set the name of the location

Parameters

string $locationName

Returns

mixed —

visit()

visit(\GuzzleHttp\Command\CommandInterface  $command, \Psr\Http\Message\RequestInterface  $request, \GuzzleHttp\Command\Guzzle\Parameter  $param) : \Psr\Http\Message\RequestInterface

Visits a location for each top-level parameter

Parameters

\GuzzleHttp\Command\CommandInterface $command
\Psr\Http\Message\RequestInterface $request
\GuzzleHttp\Command\Guzzle\Parameter $param

Returns

\Psr\Http\Message\RequestInterface —

after()

after(\GuzzleHttp\Command\CommandInterface  $command, \Psr\Http\Message\RequestInterface  $request, \GuzzleHttp\Command\Guzzle\Operation  $operation) : \Psr\Http\Message\RequestInterface

Called when all of the parameters of a command have been visited.

Parameters

\GuzzleHttp\Command\CommandInterface $command
\Psr\Http\Message\RequestInterface $request
\GuzzleHttp\Command\Guzzle\Operation $operation

Returns

\Psr\Http\Message\RequestInterface —

prepareValue()

prepareValue(mixed  $value, \GuzzleHttp\Command\Guzzle\Parameter  $param) : array|mixed

Prepare (filter and set desired name for request item) the value for request.

Parameters

mixed $value
\GuzzleHttp\Command\Guzzle\Parameter $param

Returns

array|mixed —

resolveRecursively()

resolveRecursively(array  $value, \GuzzleHttp\Command\Guzzle\Parameter  $param) : array

Recursively prepare and filter nested values.

Parameters

array $value

Value to map

\GuzzleHttp\Command\Guzzle\Parameter $param

Parameter related to the current key.

Returns

array —

Returns the mapped array