Class class.ilRegistrationAccessLimitation. More...

Collaboration diagram for ilRegistrationRoleAccessLimitations:

Public Member Functions
	__construct ()

	save ()

	validate ()

	getMode (int $a_role_id)

	setMode (string $a_mode, int $a_role_id)

	getAbsolute (int $a_role_id)

	setAbsolute (?string $date, int $a_role_id)

	getRelative (int $a_role_id, string $a_type)

	setRelative (?array $a_arr, int $a_role_id)

	resetAccessLimitations ()

Data Fields
const	IL_REG_ACCESS_LIMITATION_MISSING_MODE = 1

const	IL_REG_ACCESS_LIMITATION_OUT_OF_DATE = 2

Protected Attributes
ilDBInterface	$db

Private Member Functions
	read ()

Private Attributes
array	$access_limitations = []

Detailed Description

Class class.ilRegistrationAccessLimitation.

Author: Sascha Hofmann sasch.nosp@m.ahof.nosp@m.mann@.nosp@m.gmx..nosp@m.de

Definition at line 26 of file class.ilRegistrationRoleAccessLimitations.php.

Constructor & Destructor Documentation

◆ __construct()

ilRegistrationRoleAccessLimitations::__construct ( )

Definition at line 36 of file class.ilRegistrationRoleAccessLimitations.php.

    {
        global $DIC;
 
        $this->db = $DIC->database();
        $this->read();
    }

References $DIC, and read().

Here is the call graph for this function:

Member Function Documentation

◆ getAbsolute()

ilRegistrationRoleAccessLimitations::getAbsolute ( int $a_role_id )

Definition at line 109 of file class.ilRegistrationRoleAccessLimitations.php.

                                               : int
    {
        return $this->access_limitations[$a_role_id]['absolute'] ?? time();
    }

◆ getMode()

ilRegistrationRoleAccessLimitations::getMode ( int $a_role_id )

Definition at line 99 of file class.ilRegistrationRoleAccessLimitations.php.

                                           : string
    {
        return isset($this->access_limitations[$a_role_id]) ? $this->access_limitations[$a_role_id]['mode'] : 'null';
    }

◆ getRelative()

ilRegistrationRoleAccessLimitations::getRelative	(	int	$a_role_id,
		string	$a_type
	)

Definition at line 124 of file class.ilRegistrationRoleAccessLimitations.php.

                                                               : int
    {
        return $this->access_limitations[$a_role_id]['relative_' . $a_type] ?? 0;
    }

◆ read()

ilRegistrationRoleAccessLimitations::read ( )

private

Definition at line 44 of file class.ilRegistrationRoleAccessLimitations.php.

                           : void
    {
        $query = "SELECT * FROM reg_access_limit ";
        $res = $this->db->query($query);
 
        $this->access_limitations = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $role_id = (int) $row->role_id;
            $this->access_limitations[$role_id]['id'] = $role_id;
            $this->access_limitations[$role_id]['absolute'] = is_null($row->limit_absolute) ? null : (int) $row->limit_absolute;
            $this->access_limitations[$role_id]['relative_d'] = is_null($row->limit_relative_d) ? null : (int) $row->limit_relative_d;
            $this->access_limitations[$role_id]['relative_m'] = is_null($row->limit_relative_m) ? null : (int) $row->limit_relative_m;
            $this->access_limitations[$role_id]['mode'] = (string) $row->limit_mode;
        }
    }

References $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetAccessLimitations()

ilRegistrationRoleAccessLimitations::resetAccessLimitations ( )

Definition at line 143 of file class.ilRegistrationRoleAccessLimitations.php.

                                            : void
    {
        $this->access_limitations = [];
    }

◆ save()

ilRegistrationRoleAccessLimitations::save ( )

Definition at line 60 of file class.ilRegistrationRoleAccessLimitations.php.

                          : bool
    {
        foreach ($this->access_limitations as $role_id => $data) {
            $query = "DELETE FROM reg_access_limit " .
                "WHERE role_id = " . $this->db->quote($role_id, 'integer');
            $this->db->manipulate($query);
 
            $query = "INSERT INTO reg_access_limit (role_id,limit_mode,limit_absolute," .
                "limit_relative_d,limit_relative_m) " .
                "VALUES( " .
                $this->db->quote($role_id, ilDBConstants::T_INTEGER) . ", " .
                $this->db->quote($data['mode'], ilDBConstants::T_TEXT) . ", " .
                $this->db->quote($data['absolute'] ?? null, ilDBConstants::T_INTEGER) . ", " .
                $this->db->quote($data['relative_d'] ?? null, ilDBConstants::T_INTEGER) . ", " .
                $this->db->quote($data['relative_m'] ?? null, ilDBConstants::T_INTEGER) . " " .
                ")";
            $this->db->manipulate($query);
        }
        return true;
    }

References $data, ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

◆ setAbsolute()

ilRegistrationRoleAccessLimitations::setAbsolute	(	?string	$date,
		int	$a_role_id
	)

Definition at line 114 of file class.ilRegistrationRoleAccessLimitations.php.

                                                              : void
    {
        if (!is_null($date)) {
            $unix_date = strtotime($date);
            if ($unix_date) {
                $this->access_limitations[$a_role_id]['absolute'] = $unix_date;
            }
        }
    }

◆ setMode()

ilRegistrationRoleAccessLimitations::setMode	(	string	$a_mode,
		int	$a_role_id
	)

Definition at line 104 of file class.ilRegistrationRoleAccessLimitations.php.

                                                           : void
    {
        $this->access_limitations[$a_role_id]['mode'] = $a_mode;
    }

◆ setRelative()

ilRegistrationRoleAccessLimitations::setRelative	(	?array	$a_arr,
		int	$a_role_id
	)

Parameters

array{dd int|string, MM: int|string}|null $a_arr

Definition at line 132 of file class.ilRegistrationRoleAccessLimitations.php.

                                                              : void
    {
        if (null === $a_arr) {
            $this->access_limitations[$a_role_id]['relative_d'] = null;
            $this->access_limitations[$a_role_id]['relative_m'] = null;
        } else {
            $this->access_limitations[$a_role_id]['relative_d'] = (int) $a_arr['dd'];
            $this->access_limitations[$a_role_id]['relative_m'] = (int) $a_arr['MM'];
        }
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

◆ validate()

ilRegistrationRoleAccessLimitations::validate ( )

Definition at line 81 of file class.ilRegistrationRoleAccessLimitations.php.

                              : int
    {
        foreach ($this->access_limitations as $data) {
            if ($data['mode'] === 'null') {
                return self::IL_REG_ACCESS_LIMITATION_MISSING_MODE;
            }
 
            if ($data['mode'] === 'absolute' && $data['absolute'] < time()) {
                return self::IL_REG_ACCESS_LIMITATION_OUT_OF_DATE;
            }
 
            if ($data['mode'] === 'relative' && ($data['relative_d'] < 1 && $data['relative_m'] < 1)) {
                return self::IL_REG_ACCESS_LIMITATION_OUT_OF_DATE;
            }
        }
        return 0;
    }