Alternc_Api_Object_Domain Class Reference

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

Inheritance diagram for Alternc_Api_Object_Domain:

Public Member Functions
	__construct ($service)
	find ($options)
	API Method from legacy class method dom->get_domain_list() More...
	get ($options)
	API Method from legacy class method dom->get_domain_all($dom) More...
	add ($options)
	API Method from legacy class method dom->add_domain() More...
	update ($options)
	API Method from legacy class method dom->edit_domain() More...
	del ($options)
	API Method from legacy class method dom->del_domain() 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

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

Definition at line 6 of file Domain.php.

Constructor & Destructor Documentation

__construct()

Alternc_Api_Object_Domain::__construct

(

$service

)

Reimplemented from Alternc_Api_Legacyobject.

Definition at line 10 of file Domain.php.

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

References $dom.

Member Function Documentation

add()

Alternc_Api_Object_Domain::add

(

$options

)

API Method from legacy class method dom->add_domain()

Parameters

$options

a hash with parameters transmitted to legacy call mandatory parameters: domain(str), dns(bool) non-mandatory: noerase(bool, only admins), force(bool, only admins), isslave(bool), slavedom(str)

Returns

Alternc_Api_Response whose content is the newly created DOMAIN id

Definition at line 92 of file Domain.php.

                           {
        $mandatory = array("domain", "dns");
        $defaults = array("noerase" => false, "force" => false, "isslave" => false, "slavedom" => "");
        $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));
        }
        foreach ($defaults as $key => $value) {
            if (!isset($options[$key])) {
                $options[$key] = $value;
            }
        }
        if (!$this->isAdmin) { // only admin can change the options below:
            $options["noerase"] = false;
            $options["force"] = false;
        }
        $did = $this->dom->add_domain($options["domain"], $options["dns"], $options["noerase"], $options["force"], $options["isslave"], $options["slavedom"]);
        if (!$did) {
            return $this->alterncLegacyErrorManager();
        } else {
            return new Alternc_Api_Response(array("content" => $did));
        }
    }

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

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(), 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(), 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(), get(), Alternc_Api_Object_Mail\get(), Alternc_Api_Object_Subdomain\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(), Alternc_Api_Object_Subdomain\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(), update(), Alternc_Api_Object_Ftp\update(), Alternc_Api_Object_Mail\update(), Alternc_Api_Object_Mysql\update(), and Alternc_Api_Object_Policy\update().

del()

Alternc_Api_Object_Domain::del

(

$options

)

API Method from legacy class method dom->del_domain()

Parameters

$options

a hash with parameters transmitted to legacy call mandatory parameters: domain

Returns

Alternc_Api_Response TRUE if the domain has been marked for deletion.

Definition at line 160 of file Domain.php.

                           {
        if (!isset($options["domain"])) {
            return new Alternc_Api_Response(array("code" => self::ERR_ALTERNC_FUNCTION, "message" => "Missing or invalid argument: DOMAIN"));
        }
        $result = $this->dom->del_domain($options["domain"]);
        if (!$result) {
            return $this->alterncLegacyErrorManager();
        } else {
            return new Alternc_Api_Response(array("content" => true));
        }
    }

References Alternc_Api_Legacyobject\alterncLegacyErrorManager().

find()

Alternc_Api_Object_Domain::find

(

$options

)

API Method from legacy class method dom->get_domain_list()

Parameters

$options

a hash with parameters transmitted to legacy call may be "uid" to only return domains for a specific user-id (if you are not admin, this WILL only list YOUR domains anyway) may be "offset" and/or "count" to do paging.

Returns

Alternc_Api_Response whose content is the list of hosted domains on this server (no more details as of now)

Definition at line 24 of file Domain.php.

                            {
        global $cuid;
        $sql = "";
        if ($this->isAdmin) {
            if (isset($options["uid"])) {
                $uid = intval($options["uid"]);
            } else {
                $uid = -1;
            }
        } else {
            $uid = $cuid;
        }
        if ($uid != -1) {
            $sql = " WHERE compte=$uid ";
        } else {
            $sql = "";
        }
        $stmt = $this->db->prepare("SELECT * FROM domaines $sql ORDER BY domaine");
        $stmt->execute();
        $result = array();
        while ($me = $stmt->fetch(PDO::FETCH_OBJ)) {
            $result[$me->domaine] = $me;
        }
        list($offset, $count) = $this->offsetAndCount($options, count($result));
        if ($offset != -1 || $count != -1) {
            $result = array_slice($result, $offset, $count);
        }
        return new Alternc_Api_Response(array("content" => $result));
    }

References Alternc_Api_Legacyobject\$cuid, $uid, and Alternc_Api_Legacyobject\offsetAndCount().

get()

Alternc_Api_Object_Domain::get

(

$options

)

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

Parameters

$options

a hash with parameters transmitted to legacy call musr be the domain name $dom

Returns

Alternc_Api_Response whose content is the list of domain info and subdomains

Definition at line 59 of file Domain.php.

                           {
        global $cuid;
        if ($this->isAdmin) {
            if (isset($options["uid"])) {
                $cuid = intval($options["uid"]);
            }
        }
        $mandatory = array("dom");
        $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_domain_all($options["dom"]);
        $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(), find(), Alternc_Api_Object_Ftp\find(), and Alternc_Api_Object_Mysql\find().

update()

Alternc_Api_Object_Domain::update

(

$options

)

API Method from legacy class method dom->edit_domain()

Parameters

$options

a hash with parameters transmitted to legacy call mandatory parameters: domain(str), dns(bool) non-mandatory: noerase(bool, only admins), force(bool, only admins), isslave(bool), slavedom(str)

Returns

Alternc_Api_Response whose content is the newly created DOMAIN id

Definition at line 127 of file Domain.php.

                              {
        $mandatory = array("domain", "dns", "gesmx");
        $defaults = array("force" => false, "ttl" => 86400);
        $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));
        }
        foreach ($defaults as $key => $value) {
            if (!isset($options[$key])) {
                $options[$key] = $value;
            }
        }
        if (!$this->isAdmin) { // only admin can change the options below:
            $options["force"] = false;
        }
        $did = $this->dom->edit_domain($options["domain"], $options["dns"], $options["gesmx"], $options["force"], $options["ttl"]);
        if (!$did) {
            return $this->alterncLegacyErrorManager();
        } else {
            return new Alternc_Api_Response(array("content" => $did));
        }
    }

References $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(), find(), get(), Alternc_Api_Object_Subdomain\get(), Alternc_Api_Object_Mail\listDomains(), Alternc_Api_Object_Mail\login(), and Alternc_Api_Object_Subdomain\set().

$db

Alternc_Api_Legacyobject::$db

protectedinherited

Definition at line 14 of file Legacyobject.php.

$dom

Alternc_Api_Object_Domain::$dom

protected

Definition at line 8 of file Domain.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/Domain.php