ilRegistrationRoleAssignments Class Reference

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, string $a_role)
	getDefaultRole ()
	setDefaultRole ($a_role_id)
	deleteAll ()
	save ()
	__read ()

Data Fields
	$assignments = array()
	$default_role = 0

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilRegistrationRoleAssignments::__construct

(

)

Definition at line 41 of file class.ilRegistrationEmailRoleAssignments.php.

References $DIC, $ilDB, and __read().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $this->db = $ilDB;
        $this->__read();
    }

Here is the call graph for this function:

Member Function Documentation

__read()

ilRegistrationRoleAssignments::__read

(

)

Definition at line 149 of file class.ilRegistrationEmailRoleAssignments.php.

References $DIC, $ilDB, $query, $res, and ilDBConstants\FETCHMODE_OBJECT.

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

    {
        global $DIC;

        $ilias = $DIC['ilias'];
        $ilDB = $this->db;

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

        $this->assignments = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->assignments[$row->assignment_id]['id'] = $row->assignment_id;
            $this->assignments[$row->assignment_id]['role'] = $row->role;
            $this->assignments[$row->assignment_id]['domain'] = $row->domain;
        }

        $this->default_role = $ilias->getSetting('reg_default_role');

        return true;
    }

Here is the caller graph for this function:

deleteAll()

ilRegistrationRoleAssignments::deleteAll

(

)

Definition at line 111 of file class.ilRegistrationEmailRoleAssignments.php.

References $ilDB, $query, and __read().

    {
        $ilDB = $this->db;

        $query = "DELETE FROM reg_er_assignments ";
        $ilDB->manipulate($query);
        $this->__read();
        return true;
    }

Here is the call graph for this function:

getAssignments()

ilRegistrationRoleAssignments::getAssignments

(

)

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

    {
        return $this->assignments ? $this->assignments : array();
    }

getDefaultRole()

ilRegistrationRoleAssignments::getDefaultRole

(

)

Definition at line 102 of file class.ilRegistrationEmailRoleAssignments.php.

References $default_role.

Referenced by getRoleByEmail(), and save().

    {
        return $this->default_role;
    }

Here is the caller graph for this function:

getDomainsByRole()

ilRegistrationRoleAssignments::getDomainsByRole

(

int

$role_id

)

Definition at line 73 of file class.ilRegistrationEmailRoleAssignments.php.

References $ilDB, $query, and $res.

    {
        $ilDB = $this->db;

        $query = $ilDB->query("SELECT * FROM reg_er_assignments " .
            "WHERE role = " . $ilDB->quote($role_id, 'integer'));


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

        return $res;
    }

getRoleByEmail()

ilRegistrationRoleAssignments::getRoleByEmail

(

string

$a_email

)

Definition at line 51 of file class.ilRegistrationEmailRoleAssignments.php.

References $DIC, and getDefaultRole().

    {
        global $DIC;

        $ilObjDataCache = $DIC['ilObjDataCache'];

        foreach ($this->assignments as $assignment) {
            if (!$assignment['domain'] or !$assignment['role']) {
                continue;
            }
            if (stristr($a_email, $assignment['domain'])) {
                // check if role exists
                if (!$ilObjDataCache->lookupType($assignment['role'])) {
                    continue;
                }
                return $assignment['role'];
            }
        }
        // return default
        return $this->getDefaultRole();
    }

Here is the call graph for this function:

save()

ilRegistrationRoleAssignments::save

(

)

Definition at line 121 of file class.ilRegistrationEmailRoleAssignments.php.

References $DIC, $ilDB, $query, $res, __read(), and getDefaultRole().

    {
        global $DIC;

        $ilias = $DIC['ilias'];
        $ilDB = $this->db;

        // Save default role
        $ilias->setSetting('reg_default_role', $this->getDefaultRole());

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

Here is the call graph for this function:

setDefaultRole()

ilRegistrationRoleAssignments::setDefaultRole

(

$a_role_id

)

Definition at line 106 of file class.ilRegistrationEmailRoleAssignments.php.

    {
        $this->default_role = $a_role_id;
    }

setDomain()

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

Definition at line 93 of file class.ilRegistrationEmailRoleAssignments.php.

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

setRole()

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

Definition at line 97 of file class.ilRegistrationEmailRoleAssignments.php.

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

Field Documentation

$assignments

ilRegistrationRoleAssignments::$assignments = array()

Definition at line 38 of file class.ilRegistrationEmailRoleAssignments.php.

$default_role

ilRegistrationRoleAssignments::$default_role = 0

Definition at line 39 of file class.ilRegistrationEmailRoleAssignments.php.

Referenced by getDefaultRole().

---

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

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