Overview
  • Namespace
  • Class

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

Classes

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

Interfaces

  • ServiceInterface

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

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

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
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
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
public
# collection( $class, $url = null, $parent = null, $data = null )

Codecoverageignore

public
# namespaces( )

Deprecated

public array
# getNamespaces( )

Returns a list of supported namespaces

Returns a list of supported namespaces

Returns

array

Methods inherited from OpenCloud\Common\Base

__call(), checkJsonError(), generateUuid(), getInstance(), getLogger(), hasLogger(), makeResourceIteratorOptions(), populate(), setLogger(), stripNamespace(), toCamel(), toUnderscores(), url()

Methods inherited from OpenCloud\Common\Service\ServiceInterface

getUrl()

Constants summary

Constants inherited from OpenCloud\Common\Base

PATCH_CONTENT_TYPE

API documentation generated by ApiGen