/usr/share/php/Guzzle/Service/Command/CommandInterface.php is in php-guzzle 3.7.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 | <?php
namespace Guzzle\Service\Command;
use Guzzle\Common\Collection;
use Guzzle\Common\Exception\InvalidArgumentException;
use Guzzle\Http\Message\Response;
use Guzzle\Http\Message\RequestInterface;
use Guzzle\Service\Exception\CommandException;
use Guzzle\Service\Description\OperationInterface;
use Guzzle\Service\ClientInterface;
use Guzzle\Common\ToArrayInterface;
/**
* A command object that contains parameters that can be modified and accessed like an array and turned into an array
*/
interface CommandInterface extends \ArrayAccess, ToArrayInterface
{
/**
* Get the short form name of the command
*
* @return string
*/
public function getName();
/**
* Get the API operation information about the command
*
* @return OperationInterface
*/
public function getOperation();
/**
* Execute the command and return the result
*
* @return mixed Returns the result of {@see CommandInterface::execute}
* @throws CommandException if a client has not been associated with the command
*/
public function execute();
/**
* Get the client object that will execute the command
*
* @return ClientInterface|null
*/
public function getClient();
/**
* Set the client object that will execute the command
*
* @param ClientInterface $client The client object that will execute the command
*
* @return self
*/
public function setClient(ClientInterface $client);
/**
* Get the request object associated with the command
*
* @return RequestInterface
* @throws CommandException if the command has not been executed
*/
public function getRequest();
/**
* Get the response object associated with the command
*
* @return Response
* @throws CommandException if the command has not been executed
*/
public function getResponse();
/**
* Get the result of the command
*
* @return Response By default, commands return a Response object unless overridden in a subclass
* @throws CommandException if the command has not been executed
*/
public function getResult();
/**
* Set the result of the command
*
* @param mixed $result Result to set
*
* @return self
*/
public function setResult($result);
/**
* Returns TRUE if the command has been prepared for executing
*
* @return bool
*/
public function isPrepared();
/**
* Returns TRUE if the command has been executed
*
* @return bool
*/
public function isExecuted();
/**
* Prepare the command for executing and create a request object.
*
* @return RequestInterface Returns the generated request
* @throws CommandException if a client object has not been set previously or in the prepare()
*/
public function prepare();
/**
* Get the object that manages the request headers that will be set on any outbound requests from the command
*
* @return Collection
*/
public function getRequestHeaders();
/**
* Specify a callable to execute when the command completes
*
* @param mixed $callable Callable to execute when the command completes. The callable must accept a
* {@see CommandInterface} object as the only argument.
* @return self
* @throws InvalidArgumentException
*/
public function setOnComplete($callable);
}
|