Interface CommandInterface
A command object that contains parameters that can be modified and accessed like an array and turned into an array
- Guzzle\Service\Command\CommandInterface implements ArrayAccess, Guzzle\Common\ToArrayInterface
Direct known implementers
Indirect known implementers
Aws\Common\Command\JsonCommand,
Aws\Common\Command\QueryCommand,
Aws\S3\Command\S3Command,
Guzzle\Service\Command\ClosureCommand,
Guzzle\Service\Command\OperationCommand
Methods summary
-
publicgetName ( )Get the short form name of the command
-
publicgetOperation ( )Get the API operation information about the command
-
publicexecute ( )Execute the command and return the result
-
publicgetClient ( )Get the client object that will execute the command
-
publicsetClient ( Guzzle\Service\ClientInterface $client )Set the client object that will execute the command
-
publicgetRequest ( )Get the request object associated with the command
-
publicgetResponse ( )Get the response object associated with the command
-
publicgetResult ( )Get the result of the command
-
publicsetResult ( mixed $result )Set the result of the command
-
publicisPrepared ( )Returns TRUE if the command has been prepared for executing
-
publicisExecuted ( )Returns TRUE if the command has been executed
-
publicprepare ( )Prepare the command for executing and create a request object.
-
publicgetRequestHeaders ( )Get the object that manages the request headers that will be set on any outbound requests from the command
-
publicsetOnComplete ( mixed $callable )Specify a callable to execute when the command completes
Methods detail
Get the short form name of the command
Returns
stringGet the API operation information about the command
Returns
Execute the command and return the result
Returns
Throws
public
Guzzle\Service\Command\CommandInterface
setClient( Guzzle\Service\ClientInterface $client )
Set the client object that will execute the command
Parameters
- $client
Guzzle\Service\ClientInterface
$client The client object that will execute the command
Returns
Get the request object associated with the command
Returns
Throws
Get the response object associated with the command
Returns
Throws
Get the result of the command
Returns
Guzzle\Http\Message\ResponseBy default, commands return a Response object unless overridden in a subclass
Throws
Set the result of the command
Parameters
- $result
mixed
$result Result to set
Returns
Returns TRUE if the command has been prepared for executing
Returns
booleanReturns TRUE if the command has been executed
Returns
booleanPrepare the command for executing and create a request object.
Returns
Throws
Guzzle\Service\Exception\CommandExceptionif a client object has not been set previously or in the prepare()
Get the object that manages the request headers that will be set on any outbound requests from the command
Returns
Specify a callable to execute when the command completes
Parameters
- $callable
mixed
$callable Callable to execute when the command completes. The callable must accept aGuzzle\Service\Command\CommandInterfaceobject as the only argument.
Returns
Throws
Methods inherited from ArrayAccess
offsetExists(),
offsetGet(),
offsetSet(),
offsetUnset()