Overview

Namespaces

  • Contrib
    • Bundle
      • CoverallsBundle
        • Console
        • Entity
      • CoverallsV1Bundle
        • Api
        • Collector
        • Command
        • Config
        • Entity
          • Git
    • Component
      • File
      • Log
      • System
        • Git
  • Guzzle
    • Batch
      • Exception
    • Cache
    • Common
      • Exception
    • Http
      • Curl
      • Exception
      • Message
      • QueryAggregator
    • Inflection
    • Iterator
    • Log
    • Parser
      • Cookie
      • Message
      • UriTemplate
      • Url
    • Plugin
      • Async
      • Backoff
      • Cache
      • Cookie
        • CookieJar
        • Exception
      • CurlAuth
      • ErrorResponse
        • Exception
      • History
      • Log
      • Md5
      • Mock
      • Oauth
    • Service
      • Builder
      • Command
        • Factory
        • LocationVisitor
          • Request
          • Response
      • Description
      • Exception
      • Resource
    • Stream
  • PHP
  • Psr
    • Log
  • Symfony
    • Component
      • Config
        • Definition
          • Builder
          • Exception
        • Exception
        • Loader
        • Resource
        • Util
      • Console
        • Command
        • Formatter
        • Helper
        • Input
        • Output
        • Tester
      • EventDispatcher
        • Debug
      • Finder
        • Adapter
        • Comparator
        • Exception
        • Expression
        • Iterator
        • Shell
      • Stopwatch
      • Yaml
        • Exception

Classes

  • Operation
  • Parameter
  • SchemaFormatter
  • SchemaValidator
  • ServiceDescription
  • ServiceDescriptionLoader

Interfaces

  • OperationInterface
  • ServiceDescriptionInterface
  • ValidatorInterface
  • Overview
  • Namespace
  • Class
  • Tree
  • Todo

Interface ServiceDescriptionInterface

A ServiceDescription stores service information based on a service document

Guzzle\Service\Description\ServiceDescriptionInterface implements Serializable

Direct known implementers

Guzzle\Service\Description\ServiceDescription
Namespace: Guzzle\Service\Description
Located at Guzzle/Service/Description/ServiceDescriptionInterface.php
Methods summary
public string
# getBaseUrl( )

Get the basePath/baseUrl of the description

Get the basePath/baseUrl of the description

Returns

string
public array
# getOperations( )

Get the API operations of the service

Get the API operations of the service

Returns

array
Returns an array of Guzzle\Service\Description\OperationInterface objects
public boolean
# hasOperation( string $name )

Check if the service has an operation by name

Check if the service has an operation by name

Parameters

$name
string
$name Name of the operation to check

Returns

boolean
public Guzzle\Service\Description\OperationInterface|null
# getOperation( string $name )

Get an API operation by name

Get an API operation by name

Parameters

$name
string
$name Name of the command

Returns

Guzzle\Service\Description\OperationInterface|null
public Guzzle\Service\Description\Parameter|null
# getModel( string $id )

Get a specific model from the description

Get a specific model from the description

Parameters

$id
string
$id ID of the model

Returns

Guzzle\Service\Description\Parameter|null
public array
# getModels( )

Get all service description models

Get all service description models

Returns

array
public boolean
# hasModel( string $id )

Check if the description has a specific model by name

Check if the description has a specific model by name

Parameters

$id
string
$id ID of the model

Returns

boolean
public string
# getApiVersion( )

Get the API version of the service

Get the API version of the service

Returns

string
public string
# getName( )

Get the name of the API

Get the name of the API

Returns

string
public string
# getDescription( )

Get a summary of the purpose of the API

Get a summary of the purpose of the API

Returns

string
public null|mixed
# getData( string $key )

Get arbitrary data from the service description that is not part of the Guzzle spec

Get arbitrary data from the service description that is not part of the Guzzle spec

Parameters

$key
string
$key Data key to retrieve

Returns

null|mixed
public Guzzle\Service\Description\ServiceDescriptionInterface
# setData( string $key, mixed $value )

Set arbitrary data on the service description

Set arbitrary data on the service description

Parameters

$key
string
$key Data key to set
$value
mixed
$value Value to set

Returns

Guzzle\Service\Description\ServiceDescriptionInterface
Methods inherited from Serializable
serialize(), unserialize()
php-coveralls API documentation generated by ApiGen 2.8.0