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

  • ArrayAccess
  • Base
  • Lang
  • Metadata
  • Overview
  • Namespace
  • Class
  • Tree

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\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\Agent, OpenCloud\ObjectStore\Resource\ContainerMetadata, OpenCloud\ObjectStore\Resource\DataObject, OpenCloud\ObjectStore\Service, OpenCloud\Orchestration\Resource\BuildInfo, OpenCloud\Orchestration\Resource\Event, OpenCloud\Orchestration\Resource\Resource, OpenCloud\Orchestration\Resource\ResourceType, OpenCloud\Orchestration\Resource\Stack, OpenCloud\Orchestration\Service, OpenCloud\Queues\Resource\Claim, OpenCloud\CloudMonitoring\Resource\AgentConnection, OpenCloud\Queues\Resource\Message, OpenCloud\Queues\Resource\Queue, OpenCloud\Queues\Service, OpenCloud\Volume\Resource\Snapshot, OpenCloud\Volume\Resource\Volume, 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\CloudMonitoring\Resource\CheckType, OpenCloud\Autoscale\Resource\GroupConfiguration, OpenCloud\CloudMonitoring\Resource\Entity, OpenCloud\CloudMonitoring\Resource\Metric, OpenCloud\CloudMonitoring\Resource\MetricDataPoint, OpenCloud\CloudMonitoring\Resource\Notification, OpenCloud\CloudMonitoring\Resource\NotificationHistory, OpenCloud\CloudMonitoring\Resource\NotificationType, OpenCloud\CloudMonitoring\Resource\ReadOnlyResource, OpenCloud\CloudMonitoring\Resource\View, OpenCloud\CloudMonitoring\Resource\Zone, OpenCloud\CloudMonitoring\Service, OpenCloud\Autoscale\Resource\LaunchConfiguration, 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\Compute\Resource\Network, OpenCloud\Compute\Resource\Server, OpenCloud\Compute\Resource\ServerMetadata, OpenCloud\Autoscale\Resource\ScalingPolicy, OpenCloud\Compute\Resource\VolumeAttachment, OpenCloud\Compute\Service, OpenCloud\Database\Resource\Configuration, OpenCloud\Database\Resource\Database, OpenCloud\Database\Resource\Datastore, OpenCloud\Database\Resource\DatastoreVersion, OpenCloud\Database\Resource\Instance, OpenCloud\Database\Resource\User, OpenCloud\Database\Service, OpenCloud\DNS\Resource\AbstractResource, OpenCloud\Autoscale\Resource\Webhook, OpenCloud\DNS\Resource\AsyncResponse, OpenCloud\DNS\Resource\Domain, OpenCloud\DNS\Resource\PtrRecord, OpenCloud\DNS\Resource\Record, OpenCloud\DNS\Resource\Subdomain, OpenCloud\DNS\Service, OpenCloud\Identity\Resource\Role, OpenCloud\Identity\Resource\Tenant, OpenCloud\Identity\Resource\Token, OpenCloud\Identity\Resource\User, OpenCloud\Autoscale\Service, OpenCloud\Identity\Service, OpenCloud\Image\Resource\AbstractSchemaResource, OpenCloud\Image\Resource\Image, OpenCloud\Image\Resource\Member, OpenCloud\Image\Service, OpenCloud\LoadBalancer\Resource\AbstractResource, OpenCloud\LoadBalancer\Resource\Access, OpenCloud\LoadBalancer\Resource\Algorithm, OpenCloud\LoadBalancer\Resource\AllowedDomain, OpenCloud\LoadBalancer\Resource\CertificateMapping, OpenCloud\CDN\Resource\Flavor, OpenCloud\LoadBalancer\Resource\ConnectionLogging, OpenCloud\LoadBalancer\Resource\ConnectionThrottle, OpenCloud\LoadBalancer\Resource\ContentCaching, OpenCloud\LoadBalancer\Resource\ErrorPage, OpenCloud\LoadBalancer\Resource\HealthMonitor, OpenCloud\LoadBalancer\Resource\LoadBalancer, OpenCloud\LoadBalancer\Resource\Metadata, OpenCloud\LoadBalancer\Resource\Node, OpenCloud\LoadBalancer\Resource\NodeEvent, OpenCloud\LoadBalancer\Resource\NonIdUriResource, OpenCloud\CDN\Resource\Service, OpenCloud\LoadBalancer\Resource\Protocol, OpenCloud\LoadBalancer\Resource\ReadOnlyResource, OpenCloud\LoadBalancer\Resource\SessionPersistence, OpenCloud\LoadBalancer\Resource\SSLTermination, OpenCloud\LoadBalancer\Resource\Stats, OpenCloud\LoadBalancer\Resource\UsageRecord, OpenCloud\LoadBalancer\Resource\VirtualIp, OpenCloud\LoadBalancer\Service, OpenCloud\Networking\Resource\Network, OpenCloud\Networking\Resource\Port, OpenCloud\CDN\Service, OpenCloud\Networking\Resource\SecurityGroup, OpenCloud\Networking\Resource\SecurityGroupRule, OpenCloud\Networking\Resource\Subnet, OpenCloud\Networking\Service, OpenCloud\ObjectStore\AbstractService, OpenCloud\ObjectStore\CDNService, OpenCloud\ObjectStore\Resource\AbstractContainer, OpenCloud\ObjectStore\Resource\Account, OpenCloud\ObjectStore\Resource\CDNContainer, OpenCloud\ObjectStore\Resource\Container
Abstract
Namespace: OpenCloud\Common
Located at OpenCloud/Common/Base.php
Methods summary
public static static
# getInstance( )

Returns

static
static
public
# __call( mixed $method, mixed $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
Exceptions\RuntimeException
protected mixed
# setProperty( mixed $property, mixed $value )

We can set a property under three conditions:

We can set a property under three conditions:

  1. If it has a concrete setter: setProperty()
  2. If the property exists
  3. If the property name's prefix is in an approved list

Parameters

$property
$value

Returns

mixed
mixed
protected boolean
# propertyExists( string $property, boolean $allowRetry = true )

Basic check to see whether property exists.

Basic check to see whether property exists.

Parameters

$property
The property name being investigated.
$allowRetry
If set to TRUE, the check will try to format the name in underscores because there are sometimes discrepancies between camelCaseNames and underscore_names.

Returns

boolean
bool
public mixed
# toCamel( mixed $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
mixed
public mixed
# toUnderscores( mixed $string )

Convert string to underscore format.

Convert string to underscore format.

Parameters

$string

Returns

mixed
mixed
protected mixed
# getProperty( string $property )

Grab value out of the data array.

Grab value out of the data array.

Parameters

$property

Returns

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

Sets the logger.

Sets the logger.

Parameters

$logger

Returns

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

Returns the Logger object.

Returns the Logger object.

Returns

Psr\Log\LoggerInterface
LoggerInterface
public boolean
# hasLogger( )

Returns

boolean
bool
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
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
Exceptions\JsonError

CodeCoverageIgnore

public static
# generateUuid( )
public
# makeResourceIteratorOptions( mixed $resource )
public
# stripNamespace( mixed $namespace )
protected static
# getJsonHeader( )
protected static
# getPatchHeaders( )
Constants summary
string PATCH_CONTENT_TYPE
#OpenCloud\Common\MimeConst::JSON_PATCH
Properties summary
protected array $aliases

The aliases configure for the properties of the instance.

The aliases configure for the properties of the instance.

#array()
API documentation generated by ApiGen 2.8.0