Overview
  • Namespace
  • Class

Namespaces

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

Classes

  • Subdomain

Class Subdomain

Subdomain.

Omines\DirectAdmin\Objects\BaseObject
Extended by Omines\DirectAdmin\Objects\DomainObject
Extended by Omines\DirectAdmin\Objects\Domains\Subdomain
Namespace: Omines\DirectAdmin\Objects\Domains
Author: Niels Keurentjes niels.keurentjes@omines.com
Located at DirectAdmin/Objects/Domains/Subdomain.php

Methods summary

public
# __construct( string $prefix, Omines\DirectAdmin\Objects\Domain $domain )

Construct the object.

Construct the object.

Parameters

$prefix
The domain name
$domain
The containing domain

Overrides

Omines\DirectAdmin\Objects\DomainObject::__construct
public static Omines\DirectAdmin\Objects\Domains\Subdomain
# create( Omines\DirectAdmin\Objects\Domain $domain, string $prefix )

Creates a new subdomain.

Creates a new subdomain.

Parameters

$domain
Parent domain
$prefix
Prefix of the subdomain

Returns

Omines\DirectAdmin\Objects\Domains\Subdomain
The newly created object
public
# delete( boolean $deleteContents = true )

Deletes the subdomain.

Deletes the subdomain.

Parameters

$deleteContents
Whether to delete all directory contents as well
public string
# getDomainName( )

Returns the full domain name for the subdomain.

Returns the full domain name for the subdomain.

Returns

string

Overrides

Omines\DirectAdmin\Objects\DomainObject::getDomainName
public string
# getBaseDomainName( )

Returns the full domain name for the subdomain.

Returns the full domain name for the subdomain.

Returns

string
public string
# getPrefix( )

Returns the prefix of the subdomain.

Returns the prefix of the subdomain.

Returns

string
public string
# __toString( )

Allows the class to be used as a string representing the full domain name.

Allows the class to be used as a string representing the full domain name.

Returns

string

Methods inherited from Omines\DirectAdmin\Objects\DomainObject

getDomain(), invokePost(), toDomainObjectArray()

Methods inherited from Omines\DirectAdmin\Objects\BaseObject

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

API documentation generated by ApiGen