ilRegistrationRoleAssignments Class Reference

Class class.ilregistrationEmailRoleAssignments. More...

Collaboration diagram for ilRegistrationRoleAssignments:

Public Member Functions
	__construct ()
	getRoleByEmail (string $a_email)
	getDomainsByRole (int $role_id)
	getAssignments ()
	setDomain (int $id, string $a_domain)
	setRole (int $id, int $a_role)
	getDefaultRole ()
	setDefaultRole (int $a_role_id)
	deleteAll ()
	save ()
	read ()

Data Fields
const	IL_REG_MISSING_DOMAIN = 1
const	IL_REG_MISSING_ROLE = 2
array	$assignments = []
int	$default_role = 0

Protected Attributes
ilDBInterface	$db
ilSetting	$settings

Detailed Description

Class class.ilregistrationEmailRoleAssignments.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 25 of file class.ilRegistrationRoleAssignments.php.

Constructor & Destructor Documentation

__construct()

ilRegistrationRoleAssignments::__construct

(

)

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

References $DIC, read(), and ILIAS\Repository\settings().

    {
        global $DIC;

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

Here is the call graph for this function:

Member Function Documentation

deleteAll()

ilRegistrationRoleAssignments::deleteAll

(

)

Definition at line 100 of file class.ilRegistrationRoleAssignments.php.

References read().

                               : bool
    {
        $query = "DELETE FROM reg_er_assignments ";
        $this->db->manipulate($query);
        $this->read();
        return true;
    }

Here is the call graph for this function:

getAssignments()

ilRegistrationRoleAssignments::getAssignments

(

)

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

References $assignments.

                                    : array
    {
        return $this->assignments;
    }

getDefaultRole()

ilRegistrationRoleAssignments::getDefaultRole

(

)

Definition at line 90 of file class.ilRegistrationRoleAssignments.php.

References $default_role.

Referenced by getRoleByEmail(), and save().

                                    : int
    {
        return $this->default_role;
    }

Here is the caller graph for this function:

getDomainsByRole()

ilRegistrationRoleAssignments::getDomainsByRole

(

int

$role_id

)

Definition at line 63 of file class.ilRegistrationRoleAssignments.php.

References $res.

                                                  : array
    {
        $query = $this->db->query("SELECT * FROM reg_er_assignments " .
            "WHERE role = " . $this->db->quote($role_id, 'integer'));

        $res = [];
        while ($row = $this->db->fetchAssoc($query)) {
            $res[] = $row["domain"];
        }
        return $res;
    }

getRoleByEmail()

ilRegistrationRoleAssignments::getRoleByEmail

(

string

$a_email

)

Definition at line 45 of file class.ilRegistrationRoleAssignments.php.

References ilObject\_lookupType(), and getDefaultRole().

                                                   : int
    {
        foreach ($this->assignments as $assignment) {
            if (!$assignment['domain'] || !$assignment['role']) {
                continue;
            }
            if (stripos($a_email, $assignment['domain']) !== false) {
                // check if role exists
                if (!ilObject::_lookupType($assignment['role'])) {
                    continue;
                }
                return $assignment['role'];
            }
        }
        // return default
        return $this->getDefaultRole();
    }

Here is the call graph for this function:

read()

ilRegistrationRoleAssignments::read

(

)

Definition at line 129 of file class.ilRegistrationRoleAssignments.php.

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

Referenced by __construct(), deleteAll(), and save().

                          : bool
    {
        $query = "SELECT * FROM reg_er_assignments ";
        $res = $this->db->query($query);

        $this->assignments = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->assignments[$row->assignment_id]['id'] = (int) $row->assignment_id;
            $this->assignments[$row->assignment_id]['role'] = (int) $row->role;
            $this->assignments[$row->assignment_id]['domain'] = $row->domain;
        }
        $this->default_role = (int) $this->settings->get('reg_default_role', '0');
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilRegistrationRoleAssignments::save

(

)

Definition at line 108 of file class.ilRegistrationRoleAssignments.php.

References $res, getDefaultRole(), read(), and ILIAS\Repository\settings().

                          : bool
    {
        // Save default role
        $this->settings->set('reg_default_role', (string) $this->getDefaultRole());

        foreach ($this->assignments as $assignment) {
            if (empty($assignment['id'])) {
                $next_id = $this->db->nextId('reg_er_assignments');
                $query = "INSERT INTO reg_er_assignments (assignment_id,domain,role) " .
                    "VALUES( " .
                    $this->db->quote($next_id, 'integer') . ', ' .
                    $this->db->quote($assignment['domain'], 'text') . ", " .
                    $this->db->quote($assignment['role'], 'integer') .
                    ")";
                $res = $this->db->manipulate($query);
            }
        }
        $this->read();
        return true;
    }

Here is the call graph for this function:

setDefaultRole()

ilRegistrationRoleAssignments::setDefaultRole

(

int

$a_role_id

)

Definition at line 95 of file class.ilRegistrationRoleAssignments.php.

                                                  : void
    {
        $this->default_role = $a_role_id;
    }

setDomain()

ilRegistrationRoleAssignments::setDomain	(	int	$id,
		string	$a_domain
	)

Definition at line 80 of file class.ilRegistrationRoleAssignments.php.

References $id.

                                                        : void
    {
        $this->assignments[$id]['domain'] = $a_domain;
    }

setRole()

ilRegistrationRoleAssignments::setRole	(	int	$id,
		int	$a_role
	)

Definition at line 85 of file class.ilRegistrationRoleAssignments.php.

References $id.

                                                 : void
    {
        $this->assignments[$id]['role'] = $a_role;
    }

Field Documentation

$assignments

array ilRegistrationRoleAssignments::$assignments = []

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

Referenced by getAssignments().

$db

ilDBInterface ilRegistrationRoleAssignments::$db

protected

Definition at line 33 of file class.ilRegistrationRoleAssignments.php.

$default_role

int ilRegistrationRoleAssignments::$default_role = 0

Definition at line 31 of file class.ilRegistrationRoleAssignments.php.

Referenced by getDefaultRole().

$settings

ilSetting ilRegistrationRoleAssignments::$settings

protected

Definition at line 34 of file class.ilRegistrationRoleAssignments.php.

IL_REG_MISSING_DOMAIN

const ilRegistrationRoleAssignments::IL_REG_MISSING_DOMAIN = 1

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

IL_REG_MISSING_ROLE

const ilRegistrationRoleAssignments::IL_REG_MISSING_ROLE = 2

Definition at line 28 of file class.ilRegistrationRoleAssignments.php.

---

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

• components/ILIAS/Registration/classes/class.ilRegistrationRoleAssignments.php