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

  • Service
  • Overview
  • Namespace
  • Class
  • Tree

Class Service

DNS Service.

OpenCloud\Common\Base
Extended by OpenCloud\Common\Service\AbstractService implements OpenCloud\Common\Service\ServiceInterface
Extended by OpenCloud\Common\Service\CatalogService
Extended by OpenCloud\DNS\Service
Namespace: OpenCloud\DNS
Located at OpenCloud/DNS/Service.php
Methods summary
public
# collection( mixed $class, mixed $url = null, mixed $parent = null, mixed $data = null )

CodeCoverageIgnore

Overrides

OpenCloud\Common\Service\AbstractService::collection()
public OpenCloud\DNS\Resource\Domain
# domain( mixed $info = null )

Returns a domain

Returns a domain

Parameters

$info
either the ID, an object, or array of parameters

Returns

OpenCloud\DNS\Resource\Domain
Resource\Domain
public OpenCloud\DNS\Resource\Domain
# domainByName( string $domainName )

Returns a domain, given a domain name

Returns a domain, given a domain name

Parameters

$domainName
Domain name

Returns

OpenCloud\DNS\Resource\Domain
the domain object
public OpenCloud\DNS\Collection\DnsIterator
# domainList( array $filter = array() )

Returns a collection of domains

Returns a collection of domains

Parameters

$filter
key/value pairs to use as query strings

Returns

OpenCloud\DNS\Collection\DnsIterator
OpenCloud\DNS\Collection\DnsIterator
public OpenCloud\DNS\Resource\Record
# ptrRecord( mixed $info = null )

returns a PtrRecord object for a server

returns a PtrRecord object for a server

Parameters

$info
ID, array, or object containing record data

Returns

OpenCloud\DNS\Resource\Record
Resource\Record
public OpenCloud\DNS\Collection\DnsIterator
# ptrRecordList( OpenCloud\DNS\Resource\HasPtrRecordsInterface $parent )

returns a Collection of PTR records for a given Server

returns a Collection of PTR records for a given Server

Parameters

$parent
$server the server for which to retrieve the PTR records

Returns

OpenCloud\DNS\Collection\DnsIterator
OpenCloud\DNS\Collection\DnsIterator
public OpenCloud\DNS\Resource\AsyncResponse
# asyncRequest( string $url, string $method = 'GET', array $headers = array(), string $body = null )

retrieves an asynchronous response

retrieves an asynchronous response

This method calls the provided $url and expects an asynchronous response. It checks for various HTTP error codes and returns an AsyncResponse object. This object can then be used to poll for the status or to retrieve the final data as needed.

Parameters

$url
the URL of the request
$method
the HTTP method to use
$headers
key/value pairs for headers to include
$body
the body of the request (for PUT and POST)

Returns

OpenCloud\DNS\Resource\AsyncResponse
Resource\AsyncResponse
public OpenCloud\DNS\Resource\AsyncResponse
# import( string $data )

Imports domain records

Imports domain records

Note that this function is called from the service (DNS) level, and not (as you might suspect) from the Domain object. Because the function return an AsyncResponse, the domain object will not actually exist until some point after the import has occurred.

Parameters

$data
the BIND<sub>9</sub> formatted data to import

Returns

OpenCloud\DNS\Resource\AsyncResponse
Resource\AsyncResponse
public array
# limits( mixed $type = null )

returns a list of limits

returns a list of limits

Returns

array
of limits

Overrides

OpenCloud\Common\Service\CatalogService::limits()
public array
# limitTypes( )

returns an array of limit types

returns an array of limit types

Returns

array
array
public OpenCloud\DNS\Collection\DnsIterator
# listAsyncJobs( array $query = array() )

List asynchronous responses' statuses.

List asynchronous responses' statuses.

Parameters

$query
Any query parameters. Optional.

Returns

OpenCloud\DNS\Collection\DnsIterator
OpenCloud\DNS\Collection\DnsIterator

See

http://docs.rackspace.com/cdns/api/v1.0/cdns-devguide/content/viewing_status_all_asynch_jobs.html
public
# getAsyncJob( mixed $jobId, mixed $showDetails = true )
Methods inherited from OpenCloud\Common\Service\CatalogService
__construct(), getBaseUrl(), getExtensions(), getName(), getRegion(), getType(), getUrl(), getUrlType()
Methods inherited from OpenCloud\Common\Service\AbstractService
getClient(), getCurrentNamespace(), getEndpoint(), getNamespaces(), getResources(), resolveResourceClass(), resource(), resourceList(), setClient(), setEndpoint()
Methods inherited from OpenCloud\Common\Base
__call(), checkJsonError(), generateUuid(), getInstance(), getJsonHeader(), getLogger(), getPatchHeaders(), getProperty(), hasLogger(), makeResourceIteratorOptions(), populate(), propertyExists(), setLogger(), setProperty(), stripNamespace(), toCamel(), toUnderscores()
Constants summary
string DEFAULT_TYPE
#'rax:dns'
string DEFAULT_NAME
#'cloudDNS'
Constants inherited from OpenCloud\Common\Service\CatalogService
DEFAULT_URL_TYPE, SUPPORTED_VERSION
Constants inherited from OpenCloud\Common\Base
PATCH_CONTENT_TYPE
Properties summary
protected boolean $regionless

Indicates whether a service is "regionless" or not. Defaults to FALSE because nearly all services
are region-specific.

Indicates whether a service is "regionless" or not. Defaults to FALSE because nearly all services are region-specific.

#true
Properties inherited from OpenCloud\Common\Service\AbstractService
$client, $endpoint, $namespaces, $resources
Properties inherited from OpenCloud\Common\Base
$aliases
API documentation generated by ApiGen 2.8.0