Alternc_Api_Object_Account Class Reference

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

Inheritance diagram for Alternc_Api_Object_Account:

Public Member Functions
	add ($options)
	API Method from legacy class method admin->add_mem() More...
	update ($options)
	API Method from legacy class method admin->update_mem() More...
	del ($options)
	API Method from legacy class method admin->del_mem() More...
	lock ($options)
	API Method from legacy class method admin->lock_mem() More...
	unlock ($options)
	API Method from legacy class method admin->unlock_mem() More...
	setAdmin ($options)
	API Method from legacy class method admin->normal2su() More...
	unsetAdmin ($options)
	API Method from legacy class method admin->su2normal() More...
	find ($options)
	API Method from legacy class method admin->get_list() 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
	$admin
	$cuid
	$isAdmin
	$db

Detailed Description

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

Definition at line 6 of file Account.php.

Member Function Documentation

add()

Alternc_Api_Object_Account::add

(

$options

)

API Method from legacy class method admin->add_mem()

Parameters

$options

a hash with parameters transmitted to legacy call mandatory parameters: login, pass, nom, prenom, mail, non-mandatory: canpass, type, duration, notes, force, create_dom, db_server_id

Returns

Alternc_Api_Response whose content is the newly created UID

Definition at line 14 of file Account.php.

                           {
        $mandatory = array("login", "pass", "nom", "prenom", "mail");
        $defaults = array("canpass" => 1, "type" => "default", "duration" => 0, "notes" => "", "force" => 0, "create_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));
        }
        foreach ($defaults as $key => $value) {
            if (!isset($options[$key])) {
                $options[$key] = $value;
            }
        }
        if (!isset($options["db_server_id"])) {
            $stmt = $this->db->prepare("SELECT MIN(db_servers.id) AS id FROM db_servers;");
            $stmt->execute();
            $me = $stmt->fetch(PDO::FETCH_OBJ);
            $options["db_server_id"] = $me->id;
        }
        $uid = $this->admin->add_mem($options["login"], $options["pass"], $options["nom"], $options["prenom"], $options["mail"], $options["canpass"], $options["type"], $options["duration"], $options["notes"], $options["force"], $options["create_dom"], $options["db_server_id"]);
        if (!$uid) {
            return $this->alterncLegacyErrorManager();
        } else {
            return new Alternc_Api_Response(array("content" => $uid));
        }
    }

References $key, $uid, $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(), 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(), 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(), 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(), 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(), lock(), Alternc_Api_Object_Mysql\lock(), Alternc_Api_Object_Ssl\newCsr(), Alternc_Api_Object_Mail\passwd(), Alternc_Api_Object_Subdomain\set(), setAdmin(), Alternc_Api_Object_Mysql\setAdmin(), Alternc_Api_Object_Ssl\share(), Alternc_Api_Object_Mail\undelete(), unlock(), Alternc_Api_Object_Mysql\unlock(), unsetAdmin(), Alternc_Api_Object_Mysql\unsetAdmin(), 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().

del()

Alternc_Api_Object_Account::del

(

$options

)

API Method from legacy class method admin->del_mem()

Parameters

$options

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

Returns

Alternc_Api_Response TRUE if the account has been deleted.

Definition at line 82 of file Account.php.

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

References Alternc_Api_Legacyobject\alterncLegacyErrorManager().

find()

Alternc_Api_Object_Account::find

(

$options

)

API Method from legacy class method admin->get_list()

Parameters

$options

a hash with parameters transmitted to legacy call non-mandatory parameters: ONE OF: uid(strict), login(like %%), domain(like %%), creator(strict, by uid), Any of: offset(int=0), count(int=+inf)

Returns

Alternc_Api_Response An array with all matching users informations as hashes

Definition at line 169 of file Account.php.

                            {
        $result = false;
        if (!$result && isset($options["uid"])) {
            $result = $this->admin->get(intval($options["uid"]));
            if ($result)
                $result = array($result);
        }
        if (!$result && isset($options["login"])) {
            $result = $this->admin->get_list(1/* ALL */, "", $options["login"], "login");
        }
        if (!$result && isset($options["domain"])) {
            $result = $this->admin->get_list(1/* ALL */, "", $options["domain"], "domaine");
        }
        if (!$result && isset($options["creator"])) {
            $result = $this->admin->get_list(1/* ALL */, intval($options["creator"]));
        }
        if (!$result) {          // everybody
            $result = $this->admin->get_list(1/* ALL */, "");
        }
 
        if (!$result) {
            return $this->alterncLegacyErrorManager();
        } else {
            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\alterncLegacyErrorManager(), and Alternc_Api_Legacyobject\offsetAndCount().

lock()

Alternc_Api_Object_Account::lock

(

$options

)

API Method from legacy class method admin->lock_mem()

Parameters

$options

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

Returns

Alternc_Api_Response TRUE if the account has been locked

Definition at line 99 of file Account.php.

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

References 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 find(), Alternc_Api_Object_Domain\find(), Alternc_Api_Object_Ftp\find(), and Alternc_Api_Object_Mysql\find().

setAdmin()

Alternc_Api_Object_Account::setAdmin

(

$options

)

API Method from legacy class method admin->normal2su()

Parameters

$options

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

Returns

Alternc_Api_Response TRUE if the account has been set to be an administator

Definition at line 133 of file Account.php.

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

References Alternc_Api_Legacyobject\alterncLegacyErrorManager().

unlock()

Alternc_Api_Object_Account::unlock

(

$options

)

API Method from legacy class method admin->unlock_mem()

Parameters

$options

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

Returns

Alternc_Api_Response TRUE if the account has been unlocked

Definition at line 116 of file Account.php.

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

References Alternc_Api_Legacyobject\alterncLegacyErrorManager().

unsetAdmin()

Alternc_Api_Object_Account::unsetAdmin

(

$options

)

API Method from legacy class method admin->su2normal()

Parameters

$options

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

Returns

Alternc_Api_Response TRUE if the account has been set to NOT be an administrator

Definition at line 150 of file Account.php.

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

References Alternc_Api_Legacyobject\alterncLegacyErrorManager().

update()

Alternc_Api_Object_Account::update

(

$options

)

API Method from legacy class method admin->update_mem()

Parameters

$options

a hash with parameters transmitted to legacy call mandatory parameters: nom, prenom, mail, non-mandatory: pass, canpass, type, duration, notes, force, create_dom, db_server_id

Returns

Alternc_Api_Response whose content is the updated UID

Definition at line 51 of file Account.php.

                              {
        $defaults = array("nom", "prenom", "mail", "canpass", "enabled", "type", "duration", "notes");
        if (!isset($options["uid"])) {
            return new Alternc_Api_Response(array("code" => self::ERR_INVALID_ARGUMENT, "message" => "Missing or invalid argument: UID"));
        }
        $uid = intval($options["uid"]);
        $old = $this->admin->get($uid);
        if (!$old) {
            return new Alternc_Api_Response(array("code" => self::ERR_NOT_FOUND, "message" => "User not found"));
        }
 
        foreach ($defaults as $key) {
            if (!isset($options[$key])) {
                $options[$key] = $old[$key];
            }
        }
        if (!isset($options["pass"]))
            $options["pass"] = "";
        $uid = $this->admin->update_mem($uid, $options["mail"], $options["nom"], $options["prenom"], $options["pass"], $options["enabled"], $options["canpass"], $options["type"], $options["duration"], $options["notes"]);
        if (!$uid) {
            return $this->alterncLegacyErrorManager();
        } else {
            return new Alternc_Api_Response(array("content" => $uid));
        }
    }

References $key, $uid, 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(), 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.

$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/Account.php