AwsQueryVisitor
extends AbstractRequestVisitor
in package
Location visitor used to serialize AWS query parameters (e.g. EC2, SES, SNS, SQS, etc) as POST fields
Table of Contents
Properties
- $fqname : mixed
Methods
- after() : mixed
- Called after visiting all parameters
- visit() : mixed
- Called once for each parameter being visited that matches the location type
- customResolver() : mixed
- Map nested parameters into the location_key based parameters
- prepareValue() : array<string|int, mixed>|mixed
- Prepare (filter and set desired name for request item) the value for request.
- resolveArray() : mixed
- Custom handling for arrays
- resolveObject() : mixed
- Custom handling for objects
- resolveRecursively() : array<string|int, mixed>
- Map nested parameters into the location_key based parameters
Properties
$fqname
private
mixed
$fqname
Methods
after()
Called after visiting all parameters
public
after(CommandInterface $command, RequestInterface $request) : mixed
Parameters
- $command : CommandInterface
-
Command being visited
- $request : RequestInterface
-
Request being visited
Tags
visit()
Called once for each parameter being visited that matches the location type
public
visit(CommandInterface $command, RequestInterface $request, Parameter $param, mixed $value) : mixed
Parameters
- $command : CommandInterface
-
Command being visited
- $request : RequestInterface
-
Request being visited
- $param : Parameter
-
Parameter being visited
- $value : mixed
-
Value to set
customResolver()
Map nested parameters into the location_key based parameters
protected
customResolver(array<string|int, mixed> $value, Parameter $param, array<string|int, mixed> &$query[, string $prefix = '' ]) : mixed
Parameters
- $value : array<string|int, mixed>
-
Value to map
- $param : Parameter
-
Parameter that holds information about the current key
- $query : array<string|int, mixed>
-
Built up query string values
- $prefix : string = ''
-
String to prepend to sub query values
prepareValue()
Prepare (filter and set desired name for request item) the value for request.
protected
prepareValue(mixed $value, Parameter $param) : array<string|int, mixed>|mixed
Parameters
- $value : mixed
- $param : Parameter
Return values
array<string|int, mixed>|mixedresolveArray()
Custom handling for arrays
protected
resolveArray(Parameter $param, array<string|int, mixed> $value, string $prefix, array<string|int, mixed> &$query) : mixed
Parameters
- $param : Parameter
-
Parameter for the object
- $value : array<string|int, mixed>
-
Value that is set for this parameter
- $prefix : string
-
Prefix for the resulting key
- $query : array<string|int, mixed>
-
Query string array passed by reference
resolveObject()
Custom handling for objects
protected
resolveObject(Parameter $param, array<string|int, mixed> $value, string $prefix, array<string|int, mixed> &$query) : mixed
Parameters
- $param : Parameter
-
Parameter for the object
- $value : array<string|int, mixed>
-
Value that is set for this parameter
- $prefix : string
-
Prefix for the resulting key
- $query : array<string|int, mixed>
-
Query string array passed by reference
resolveRecursively()
Map nested parameters into the location_key based parameters
protected
resolveRecursively(array<string|int, mixed> $value, Parameter $param) : array<string|int, mixed>
Parameters
- $value : array<string|int, mixed>
-
Value to map
- $param : Parameter
-
Parameter that holds information about the current key
Return values
array<string|int, mixed> —Returns the mapped array