Class to represent a platform user. More...

Inheritance diagram for ILIAS\LTI\ToolProvider\User:

Collaboration diagram for ILIAS\LTI\ToolProvider\User:

Public Member Functions
	__construct ()
	Class constructor. More...

	initialize ()
	Initialise the user. More...

	initialise ()
	Initialise the user. More...

	setNames (string $firstname, string $lastname, string $fullname)
	Set the user's name. More...

	setEmail (string $email, string $defaultEmail=null)
	Set the user's email address. More...

	isAdmin ()
	Check if the user is an administrator (at any of the system, institution or context levels). More...

	isStaff ()
	Check if the user is staff. More...

	isLearner ()
	Check if the user is a learner. More...

Data Fields
string	$firstname = ''
	User's first name. More...

string	$lastname = ''
	User's last name (surname or family name). More...

string	$fullname = ''
	User's fullname. More...

string	$sourcedId = null
	User's sourcedId. More...

string	$username = null
	User's username. More...

string	$email = ''
	User's email address. More...

string	$image = ''
	User's image URI. More...

array	$roles = array()
	Roles for user. More...

array	$groups = array()
	Groups for user. More...

string	$ltiUserId = null
	user ID as supplied in the last connection request. More...

Static Public Attributes
static bool	$allowEmptyName = false
	Allow user name field to be empty? More...

Private Member Functions
	hasRole (string $role)
	Check whether the user has a specified role name. More...

Detailed Description

Class to represent a platform user.

Author: Stephen P Vickers steph.nosp@m.en@s.nosp@m.pvsof.nosp@m.twar.nosp@m.eprod.nosp@m.ucts.nosp@m..com

Copyright: SPV Software Products @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3

Definition at line 30 of file User.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\LTI\ToolProvider\User::__construct ( )

Class constructor.

Reimplemented in ILIAS\LTI\ToolProvider\UserResult.

Definition at line 112 of file User.php.

    {
        $this->initialize();
    }

References ILIAS\LTI\ToolProvider\User\initialize().

Here is the call graph for this function:

Member Function Documentation

◆ hasRole()

ILIAS\LTI\ToolProvider\User::hasRole ( string $role )

private

Check whether the user has a specified role name.

Parameters

string $role Name of role

Returns: bool True if the user has the specified role

Definition at line 244 of file User.php.

                                          : bool
    {
        $ok = in_array($role, $this->roles);
        if (!$ok && (strpos($role, 'urn:') !== 0) && (strpos($role, 'http://') !== 0) && (strpos($role, 'https://') !== 0)) {
            $role = "urn:lti:role:ims/lis/{$role}";
            $ok = in_array($role, $this->roles);
        }
        if (!$ok) {
            $role2 = null;
            $role3 = null;
            if (strpos($role, 'urn:') === 0) {
                if (strpos($role, 'urn:lti:role:ims/lis/') === 0) {
                    $role2 = 'http://purl.imsglobal.org/vocab/lis/v2/membership#' . substr($role, 21);
                } elseif (strpos($role, 'urn:lti:instrole:ims/lis/') === 0) {
                    $role2 = 'http://purl.imsglobal.org/vocab/lis/v2/person#' . substr($role, 25);
                    $role3 = 'http://purl.imsglobal.org/vocab/lis/v2/institution/person#' . substr($role, 25);
                } elseif (strpos($role, 'urn:lti:sysrole:ims/lis/') === 0) {
                    $role2 = 'http://purl.imsglobal.org/vocab/lis/v2/person#' . substr($role, 24);
                    $role3 = 'http://purl.imsglobal.org/vocab/lis/v2/system/person#' . substr($role, 24);
                }
            } elseif (strpos($role, 'http://purl.imsglobal.org/vocab/lis/v2/') === 0) {
                if (strpos($role, 'http://purl.imsglobal.org/vocab/lis/v2/membership#') === 0) {
                    $role2 = 'urn:lti:role:ims/lis/' . substr($role, 50);
                } elseif (strpos($role, 'http://purl.imsglobal.org/vocab/lis/v2/person#') === 0) {
                    $role2 = 'urn:lti:instrole:ims/lis/' . substr($role, 46);
                    $role3 = 'urn:lti:sysrole:ims/lis/' . substr($role, 46);
                } elseif (strpos($role, 'http://purl.imsglobal.org/vocab/lis/v2/institution/person#') === 0) {
                    $role2 = 'urn:lti:instrole:ims/lis/' . substr($role, 58);
                    $role3 = 'http://purl.imsglobal.org/vocab/lis/v2/person#' . substr($role, 58);
                } elseif (strpos($role, 'http://purl.imsglobal.org/vocab/lis/v2/system/person#') === 0) {
                    $role2 = 'urn:lti:sysrole:ims/lis/' . substr($role, 53);
                    $role3 = 'http://purl.imsglobal.org/vocab/lis/v2/person#' . substr($role, 53);
                }
            }
            if (!empty($role2)) {
                $ok = in_array($role2, $this->roles);
                if (!$ok && !empty($role3)) {
                    $ok = in_array($role3, $this->roles);
                }
            }
        }
 
        return $ok;
    }

Referenced by ILIAS\LTI\ToolProvider\User\isAdmin(), ILIAS\LTI\ToolProvider\User\isLearner(), and ILIAS\LTI\ToolProvider\User\isStaff().

Here is the caller graph for this function:

◆ initialise()

ILIAS\LTI\ToolProvider\User::initialise ( )

Initialise the user.

Synonym for initialize().

Definition at line 138 of file User.php.

    {
        $this->initialize();
    }

References ILIAS\LTI\ToolProvider\User\initialize().

Here is the call graph for this function:

◆ initialize()

ILIAS\LTI\ToolProvider\User::initialize ( )

Initialise the user.

Reimplemented in ILIAS\LTI\ToolProvider\UserResult.

Definition at line 120 of file User.php.

    {
        $this->firstname = '';
        $this->lastname = '';
        $this->fullname = '';
        $this->sourcedId = null;
        $this->username = null;
        $this->email = '';
        $this->image = '';
        $this->roles = array();
        $this->groups = array();
    }

Referenced by ILIAS\LTI\ToolProvider\User\__construct(), and ILIAS\LTI\ToolProvider\User\initialise().

Here is the caller graph for this function:

◆ isAdmin()

ILIAS\LTI\ToolProvider\User::isAdmin ( )

Check if the user is an administrator (at any of the system, institution or context levels).

Returns: bool True if the user has a role of administrator

Definition at line 209 of file User.php.

                             : bool
    {
        return $this->hasRole('Administrator') || $this->hasRole('urn:lti:sysrole:ims/lis/SysAdmin') ||
            $this->hasRole('urn:lti:sysrole:ims/lis/Administrator') || $this->hasRole('urn:lti:instrole:ims/lis/Administrator');
    }

References ILIAS\LTI\ToolProvider\User\hasRole().

Here is the call graph for this function:

◆ isLearner()

ILIAS\LTI\ToolProvider\User::isLearner ( )

Check if the user is a learner.

Returns: bool True if the user has a role of learner

Definition at line 230 of file User.php.

                               : bool
    {
        return $this->hasRole('Learner');
    }

References ILIAS\LTI\ToolProvider\User\hasRole().

Here is the call graph for this function:

◆ isStaff()

ILIAS\LTI\ToolProvider\User::isStaff ( )

Check if the user is staff.

Returns: bool True if the user has a role of instructor, contentdeveloper or teachingassistant

Definition at line 220 of file User.php.

                             : bool
    {
        return ($this->hasRole('Instructor') || $this->hasRole('ContentDeveloper') || $this->hasRole('TeachingAssistant'));
    }

References ILIAS\LTI\ToolProvider\User\hasRole().

Here is the call graph for this function:

◆ setEmail()

ILIAS\LTI\ToolProvider\User::setEmail	(	string	$email,
		string	$defaultEmail = `null`
	)

Set the user's email address.

Parameters

string	$email	Email address value
string \| null	$defaultEmail	Value to use if no email is provided (optional, default is none)

Definition at line 186 of file User.php.

    {
        if (!empty($email)) {
            $this->email = $email;
        } elseif (!empty($defaultEmail)) {
            $this->email = $defaultEmail;
            if (substr($this->email, 0, 1) === '@') {
                if (!empty($this->username)) {
                    $this->email = "{$this->username}{$this->email}";
                } else {
                    $this->email = "{$this->ltiUserId}{$this->email}";
                }
            }
        } else {
            $this->email = '';
        }
    }

References ILIAS\LTI\ToolProvider\User\$email.

◆ setNames()

ILIAS\LTI\ToolProvider\User::setNames	(	string	$firstname,
		string	$lastname,
		string	$fullname
	)

Set the user's name.

Parameters

string	$firstname	User's first name.
string	$lastname	User's last name.
string	$fullname	User's full name.

Definition at line 149 of file User.php.

    {
        $names = array(0 => '', 1 => '');
        if (!empty($fullname)) {
            $this->fullname = trim($fullname);
            $names = preg_split("/[\s]+/", $this->fullname, 2);
        }
        if (!empty($firstname)) {
            $this->firstname = trim($firstname);
            $names[0] = $this->firstname;
        } elseif (!empty($names[0])) {
            $this->firstname = $names[0];
        } elseif (!static::$allowEmptyName) {
            $this->firstname = 'User';
        } else {
            $this->firstname = '';
        }
        if (!empty($lastname)) {
            $this->lastname = trim($lastname);
            $names[1] = $this->lastname;
        } elseif (!empty($names[1])) {
            $this->lastname = $names[1];
        } elseif (!static::$allowEmptyName) {
            $this->lastname = $this->ltiUserId;
        } else {
            $this->lastname = '';
        }
        if (empty($this->fullname) && (!empty($this->firstname) || !empty($this->lastname))) {
            $this->fullname = trim("{$this->firstname} {$this->lastname}");
        }
    }

References ILIAS\LTI\ToolProvider\User\$firstname, ILIAS\LTI\ToolProvider\User\$fullname, ILIAS\LTI\ToolProvider\User\$lastname, and ILIAS\LTI\ToolProvider\User\$ltiUserId.

Field Documentation

◆ $allowEmptyName

bool ILIAS\LTI\ToolProvider\User::$allowEmptyName = false

static

Allow user name field to be empty?

Definition at line 58 of file User.php.

◆ $email

string ILIAS\LTI\ToolProvider\User::$email = ''

User's email address.

Definition at line 79 of file User.php.

Referenced by ILIAS\LTI\ToolProvider\User\setEmail().

◆ $firstname

string ILIAS\LTI\ToolProvider\User::$firstname = ''

User's first name.

Definition at line 37 of file User.php.

Referenced by ILIAS\LTI\ToolProvider\User\setNames().

◆ $fullname

string ILIAS\LTI\ToolProvider\User::$fullname = ''

User's fullname.

Definition at line 51 of file User.php.

Referenced by ILIAS\LTI\ToolProvider\User\setNames().

◆ $groups

array ILIAS\LTI\ToolProvider\User::$groups = array()

Groups for user.

Definition at line 100 of file User.php.

◆ $image

string ILIAS\LTI\ToolProvider\User::$image = ''

User's image URI.

Definition at line 86 of file User.php.

◆ $lastname

string ILIAS\LTI\ToolProvider\User::$lastname = ''

User's last name (surname or family name).

Definition at line 44 of file User.php.

Referenced by ILIAS\LTI\ToolProvider\User\setNames().

◆ $ltiUserId

string null ILIAS\LTI\ToolProvider\User::$ltiUserId = null

user ID as supplied in the last connection request.

Definition at line 107 of file User.php.

Referenced by ILIAS\LTI\ToolProvider\UserResult\fromResourceLink(), ILIAS\LTI\ToolProvider\UserResult\getId(), and ILIAS\LTI\ToolProvider\User\setNames().

◆ $roles

array ILIAS\LTI\ToolProvider\User::$roles = array()

Roles for user.

Definition at line 93 of file User.php.

◆ $sourcedId

string ILIAS\LTI\ToolProvider\User::$sourcedId = null

User's sourcedId.

Definition at line 65 of file User.php.

◆ $username

string ILIAS\LTI\ToolProvider\User::$username = null

User's username.

Definition at line 72 of file User.php.

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

Services/LTI/src/ToolProvider/User.php

Public Member Functions

Data Fields

Static Public Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ hasRole()

◆ initialise()

◆ initialize()

◆ isAdmin()

◆ isLearner()

◆ isStaff()

◆ setEmail()

◆ setNames()

Field Documentation

◆ $allowEmptyName

◆ $email

◆ $firstname

◆ $fullname

◆ $groups

◆ $image

◆ $lastname

◆ $ltiUserId

◆ $roles

◆ $sourcedId

◆ $username