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

  • ArrayAccess
  • Base
  • Collection
  • Lang
  • Metadata
  • PersistentObject

Class Base

The root class for all other objects used or defined by this SDK.

It contains common code for error handling as well as service functions that are useful. Because it is an abstract class, it cannot be called directly, and it has no publicly-visible properties.

Direct known subclasses

OpenCloud\Common\Collection, OpenCloud\Common\Metadata, OpenCloud\Common\Resource\BaseResource, OpenCloud\Common\Service\AbstractService, OpenCloud\ObjectStore\Resource\AbstractResource

Indirect known subclasses

OpenCloud\Autoscale\Resource\AbstractResource, OpenCloud\Autoscale\Resource\Group, OpenCloud\CloudMonitoring\Resource\AbstractResource, OpenCloud\ObjectStore\CDNService, OpenCloud\ObjectStore\Resource\AbstractContainer, OpenCloud\ObjectStore\Resource\Account, OpenCloud\ObjectStore\Resource\CDNContainer, OpenCloud\ObjectStore\Resource\Container, OpenCloud\ObjectStore\Resource\ContainerMetadata, OpenCloud\ObjectStore\Resource\DataObject, OpenCloud\ObjectStore\Service, OpenCloud\Orchestration\Resource\BuildInfo, OpenCloud\Orchestration\Resource\Event, OpenCloud\CloudMonitoring\Resource\Agent, OpenCloud\Orchestration\Resource\Resource, OpenCloud\Orchestration\Resource\ResourceType, OpenCloud\Orchestration\Resource\Stack, OpenCloud\Orchestration\Service, OpenCloud\Queues\Resource\Claim, OpenCloud\Queues\Resource\Message, OpenCloud\Queues\Resource\Queue, OpenCloud\Queues\Service, OpenCloud\Volume\Resource\Snapshot, OpenCloud\Volume\Resource\Volume, OpenCloud\CloudMonitoring\Resource\AgentConnection, OpenCloud\Volume\Resource\VolumeType, OpenCloud\Volume\Service, OpenCloud\CloudMonitoring\Resource\AgentHost, OpenCloud\CloudMonitoring\Resource\AgentHostInfo, OpenCloud\CloudMonitoring\Resource\AgentTarget, OpenCloud\CloudMonitoring\Resource\AgentToken, OpenCloud\CloudMonitoring\Resource\Alarm, OpenCloud\CloudMonitoring\Resource\Changelog, OpenCloud\CloudMonitoring\Resource\Check, OpenCloud\Autoscale\Resource\GroupConfiguration, OpenCloud\CloudMonitoring\Resource\CheckType, OpenCloud\CloudMonitoring\Resource\Entity, OpenCloud\CloudMonitoring\Resource\Metric, OpenCloud\CloudMonitoring\Resource\MetricDataPoint, OpenCloud\CloudMonitoring\Resource\Notification, OpenCloud\CloudMonitoring\Resource\NotificationHistory, OpenCloud\CloudMonitoring\Resource\NotificationPlan, OpenCloud\CloudMonitoring\Resource\NotificationType, OpenCloud\CloudMonitoring\Resource\ReadOnlyResource, OpenCloud\CloudMonitoring\Resource\View, OpenCloud\Autoscale\Resource\LaunchConfiguration, OpenCloud\CloudMonitoring\Resource\Zone, OpenCloud\CloudMonitoring\Service, OpenCloud\Common\PersistentObject, OpenCloud\Common\Resource\NovaResource, OpenCloud\Common\Resource\PersistentResource, OpenCloud\Common\Resource\ReadOnlyResource, OpenCloud\Common\Service\CatalogService, OpenCloud\Common\Service\NovaService, OpenCloud\Compute\Resource\Flavor, OpenCloud\Compute\Resource\Image, OpenCloud\Autoscale\Resource\ScalingPolicy, OpenCloud\Compute\Resource\KeyPair, OpenCloud\Compute\Resource\Network, OpenCloud\Compute\Resource\Server, OpenCloud\Compute\Resource\ServerMetadata, OpenCloud\Compute\Resource\VolumeAttachment, OpenCloud\Compute\Service, OpenCloud\Database\Resource\Backup, OpenCloud\Database\Resource\Configuration, OpenCloud\Database\Resource\Database, OpenCloud\Database\Resource\Datastore, OpenCloud\Autoscale\Resource\Webhook, OpenCloud\Database\Resource\DatastoreVersion, OpenCloud\Database\Resource\Instance, OpenCloud\Database\Resource\User, OpenCloud\Database\Service, OpenCloud\DNS\Resource\AbstractResource, OpenCloud\DNS\Resource\AsyncResponse, OpenCloud\DNS\Resource\Domain, OpenCloud\DNS\Resource\PtrRecord, OpenCloud\DNS\Resource\Record, OpenCloud\DNS\Resource\Subdomain, OpenCloud\Autoscale\Service, OpenCloud\DNS\Service, OpenCloud\Identity\Resource\Role, OpenCloud\Identity\Resource\Tenant, OpenCloud\Identity\Resource\Token, OpenCloud\Identity\Resource\User, OpenCloud\Identity\Service, OpenCloud\Image\Resource\AbstractSchemaResource, OpenCloud\Image\Resource\Image, OpenCloud\Image\Resource\Member, OpenCloud\Image\Service, OpenCloud\CDN\Resource\Flavor, OpenCloud\LoadBalancer\Resource\AbstractResource, OpenCloud\LoadBalancer\Resource\Access, OpenCloud\LoadBalancer\Resource\Algorithm, OpenCloud\LoadBalancer\Resource\AllowedDomain, OpenCloud\LoadBalancer\Resource\CertificateMapping, OpenCloud\LoadBalancer\Resource\ConnectionLogging, OpenCloud\LoadBalancer\Resource\ConnectionThrottle, OpenCloud\LoadBalancer\Resource\ContentCaching, OpenCloud\LoadBalancer\Resource\ErrorPage, OpenCloud\LoadBalancer\Resource\HealthMonitor, OpenCloud\CDN\Resource\Service, OpenCloud\LoadBalancer\Resource\LoadBalancer, OpenCloud\LoadBalancer\Resource\Metadata, OpenCloud\LoadBalancer\Resource\Node, OpenCloud\LoadBalancer\Resource\NodeEvent, OpenCloud\LoadBalancer\Resource\NonIdUriResource, OpenCloud\LoadBalancer\Resource\Protocol, OpenCloud\LoadBalancer\Resource\ReadOnlyResource, OpenCloud\LoadBalancer\Resource\SessionPersistence, OpenCloud\LoadBalancer\Resource\SSLTermination, OpenCloud\LoadBalancer\Resource\Stats, OpenCloud\CDN\Service, OpenCloud\LoadBalancer\Resource\UsageRecord, OpenCloud\LoadBalancer\Resource\VirtualIp, OpenCloud\LoadBalancer\Service, OpenCloud\Networking\Resource\Network, OpenCloud\Networking\Resource\Port, OpenCloud\Networking\Resource\SecurityGroup, OpenCloud\Networking\Resource\SecurityGroupRule, OpenCloud\Networking\Resource\Subnet, OpenCloud\Networking\Service, OpenCloud\ObjectStore\AbstractService

Abstract
Namespace: OpenCloud\Common
Located at OpenCloud/Common/Base.php

Methods summary

public static static
# getInstance( )

Returns

static
public
# __call( $method, $args )

Intercept non-existent method calls for dynamic getter/setter functionality.

Intercept non-existent method calls for dynamic getter/setter functionality.

Parameters

$method
$args

Throws

OpenCloud\Common\Exceptions\RuntimeException
public mixed
# toCamel( $string, boolean $capitalise = true )

Convert a string to camelCase format.

Convert a string to camelCase format.

Parameters

$string
$capitalise
Optional flag which allows for word capitalization.

Returns

mixed
public mixed
# toUnderscores( $string )

Convert string to underscore format.

Convert string to underscore format.

Parameters

$string

Returns

mixed
public
# setLogger( Psr\Log\LoggerInterface $logger = null )

Sets the logger.

Sets the logger.

Parameters

$logger

Returns


$this
public Psr\Log\LoggerInterface
# getLogger( )

Returns the Logger object.

Returns the Logger object.

Returns

Psr\Log\LoggerInterface
public boolean
# hasLogger( )

Returns

boolean
public
# url( $path = null, array $query = array() )

Deprecated

public
# populate( mixed $info, boolean $setObjects = true )

Populates the current object based on an unknown data type.

Populates the current object based on an unknown data type.

Parameters

$info
$setObjects

Throws

OpenCloud\Common\Exceptions\InvalidArgumentError
public static
# checkJsonError( )

Checks the most recent JSON operation for errors.

Checks the most recent JSON operation for errors.

Throws

OpenCloud\Common\Exceptions\JsonError

Codecoverageignore

public static
# generateUuid( )
public
# makeResourceIteratorOptions( $resource )
public
# stripNamespace( $namespace )

Constants summary

string PATCH_CONTENT_TYPE
# OpenCloud\Common\MimeConst::JSON_PATCH
API documentation generated by ApiGen