Class to represent a tool consumer user. More...

Collaboration diagram for IMSGlobal\LTI\ToolProvider\User:

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

	initialize ()
	Initialise the user. More...

	initialise ()
	Initialise the user. More...

	save ()
	Save the user to the database. More...

	delete ()
	Delete the user from the database. More...

	getResourceLink ()
	Get resource link. More...

	getRecordId ()
	Get record ID of user. More...

	setRecordId ($id)
	Set record ID of user. More...

	setResourceLinkId ($resourceLinkId)
	Set resource link ID of user. More...

	getDataConnector ()
	Get the data connector. More...

	getId ($idScope=null)
	Get the user ID (which may be a compound of the tool consumer and resource link IDs). More...

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

	setEmail ($email, $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...

Static Public Member Functions
static	fromRecordId ($id, $dataConnector)
	Load the user from the database. More...

static	fromResourceLink ($resourceLink, $ltiUserId)
	Class constructor from resource link. More...

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

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

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

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

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

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

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

	$ltiResultSourcedId = null
	User's result sourcedid. More...

	$created = null
	Date/time the record was created. More...

	$updated = null
	Date/time the record was last updated. More...

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

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

	load ($id=null)
	Load the user from the database. More...

Private Attributes
	$resourceLink = null
	Resource link object. More...

	$resourceLinkId = null
	Resource link record ID. More...

	$id = null
	User record ID value. More...

	$dataConnector = null
	Data connector object or string. More...

Detailed Description

Class to represent a tool consumer user.

Author: Stephen P Vickers svick.nosp@m.ers@.nosp@m.imsgl.nosp@m.obal.nosp@m..org

Copyright: IMS Global Learning Consortium Inc

Date: 2016

Version: 3.0.2 @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0

Definition at line 15 of file User.php.

Constructor & Destructor Documentation

◆ __construct()

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

Class constructor.

Definition at line 113 of file User.php.

    {
 
        $this->initialize();
 
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ delete()

IMSGlobal\LTI\ToolProvider\User::delete ( )

Delete the user from the database.

Returns: boolean True if the user object was successfully deleted

Definition at line 174 of file User.php.

    {
 
        $ok = $this->getDataConnector()->deleteUser($this);
 
        return $ok;
 
    }

References $ok, and IMSGlobal\LTI\ToolProvider\User\getDataConnector().

Here is the call graph for this function:

◆ fromRecordId()

static IMSGlobal\LTI\ToolProvider\User::fromRecordId	(	$id,
		$dataConnector
	)

static

Load the user from the database.

Parameters

int	$id	Record ID of user
DataConnector	$dataConnector	Database connection object

Returns: User User object

Definition at line 395 of file User.php.

    {
 
        $user = new User();
        $user->dataConnector = $dataConnector;
        $user->load($id);
 
        return $user;
 
    }

References IMSGlobal\LTI\ToolProvider\User\$dataConnector, and IMSGlobal\LTI\ToolProvider\User\$id.

Referenced by IMSGlobal\LTI\ToolProvider\DataConnector\DataConnector_pdo\getUserResultSourcedIDsResourceLink().

Here is the caller graph for this function:

◆ fromResourceLink()

static IMSGlobal\LTI\ToolProvider\User::fromResourceLink	(	$resourceLink,
		$ltiUserId
	)

static

Class constructor from resource link.

Parameters

ResourceLink	$resourceLink	Resource_Link object
string	$ltiUserId	User ID value

Returns: User

Definition at line 413 of file User.php.

    {
 
        $user = new User();
        $user->resourceLink = $resourceLink;
        if (!is_null($resourceLink)) {
            $user->resourceLinkId = $resourceLink->getRecordId();
            $user->dataConnector = $resourceLink->getDataConnector();
        }
        $user->ltiUserId = $ltiUserId;
        if (!empty($ltiUserId)) {
            $user->load();
        }
 
        return $user;
 
    }

References IMSGlobal\LTI\ToolProvider\User\$ltiUserId, and IMSGlobal\LTI\ToolProvider\User\$resourceLink.

Referenced by IMSGlobal\LTI\ToolProvider\ToolProvider\authenticate(), IMSGlobal\LTI\ToolProvider\ResourceLink\doMembershipsService(), IMSGlobal\LTI\ToolProvider\Service\Membership\get(), IMSGlobal\LTI\ToolProvider\DataConnector\DataConnector_mysql\getUserResultSourcedIDsResourceLink(), and ilLTIAppEventListener\tryOutcomeService().

Here is the caller graph for this function:

◆ getDataConnector()

IMSGlobal\LTI\ToolProvider\User::getDataConnector ( )

Get the data connector.

Returns: mixed Data connector object or string

Definition at line 240 of file User.php.

    {
 
        return $this->dataConnector;
 
    }

References IMSGlobal\LTI\ToolProvider\User\$dataConnector.

Referenced by IMSGlobal\LTI\ToolProvider\User\delete(), IMSGlobal\LTI\ToolProvider\User\getResourceLink(), IMSGlobal\LTI\ToolProvider\User\load(), and IMSGlobal\LTI\ToolProvider\User\save().

Here is the caller graph for this function:

◆ getId()

IMSGlobal\LTI\ToolProvider\User::getId ( $idScope = null )

Get the user ID (which may be a compound of the tool consumer and resource link IDs).

Parameters

int $idScope Scope to use for user ID (optional, default is null for consumer default setting)

Returns: string User ID value

Definition at line 254 of file User.php.

    {
 
        if (empty($idScope)) {
            if (!is_null($this->resourceLink)) {
                $idScope = $this->resourceLink->getConsumer()->idScope;
            } else {
                $idScope = ToolProvider::ID_SCOPE_ID_ONLY;
            }
        }
        switch ($idScope) {
            case ToolProvider::ID_SCOPE_GLOBAL:
                $id = $this->getResourceLink()->getKey() . ToolProvider::ID_SCOPE_SEPARATOR . $this->ltiUserId;
                break;
            case ToolProvider::ID_SCOPE_CONTEXT:
                $id = $this->getResourceLink()->getKey();
                if ($this->resourceLink->ltiContextId) {
                    $id .= ToolProvider::ID_SCOPE_SEPARATOR . $this->resourceLink->ltiContextId;
                }
                $id .= ToolProvider::ID_SCOPE_SEPARATOR . $this->ltiUserId;
                break;
            case ToolProvider::ID_SCOPE_RESOURCE:
                $id = $this->getResourceLink()->getKey();
                if ($this->resourceLink->ltiResourceLinkId) {
                    $id .= ToolProvider::ID_SCOPE_SEPARATOR . $this->resourceLink->ltiResourceLinkId;
                }
                $id .= ToolProvider::ID_SCOPE_SEPARATOR . $this->ltiUserId;
                break;
            default:
                $id = $this->ltiUserId;
                break;
        }
 
        return $id;
 
    }

References IMSGlobal\LTI\ToolProvider\User\$id, IMSGlobal\LTI\ToolProvider\User\$ltiUserId, IMSGlobal\LTI\ToolProvider\User\getResourceLink(), IMSGlobal\LTI\ToolProvider\ToolProvider\ID_SCOPE_CONTEXT, IMSGlobal\LTI\ToolProvider\ToolProvider\ID_SCOPE_GLOBAL, IMSGlobal\LTI\ToolProvider\ToolProvider\ID_SCOPE_ID_ONLY, IMSGlobal\LTI\ToolProvider\ToolProvider\ID_SCOPE_RESOURCE, and IMSGlobal\LTI\ToolProvider\ToolProvider\ID_SCOPE_SEPARATOR.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRecordId()

IMSGlobal\LTI\ToolProvider\User::getRecordId ( )

Get record ID of user.

Returns: int Record ID of user

Definition at line 204 of file User.php.

    {
 
        return $this->id;
 
    }

References IMSGlobal\LTI\ToolProvider\User\$id.

◆ getResourceLink()

IMSGlobal\LTI\ToolProvider\User::getResourceLink ( )

Get resource link.

Returns: ResourceLink Resource link object

Definition at line 188 of file User.php.

    {
 
        if (is_null($this->resourceLink) && !is_null($this->resourceLinkId)) {
            $this->resourceLink = ResourceLink::fromRecordId($this->resourceLinkId, $this->getDataConnector());
        }
 
        return $this->resourceLink;
 
    }

References IMSGlobal\LTI\ToolProvider\User\$resourceLink, IMSGlobal\LTI\ToolProvider\ResourceLink\fromRecordId(), and IMSGlobal\LTI\ToolProvider\User\getDataConnector().

Referenced by IMSGlobal\LTI\ToolProvider\User\getId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasRole()

IMSGlobal\LTI\ToolProvider\User::hasRole ( $role )

private

Check whether the user has a specified role name.

Parameters

string $role Name of role

Returns: boolean True if the user has the specified role

Definition at line 442 of file User.php.

                                    {
 
        if (substr($role, 0, 4) !== 'urn:')
        {
            $role = 'urn:lti:role:ims/lis/' . $role;
        }
 
        return in_array($role, $this->roles);
 
    }

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

Here is the caller graph for this function:

◆ initialise()

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

Initialise the user.

Pseudonym for initialize().

Definition at line 144 of file User.php.

    {
 
        $this->initialize();
 
    }

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

Here is the call graph for this function:

◆ initialize()

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

Initialise the user.

Definition at line 123 of file User.php.

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

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

Here is the caller graph for this function:

◆ isAdmin()

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

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

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

Definition at line 355 of file User.php.

    {
 
        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 IMSGlobal\LTI\ToolProvider\User\hasRole().

Here is the call graph for this function:

◆ isLearner()

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

Check if the user is a learner.

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

Definition at line 380 of file User.php.

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

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

Here is the call graph for this function:

◆ isStaff()

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

Check if the user is staff.

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

Definition at line 368 of file User.php.

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

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

Here is the call graph for this function:

◆ load()

IMSGlobal\LTI\ToolProvider\User::load ( $id = null )

private

Load the user from the database.

Parameters

int $id Record ID of user (optional, default is null)

Returns: boolean True if the user object was successfully loaded

Definition at line 460 of file User.php.

    {
 
        $this->initialize();
        $this->id = $id;
        $dataConnector = $this->getDataConnector();
        if (!is_null($dataConnector)) {
            return $dataConnector->loadUser($this);
        }
 
        return false;
    }

References IMSGlobal\LTI\ToolProvider\User\$dataConnector, IMSGlobal\LTI\ToolProvider\User\$id, IMSGlobal\LTI\ToolProvider\User\getDataConnector(), and IMSGlobal\LTI\ToolProvider\User\initialize().

Here is the call graph for this function:

◆ save()

IMSGlobal\LTI\ToolProvider\User::save ( )

Save the user to the database.

Returns: boolean True if the user object was successfully saved

Definition at line 156 of file User.php.

    {
 
        if (!empty($this->ltiResultSourcedId) && !is_null($this->resourceLinkId)) {
            $ok = $this->getDataConnector()->saveUser($this);
        } else {
            $ok = true;
        }
 
        return $ok;
 
    }

References $ok, and IMSGlobal\LTI\ToolProvider\User\getDataConnector().

Here is the call graph for this function:

◆ setEmail()

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

Set the user's email address.

Parameters

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

Definition at line 334 of file User.php.

    {
 
      if (!empty($email)) {
          $this->email = $email;
      } else if (!empty($defaultEmail)) {
          $this->email = $defaultEmail;
          if (substr($this->email, 0, 1) === '@') {
              $this->email = $this->getId() . $this->email;
          }
      } else {
          $this->email = '';
      }
 
    }

References IMSGlobal\LTI\ToolProvider\User\$email, and IMSGlobal\LTI\ToolProvider\User\getId().

Here is the call graph for this function:

◆ setNames()

IMSGlobal\LTI\ToolProvider\User::setNames	(	$firstname,
		$lastname,
		$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 298 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;
        } else if (!empty($names[0])) {
            $this->firstname = $names[0];
        } else {
            $this->firstname = 'User';
        }
        if (!empty($lastname)) {
            $this->lastname = trim($lastname);
            $names[1] = $this->lastname;
        } else if (!empty($names[1])) {
            $this->lastname = $names[1];
        } else {
            $this->lastname = $this->ltiUserId;
        }
        if (empty($this->fullname)) {
            $this->fullname = "{$this->firstname} {$this->lastname}";
        }
 
    }

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

◆ setRecordId()

IMSGlobal\LTI\ToolProvider\User::setRecordId ( $id )

Set record ID of user.

Parameters

int $id Record ID of user

Definition at line 216 of file User.php.

    {
 
        $this->id = $id;
 
    }

References IMSGlobal\LTI\ToolProvider\User\$id.

◆ setResourceLinkId()

IMSGlobal\LTI\ToolProvider\User::setResourceLinkId ( $resourceLinkId )

Set resource link ID of user.

Parameters

int $resourceLinkId Resource link ID of user

Definition at line 228 of file User.php.

    {
 
        $this->resourceLinkId = $resourceLinkId;
 
    }

References IMSGlobal\LTI\ToolProvider\User\$resourceLinkId.

Field Documentation

◆ $created

object IMSGlobal\LTI\ToolProvider\User::$created = null

Date/time the record was created.

Definition at line 71 of file User.php.

◆ $dataConnector

mixed IMSGlobal\LTI\ToolProvider\User::$dataConnector = null

private

Data connector object or string.

Definition at line 108 of file User.php.

Referenced by IMSGlobal\LTI\ToolProvider\User\fromRecordId(), IMSGlobal\LTI\ToolProvider\User\getDataConnector(), and IMSGlobal\LTI\ToolProvider\User\load().

◆ $email

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

User's email address.

Definition at line 41 of file User.php.

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

◆ $firstname

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

User's first name.

Definition at line 23 of file User.php.

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

◆ $fullname

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

User's fullname.

Definition at line 35 of file User.php.

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

◆ $groups

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

Groups for user.

Definition at line 59 of file User.php.

◆ $id

string IMSGlobal\LTI\ToolProvider\User::$id = null

private

User record ID value.

Definition at line 96 of file User.php.

Referenced by IMSGlobal\LTI\ToolProvider\User\fromRecordId(), IMSGlobal\LTI\ToolProvider\User\getId(), IMSGlobal\LTI\ToolProvider\User\getRecordId(), IMSGlobal\LTI\ToolProvider\User\load(), and IMSGlobal\LTI\ToolProvider\User\setRecordId().

◆ $image

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

User's image URI.

Definition at line 47 of file User.php.

◆ $lastname

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

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

Definition at line 29 of file User.php.

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

◆ $ltiResultSourcedId

string IMSGlobal\LTI\ToolProvider\User::$ltiResultSourcedId = null

User's result sourcedid.

Definition at line 65 of file User.php.

◆ $ltiUserId

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

user ID as supplied in the last connection request.

Definition at line 102 of file User.php.

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

◆ $resourceLink

ResourceLink IMSGlobal\LTI\ToolProvider\User::$resourceLink = null

private

Resource link object.

Definition at line 84 of file User.php.

Referenced by IMSGlobal\LTI\ToolProvider\User\fromResourceLink(), and IMSGlobal\LTI\ToolProvider\User\getResourceLink().

◆ $resourceLinkId

int IMSGlobal\LTI\ToolProvider\User::$resourceLinkId = null

private

Resource link record ID.

Definition at line 90 of file User.php.

Referenced by IMSGlobal\LTI\ToolProvider\User\setResourceLinkId().

◆ $roles

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

Roles for user.

Definition at line 53 of file User.php.

◆ $updated

object IMSGlobal\LTI\ToolProvider\User::$updated = null

Date/time the record was last updated.

Definition at line 77 of file User.php.

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

libs/composer/vendor/imsglobal/lti/src/ToolProvider/User.php

Public Member Functions

Static Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ delete()

◆ fromRecordId()

◆ fromResourceLink()

◆ getDataConnector()

◆ getId()

◆ getRecordId()

◆ getResourceLink()

◆ hasRole()

◆ initialise()

◆ initialize()

◆ isAdmin()

◆ isLearner()

◆ isStaff()

◆ load()

◆ save()

◆ setEmail()

◆ setNames()

◆ setRecordId()

◆ setResourceLinkId()

Field Documentation

◆ $created

◆ $dataConnector

◆ $email

◆ $firstname

◆ $fullname

◆ $groups

◆ $id

◆ $image

◆ $lastname

◆ $ltiResultSourcedId

◆ $ltiUserId

◆ $resourceLink

◆ $resourceLinkId

◆ $roles

◆ $updated