Overview

Namespaces

  • OpenCloud
    • Autoscale
      • Resource
    • CDN
      • Resource
    • CloudMonitoring
      • Collection
      • Exception
      • Resource
    • Common
      • Collection
      • Constants
      • Exceptions
      • Http
        • Message
      • Log
      • Resource
      • Service
    • Compute
      • Constants
      • Exception
      • Resource
    • Database
      • Resource
    • DNS
      • Collection
      • Resource
    • Identity
      • Constants
      • Resource
    • Image
      • Enum
      • Resource
        • JsonPatch
        • Schema
    • LoadBalancer
      • Collection
      • Enum
      • Resource
    • Networking
      • Resource
    • ObjectStore
      • Constants
      • Enum
      • Exception
      • Resource
      • Upload
    • Orchestration
      • Resource
    • Queues
      • Collection
      • Exception
      • Resource
    • Volume
      • Resource
  • PHP

Classes

  • AbstractService
  • Catalog
  • CatalogItem
  • CatalogService
  • Endpoint
  • NovaService
  • ServiceBuilder

Interfaces

  • ServiceInterface
  • Overview
  • Namespace
  • Class
  • Tree

Class AbstractService

This class defines a cloud service; a relationship between a specific OpenStack and a provided service, represented by a URL in the service catalog.

Because Service is an abstract class, it cannot be called directly. Provider services such as Rackspace Cloud Servers or OpenStack Swift are each subclassed from Service.

OpenCloud\Common\Base
Extended by OpenCloud\Common\Service\AbstractService implements OpenCloud\Common\Service\ServiceInterface

Direct known subclasses

OpenCloud\Common\Service\CatalogService, OpenCloud\Identity\Service

Indirect known subclasses

OpenCloud\Autoscale\Service, OpenCloud\CDN\Service, OpenCloud\ObjectStore\AbstractService, OpenCloud\ObjectStore\CDNService, OpenCloud\ObjectStore\Service, OpenCloud\Orchestration\Service, OpenCloud\Queues\Service, OpenCloud\Volume\Service, OpenCloud\CloudMonitoring\Service, OpenCloud\Common\Service\NovaService, OpenCloud\Compute\Service, OpenCloud\Database\Service, OpenCloud\DNS\Service, OpenCloud\Image\Service, OpenCloud\LoadBalancer\Service, OpenCloud\Networking\Service
Abstract
Namespace: OpenCloud\Common\Service
Located at OpenCloud/Common/Service/AbstractService.php
Methods summary
public
# setClient( Guzzle\Http\ClientInterface $client )

Parameters

$client

Implementation of

OpenCloud\Common\Service\ServiceInterface::setClient()
public OpenCloud\Common\Http\Client
# getClient( )

Returns

OpenCloud\Common\Http\Client
\OpenCloud\Common\Http\Client

Implementation of

OpenCloud\Common\Service\ServiceInterface::getClient()
public
# setEndpoint( OpenCloud\Common\Service\Endpoint $endpoint )

Parameters

$endpoint

Implementation of

OpenCloud\Common\Service\ServiceInterface::setEndpoint()
public OpenCloud\Common\Service\Endpoint
# getEndpoint( )

Returns

OpenCloud\Common\Service\Endpoint
\OpenCloud\Common\Service\Endpoint

Implementation of

OpenCloud\Common\Service\ServiceInterface::getEndpoint()
public array
# getResources( )

Get all associated resources for this service.

Get all associated resources for this service.

Returns

array
array
protected type
# getCurrentNamespace( )

Internal method for accessing child namespace from parent scope.

Internal method for accessing child namespace from parent scope.

Returns

type
type
protected string
# resolveResourceClass( mixed $resourceName )

Resolves FQCN for local resource.

Resolves FQCN for local resource.

Parameters

$resourceName

Returns

string
string

Throws

OpenCloud\Common\Exceptions\UnrecognizedServiceError
\OpenCloud\Common\Exceptions\UnrecognizedServiceError
public object
# resource( string $resourceName, mixed $info = null, mixed $parent = null )

Factory method for instantiating resource objects.

Factory method for instantiating resource objects.

Parameters

$resourceName
$info
(default: null)
$parent
The parent object

Returns

object
object
public OpenCloud\Common\Collection\PaginatedIterator
# resourceList( string $resourceName, string|null $url = null, string|null $parent = null )

Factory method for instantiating a resource collection.

Factory method for instantiating a resource collection.

Parameters

$resourceName
$url
$parent

Returns

OpenCloud\Common\Collection\PaginatedIterator
PaginatedIterator
public
# collection( mixed $class, mixed $url = null, mixed $parent = null, mixed $data = null )

CodeCoverageIgnore

public array
# getNamespaces( )

Returns a list of supported namespaces

Returns a list of supported namespaces

Returns

array
array
Methods inherited from OpenCloud\Common\Base
__call(), checkJsonError(), generateUuid(), getInstance(), getJsonHeader(), getLogger(), getPatchHeaders(), getProperty(), hasLogger(), makeResourceIteratorOptions(), populate(), propertyExists(), setLogger(), setProperty(), stripNamespace(), toCamel(), toUnderscores()
Methods inherited from OpenCloud\Common\Service\ServiceInterface
getUrl()
Constants inherited from OpenCloud\Common\Base
PATCH_CONTENT_TYPE
Properties summary
protected OpenCloud\Common\Http\Client $client

The client which interacts with the API.

The client which interacts with the API.

#
protected OpenCloud\Common\Service\Endpoint $endpoint

The endpoint for this service.

The endpoint for this service.

#
protected array $resources

A collection of resource models that this service has control over.

A collection of resource models that this service has control over.

#array()
protected array $namespaces

Namespaces for this service.

Namespaces for this service.

#array()
Properties inherited from OpenCloud\Common\Base
$aliases
API documentation generated by ApiGen 2.8.0