Interface OperationInterface
Interface defining data objects that hold the information of an API operation
- Guzzle\Service\Description\OperationInterface implements Guzzle\Common\ToArrayInterface
Direct known implementers
Methods summary
-
publicgetServiceDescription ( )Get the service description that the operation belongs to
-
publicsetServiceDescription ( Guzzle\Service\Description\ServiceDescriptionInterface $description )Set the service description that the operation belongs to
-
publicgetParams ( )Get the params of the operation
-
publicgetParamNames ( )Returns an array of parameter names
-
publichasParam ( string $name )Check if the operation has a specific parameter by name
-
publicgetParam ( string $param )Get a single parameter of the operation
-
publicgetHttpMethod ( )Get the HTTP method of the operation
-
publicgetClass ( )Get the concrete operation class that implements this operation
-
publicgetName ( )Get the name of the operation
-
publicgetSummary ( )Get a short summary of what the operation does
-
publicgetNotes ( )Get a longer text field to explain the behavior of the operation
-
publicgetDocumentationUrl ( )Get the documentation URL of the operation
-
publicgetResponseClass ( )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'.
-
publicgetResponseType ( )Get information about how the response is unmarshalled: One of 'primitive', 'class', 'model', or 'documentation'
-
publicgetResponseNotes ( )Get notes about the response of the operation
-
publicgetDeprecated ( )Get whether or not the operation is deprecated
-
publicgetUri ( )Get the URI that will be merged into the generated request
-
publicgetErrorResponses ( )Get the errors that could be encountered when executing the operation
-
publicgetData ( string $name )Get extra data from the operation
Methods detail
Get the service description that the operation belongs to
Returns
public
Guzzle\Service\Description\OperationInterface
setServiceDescription( Guzzle\Service\Description\ServiceDescriptionInterface $description )
Set the service description that the operation belongs to
Parameters
- $description
Guzzle\Service\Description\ServiceDescriptionInterface
$description Service description
Returns
Get the params of the operation
Returns
arrayReturns an array of parameter names
Returns
arrayCheck if the operation has a specific parameter by name
Parameters
- $name
string
$name Name of the param
Returns
booleanGet a single parameter of the operation
Parameters
- $param
string
$param Parameter to retrieve by name
Returns
Get the HTTP method of the operation
Returns
string|nullGet the concrete operation class that implements this operation
Returns
stringGet the name of the operation
Returns
string|nullGet a short summary of what the operation does
Returns
string|nullGet a longer text field to explain the behavior of the operation
Returns
string|nullGet the documentation URL of the operation
Returns
string|nullGet 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'.
Returns
string|nullGet information about how the response is unmarshalled: One of 'primitive', 'class', 'model', or 'documentation'
Returns
stringGet notes about the response of the operation
Returns
string|nullGet whether or not the operation is deprecated
Returns
booleanGet the URI that will be merged into the generated request
Returns
stringGet the errors that could be encountered when executing the operation
Returns
arrayGet extra data from the operation
Parameters
- $name
string
$name Name of the data point to retrieve
Returns
mixed|nullMethods inherited from Guzzle\Common\ToArrayInterface
Magic methods summary
Constants summary
string |
TYPE_PRIMITIVE |
'primitive' |
|
string |
TYPE_CLASS |
'class' |
|
string |
TYPE_DOCUMENTATION |
'documentation' |
|
string |
TYPE_MODEL |
'model' |