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

  • AbstractResource
  • Account
  • Agent
  • AgentConnection
  • AgentHost
  • AgentHostInfo
  • AgentTarget
  • AgentToken
  • Alarm
  • Changelog
  • Check
  • CheckType
  • Entity
  • Metric
  • Notification
  • NotificationHistory
  • NotificationPlan
  • NotificationType
  • ReadonlyResource
  • View
  • Zone

Interfaces

  • ResourceInterface
  • Overview
  • Namespace
  • Class
  • Tree
  • Download

Class AbstractResource

Abstract AbstractResource class.

OpenCloud\Common\Base
Extended by OpenCloud\Common\PersistentObject
Extended by OpenCloud\CloudMonitoring\Resource\AbstractResource

Direct known subclasses

OpenCloud\CloudMonitoring\Resource\Account, OpenCloud\CloudMonitoring\Resource\AgentToken, OpenCloud\CloudMonitoring\Resource\Alarm, OpenCloud\CloudMonitoring\Resource\Check, OpenCloud\CloudMonitoring\Resource\Entity, OpenCloud\CloudMonitoring\Resource\Notification, OpenCloud\CloudMonitoring\Resource\NotificationPlan, OpenCloud\CloudMonitoring\Resource\ReadonlyResource
Abstract
Namespace: OpenCloud\CloudMonitoring\Resource
Package: phpOpenCloud
Author: Jamie Hannaford <jamie@limetree.org>
Version: 1.0
Extends: PersistentObject
Located at OpenCloud/CloudMonitoring/Resource/AbstractResource.php
Methods summary
public
# __construct( mixed $service, mixed $info )

__construct function.

__construct function.

Parameters

$service
mixed
$service
$info
mixed
$info

Overrides

OpenCloud\Common\PersistentObject::__construct()
public
# getProperty( mixed $haystack, mixed $needle )

Retrieve property from array/object.

Retrieve property from array/object.

Parameters

$haystack
mixed
$haystack
$needle
mixed
$needle
public
# url( string $subresource = '', array $query = array() )

Url function.

Url function.

Parameters

$subresource
string
$subresource (default: '')
$query
array
$qstr optional k/v pairs for query strings

Throws

UrlError
if URL is not defined

Overrides

OpenCloud\Common\PersistentObject::url()
protected
# createJson( )

Procedure for JSON create object.

Procedure for JSON create object.

Throws

CreateError
if not overridden

Overrides

OpenCloud\Common\PersistentObject::createJson()
protected
# updateJson( mixed $params = array() )

Procedure for JSON update object.

Procedure for JSON update object.

Throws

UpdateError
if not overridden

Overrides

OpenCloud\Common\PersistentObject::updateJson()
public
# listAll( )

Retrieves a collection of resource objects.

Retrieves a collection of resource objects.

public
# updateUrl( )
public
# update( array $params = array() )

Update object.

Update object.

Parameters

$params
array
$params (default: array())

Throws

VolumeCreateError
if HTTP status is not Success

Overrides

OpenCloud\Common\PersistentObject::update()
public
# delete( )

Delete object.

Delete object.

Throws

DeleteError
if HTTP status is not Success

CodeCoverageIgnore

Overrides

OpenCloud\Common\PersistentObject::delete()
protected
# request( mixed $url, string $method = 'GET', array $headers = array(), mixed $body = null )

Request function.

Request function.

Parameters

$url
mixed
$url
$method
string
$method (default: 'GET')
$headers
array
$headers (default: array())
$body
mixed
$body (default: null)
public
# test( array $params = array(), boolean $debug = false )

Test the validity of certain parameters for the resource.

Test the validity of certain parameters for the resource.

Parameters

$params
array
$params (default: array())
$debug
boolean
$debug (default: false)
public
# testExisting( boolean $debug = false )

Test the validity of an existing resource.

Test the validity of an existing resource.

Parameters

$debug
boolean
$debug (default: false)
public
# refresh( mixed $id = null, mixed $url = null )

Refreshes the object from the origin (useful when the server is changing states)

Refreshes the object from the origin (useful when the server is changing states)

Throws

IdRequiredError

Overrides

OpenCloud\Common\PersistentObject::refresh()
Methods inherited from OpenCloud\Common\PersistentObject
__set(), action(), checkExtension(), create(), createUrl(), customAction(), findLink(), getParent(), getService(), id(), jsonCollectionElement(), jsonCollectionName(), jsonName(), name(), noCreate(), noDelete(), noUpdate(), parent(), primaryKeyField(), region(), resourceName(), service(), setParent(), setService(), status(), waitFor()
Methods inherited from OpenCloud\Common\Base
checkJsonError(), getHttpRequestObject(), getLogger(), makeQueryString(), populate(), setLogger(), setProperty()
Properties summary
public mixed $id
#

Unique identifier

Unique identifier

public mixed $name
#

Name

Name

PHP OpenCloud API API documentation generated by ApiGen 2.8.0