Alternc_Api_Object_Subdomain Class Reference

Subdomain Api of AlternC, used by alternc-api package. More...

Inheritance diagram for Alternc_Api_Object_Subdomain:

Public Member Functions
	__construct ($service)
	get ($options)
	API Method from legacy class method dom->get_sub_domain_all($dom) More...
	set ($options)
	API Method from legacy class method dom->set_sub_domain($dom) More...

Public Attributes
const	ERR_INVALID_ARGUMENT = 111201
const	ERR_ALTERNC_FUNCTION = 111202
const	ERR_NOT_FOUND = 111203

Protected Member Functions
	alterncLegacyErrorManager ()
	return a proper Alternc_Api_Response from an error class and error string from AlternC legacy class More...
	offsetAndCount ($options, $max)
	ensure that offset & count are set properly from $options. More...

Protected Attributes
	$dom
	$admin
	$cuid
	$isAdmin
	$db

Detailed Description

Subdomain Api of AlternC, used by alternc-api package.

Definition at line 6 of file Subdomain.php.

Constructor & Destructor Documentation

__construct()

Alternc_Api_Object_Subdomain::__construct

(

$service

)

Reimplemented from Alternc_Api_Legacyobject.

Definition at line 10 of file Subdomain.php.

                                   {
        global $dom;
        parent::__construct($service);
        $this->dom = $dom;
    }

References $dom.

Member Function Documentation

alterncLegacyErrorManager()

Alternc_Api_Legacyobject::alterncLegacyErrorManager ( )

protectedinherited

return a proper Alternc_Api_Response from an error class and error string from AlternC legacy class

Definition at line 38 of file Legacyobject.php.

                                                   {
        global $err;
        return new Alternc_Api_Response(array("code" => self::ERR_ALTERNC_FUNCTION, "message" => "[" . $err->clsid . "] " . $err->error));
    }

References $err.

Referenced by Alternc_Api_Object_Mail\account(), Alternc_Api_Object_Account\add(), Alternc_Api_Object_Domain\add(), Alternc_Api_Object_Ftp\add(), Alternc_Api_Object_Mysql\add(), Alternc_Api_Object_Ssl\aliasAdd(), Alternc_Api_Object_Ssl\aliasDel(), Alternc_Api_Object_Policy\check(), Alternc_Api_Object_Mail\create(), Alternc_Api_Object_Account\del(), Alternc_Api_Object_Domain\del(), Alternc_Api_Object_Ftp\del(), Alternc_Api_Object_Mysql\del(), Alternc_Api_Object_Mail\delete(), Alternc_Api_Object_Mail\disable(), Alternc_Api_Object_Mail\enable(), Alternc_Api_Object_Ssl\finalize(), Alternc_Api_Object_Account\find(), Alternc_Api_Object_Ftp\find(), Alternc_Api_Object_Mysql\find(), Alternc_Api_Object_Policy\find(), Alternc_Api_Object_Domain\get(), Alternc_Api_Object_Mail\get(), get(), Alternc_Api_Object_Mail\getAll(), Alternc_Api_Object_Ssl\getCertificate(), Alternc_Api_Object_Ssl\importCert(), Alternc_Api_Object_Mail\isAvailable(), Alternc_Api_Object_Ftp\isFtp(), Alternc_Api_Object_Mail\listDomains(), Alternc_Api_Object_Account\lock(), Alternc_Api_Object_Mysql\lock(), Alternc_Api_Object_Ssl\newCsr(), Alternc_Api_Object_Mail\passwd(), set(), Alternc_Api_Object_Account\setAdmin(), Alternc_Api_Object_Mysql\setAdmin(), Alternc_Api_Object_Ssl\share(), Alternc_Api_Object_Mail\undelete(), Alternc_Api_Object_Account\unlock(), Alternc_Api_Object_Mysql\unlock(), Alternc_Api_Object_Account\unsetAdmin(), Alternc_Api_Object_Mysql\unsetAdmin(), Alternc_Api_Object_Account\update(), Alternc_Api_Object_Domain\update(), Alternc_Api_Object_Ftp\update(), Alternc_Api_Object_Mail\update(), Alternc_Api_Object_Mysql\update(), and Alternc_Api_Object_Policy\update().

get()

Alternc_Api_Object_Subdomain::get

(

$options

)

API Method from legacy class method dom->get_sub_domain_all($dom)

Parameters

$options

a hash with parameters transmitted to legacy call musr be the subdomain id ID

Returns

Alternc_Api_Response whose content is the list of subdomains on this server

Definition at line 21 of file Subdomain.php.

                           {
        global $cuid;
        if ($this->isAdmin) {
            if (isset($options["uid"])) {
                $cuid = intval($options["uid"]);
            }
        }
        $mandatory = array("id");
        $missing = "";
        foreach ($mandatory as $key) {
            if (!isset($options[$key])) {
                $missing.=$key . " ";
            }
        }
        if ($missing) {
            return new Alternc_Api_Response(array("code" => self::ERR_INVALID_ARGUMENT, "message" => "Missing or invalid argument: " . $missing));
        }
        $this->dom->lock();
        $did = $this->dom->get_sub_domain_all($options["id"]);
        $this->dom->unlock();
        if (!$did) {
            return $this->alterncLegacyErrorManager();
        } else {
            return new Alternc_Api_Response(array("content" => $did));
        }
    }

References Alternc_Api_Legacyobject\$cuid, $key, and Alternc_Api_Legacyobject\alterncLegacyErrorManager().

offsetAndCount()

Alternc_Api_Legacyobject::offsetAndCount (   $options,   $max  )

protectedinherited

ensure that offset & count are set properly from $options.

Definition at line 45 of file Legacyobject.php.

                                                      {
        $offset = -1;
        $count = -1;
        if (isset($options["count"]))
            $count = intval($options["count"]);
        if (isset($options["offset"]))
            $offset = intval($options["offset"]);
        if ($offset != -1 || $count != -1) {
            if ($offset < 0 || $offset > $max)
                $offset = 0;
            if ($count < 0 || $count > 1000)
                $count = 1000;
        }
        return array($offset, $count);
    }

Referenced by Alternc_Api_Object_Account\find(), Alternc_Api_Object_Domain\find(), Alternc_Api_Object_Ftp\find(), and Alternc_Api_Object_Mysql\find().

set()

Alternc_Api_Object_Subdomain::set

(

$options

)

API Method from legacy class method dom->set_sub_domain($dom)

Parameters

$options

a hash with parameters transmitted to legacy call must be $dom, $sub, $type, $dest and could be $sub_domain_id

Returns

Alternc_Api_Response whose content is true or false if the change has been made

Definition at line 54 of file Subdomain.php.

                           {
        global $cuid;
        if ($this->isAdmin) {
            if (isset($options["uid"])) {
                $cuid = intval($options["uid"]);
            }
        }
        $mandatory = array("dom", "sub", "type", "dest");
        $defaults = array("sub_domain_id" => null);
        $missing = "";
        foreach ($mandatory as $key) {
            if (!isset($options[$key])) {
                $missing.=$key . " ";
            }
        }
        foreach ($defaults as $key => $value) {
            if (!isset($options[$key])) {
                $options[$key] = $value;
            }
        }
        if ($missing) {
            return new Alternc_Api_Response(array("code" => self::ERR_INVALID_ARGUMENT, "message" => "Missing or invalid argument: " . $missing));
        }
        $this->dom->lock();
        $did = $this->dom->set_sub_domain($options["dom"], $options["sub"], $options["type"], $options["dest"], $options["sub_domain_id"]);
        $this->dom->unlock();
        if (!$did) {
            return $this->alterncLegacyErrorManager();
        } else {
            return new Alternc_Api_Response(array("content" => $did));
        }
    }

References Alternc_Api_Legacyobject\$cuid, $key, $value, and Alternc_Api_Legacyobject\alterncLegacyErrorManager().

Member Data Documentation

$admin

Alternc_Api_Legacyobject::$admin

protectedinherited

Definition at line 11 of file Legacyobject.php.

Referenced by Alternc_Api_Legacyobject\__construct().

$cuid

Alternc_Api_Legacyobject::$cuid

protectedinherited

Definition at line 12 of file Legacyobject.php.

Referenced by Alternc_Api_Legacyobject\__construct(), Alternc_Api_Object_Domain\find(), Alternc_Api_Object_Domain\get(), get(), Alternc_Api_Object_Mail\listDomains(), Alternc_Api_Object_Mail\login(), and set().

$db

Alternc_Api_Legacyobject::$db

protectedinherited

Definition at line 14 of file Legacyobject.php.

$dom

Alternc_Api_Object_Subdomain::$dom

protected

Definition at line 8 of file Subdomain.php.

Referenced by __construct().

$isAdmin

Alternc_Api_Legacyobject::$isAdmin

protectedinherited

Definition at line 13 of file Legacyobject.php.

Referenced by Alternc_Api_Legacyobject\__construct().

ERR_ALTERNC_FUNCTION

const Alternc_Api_Legacyobject::ERR_ALTERNC_FUNCTION = 111202

inherited

Definition at line 17 of file Legacyobject.php.

ERR_INVALID_ARGUMENT

const Alternc_Api_Legacyobject::ERR_INVALID_ARGUMENT = 111201

inherited

Definition at line 16 of file Legacyobject.php.

ERR_NOT_FOUND

const Alternc_Api_Legacyobject::ERR_NOT_FOUND = 111203

inherited

Definition at line 18 of file Legacyobject.php.

---

The documentation for this class was generated from the following file:

• lib/Alternc/Api/Object/Subdomain.php