Open Journal Systems  3.3.0
Guzzle\Service\Command\OperationCommand Class Reference
Inheritance diagram for Guzzle\Service\Command\OperationCommand:
Guzzle\Service\Command\AbstractCommand Guzzle\Common\Collection Guzzle\Service\Command\CommandInterface Guzzle\Common\ToArrayInterface Guzzle\Common\ToArrayInterface

Public Member Functions

 getRequestSerializer ()
 
 getResponseParser ()
 
 setRequestSerializer (RequestSerializerInterface $serializer)
 
 setResponseParser (ResponseParserInterface $parser)
 
- Public Member Functions inherited from Guzzle\Service\Command\AbstractCommand
 __clone ()
 
 __construct ($parameters=array(), OperationInterface $operation=null)
 
 __invoke ()
 
 execute ()
 
 getClient ()
 
 getName ()
 
 getOperation ()
 
 getRequest ()
 
 getRequestHeaders ()
 
 getResponse ()
 
 getResult ()
 
 getValidationErrors ()
 
 isExecuted ()
 
 isPrepared ()
 
 prepare ()
 
 setClient (ClientInterface $client)
 
 setOnComplete ($callable)
 
 setResult ($result)
 
 setValidator (ValidatorInterface $validator)
 
- Public Member Functions inherited from Guzzle\Common\Collection
 __construct (array $data=array())
 
 add ($key, $value)
 
 clear ()
 
 count ()
 
 filter (\Closure $closure, $static=true)
 
 get ($key)
 
 getAll (array $keys=null)
 
 getIterator ()
 
 getKeys ()
 
 getPath ($path, $separator='/', $data=null)
 
 hasKey ($key)
 
 hasValue ($value)
 
 inject ($input)
 
 keySearch ($key)
 
 map (\Closure $closure, array $context=array(), $static=true)
 
 merge ($data)
 
 offsetExists ($offset)
 
 offsetGet ($offset)
 
 offsetSet ($offset, $value)
 
 offsetUnset ($offset)
 
 overwriteWith ($data)
 
 remove ($key)
 
 replace (array $data)
 
 set ($key, $value)
 
 setPath ($path, $value)
 
 toArray ()
 

Protected Member Functions

 build ()
 
 process ()
 
- Protected Member Functions inherited from Guzzle\Service\Command\AbstractCommand
 createOperation ()
 
 getValidator ()
 
 init ()
 
 validate ()
 

Protected Attributes

 $requestSerializer
 
 $responseParser
 
- Protected Attributes inherited from Guzzle\Service\Command\AbstractCommand
 $client
 
 $onComplete
 
 $operation
 
 $request
 
 $result
 
 $validator
 
- Protected Attributes inherited from Guzzle\Common\Collection
 $data
 

Additional Inherited Members

- Static Public Member Functions inherited from Guzzle\Common\Collection
static fromConfig (array $config=array(), array $defaults=array(), array $required=array())
 
- Data Fields inherited from Guzzle\Service\Command\AbstractCommand
const DISABLE_VALIDATION = 'command.disable_validation'
 
const HEADERS_OPTION = 'command.headers'
 
const HIDDEN_PARAMS = 'command.hidden_params'
 
const ON_COMPLETE = 'command.on_complete'
 
const REQUEST_OPTIONS = 'command.request_options'
 
const RESPONSE_BODY = 'command.response_body'
 
const RESPONSE_PROCESSING = 'command.response_processing'
 
const TYPE_MODEL = 'model'
 
const TYPE_NO_TRANSLATION = 'no_translation'
 
const TYPE_RAW = 'raw'
 

Detailed Description

A command that creates requests based on {

See also
Guzzle\Service\Description\OperationInterface} objects, and if the matching operation uses a service description model in the responseClass attribute, then this command will marshal the response into an associative array based on the JSON schema of the model.

Definition at line 10 of file OperationCommand.php.

Member Function Documentation

◆ build()

Guzzle\Service\Command\OperationCommand::build ( )
protected

Create the request object that will carry out the command

Reimplemented from Guzzle\Service\Command\AbstractCommand.

Definition at line 82 of file OperationCommand.php.

References Guzzle\Service\Command\OperationCommand\getRequestSerializer().

◆ getRequestSerializer()

Guzzle\Service\Command\OperationCommand::getRequestSerializer ( )

◆ getResponseParser()

Guzzle\Service\Command\OperationCommand::getResponseParser ( )

◆ process()

Guzzle\Service\Command\OperationCommand::process ( )
protected

Create the result of the command after the request has been completed. Override this method in subclasses to customize this behavior

Reimplemented from Guzzle\Service\Command\AbstractCommand.

Definition at line 88 of file OperationCommand.php.

References Guzzle\Service\Command\OperationCommand\getResponseParser(), and Guzzle\Service\Command\AbstractCommand\RESPONSE_PROCESSING.

◆ setRequestSerializer()

Guzzle\Service\Command\OperationCommand::setRequestSerializer ( RequestSerializerInterface  $serializer)

Set the request serializer used with the command

Parameters
RequestSerializerInterface$serializerRequest serializer
Returns
self

Definition at line 45 of file OperationCommand.php.

◆ setResponseParser()

Guzzle\Service\Command\OperationCommand::setResponseParser ( ResponseParserInterface  $parser)

Set the response parser used with the command

Parameters
ResponseParserInterface$parserResponse parser
Returns
self

Definition at line 31 of file OperationCommand.php.

Field Documentation

◆ $requestSerializer

RequestSerializerInterface Guzzle\Service\Command\OperationCommand::$requestSerializer
protected

◆ $responseParser

ResponseParserInterface Guzzle\Service\Command\OperationCommand::$responseParser
protected

Response parser

Definition at line 22 of file OperationCommand.php.

Referenced by Guzzle\Service\Command\OperationCommand\getResponseParser().


The documentation for this class was generated from the following file: