Interface Guzzle\Service\Description\OperationInterface

ExtendsGuzzle\Common\ToArrayInterface
Implemented byGuzzle\Service\Description\Operation

Interface defining data objects that hold the information of an API operation

Public Methods

Hide inherited methods

MethodDescriptionDefined By
getClass() Get the concrete operation class that implements this operation Guzzle\Service\Description\OperationInterface
getData() Get extra data from the operation Guzzle\Service\Description\OperationInterface
getDeprecated() Get whether or not the operation is deprecated Guzzle\Service\Description\OperationInterface
getDocumentationUrl() Get the documentation URL of the operation Guzzle\Service\Description\OperationInterface
getErrorResponses() Get the errors that could be encountered when executing the operation Guzzle\Service\Description\OperationInterface
getHttpMethod() Get the HTTP method of the operation Guzzle\Service\Description\OperationInterface
getName() Get the name of the operation Guzzle\Service\Description\OperationInterface
getNotes() Get a longer text field to explain the behavior of the operation Guzzle\Service\Description\OperationInterface
getParam() Get a single parameter of the operation Guzzle\Service\Description\OperationInterface
getParamNames() Returns an array of parameter names Guzzle\Service\Description\OperationInterface
getParams() Get the params of the operation Guzzle\Service\Description\OperationInterface
getResponseClass() Get what is returned from the method. Can be a primitive, class name, or model. For example, the responseClass could be 'array', which would inherently use a responseType of 'primitive'. Using a class name would set a responseType of 'class'. Specifying a model by ID will use a responseType of 'model'. Guzzle\Service\Description\OperationInterface
getResponseNotes() Get notes about the response of the operation Guzzle\Service\Description\OperationInterface
getResponseType() Get information about how the response is unmarshalled: One of 'primitive', 'class', 'model', or 'documentation' Guzzle\Service\Description\OperationInterface
getServiceDescription() Get the service description that the operation belongs to Guzzle\Service\Description\OperationInterface
getSummary() Get a short summary of what the operation does Guzzle\Service\Description\OperationInterface
getUri() Get the URI that will be merged into the generated request Guzzle\Service\Description\OperationInterface
hasParam() Check if the operation has a specific parameter by name Guzzle\Service\Description\OperationInterface
setServiceDescription() Set the service description that the operation belongs to Guzzle\Service\Description\OperationInterface
toArray() Get the array representation of an object Guzzle\Common\ToArrayInterface

Method Details

getClass() public abstract method

Get the concrete operation class that implements this operation

public abstract string getClass ( )
getData() public abstract method

Get extra data from the operation

public abstract mixed|null getData ( $name )
$name string

Name of the data point to retrieve

getDeprecated() public abstract method

Get whether or not the operation is deprecated

public abstract bool getDeprecated ( )
getDocumentationUrl() public abstract method

Get the documentation URL of the operation

public abstract string|null getDocumentationUrl ( )
getErrorResponses() public abstract method

Get the errors that could be encountered when executing the operation

public abstract array getErrorResponses ( )
getHttpMethod() public abstract method

Get the HTTP method of the operation

public abstract string|null getHttpMethod ( )
getName() public abstract method

Get the name of the operation

public abstract string|null getName ( )
getNotes() public abstract method

Get a longer text field to explain the behavior of the operation

public abstract string|null getNotes ( )
getParam() public abstract method

Get a single parameter of the operation

public abstract Guzzle\Service\Description\Parameter|null getParam ( $param )
$param string

Parameter to retrieve by name

getParamNames() public abstract method

Returns an array of parameter names

public abstract array getParamNames ( )
getParams() public abstract method

Get the params of the operation

public abstract array getParams ( )
getResponseClass() public abstract method

Get what is returned from the method. Can be a primitive, class name, or model. For example, the responseClass could be 'array', which would inherently use a responseType of 'primitive'. Using a class name would set a responseType of 'class'. Specifying a model by ID will use a responseType of 'model'.

public abstract string|null getResponseClass ( )
getResponseNotes() public abstract method

Get notes about the response of the operation

public abstract string|null getResponseNotes ( )
getResponseType() public abstract method

Get information about how the response is unmarshalled: One of 'primitive', 'class', 'model', or 'documentation'

public abstract string getResponseType ( )
getServiceDescription() public abstract method

Get the service description that the operation belongs to

public abstract Guzzle\Service\Description\ServiceDescriptionInterface|null getServiceDescription ( )
getSummary() public abstract method

Get a short summary of what the operation does

public abstract string|null getSummary ( )
getUri() public abstract method

Get the URI that will be merged into the generated request

public abstract string getUri ( )
hasParam() public abstract method

Check if the operation has a specific parameter by name

public abstract bool hasParam ( $name )
$name string

Name of the param

setServiceDescription() public abstract method

Set the service description that the operation belongs to

public abstract self setServiceDescription ( Guzzle\Service\Description\ServiceDescriptionInterface $description )
$description Guzzle\Service\Description\ServiceDescriptionInterface

Service description