HeaderVisitor
extends AbstractRequestVisitor
in package
Visitor used to apply a parameter to a header value
Table of Contents
Methods
- after() : mixed
- Called after visiting all parameters
- visit() : mixed
- Called once for each parameter being visited that matches the location type
- addPrefixedHeaders() : mixed
- Add a prefixed array of headers to the request
- prepareValue() : array<string|int, mixed>|mixed
- Prepare (filter and set desired name for request item) the value for request.
- resolveRecursively() : array<string|int, mixed>
- Map nested parameters into the location_key based parameters
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
addPrefixedHeaders()
Add a prefixed array of headers to the request
protected
addPrefixedHeaders(RequestInterface $request, Parameter $param, array<string|int, mixed> $value) : mixed
Parameters
- $request : RequestInterface
-
Request to update
- $param : Parameter
-
Parameter object
- $value : array<string|int, mixed>
-
Header array to add
Tags
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>|mixedresolveRecursively()
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