Overview
  • Namespace
  • Class

Namespaces

  • Omines
    • DirectAdmin
      • Context
      • Objects
        • Database
        • Domains
        • Email
        • Users
      • Utility

Classes

  • BaseObject
  • Database
  • Domain
  • DomainObject

Class DomainObject

Encapsulates a domain-bound object.

Omines\DirectAdmin\Objects\BaseObject
Extended by Omines\DirectAdmin\Objects\DomainObject

Direct known subclasses

Omines\DirectAdmin\Objects\Domains\Subdomain, Omines\DirectAdmin\Objects\Email\MailObject

Indirect known subclasses

Omines\DirectAdmin\Objects\Email\Forwarder, Omines\DirectAdmin\Objects\Email\Mailbox

Abstract
Namespace: Omines\DirectAdmin\Objects
Author: Niels Keurentjes niels.keurentjes@omines.com
Located at DirectAdmin/Objects/DomainObject.php

Methods summary

protected
# __construct( string $name, Omines\DirectAdmin\Objects\Domain $domain )

Parameters

$name
Canonical name for the object
$domain
Domain to which the object belongs

Overrides

Omines\DirectAdmin\Objects\BaseObject::__construct
protected array
# invokePost( string $command, string $action, array $parameters = [], boolean $clearCache = true )

Invokes a POST command on a domain object.

Invokes a POST command on a domain object.

Parameters

$command
Command to invoke
$action
Action to execute
$parameters
Additional options for the command
$clearCache
Whether to clear the domain cache

Returns

array
Response from the API
public Omines\DirectAdmin\Objects\Domain
# getDomain( )

Returns

Omines\DirectAdmin\Objects\Domain
public string
# getDomainName( )

Returns

string
public static array
# toDomainObjectArray( array $items, string $class, Omines\DirectAdmin\Objects\Domain $domain )

Converts an associative array of descriptors to objects of the specified type.

Converts an associative array of descriptors to objects of the specified type.

Parameters

$items
$class
$domain

Returns

array

Methods inherited from Omines\DirectAdmin\Objects\BaseObject

clearCache(), getCache(), getCacheItem(), getContext(), getName(), setCache(), toObjectArray(), toRichObjectArray()

API documentation generated by ApiGen