ilRegistrationCode Class Reference

Class ilRegistrationCode. More...

Collaboration diagram for ilRegistrationCode:

Static Public Member Functions
static	create (int $role, int $stamp, array $local_roles, ?string $limit, ?string $limit_date, bool $reg_type, bool $ext_type)
static	getCodesData (string $order_field, string $order_direction, int $offset, int $limit, string $filter_code, int $filter_role, string $filter_generated, string $filter_access_limitation)
static	loadCodesByIds (array $ids)
static	deleteCodes (array $ids)
static	getGenerationDates ()
static	getCodesForExport (string $filter_code, ?int $filter_role, string $filter_generated, string $filter_access_limitation)
static	isUnusedCode (string $code)
static	isValidRegistrationCode (string $a_code)
static	useCode (string $code)
static	getCodeRole (string $code)
static	getCodeData (string $code)

Data Fields
const	CODE_LENGTH = 10

Static Protected Member Functions
static	generateRandomCode ()

Protected Attributes
const	DB_TABLE = 'reg_registration_codes'

Static Private Member Functions
static	filterToSQL (string $filter_code, ?int $filter_role, string $filter_generated, string $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

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

Member Function Documentation

create()

static ilRegistrationCode::create ( int  $role, int  $stamp, array  $local_roles, ?string  $limit, ?string  $limit_date, bool  $reg_type, bool  $ext_type  )

static

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

References $data, $DIC, $id, and $ilDB.

Referenced by ilRegistrationSettingsGUI\createCodes().

     : int {
        global $DIC;

        $ilDB = $DIC->database();
        $id = $ilDB->nextId(self::DB_TABLE);

        // create unique code
        $found = true;
        $code = '';
        while ($found) {
            $code = self::generateRandomCode();
            $chk = $ilDB->queryF(
                "SELECT code_id FROM " . self::DB_TABLE . " WHERE code = %s",
                ["text"],
                [$code]
            );
            $found = (bool) $ilDB->numRows($chk);
        }

        $data = [
            'code_id' => ['integer', $id],
            'code' => ['text', $code],
            'generated_on' => ['integer', $stamp],
            'role' => ['integer', $role],
            'role_local' => ['text', implode(";", $local_roles)],
            'alimit' => ['text', $limit],
            'alimitdt' => ['text', $limit_date],
            'reg_enabled' => ['integer', $reg_type],
            'ext_enabled' => ['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 150 of file class.ilRegistrationCode.php.

References $DIC, and $ilDB.

Referenced by ilRegistrationSettingsGUI\deleteCodes().

                                                  : bool
    {
        global $DIC;

        $ilDB = $DIC->database();
        if (count($ids)) {
            return (bool) $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 ( string  $filter_code, ?int  $filter_role, string  $filter_generated, string  $filter_access_limitation  )

staticprivate

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

References $DIC, and $ilDB.

     : string {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $where = [];
        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 (count($where)) {
            return " WHERE " . implode(" AND ", $where);
        }

        return "";
    }

generateRandomCode()

static ilRegistrationCode::generateRandomCode ( )

staticprotected

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

                                                  : string
    {
        // missing : 01iloO
        $map = "23456789abcdefghjkmnpqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ";

        $code = "";
        $max = strlen($map) - 1;
        for ($loop = 1; $loop <= self::CODE_LENGTH; $loop++) {
            $code .= $map[random_int(0, $max)];
        }
        return $code;
    }

getCodeData()

static ilRegistrationCode::getCodeData ( string  $code )

static

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

References $DIC, and $ilDB.

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

                                                    : array
    {
        global $DIC;

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

Here is the caller graph for this function:

getCodeRole()

static ilRegistrationCode::getCodeRole ( string  $code )

static

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

References $DIC, and $ilDB.

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

                                                    : int
    {
        global $DIC;

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

Here is the caller graph for this function:

getCodesData()

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

static

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

References $DIC, and $ilDB.

Referenced by ilRegistrationCodesTableGUI\getItems().

     : array {
        global $DIC;

        $ilDB = $DIC->database();

        // 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($limit, $offset);
        $set = $ilDB->query($sql);
        $result = [];
        while ($rec = $ilDB->fetchAssoc($set)) {
            $rec['generated'] = $rec['generated_on'];
            $result[] = $rec;
        }
        return ["cnt" => $cnt, "set" => $result];
    }

Here is the caller graph for this function:

getCodesForExport()

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

static

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

References $DIC, and $ilDB.

Referenced by ilRegistrationSettingsGUI\exportCodes().

     : array {
        global $DIC;

        $ilDB = $DIC->database();

        // 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 = [];
        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 166 of file class.ilRegistrationCode.php.

References $DIC, and $ilDB.

Referenced by ilRegistrationCodesTableGUI\initFilter().

                                               : array
    {
        global $DIC;

        $ilDB = $DIC->database();

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

Here is the caller graph for this function:

isUnusedCode()

static ilRegistrationCode::isUnusedCode ( string  $code )

static

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

References $DIC, and $ilDB.

Referenced by ilAccountCode\isUnusedCode().

                                                     : bool
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

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

Here is the caller graph for this function:

isValidRegistrationCode()

static ilRegistrationCode::isValidRegistrationCode ( string  $a_code )

static

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

References $DIC, $ilDB, $query, and $res.

Referenced by ilAccountRegistrationGUI\saveForm().

                                                                  : bool
    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = 'SELECT alimit, alimitdt 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);
        if ($ilDB->numRows($res) !== 1) {
            return false;
        }

        $is_valid = true;

        $row = $ilDB->fetchAssoc($res);
        if ($row['alimit'] === 'absolute') {
            $clock_factory = (new \ILIAS\Data\Factory())->clock();
            $right_interval = new DateTimeImmutable(
                $row['alimitdt'],
                $clock_factory->system()->now()->getTimezone()
            );

            $is_valid = $right_interval >= $clock_factory->system()->now();
        }

        return  $is_valid;
    }

Here is the caller graph for this function:

loadCodesByIds()

static ilRegistrationCode::loadCodesByIds ( array  $ids )

static

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

References $DIC, and $ilDB.

Referenced by ilRegistrationSettingsGUI\deleteConfirmation().

                                                     : array
    {
        global $DIC;

        $ilDB = $DIC->database();

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

Here is the caller graph for this function:

useCode()

static ilRegistrationCode::useCode ( string  $code )

static

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

References $DIC, and $ilDB.

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

                                                : bool
    {
        global $DIC;

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

Here is the caller graph for this function:

Field Documentation

CODE_LENGTH

const ilRegistrationCode::CODE_LENGTH = 10

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

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

DB_TABLE

const ilRegistrationCode::DB_TABLE = 'reg_registration_codes'

protected

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

---

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

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