Inheritance diagram for Guzzle\Service\Description\OperationInterface:

Public Member Functions
	getClass ()

	getData ($name)

	getDeprecated ()

	getDocumentationUrl ()

	getErrorResponses ()

	getHttpMethod ()

	getName ()

	getNotes ()

	getParam ($param)

	getParamNames ()

	getParams ()

	getResponseClass ()

	getResponseNotes ()

	getResponseType ()

	getServiceDescription ()

	getSummary ()

	getUri ()

	hasParam ($name)

	setServiceDescription (ServiceDescriptionInterface $description)

Public Member Functions inherited from Guzzle\Common\ToArrayInterface
	toArray ()

Data Fields
const	TYPE_CLASS = 'class'

const	TYPE_DOCUMENTATION = 'documentation'

const	TYPE_MODEL = 'model'

const	TYPE_PRIMITIVE = 'primitive'

Detailed Description

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

Definition at line 10 of file OperationInterface.php.

Member Function Documentation

◆ getClass()

Guzzle\Service\Description\OperationInterface::getClass ( )

Get the concrete operation class that implements this operation

Returns: string

Implemented in Guzzle\Service\Description\Operation.

◆ getData()

Guzzle\Service\Description\OperationInterface::getData ( $name )

Get extra data from the operation

Parameters

string $name Name of the data point to retrieve

Returns: mixed|null

Implemented in Guzzle\Service\Description\Operation.

◆ getDeprecated()

Guzzle\Service\Description\OperationInterface::getDeprecated ( )

Get whether or not the operation is deprecated

Returns: bool

Implemented in Guzzle\Service\Description\Operation.

◆ getDocumentationUrl()

Guzzle\Service\Description\OperationInterface::getDocumentationUrl ( )

Get the documentation URL of the operation

Returns: string|null

Implemented in Guzzle\Service\Description\Operation.

◆ getErrorResponses()

Guzzle\Service\Description\OperationInterface::getErrorResponses ( )

Get the errors that could be encountered when executing the operation

Returns: array

Implemented in Guzzle\Service\Description\Operation.

◆ getHttpMethod()

Guzzle\Service\Description\OperationInterface::getHttpMethod ( )

Get the HTTP method of the operation

Returns: string|null

Implemented in Guzzle\Service\Description\Operation.

◆ getName()

Guzzle\Service\Description\OperationInterface::getName ( )

Get the name of the operation

Returns: string|null

Implemented in Guzzle\Service\Description\Operation.

Referenced by Guzzle\Service\Description\ServiceDescription\addOperation().

◆ getNotes()

Guzzle\Service\Description\OperationInterface::getNotes ( )

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

Returns: string|null

Implemented in Guzzle\Service\Description\Operation.

◆ getParam()

Guzzle\Service\Description\OperationInterface::getParam ( $param )

Get a single parameter of the operation

Parameters

string $param Parameter to retrieve by name

Returns: Parameter|null

Implemented in Guzzle\Service\Description\Operation.

◆ getParamNames()

Guzzle\Service\Description\OperationInterface::getParamNames ( )

Returns an array of parameter names

Returns: array

Implemented in Guzzle\Service\Description\Operation.

◆ getParams()

Guzzle\Service\Description\OperationInterface::getParams ( )

Get the params of the operation

Returns: array

Implemented in Guzzle\Service\Description\Operation.

◆ getResponseClass()

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'.