ILIAS\Registration\RegistrationCodeRepository Class Reference

Collaboration diagram for ILIAS\Registration\RegistrationCodeRepository:

Public Member Functions
	__construct (protected readonly ilDBInterface $db)
	getTotalCodeCount (?CodeFilter $code_filter=null)
	getCodesData (string $order_field, string $order_direction, int $offset, int $limit, CodeFilter $code_filter=null)
	loadCodesByIds (array $ids)
	deleteCodes (array $ids)
	getGenerationDates ()
	getCodesByFilter (CodeFilter $code_filter)

Private Member Functions
	filterToSQL (CodeFilter $code_filter,)

Private Attributes
const string	TABLE_NAME = 'reg_registration_codes'

Detailed Description

Definition at line 26 of file RegistrationCodeRepository.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Registration\RegistrationCodeRepository::__construct

(

protected readonly ilDBInterface

$db

)

Definition at line 30 of file RegistrationCodeRepository.php.

      {
    }

Member Function Documentation

deleteCodes()

ILIAS\Registration\RegistrationCodeRepository::deleteCodes

(

array

$ids

)

Parameters

list<int>

$ids

Definition at line 145 of file RegistrationCodeRepository.php.

References ilDBConstants\T_INTEGER.

                                           : bool
    {
        if (\count($ids)) {
            return (bool) $this->db->manipulate('DELETE FROM ' . self::TABLE_NAME . ' WHERE ' . $this->db->in(
                'code_id',
                $ids,
                false,
                ilDBConstants::T_INTEGER
            ));
        }

        return false;
    }

filterToSQL()

ILIAS\Registration\RegistrationCodeRepository::filterToSQL ( CodeFilter  $code_filter )

private

Definition at line 35 of file RegistrationCodeRepository.php.

References ILIAS\Registration\CodeFilter\getAccessLimitation(), ILIAS\Registration\CodeFilter\getCode(), ILIAS\Registration\CodeFilter\getGenerated(), ILIAS\Registration\CodeFilter\getRole(), ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

Referenced by ILIAS\Registration\RegistrationCodeRepository\getCodesByFilter(), ILIAS\Registration\RegistrationCodeRepository\getCodesData(), and ILIAS\Registration\RegistrationCodeRepository\getTotalCodeCount().

     : string {
        $where = [];
        if ($code_filter->getCode()) {
            $where[] = $this->db->like('code', ilDBConstants::T_TEXT, '%' . $code_filter->getCode() . '%');
        }
        if ($code_filter->getRole()) {
            $where[] = 'role = ' . $this->db->quote($code_filter->getRole(), ilDBConstants::T_INTEGER);
        }
        if ($code_filter->getGenerated()) {
            $where[] = 'generated_on = ' . $this->db->quote($code_filter->getGenerated(), ilDBConstants::T_TEXT);
        }
        if ($code_filter->getAccessLimitation()) {
            $where[] = 'alimit = ' . $this->db->quote($code_filter->getAccessLimitation(), ilDBConstants::T_TEXT);
        }
        if ($where !== []) {
            return ' WHERE ' . implode(' AND ', $where);
        }

        return '';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCodesByFilter()

ILIAS\Registration\RegistrationCodeRepository::getCodesByFilter

(

CodeFilter

$code_filter

)

Returns

list<array{ code_id: int, code: string, role: int, generated_on: int, used: int, role_local: string, alimit: string, alimitdt: string, reg_enabled: int, ext_enabled: int, }

Definition at line 187 of file RegistrationCodeRepository.php.

References ILIAS\Registration\RegistrationCodeRepository\filterToSQL().

                                                             : array
    {
        $set = $this->db->query(
            'SELECT * FROM ' . self::TABLE_NAME .
            ($code_filter ? $this->filterToSQL($code_filter) : '')
        );
        $result = [];
        while ($rec = $this->db->fetchAssoc($set)) {
            $result[] = $rec;
        }

        return $result;
    }

Here is the call graph for this function:

getCodesData()

ILIAS\Registration\RegistrationCodeRepository::getCodesData	(	string	$order_field,
		string	$order_direction,
		int	$offset,
		int	$limit,
		CodeFilter	$code_filter = null
	)

Returns

list<array{ code_id: int, code: string, role: int, used: int, role_local: string, alimit: string, alimitdt: string, reg_enabled: int, ext_enabled: int, generated: int }

Definition at line 84 of file RegistrationCodeRepository.php.

References ILIAS\Registration\RegistrationCodeRepository\filterToSQL(), and ILIAS\Repository\int().

     : array {
        $sql = 'SELECT * FROM ' . self::TABLE_NAME . ($code_filter ? $this->filterToSQL($code_filter) : '');
        if ($order_field) {
            if ($order_field === 'generated') {
                $order_field = 'generated_on';
            }
            $sql .= ' ORDER BY ' . $order_field . ' ' . $order_direction;
        }

        $this->db->setLimit($limit, $offset);
        $set = $this->db->query($sql);
        $result = [];
        while ($rec = $this->db->fetchAssoc($set)) {
            $rec['generated'] = (int) $rec['generated_on'];
            unset($rec['generated_on']);
            $result[] = $rec;
        }

        return $result;
    }

Here is the call graph for this function:

getGenerationDates()

ILIAS\Registration\RegistrationCodeRepository::getGenerationDates

(

)

Returns

list<int>

Definition at line 162 of file RegistrationCodeRepository.php.

References ILIAS\Repository\int().

                                        : array
    {
        $set = $this->db->query('SELECT DISTINCT(generated_on) genr FROM ' . self::TABLE_NAME . ' ORDER BY genr');
        $result = [];
        while ($rec = $this->db->fetchAssoc($set)) {
            $result[] = (int) $rec['genr'];
        }

        return $result;
    }

Here is the call graph for this function:

getTotalCodeCount()

ILIAS\Registration\RegistrationCodeRepository::getTotalCodeCount

(

?CodeFilter

$code_filter = null

)

Definition at line 58 of file RegistrationCodeRepository.php.

References ILIAS\Registration\RegistrationCodeRepository\filterToSQL(), and ILIAS\Repository\int().

     : int {
        $set = $this->db->query('SELECT COUNT(*) AS cnt FROM ' . self::TABLE_NAME . ($code_filter ? $this->filterToSQL($code_filter) : ''));
        $cnt = 0;
        if ($rec = $this->db->fetchAssoc($set)) {
            $cnt = (int) ($rec['cnt'] ?? 0);
        }

        return $cnt;
    }

Here is the call graph for this function:

loadCodesByIds()

ILIAS\Registration\RegistrationCodeRepository::loadCodesByIds

(

array

$ids

)

Parameters

list<int>

$ids

Returns

list<array{ code_id: int, code: string, role: int, used: int, role_local: string, alimit: string, alimitdt: string, reg_enabled: int, ext_enabled: int, generated: int }

Definition at line 126 of file RegistrationCodeRepository.php.

References ilDBConstants\T_INTEGER.

                                              : array
    {
        $set = $this->db->query('SELECT * FROM ' . self::TABLE_NAME . ' WHERE ' . $this->db->in(
            'code_id',
            $ids,
            false,
            ilDBConstants::T_INTEGER
        ));
        $result = [];
        while ($rec = $this->db->fetchAssoc($set)) {
            $result[] = $rec;
        }

        return $result;
    }

Field Documentation

TABLE_NAME

const string ILIAS\Registration\RegistrationCodeRepository::TABLE_NAME = 'reg_registration_codes'

private

Definition at line 28 of file RegistrationCodeRepository.php.

---

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

• components/ILIAS/Registration/src/RegistrationCodeRepository.php