Overview

Namespaces

  • None
  • OpenCloud
    • Autoscale
      • Resource
    • CloudMonitoring
      • Exception
      • Resource
    • Common
      • Exceptions
      • Log
      • Request
        • Response
    • Compute
    • Database
    • DNS
    • LoadBalancer
      • Resources
    • ObjectStore
      • Resource
    • Orchestration
    • Volume
  • PHP

Classes

  • Service
  • Snapshot
  • Volume
  • VolumeType
  • Overview
  • Namespace
  • Class
  • Tree
  • Download

Class Service

Nova is an abstraction layer for the OpenStack compute service.

Nova is used as a basis for several products, including Compute services as well as Rackspace's Cloud Databases. This class is, in essence, a vehicle for sharing common code between those other classes.

OpenCloud\Common\Base
Extended by OpenCloud\Common\Service
Extended by OpenCloud\Common\Nova
Extended by OpenCloud\Volume\Service
Namespace: OpenCloud\Volume
Located at OpenCloud/Volume/Service.php
Methods summary
public
# __construct( OpenCloud\OpenStack $connection, string $name, string $region, string $urltype )

creates the VolumeService object

creates the VolumeService object

Parameters

$connection
OpenCloud\Identity
$conn - a connection object
$name
string
$serviceRegion - identifies the region of this Compute service
$region
string
$urltype - identifies the URL type ("publicURL", "privateURL")
$urltype
string
$serviceName - identifies the name of the service in the catalog

Overrides

OpenCloud\Common\Nova::__construct()
public VolumeService\Volume
# Volume( string $id = null )

Returns a Volume object

Returns a Volume object

Parameters

$id
string
$id the Volume ID

Returns

VolumeService\Volume

Api

public Collection
# VolumeList( boolean $details = true, array $filter = array() )

Returns a Collection of Volume objects

Returns a Collection of Volume objects

Parameters

$details
boolean
$details if TRUE, return all details
$filter
array
$filters array of filter key/value pairs

Returns

Collection

Api

public VolumeService\Volume
# VolumeType( string $id = null )

Returns a VolumeType object

Returns a VolumeType object

Parameters

$id
string
$id the VolumeType ID

Returns

VolumeService\Volume

Api

public Collection
# VolumeTypeList( array $filter = array() )

Returns a Collection of VolumeType objects

Returns a Collection of VolumeType objects

Parameters

$filter
array
$filters array of filter key/value pairs

Returns

Collection

Api

public OpenCloud\Volume\Snapshot
# Snapshot( mixed $id = null )

returns a Snapshot object associated with this volume

returns a Snapshot object associated with this volume

Returns

OpenCloud\Volume\Snapshot
public Collection
# SnapshotList( boolean $filter = array() )

Returns a Collection of Snapshot objects

Returns a Collection of Snapshot objects

Parameters

$filter
boolean
$detail TRUE to return full details

Returns

Collection

Api

Methods inherited from OpenCloud\Common\Nova
Flavor(), FlavorList(), Request(), load_namespaces()
Methods inherited from OpenCloud\Common\Service
collection(), extensions(), getConnection(), getCurrentNamespace(), getResources(), limits(), name(), namespaces(), region(), request(), resolveResourceClass(), resource(), resourceList(), setConnection(), url()
Methods inherited from OpenCloud\Common\Base
__set(), checkJsonError(), getHttpRequestObject(), getLogger(), makeQueryString(), populate(), setLogger(), setProperty()
Properties inherited from OpenCloud\Common\Service
$_namespaces, $conn
PHP OpenCloud API API documentation generated by ApiGen 2.8.0