Properties

$parameters

$parameters : array

Type

array — Parameters

$additionalParameters

$additionalParameters : \GuzzleHttp\Command\Guzzle\Parameter

Type

Parameter — Additional parameters schema

$description

$description : \GuzzleHttp\Command\Guzzle\DescriptionInterface

Type

DescriptionInterface

$config

$config : array

Type

array — Config data

Methods

__construct()

__construct(array  $config = [], \GuzzleHttp\Command\Guzzle\DescriptionInterface  $description = null) : mixed

Builds an Operation object using an array of configuration data.

  • name: (string) Name of the command
  • httpMethod: (string) HTTP method of the operation
  • uri: (string) URI template that can create a relative or absolute URL
  • parameters: (array) Associative array of parameters for the command. Each value must be an array that is used to create {@see \GuzzleHttp\Command\Guzzle\Parameter} objects.
  • summary: (string) This is a short summary of what the operation does
  • notes: (string) A longer description of the operation.
  • documentationUrl: (string) Reference URL providing more information about the operation.
  • responseModel: (string) The model name used for processing response.
  • deprecated: (bool) Set to true if this is a deprecated command
  • errorResponses: (array) Errors that could occur when executing the command. Array of hashes, each with a 'code' (the HTTP response code), 'phrase' (response reason phrase or description of the error), and 'class' (a custom exception class that would be thrown if the error is encountered).
  • data: (array) Any extra data that might be used to help build or serialize the operation
  • additionalParameters: (null|array) Parameter schema to use when an option is passed to the operation that is not in the schema

Parameters

array $config

Array of configuration data

\GuzzleHttp\Command\Guzzle\DescriptionInterface $description

Service description used to resolve models if $ref tags are found

Throws

\InvalidArgumentException

Returns

mixed —

toArray()

toArray() : array

Get the array representation of an object

Returns

array —

getServiceDescription()

getServiceDescription() : \GuzzleHttp\Command\Guzzle\Description

Get the service description that the operation belongs to

Returns

\GuzzleHttp\Command\Guzzle\Description —

getParams()

getParams() : \GuzzleHttp\Command\Guzzle\Parameter[]

Get the params of the operation

Returns

\GuzzleHttp\Command\Guzzle\Parameter[] —

getAdditionalParameters()

getAdditionalParameters() : \GuzzleHttp\Command\Guzzle\Parameter|null

Get additionalParameters of the operation

Returns

\GuzzleHttp\Command\Guzzle\Parameter|null —

hasParam()

hasParam(string  $name) : bool

Check if the operation has a specific parameter by name

Parameters

string $name

Name of the param

Returns

bool —

getParam()

getParam(string  $name) : \GuzzleHttp\Command\Guzzle\Parameter|null

Get a single parameter of the operation

Parameters

string $name

Parameter to retrieve by name

Returns

\GuzzleHttp\Command\Guzzle\Parameter|null —

getHttpMethod()

getHttpMethod() : string|null

Get the HTTP method of the operation

Returns

string|null —

getName()

getName() : string|null

Get the name of the operation

Returns

string|null —

getSummary()

getSummary() : string|null

Get a short summary of what the operation does

Returns

string|null —

getNotes()

getNotes() : string|null

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

Returns

string|null —

getDocumentationUrl()

getDocumentationUrl() : string|null

Get the documentation URL of the operation

Returns

string|null —

getResponseModel()

getResponseModel() : string

Get the name of the model used for processing the response.

Returns

string —

getDeprecated()

getDeprecated() : bool

Get whether or not the operation is deprecated

Returns

bool —

getUri()

getUri() : string

Get the URI that will be merged into the generated request

Returns

string —

getErrorResponses()

getErrorResponses() : array

Get the errors that could be encountered when executing the operation

Returns

array —

getData()

getData(string  $name = null) : mixed|null

Get extra data from the operation

Parameters

string $name

Name of the data point to retrieve or null to retrieve all of the extra data.

Returns

mixed|null —

resolveExtends()

resolveExtends( $name, array  $config) : array

Parameters

$name
array $config

Returns

array —

resolveParameters()

resolveParameters() : void

Process the description and extract the parameter config