Class to represent a platform user. More...

Inheritance diagram for ILIAS\LTI\ToolProvider\UserResult:

Collaboration diagram for ILIAS\LTI\ToolProvider\UserResult:

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

	initialize ()
	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...

	setResourceLink (ResourceLink $resourceLink)
	Set resource link. More...

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

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

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

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

	setDataConnector (DataConnector $dataConnector)
	Set the data connector. More...

	getId (int $idScope=null, Platform $platform=null)
	Get the user ID (which may be a compound of the platform and resource link IDs). More...

Public Member Functions inherited from ILIAS\LTI\ToolProvider\User
	__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...

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

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

Data Fields
string	$ltiResultSourcedId = null
	UserResult's result sourcedid. More...

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

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

Data Fields inherited from ILIAS\LTI\ToolProvider\User
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...

Private Member Functions
	load (int $id=null)
	Load the user from the database. More...

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

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

int	$id = null
	UserResult record ID value. More...

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

Additional Inherited Members
Static Public Attributes inherited from ILIAS\LTI\ToolProvider\User
static bool	$allowEmptyName = false
	Allow user name field to be empty? 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 http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3

Definition at line 30 of file UserResult.php.

Constructor & Destructor Documentation

◆ __construct()

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

Class constructor.

Definition at line 84 of file UserResult.php.

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

     {
         $this->initialize();
     }

Here is the call graph for this function:

Member Function Documentation

◆ delete()

ILIAS\LTI\ToolProvider\UserResult::delete ( )

Delete the user from the database.

Returns: bool True if the user object was successfully deleted

Definition at line 121 of file UserResult.php.

References ILIAS\LTI\ToolProvider\UserResult\getDataConnector().

                             : bool
     {
         $ok = $this->getDataConnector()->deleteUserResult($this);
 
         return $ok;
     }

Here is the call graph for this function:

◆ fromRecordId()

static ILIAS\LTI\ToolProvider\UserResult::fromRecordId	(	int	$id,
		DataConnector	$dataConnector
	)

static

Load the user from the database.

Parameters

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

Returns: UserResult UserResult object

Definition at line 250 of file UserResult.php.

References ILIAS\LTI\ToolProvider\UserResult\$dataConnector.

                                                                               : UserResult
     {
         $userresult = new UserResult();
         $userresult->dataConnector = $dataConnector;
         $userresult->load($id);
 
         return $userresult;
     }

◆ fromResourceLink()

static ILIAS\LTI\ToolProvider\UserResult::fromResourceLink	(	ResourceLink	$resourceLink,
		string	$ltiUserId
	)

static

Class constructor from resource link.

Parameters

ResourceLink	$resourceLink	ResourceLink object
string	$ltiUserId	UserResult ID value

Returns: UserResult UserResult object

Definition at line 265 of file UserResult.php.

References ILIAS\LTI\ToolProvider\User\$ltiUserId, ILIAS\LTI\ToolProvider\UserResult\$resourceLink, ILIAS\LTI\ToolProvider\ResourceLink\getDataConnector(), and ILIAS\LTI\ToolProvider\ResourceLink\getRecordId().

Referenced by ILIAS\LTI\ToolProvider\Tool\authenticate(), ILIAS\LTI\ToolProvider\Service\Membership\getMembers(), ILIAS\LTI\ToolProvider\ResourceLink\getMemberships(), ilLTIAppEventListener\handleOutcomeWithoutLP(), and ilLTIAppEventListener\tryOutcomeService().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDataConnector()

ILIAS\LTI\ToolProvider\UserResult::getDataConnector ( )

Get the data connector.

Returns: mixed Data connector object or string

Definition at line 185 of file UserResult.php.

References ILIAS\LTI\ToolProvider\UserResult\$dataConnector.

Referenced by ILIAS\LTI\ToolProvider\UserResult\delete(), ILIAS\LTI\ToolProvider\UserResult\getResourceLink(), ILIAS\LTI\ToolProvider\UserResult\load(), and ILIAS\LTI\ToolProvider\UserResult\save().

     {
         return $this->dataConnector;
     }

Here is the caller graph for this function:

◆ getId()

ILIAS\LTI\ToolProvider\UserResult::getId	(	int	$idScope = `null`,
		Platform	$platform = `null`
	)

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

Parameters

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

Returns: string UserResult ID value

Definition at line 205 of file UserResult.php.

References ILIAS\LTI\ToolProvider\UserResult\$id, ILIAS\LTI\ToolProvider\$key, ILIAS\LTI\ToolProvider\User\$ltiUserId, ILIAS\LTI\ToolProvider\UserResult\getResourceLink(), ILIAS\LTI\ToolProvider\Tool\ID_SCOPE_CONTEXT, ILIAS\LTI\ToolProvider\Tool\ID_SCOPE_GLOBAL, ILIAS\LTI\ToolProvider\Tool\ID_SCOPE_ID_ONLY, ILIAS\LTI\ToolProvider\Tool\ID_SCOPE_RESOURCE, and ILIAS\LTI\ToolProvider\Tool\ID_SCOPE_SEPARATOR.

                                                                          : string
     {
         $key = '';
         if (is_null($platform) && !is_null($this->getResourceLink())) {
             $platform = $this->getResourceLink()->getPlatform();
         }
         if (!is_null($platform)) {
             $key = $platform->getId();
         }
         if (is_null($idScope) && !is_null($this->getResourceLink())) {
             $idScope = $this->resourceLink->getPlatform()->idScope;
         }
         if (is_null($idScope)) {
             $idScope = Tool::ID_SCOPE_ID_ONLY;
         }
         switch ($idScope) {
             case Tool::ID_SCOPE_GLOBAL:
                 $id = $key . Tool::ID_SCOPE_SEPARATOR . $this->ltiUserId;
                 break;
             case Tool::ID_SCOPE_CONTEXT:
                 if ($this->resourceLink->getContext() && $this->resourceLink->getContext()->ltiContextId) {
                     $id = $key . Tool::ID_SCOPE_SEPARATOR . $this->resourceLink->getContext()->ltiContextId;
                 }
                 $id .= Tool::ID_SCOPE_SEPARATOR . $this->ltiUserId;
                 break;
             case Tool::ID_SCOPE_RESOURCE:
                 if (!is_null($this->resourceLink) && !empty($this->resourceLink->ltiResourceLinkId)) {
                     $id = $key . Tool::ID_SCOPE_SEPARATOR . $this->resourceLink->ltiResourceLinkId;
                 }
                 $id .= Tool::ID_SCOPE_SEPARATOR . $this->ltiUserId;
                 break;
             default:
                 $id = $this->ltiUserId;
                 break;
         }
 
         return $id;
     }

Here is the call graph for this function:

◆ getRecordId()

ILIAS\LTI\ToolProvider\UserResult::getRecordId ( )

Get record ID of user.

Returns: int Record ID of user

Definition at line 156 of file UserResult.php.

References ILIAS\LTI\ToolProvider\UserResult\$id.

                                  : ?int
     {
         return $this->id;
     }

◆ getResourceLink()

ILIAS\LTI\ToolProvider\UserResult::getResourceLink ( )

Get resource link.

Returns: ResourceLink Resource link object

Definition at line 133 of file UserResult.php.

References ILIAS\LTI\ToolProvider\UserResult\$resourceLink, ILIAS\LTI\ToolProvider\ResourceLink\fromRecordId(), and ILIAS\LTI\ToolProvider\UserResult\getDataConnector().

Referenced by ILIAS\LTI\ToolProvider\ResourceLink\doOutcomesService(), and ILIAS\LTI\ToolProvider\UserResult\getId().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initialize()

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

Initialise the user.

Definition at line 92 of file UserResult.php.

Referenced by ILIAS\LTI\ToolProvider\UserResult\__construct(), ILIAS\LTI\ToolProvider\DataConnector\DataConnector\deleteUserResult(), and ILIAS\LTI\ToolProvider\UserResult\load().

     {
         parent::initialize();
         $this->ltiResultSourcedId = null;
         $this->created = null;
         $this->updated = null;
     }

Here is the caller graph for this function:

◆ load()

ILIAS\LTI\ToolProvider\UserResult::load ( int $id = null )

private

Load the user from the database.

Parameters

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

Returns: bool True if the user object was successfully loaded

Definition at line 290 of file UserResult.php.

References ILIAS\LTI\ToolProvider\UserResult\$id, ILIAS\LTI\ToolProvider\UserResult\getDataConnector(), ILIAS\LTI\ToolProvider\UserResult\initialize(), and ILIAS\LTI\ToolProvider\DataConnector\DataConnector\loadUserResult().

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

Here is the call graph for this function:

◆ save()

ILIAS\LTI\ToolProvider\UserResult::save ( )

Save the user to the database.

Returns: bool True if the user object was successfully saved

Definition at line 105 of file UserResult.php.

References ILIAS\LTI\ToolProvider\UserResult\getDataConnector().

                           : bool
     {
         if (!is_null($this->resourceLinkId)) {
             $ok = $this->getDataConnector()->saveUserResult($this);
         } else {
             $ok = true;
         }
 
         return $ok;
     }

Here is the call graph for this function:

◆ setDataConnector()

ILIAS\LTI\ToolProvider\UserResult::setDataConnector ( DataConnector $dataConnector )

Set the data connector.

Parameters

DataConnector $dataConnector Data connector object

Definition at line 194 of file UserResult.php.

References ILIAS\LTI\ToolProvider\UserResult\$dataConnector.

     {
         $this->dataConnector = $dataConnector;
     }

◆ setRecordId()

ILIAS\LTI\ToolProvider\UserResult::setRecordId ( int $id )

Set record ID of user.

Parameters

int $id Record ID of user

Definition at line 165 of file UserResult.php.

References ILIAS\LTI\ToolProvider\UserResult\$id.

     {
         $this->id = $id;
     }

◆ setResourceLink()

ILIAS\LTI\ToolProvider\UserResult::setResourceLink ( ResourceLink $resourceLink )

Set resource link.

Parameters

ResourceLink $resourceLink Resource link object

Definition at line 146 of file UserResult.php.

References ILIAS\LTI\ToolProvider\UserResult\$resourceLink.

     {
         $this->resourceLink = $resourceLink;
     }

◆ setResourceLinkId()

ILIAS\LTI\ToolProvider\UserResult::setResourceLinkId ( int $resourceLinkId )

Set resource link ID of user.

Parameters

int $resourceLinkId Resource link ID of user

Definition at line 174 of file UserResult.php.

References ILIAS\LTI\ToolProvider\UserResult\$resourceLinkId.

     {
         $this->resourceLink = null;
         $this->resourceLinkId = $resourceLinkId;
     }

Field Documentation

◆ $created

int null ILIAS\LTI\ToolProvider\UserResult::$created = null

Date/time the record was created.

Definition at line 44 of file UserResult.php.

◆ $dataConnector

DataConnector null ILIAS\LTI\ToolProvider\UserResult::$dataConnector = null

private

Data connector object or string.

Definition at line 79 of file UserResult.php.

Referenced by ILIAS\LTI\ToolProvider\UserResult\fromRecordId(), ILIAS\LTI\ToolProvider\UserResult\getDataConnector(), and ILIAS\LTI\ToolProvider\UserResult\setDataConnector().

◆ $id

int null ILIAS\LTI\ToolProvider\UserResult::$id = null

private

UserResult record ID value.

Definition at line 72 of file UserResult.php.

Referenced by ILIAS\LTI\ToolProvider\UserResult\getId(), ILIAS\LTI\ToolProvider\UserResult\getRecordId(), ILIAS\LTI\ToolProvider\UserResult\load(), and ILIAS\LTI\ToolProvider\UserResult\setRecordId().

◆ $ltiResultSourcedId

string null ILIAS\LTI\ToolProvider\UserResult::$ltiResultSourcedId = null

UserResult's result sourcedid.

Definition at line 37 of file UserResult.php.

◆ $resourceLink

ResourceLink null ILIAS\LTI\ToolProvider\UserResult::$resourceLink = null

private

Resource link object.

Definition at line 58 of file UserResult.php.

Referenced by ILIAS\LTI\ToolProvider\UserResult\fromResourceLink(), ILIAS\LTI\ToolProvider\UserResult\getResourceLink(), and ILIAS\LTI\ToolProvider\UserResult\setResourceLink().

◆ $resourceLinkId

int null ILIAS\LTI\ToolProvider\UserResult::$resourceLinkId = null

private

Resource link record ID.

Definition at line 65 of file UserResult.php.

Referenced by ILIAS\LTI\ToolProvider\UserResult\setResourceLinkId().

◆ $updated

int null ILIAS\LTI\ToolProvider\UserResult::$updated = null

Date/time the record was last updated.

Definition at line 51 of file UserResult.php.

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

Services/LTI/src/ToolProvider/UserResult.php

Public Member Functions

Static Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ delete()

◆ fromRecordId()

◆ fromResourceLink()

◆ getDataConnector()

◆ getId()

◆ getRecordId()

◆ getResourceLink()

◆ initialize()

◆ load()

◆ save()

◆ setDataConnector()

◆ setRecordId()

◆ setResourceLink()

◆ setResourceLinkId()

Field Documentation

◆ $created

◆ $dataConnector

◆ $id

◆ $ltiResultSourcedId

◆ $resourceLink

◆ $resourceLinkId

◆ $updated