ilRegistrationCode Class Reference

Class ilRegistrationCode. More...

Collaboration diagram for ilRegistrationCode:

Static Public Member Functions
static	create ($role, $stamp, $local_roles, $limit, $limit_date, $reg_type, $ext_type)
static	getCodesData ($order_field, $order_direction, $offset, $limit, $filter_code, $filter_role, $filter_generated, $filter_access_limitation)
static	loadCodesByIds (array $ids)
static	deleteCodes (array $ids)
static	getGenerationDates ()
static	getCodesForExport ($filter_code, $filter_role, $filter_generated, $filter_access_limitation)
static	isUnusedCode ($code)
	Check if code has been used already type $ilDB. More...
static	isValidRegistrationCode ($a_code)
	Check if given code is a valid registration code. More...
static	useCode ($code)
static	getCodeRole ($code)
static	getCodeData ($code)

Data Fields
const	DB_TABLE = 'reg_registration_codes'
const	CODE_LENGTH = 10

Static Protected Member Functions
static	generateRandomCode ()
static	filterToSQL ($filter_code, $filter_role, $filter_generated, $filter_access_limitation)

Detailed Description

Class ilRegistrationCode.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Version

Id

class.ilRegistrationSettingsGUI.php 23797 2010-05-07 15:54:03Z jluetzen

Definition at line 13 of file class.ilRegistrationCode.php.

Member Function Documentation

create()

static ilRegistrationCode::create (   $role,   $stamp,   $local_roles,   $limit,   $limit_date,   $reg_type,   $ext_type  )

static

Definition at line 18 of file class.ilRegistrationCode.php.

References $code, $data, $id, $ilDB, and array.

Referenced by ilRegistrationSettingsGUI\createCodes().

    {
        global $ilDB;
        
        $id = $ilDB->nextId(self::DB_TABLE);
        
        // create unique code
        $found = true;
        while ($found) {
            $code = self::generateRandomCode();
            $chk = $ilDB->queryF("SELECT code_id FROM " . self::DB_TABLE . " WHERE code = %s", array("text"), array($code));
            $found = (bool) $ilDB->numRows($chk);
        }
        
        if (is_array($local_roles)) {
            $local_roles = implode(";", $local_roles);
        }
        if ($limit == "relative" && is_array($limit_date)) {
            $limit_date = serialize($limit_date);
        }
        
        $data = array(
            'code_id' => array('integer', $id),
            'code' => array('text', $code),
            'generated_on' => array('integer', $stamp),
            'role' => array('integer', $role),
            'role_local' => array('text', $local_roles),
            'alimit' => array('text', $limit),
            'alimitdt' => array('text', $limit_date),
            'reg_enabled' => array('integer',$reg_type),
            'ext_enabled' => array('integer',$ext_type)
            );

        $ilDB->insert(self::DB_TABLE, $data);
        return $id;
    }

Here is the caller graph for this function:

deleteCodes()

static ilRegistrationCode::deleteCodes ( array  $ids )

static

Definition at line 113 of file class.ilRegistrationCode.php.

References $ilDB.

Referenced by ilRegistrationSettingsGUI\deleteCodes().

    {
        global $ilDB;

        if (sizeof($ids)) {
            return $ilDB->manipulate("DELETE FROM " . self::DB_TABLE . " WHERE " . $ilDB->in("code_id", $ids, false, "integer"));
        }
        return false;
    }

Here is the caller graph for this function:

filterToSQL()

static ilRegistrationCode::filterToSQL (   $filter_code,   $filter_role,   $filter_generated,   $filter_access_limitation  )

staticprotected

Definition at line 135 of file class.ilRegistrationCode.php.

References $ilDB, and array.

    {
        global $ilDB;

        $where = array();
        if ($filter_code) {
            $where[] = $ilDB->like("code", "text", "%" . $filter_code . "%");
        }
        if ($filter_role) {
            $where[] ="role = " . $ilDB->quote($filter_role, "integer");
        }
        if ($filter_generated) {
            $where[] ="generated_on = " . $ilDB->quote($filter_generated, "text");
        }
        if ($filter_access_limitation) {
            $where[] ="alimit = " . $ilDB->quote($filter_access_limitation, "text");
        }
        if (sizeof($where)) {
            return " WHERE " . implode(" AND ", $where);
        } else {
            return "";
        }
    }

generateRandomCode()

static ilRegistrationCode::generateRandomCode ( )

staticprotected

Definition at line 55 of file class.ilRegistrationCode.php.

References $code.

    {
        // missing : 01iloO
        $map = "23456789abcdefghjkmnpqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ";
        
        $code = "";
        $max = strlen($map)-1;
        for ($loop = 1; $loop <= self::CODE_LENGTH; $loop++) {
            $code .= $map[mt_rand(0, $max)];
        }
        return $code;
    }

getCodeData()

static ilRegistrationCode::getCodeData (   $code )

static

Definition at line 229 of file class.ilRegistrationCode.php.

References $code, $ilDB, and $row.

Referenced by ilAccountCode\applyAccessLimits(), ilAccountCode\applyRoleAssignments(), ilAccountCode\getCodeValidUntil(), and ilAccountRegistrationGUI\saveForm().

    {
        global $ilDB;

        $set = $ilDB->query("SELECT role, role_local, alimit, alimitdt, reg_enabled, ext_enabled" .
            " FROM " . self::DB_TABLE .
            " WHERE code = " . $ilDB->quote($code, "text"));
        $row = $ilDB->fetchAssoc($set);
        return $row;
    }

Here is the caller graph for this function:

getCodeRole()

static ilRegistrationCode::getCodeRole (   $code )

static

Definition at line 218 of file class.ilRegistrationCode.php.

References $code, $ilDB, and $row.

Referenced by ilAccountCode\applyRoleAssignments(), and ilAccountRegistrationGUI\saveForm().

    {
        global $ilDB;

        $set = $ilDB->query("SELECT role FROM " . self::DB_TABLE . " WHERE code = " . $ilDB->quote($code, "text"));
        $row = $ilDB->fetchAssoc($set);
        if (isset($row["role"])) {
            return $row["role"];
        }
    }

Here is the caller graph for this function:

getCodesData()

static ilRegistrationCode::getCodesData (   $order_field,   $order_direction,   $offset,   $limit,   $filter_code,   $filter_role,   $filter_generated,   $filter_access_limitation  )

static

Definition at line 68 of file class.ilRegistrationCode.php.

References $ilDB, $result, and array.

Referenced by ilRegistrationCodesTableGUI\getItems().

    {
        global $ilDB;
        
        // filter
        $where = self::filterToSQL($filter_code, $filter_role, $filter_generated, $filter_access_limitation);

        // count query
        $set = $ilDB->query("SELECT COUNT(*) AS cnt FROM " . self::DB_TABLE . $where);
        $cnt = 0;
        if ($rec = $ilDB->fetchAssoc($set)) {
            $cnt = $rec["cnt"];
        }
        
        $sql = "SELECT * FROM " . self::DB_TABLE . $where;
        if ($order_field) {
            if ($order_field == 'generated') {
                $order_field = 'generated_on';
            }
            $sql .= " ORDER BY " . $order_field . " " . $order_direction;
        }
        
        // set query
        $ilDB->setLimit((int) $limit, (int) $offset);
        $set = $ilDB->query($sql);
        $result = array();
        while ($rec = $ilDB->fetchAssoc($set)) {
            $rec['generated'] = $rec['generated_on'];
            $result[] = $rec;
        }
        return array("cnt" => $cnt, "set" => $result);
    }

Here is the caller graph for this function:

getCodesForExport()

static ilRegistrationCode::getCodesForExport (   $filter_code,   $filter_role,   $filter_generated,   $filter_access_limitation  )

static

Definition at line 159 of file class.ilRegistrationCode.php.

References $ilDB, $result, and array.

Referenced by ilRegistrationSettingsGUI\exportCodes().

    {
        global $ilDB;

        // filter
        $where = self::filterToSQL($filter_code, $filter_role, $filter_generated, $filter_access_limitation);

        // set query
        $set = $ilDB->query("SELECT code FROM " . self::DB_TABLE . $where . " ORDER BY code_id");
        $result = array();
        while ($rec = $ilDB->fetchAssoc($set)) {
            $result[] = $rec["code"];
        }
        return $result;
    }

Here is the caller graph for this function:

getGenerationDates()

static ilRegistrationCode::getGenerationDates ( )

static

Definition at line 123 of file class.ilRegistrationCode.php.

References $ilDB, $result, and array.

Referenced by ilRegistrationCodesTableGUI\initFilter().

    {
        global $ilDB;
        
        $set = $ilDB->query("SELECT DISTINCT(generated_on) genr FROM " . self::DB_TABLE . " ORDER BY genr");
        $result = array();
        while ($rec = $ilDB->fetchAssoc($set)) {
            $result[] = $rec["genr"];
        }
        return $result;
    }

Here is the caller graph for this function:

isUnusedCode()

static ilRegistrationCode::isUnusedCode (   $code )

static

Check if code has been used already type $ilDB.

Parameters

type

$code

Returns

boolean

Definition at line 181 of file class.ilRegistrationCode.php.

References $code, and $ilDB.

Referenced by ilAccountCode\isUnusedCode().

    {
        global $ilDB;
        
        $set = $ilDB->query("SELECT used FROM " . self::DB_TABLE . " WHERE code = " . $ilDB->quote($code, "text"));
        $set = $ilDB->fetchAssoc($set);
        if ($set && !$set["used"]) {
            return true;
        }
        return false;
    }

Here is the caller graph for this function:

isValidRegistrationCode()

static ilRegistrationCode::isValidRegistrationCode (   $a_code )

static

Check if given code is a valid registration code.

Parameters

string

$a_code

code

Returns

bool

Definition at line 198 of file class.ilRegistrationCode.php.

References $ilDB, $query, and $res.

Referenced by ilAccountRegistrationGUI\saveForm().

    {
        global $ilDB;
        
        $query = 'SELECT code_id FROM reg_registration_codes ' .
            'WHERE used = ' . $ilDB->quote(0, 'integer') . ' ' .
            'AND reg_enabled = ' . $ilDB->quote(1, 'integer') . ' ' .
            'AND code = ' . $ilDB->quote($a_code, 'text');
        $res = $ilDB->query($query);
        
        return $res->numRows() ? true : false;
    }

Here is the caller graph for this function:

loadCodesByIds()

static ilRegistrationCode::loadCodesByIds ( array  $ids )

static

Definition at line 101 of file class.ilRegistrationCode.php.

References $ilDB, $result, and array.

Referenced by ilRegistrationSettingsGUI\deleteConfirmation().

    {
        global $ilDB;

        $set = $ilDB->query("SELECT * FROM " . self::DB_TABLE . " WHERE " . $ilDB->in("code_id", $ids, false, "integer"));
        $result = array();
        while ($rec = $ilDB->fetchAssoc($set)) {
            $result[] = $rec;
        }
        return $result;
    }

Here is the caller graph for this function:

useCode()

static ilRegistrationCode::useCode (   $code )

static

Definition at line 211 of file class.ilRegistrationCode.php.

References $code, $ilDB, array, and time.

Referenced by ilAccountRegistrationGUI\saveForm(), and ilAccountCode\useCode().

    {
        global $ilDB;

        return (bool) $ilDB->update(self::DB_TABLE, array("used"=>array("timestamp", time())), array("code"=>array("text", $code)));
    }

Here is the caller graph for this function:

Field Documentation

CODE_LENGTH

const ilRegistrationCode::CODE_LENGTH = 10

Definition at line 16 of file class.ilRegistrationCode.php.

Referenced by ilAccountRegistrationGUI\__initForm(), and ilRegistrationCodesTableGUI\initFilter().

DB_TABLE

const ilRegistrationCode::DB_TABLE = 'reg_registration_codes'

Definition at line 15 of file class.ilRegistrationCode.php.

---

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

• Services/Registration/classes/class.ilRegistrationCode.php