OpenCloud/DNS/Domain.php

Properties

Description

Defines a DNS domain

Classes

Domain

Properties

 
 
 
No 
No 

Description

The Domain class represents a single domain
Note that the `Subdomain` class is defined in this same file because of mutual dependencies.

Methods

AddRecord, AddSubdomain, Changes, CloneDomain, CreateJson, Export, Record, RecordList, Subdomain, SubdomainList,

AddRecord(   $record, ) : integer

Description

Adds a new record to the list (for multiple record creation)

Arguments

Name Type Description Default
$record n/a

Return value

Type Description
integer the number of records

Tags

Name Description
api

AddSubdomain(   $subdomain, ) : integer

Description

adds a new subdomain (for multiple subdomain creation)

Arguments

Name Type Description Default
$subdomain n/a

Return value

Type Description
integer the number of subdomains

Tags

Name Description
api

Changes( string   $since = null, ) : \OpenCloud\DNS\DNS\Changes

Description

returns changes since a specified date/time

Arguments

Name Type Description Default
$since string

the date or time

null

Return value

Type Description
\OpenCloud\DNS\DNS\Changes

CloneDomain( string   $newdomain, boolean   $sub = TRUE, boolean   $comments = TRUE, boolean   $email = TRUE, boolean   $records = TRUE, ) : \OpenCloud\DNS\AsyncResponse

Description

clones the domain to the specified target domain

Arguments

Name Type Description Default
$newdomain string

the new domain to create from this domain

$sub boolean

to clone subdomains as well

TRUE
$comments boolean

Replace occurrences of the reference domain name with the new domain name in comments

TRUE
$email boolean

Replace occurrences of the reference domain name with the new domain name in email addresses on the cloned (new) domain.

TRUE
$records boolean

Replace occurrences of the reference domain name with the new domain name in data fields (of records) on the cloned (new) domain. Does not affect NS records.

TRUE

Return value

Type Description
\OpenCloud\DNS\AsyncResponse

CreateJson( ) : \stdClass

Description

handles creation of multiple records at Create()

Return value

Type Description
\stdClass

Tags

Name Description
api

Export( ) : \OpenCloud\DNS\AsyncResponse

Description

exports the domain

Return value

Type Description
\OpenCloud\DNS\AsyncResponse

Record(   $info = null, ) : \OpenCloud\DNS\Record

Description

returns a Record object
Note that this method is available at the DNS level, but only for PTR records.

Arguments

Name Type Description Default
$info n/a null

Return value

Type Description
\OpenCloud\DNS\Record

RecordList( array   $filter = array(), ) : \OpenCloud\Collection

Description

returns a Collection of Record objects

Arguments

Name Type Description Default
$filter array

query-string parameters

array()

Return value

Type Description
\OpenCloud\Collection

Subdomain(   $info = array(), ) : n/a

Description

returns a Subdomain object (child of current domain)

Arguments

Name Type Description Default
$info n/a array()

Return value

Type Description
n/a n/a

SubdomainList( array   $filter = array(), ) : n/a

Description

returns a Collection of subdomains
The subdomains are all `DNS:Domain` objects that are children of the current domain.

Arguments

Name Type Description Default
$filter array

key/value pairs for query string parameters return \OpenCloud\Collection

array()

Return value

Type Description
n/a n/a

Properties

$_create_keys, $_update_keys, $accountId, $comment, $created, $emailAddress, $id, $json_collection_name, $json_name, $name, $records, $subdomains, $ttl, $updated, $url_resource,

  protected  $_create_keys = array('name', 'emailAddress', 'ttl', 'comment')




  protected  $_update_keys = array('emailAddress', 'ttl', 'comment')




  public  $accountId =




  public  $comment =




  public  $created =




  public  $emailAddress =




  public  $id =




  protected  static $json_collection_name = 'domains'




  protected  static $json_name = FALSE




  public  $name =




  private  $records = array()




  private  $subdomains = array()




  public  $ttl =




  public  $updated =




  protected  static $url_resource = 'domains'




Documentation was generated by phpDocumentor 2.0.0b6 .

Namespaces

Packages