Command
in package
implements
CommandInterface
Uses
HasDataTrait
AWS command object.
Interfaces, Classes and Traits
- CommandInterface
- A command object encapsulates the input parameters used to control the creation of a HTTP request and processing of a HTTP response.
Table of Contents
- $data : array<string|int, mixed>
- $handlerList : HandlerList
- $name : string
- __clone() : mixed
- __construct() : mixed
- Accepts an associative array of command options, including:
- count() : mixed
- get() : mixed
- getHandlerList() : HandlerList
- Get the handler list used to transfer the command.
- getIterator() : mixed
- getName() : string
- Get the name of the command
- hasParam() : bool
- Check if the command has a parameter by name.
- offsetExists() : mixed
- offsetGet() : mixed|null
- This method returns a reference to the variable to allow for indirect array modification (e.g., $foo['bar']['baz'] = 'qux').
- offsetSet() : mixed
- offsetUnset() : mixed
- toArray() : mixed
Properties
$data
private
array<string|int, mixed>
$data
= []
$handlerList
private
HandlerList
$handlerList
$name
private
string
$name
Methods
__clone()
public
__clone() : mixed
Return values
mixed —__construct()
Accepts an associative array of command options, including:
public
__construct(string $name[, array<string|int, mixed> $args = [] ][, HandlerList $list = null ]) : mixed
- @http: (array) Associative array of transfer options.
Parameters
- $name : string
-
Name of the command
- $args : array<string|int, mixed> = []
-
Arguments to pass to the command
- $list : HandlerList = null
-
Handler list
Return values
mixed —count()
public
count() : mixed
Return values
mixed —get()
public
get(mixed $name) : mixed
Parameters
- $name : mixed
Tags
Return values
mixed —getHandlerList()
Get the handler list used to transfer the command.
public
getHandlerList() : HandlerList
Return values
HandlerList —getIterator()
public
getIterator() : mixed
Return values
mixed —getName()
Get the name of the command
public
getName() : string
Return values
string —hasParam()
Check if the command has a parameter by name.
public
hasParam(mixed $name) : bool
Parameters
- $name : mixed
-
Name of the parameter to check
Return values
bool —offsetExists()
public
offsetExists(mixed $offset) : mixed
Parameters
- $offset : mixed
Return values
mixed —offsetGet()
This method returns a reference to the variable to allow for indirect array modification (e.g., $foo['bar']['baz'] = 'qux').
public
offsetGet( $offset) : mixed|null
Parameters
Return values
mixed|null —offsetSet()
public
offsetSet(mixed $offset, mixed $value) : mixed
Parameters
- $offset : mixed
- $value : mixed
Return values
mixed —offsetUnset()
public
offsetUnset(mixed $offset) : mixed
Parameters
- $offset : mixed
Return values
mixed —toArray()
public
toArray() : mixed