Overview

Namespaces

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

Classes

  • Base
  • Lang
  • Metadata
  • PersistentObject
  • Overview
  • Namespace
  • Class
  • Tree
  • Download

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\PersistentObject, OpenCloud\Common\Service\AbstractService, OpenCloud\ObjectStore\Resource\AbstractResource

Indirect known subclasses

OpenCloud\Autoscale\Resource\AbstractResource, OpenCloud\Autoscale\Resource\Group, OpenCloud\CloudMonitoring\Resource\Check, OpenCloud\CloudMonitoring\Resource\Entity, OpenCloud\CloudMonitoring\Resource\Notification, OpenCloud\CloudMonitoring\Resource\NotificationPlan, OpenCloud\CloudMonitoring\Resource\ReadonlyResource, OpenCloud\CloudMonitoring\Service, OpenCloud\Common\Service\NovaService, OpenCloud\Compute\Resource\Flavor, OpenCloud\Compute\Resource\Image, OpenCloud\Compute\Resource\KeyPair, OpenCloud\Autoscale\Resource\GroupConfiguration, OpenCloud\Compute\Resource\Network, OpenCloud\Compute\Resource\Server, OpenCloud\Compute\Resource\ServerMetadata, OpenCloud\Compute\Resource\VolumeAttachment, OpenCloud\Compute\Service, OpenCloud\Database\Resource\Database, OpenCloud\Database\Resource\Instance, OpenCloud\Database\Resource\User, OpenCloud\Database\Service, OpenCloud\DNS\Resource\AsyncResponse, OpenCloud\Autoscale\Resource\LaunchConfiguration, OpenCloud\DNS\Resource\Domain, OpenCloud\DNS\Resource\Object, OpenCloud\DNS\Resource\PtrRecord, OpenCloud\DNS\Resource\Record, OpenCloud\DNS\Resource\Subdomain, OpenCloud\DNS\Service, OpenCloud\LoadBalancer\Resource\Access, OpenCloud\LoadBalancer\Resource\Algorithm, OpenCloud\LoadBalancer\Resource\AllowedDomain, OpenCloud\LoadBalancer\Resource\BillableLoadBalancer, OpenCloud\Autoscale\Resource\ScalingPolicy, 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\Protocol, OpenCloud\Autoscale\Resource\Webhook, OpenCloud\LoadBalancer\Resource\Readonly, OpenCloud\LoadBalancer\Resource\SessionPersistence, OpenCloud\LoadBalancer\Resource\SSLTermination, OpenCloud\LoadBalancer\Resource\Stats, OpenCloud\LoadBalancer\Resource\SubResource, OpenCloud\LoadBalancer\Resource\Usage, OpenCloud\LoadBalancer\Resource\VirtualIp, OpenCloud\LoadBalancer\Service, OpenCloud\ObjectStore\AbstractService, OpenCloud\ObjectStore\CDNService, OpenCloud\Autoscale\Service, 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\Service, OpenCloud\Queues\Resource\Claim, OpenCloud\Queues\Resource\Message, OpenCloud\CloudMonitoring\Resource\AbstractResource, 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\AgentToken, OpenCloud\CloudMonitoring\Resource\Alarm
Abstract
Namespace: OpenCloud\Common
Located at OpenCloud/Common/Base.php
Methods summary
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
mixed
$method
$args
mixed
$args

Throws

OpenCloud\Common\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
mixed
$property
$value
mixed
$value

Returns

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
string
$property The property name being investigated.
$allowRetry
boolean
$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
public mixed
# toCamel( mixed $string, boolean $capitalise = true )

Convert a string to camelCase format.

Convert a string to camelCase format.

Parameters

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

Returns

mixed
public mixed
# toUnderscores( mixed $string )

Convert string to underscore format.

Convert string to underscore format.

Parameters

$string
mixed
$string

Returns

mixed
protected mixed
# getProperty( string $property )

Grab value out of the data array.

Grab value out of the data array.

Parameters

$property
string
$property

Returns

mixed
public mixed
# setLogger( OpenCloud\Common\Log\LoggerInterface $logger )

Sets the logger.

Sets the logger.

Parameters

$logger
OpenCloud\Common\Log\LoggerInterface
$logger

Returns

mixed
$this
public OpenCloud\Common\Log\AbstractLogger
# getLogger( )

Returns the Logger object.

Returns the Logger object.

Returns

OpenCloud\Common\Log\AbstractLogger
public
# getUrl( mixed $path = null, array $query = array() )

Returns the individual URL of the service/object.

Returns the individual URL of the service/object.

Throws

OpenCloud\Common\Exceptions\UrlError
public
# populate( mixed $info, boolean $setObjects = true )

Parameters

$info
mixed
$info The data structure that is populating the object.
$setObjects
boolean
$setObjects If set to TRUE, then this method will try to populate associated resources as objects rather than anonymous data types. So, a Server being populated might stock a Network object instead of a stdClass object.

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( mixed $resource )
public
# stripNamespace( mixed $namespace )
PHP OpenCloud API API documentation generated by ApiGen 2.8.0