LTI provider for LTI launch. More...

Inheritance diagram for ilLTIPlatform:

Collaboration diagram for ilLTIPlatform:

Public Member Functions
	__construct (ilLTIDataConnector $dataConnector=null)
	Class constructor. More...

	initialize ()
	Initialise the platform. More...

	setExtConsumerId (int $a_id)

	getExtConsumerId ()

	setRefId (int $a_ref_id)

	getRefId ()

	setTitle (string $title)

	getTitle ()

	setDescription (string $description)

	getDescription ()

	setPrefix (string $prefix)

	getPrefix ()

	setSecret (string $secret)

	getSecret ()

	createSecret ()
	Create a secret. More...

	setLanguage (string $lang)

	getLanguage ()

	setActive (bool $value)

	getActive ()

	setRole (int $role_id)

	getRole ()

	setEnabled (bool $a_status)

	getEnabled ()

	saveGlobalToolConsumerSettings (ilLTIDataConnector $dataConnector)
	Save global consumer settings. More...

	deleteGlobalToolConsumerSettings (ilLTIDataConnector $dataConnector)
	Delete global tool consumer settings. More...

	saveLTI (ilLTIDataConnector $dataConnector)
	Save the tool consumer to the database with ILIAS extension. More...

Static Public Member Functions
static	fromPlatformId (string $platformId, ?string $clientId, ?string $deploymentId, DataConnector $dataConnector=null, bool $autoEnable=false)
	Load the platform from the database by its platform, client and deployment IDs. More...

static	fromConsumerKey (?string $key=null, $dataConnector=null, bool $autoEnable=false)
	Load the platform from the database by its consumer key. More...

static	fromRecordId (int\|string $id, DataConnector $dataConnector)
	Load the platform from the database by its record ID. More...

static	fromExternalConsumerId (int $id, ilLTIDataConnector $dataConnector)

static	fromGlobalSettingsAndRefId (int $a_ext_consumer_id, int $a_ref_id, ilLTIDataConnector $a_data_connector)
	Load consumer from global settings and ref_id. More...

Protected Attributes
int	$ref_id = 0

int	$ext_consumer_id = 0

string	$title = ''

string	$description = ''

string	$prefix = ''

string	$user_language = ''

int	$role = 0

bool	$active = false

Private Attributes
array	$settings = null
	Setting values (LTI parameters, custom parameters and local parameters). More...

int	$id = null
	System ID value. More...

string	$key = null
	Consumer key/client ID value. More...

Detailed Description

LTI provider for LTI launch.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 32 of file class.ilLTIPlatform.php.

Constructor & Destructor Documentation

◆ __construct()

ilLTIPlatform::__construct ( ilLTIDataConnector $dataConnector = null )

Class constructor.

Parameters

ilLTIDataConnector | null $dataConnector A data connector object

Definition at line 99 of file class.ilLTIPlatform.php.

References ilLTIDataConnector\getDataConnector(), and initialize().

     {
         $this->initialize();
         if (empty($dataConnector)) {
             $dataConnector = ilLTIDataConnector::getDataConnector();
         }
         $this->dataConnector = $dataConnector;
     }

Here is the call graph for this function:

Member Function Documentation

◆ createSecret()

ilLTIPlatform::createSecret ( )

Create a secret.

Definition at line 219 of file class.ilLTIPlatform.php.

References setSecret().

                                   : void
     {
         $this->setSecret(Util::getRandomString(12));
     }

Here is the call graph for this function:

◆ deleteGlobalToolConsumerSettings()

ilLTIPlatform::deleteGlobalToolConsumerSettings ( ilLTIDataConnector $dataConnector )

Delete global tool consumer settings.

Parameters

ilLTIDataConnector $dataConnector

Definition at line 380 of file class.ilLTIPlatform.php.

References ilLTIDataConnector\deleteGlobalToolConsumerSettings().

                                                                                        : void
     {
         $dataConnector->deleteGlobalToolConsumerSettings($this);
     }

Here is the call graph for this function:

◆ fromConsumerKey()

static ilLTIPlatform::fromConsumerKey	(	?string	$key = `null`,
			$dataConnector = `null`,
		bool	$autoEnable = `false`
	)

static

Load the platform from the database by its consumer key.

Parameters

string \| null	$key	Consumer key
null	$dataConnector	A data connector object
bool	$autoEnable	true if the platform is to be enabled automatically (optional, default is false)

Returns: ilLTIPlatform Platform The platform object

Definition at line 298 of file class.ilLTIPlatform.php.

References ilLoggerFactory\getLogger().

Referenced by ilAuthProviderLTI\findGlobalRole().

                                                                                                                 : ilLTIPlatform
     {
         $platform = new ilLTIPlatform($dataConnector);
         $platform->initialize();
         $platform->setKey($key);
         ilLoggerFactory::getLogger('ltis')->debug('Loading with key: ' . $platform->getKey());
         $dataConnector->loadPlatform($platform);
         $dataConnector->loadGlobalToolConsumerSettings($platform);
         return $platform;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fromExternalConsumerId()

static ilLTIPlatform::fromExternalConsumerId	(	int	$id,
		ilLTIDataConnector	$dataConnector
	)

static

Parameters

int	$id
ilLTIDataConnector	$dataConnector

Returns: ilLTIPlatform

Definition at line 332 of file class.ilLTIPlatform.php.

References ilLTIDataConnector\loadGlobalToolConsumerSettings().

Referenced by ilObjLTIAdministrationGUI\changeStatusLTIConsumer(), ilObjLTIAdministrationGUI\deleteLTIConsumer(), ilObjLTIAdministrationGUI\editConsumer(), ilObjLTIAdministration\getActiveObjectTypes(), and ilObjLTIAdministrationGUI\updateLTIConsumer().

                                                                                              : ilLTIPlatform
     {
         $platform = new ilLTIPlatform($dataConnector);
         //$platform->setRecordId((int) $id);
         //$dataConnector->loadPlatform($platform);
         $platform->initialize();
         $platform->setExtConsumerId($id);
         if (!$dataConnector->loadGlobalToolConsumerSettings($platform)) {
             $platform->initialize();
         }
         return $platform;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fromGlobalSettingsAndRefId()

static ilLTIPlatform::fromGlobalSettingsAndRefId	(	int	$a_ext_consumer_id,
		int	$a_ref_id,
		ilLTIDataConnector	$a_data_connector
	)

static

Load consumer from global settings and ref_id.

Parameters

int	$a_ext_consumer_id
int	$a_ref_id
ilLTIDataConnector	$a_data_connector

Returns: ilLTIPlatform

Definition at line 352 of file class.ilLTIPlatform.php.

References ilLTIDataConnector\lookupRecordIdByGlobalSettingsAndRefId().

Referenced by ilLTIProviderObjectSettingGUI\initObjectSettingsForm(), and ilLTIProviderObjectSettingGUI\updateSettings().

                                                                                                                                   : ilLTIPlatform
     {
         $toolConsumer = new ilLTIPlatform(null, $a_data_connector);
         $toolConsumer->initialize();
         $toolConsumer->setExtConsumerId($a_ext_consumer_id);
         $toolConsumer->setRefId($a_ref_id);
 
         $consumer_pk = $a_data_connector->lookupRecordIdByGlobalSettingsAndRefId($toolConsumer);
         if ($consumer_pk != null) {
             $toolConsumer = self::fromRecordId($consumer_pk, $a_data_connector);
         }
         return $toolConsumer;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fromPlatformId()

static ilLTIPlatform::fromPlatformId	(	string	$platformId,
		?string	$clientId,
		?string	$deploymentId,
		DataConnector	$dataConnector = `null`,
		bool	$autoEnable = `false`
	)

static

Load the platform from the database by its platform, client and deployment IDs.

Parameters

string	$platformId	The platform ID
string \| null	$clientId	The client ID
string \| null	$deploymentId	The deployment ID
ilLTIDataConnector \| null	$dataConnector	A data connector object
bool	$autoEnable	True if the platform is to be enabled automatically (optional, default is false)

Returns: ilLTIPlatform The platform object

Definition at line 279 of file class.ilLTIPlatform.php.

References $clientId.

                                                                                                                                                                       : ilLTIPlatform
     {
         $platform = new ilLTIPlatform($dataConnector);
         $platform->initialize();
         $platform->platformId = $platformId;
         $platform->clientId = $clientId;
         $platform->deploymentId = $deploymentId;
         $dataConnector->loadPlatform($platform);
         $dataConnector->loadGlobalToolConsumerSettings($platform);
         return $platform;
     }

◆ fromRecordId()

static ilLTIPlatform::fromRecordId	(	int\|string	$id,
		DataConnector	$dataConnector
	)

static

Load the platform from the database by its record ID.

Parameters

int \| string	$id	The platform record ID
ilLTIDataConnector	$dataConnector	Database connection object

Returns: ilLTIPlatform Platform The platform object

Definition at line 315 of file class.ilLTIPlatform.php.

References ilLoggerFactory\getLogger().

Referenced by ilAuthProviderLTI\lookupConsumer().

                                                                                      : ilLTIPlatform
     {
         //        $platform = new static($dataConnector);
         $platform = new ilLTIPlatform($dataConnector);
         $platform->initialize();
         $platform->setRecordId((int) $id);
         ilLoggerFactory::getLogger('ltis')->info('Loading with record id: ' . $platform->getRecordId());
         $dataConnector->loadPlatform($platform);
         $dataConnector->loadGlobalToolConsumerSettings($platform);
         return $platform;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getActive()

ilLTIPlatform::getActive ( )

Definition at line 242 of file class.ilLTIPlatform.php.

References $active.

Referenced by ilLTIDataConnector\saveGlobalToolConsumerSettings().

                                : bool
     {
         return $this->active;
     }

Here is the caller graph for this function:

◆ getDescription()

ilLTIPlatform::getDescription ( )

Definition at line 191 of file class.ilLTIPlatform.php.

References $description.

Referenced by ilLTIDataConnector\saveGlobalToolConsumerSettings().

                                     : string
     {
         return $this->description;
     }

Here is the caller graph for this function:

◆ getEnabled()

ilLTIPlatform::getEnabled ( )

Definition at line 263 of file class.ilLTIPlatform.php.

                                 : bool
     {
         return $this->enabled;
     }

◆ getExtConsumerId()

ilLTIPlatform::getExtConsumerId ( )

Definition at line 155 of file class.ilLTIPlatform.php.

References $ext_consumer_id.

Referenced by ilAuthProviderLTI\createUser(), ilLTIDataConnector\deleteGlobalToolConsumerSettings(), ilAuthProviderLTI\handleLocalRoleAssignments(), ilLTIDataConnector\loadGlobalToolConsumerSettings(), ilLTIDataConnector\lookupRecordIdByGlobalSettingsAndRefId(), ilLTIDataConnector\saveGlobalToolConsumerSettings(), and ilLTIDataConnector\saveToolConsumerILIAS().

                                       : int
     {
         return $this->ext_consumer_id;
     }

Here is the caller graph for this function:

◆ getLanguage()

ilLTIPlatform::getLanguage ( )

Definition at line 232 of file class.ilLTIPlatform.php.

References $user_language.

Referenced by ilAuthProviderLTI\createUser(), and ilLTIDataConnector\saveGlobalToolConsumerSettings().

                                  : string
     {
         return $this->user_language;
     }

Here is the caller graph for this function:

◆ getPrefix()

ilLTIPlatform::getPrefix ( )

Definition at line 201 of file class.ilLTIPlatform.php.

References $prefix.

Referenced by ilAuthProviderLTI\createUser(), and ilLTIDataConnector\saveGlobalToolConsumerSettings().

                                : string
     {
         return $this->prefix;
     }

Here is the caller graph for this function:

◆ getRefId()

ilLTIPlatform::getRefId ( )

Definition at line 165 of file class.ilLTIPlatform.php.

References $ref_id.

Referenced by ilLTIDataConnector\lookupRecordIdByGlobalSettingsAndRefId(), and ilLTIDataConnector\saveToolConsumerILIAS().

                               : int
     {
         return $this->ref_id;
     }

Here is the caller graph for this function:

◆ getRole()

ilLTIPlatform::getRole ( )

Definition at line 252 of file class.ilLTIPlatform.php.

References $role.

Referenced by ilAuthProviderLTI\createUser(), ilLTIDataConnector\saveGlobalToolConsumerSettings(), and ilAuthProviderLTI\updateUser().

                              : int
     {
         return $this->role;
     }

Here is the caller graph for this function:

◆ getSecret()

ilLTIPlatform::getSecret ( )

Definition at line 211 of file class.ilLTIPlatform.php.

                                : ?string
     {
         return $this->secret;
     }

◆ getTitle()

ilLTIPlatform::getTitle ( )

Definition at line 181 of file class.ilLTIPlatform.php.

References $title.

Referenced by ilLTIDataConnector\saveGlobalToolConsumerSettings(), and ilLTIDataConnector\saveToolConsumerILIAS().

                               : string
     {
         return $this->title;
     }

Here is the caller graph for this function:

◆ initialize()

ilLTIPlatform::initialize ( )

Initialise the platform.

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

References ILIAS\Repository\profile(), and ILIAS\Repository\settings().

Referenced by __construct(), and ilLTIDataConnector\deleteGlobalToolConsumerSettings().

                                 : void
     {
         $this->id = null;
         $this->key = null;
         $this->name = null;
         $this->secret = null;
         $this->signatureMethod = 'HMAC-SHA1';
         $this->encryptionMethod = '';
         $this->rsaKey = null;
         $this->kid = null;
         $this->jku = '';
         $this->platformId = null;
         $this->clientId = null;
         $this->deploymentId = null;
         $this->ltiVersion = null;
         $this->consumerName = null;
         $this->consumerVersion = null;
         $this->consumerGuid = null;
         $this->profile = null;
         $this->toolProxy = null;
         $this->settings = array();
         $this->setSettings(array());
         $this->protected = false;
         $this->enabled = false;
         $this->enableFrom = null;
         $this->enableUntil = null;
         $this->lastAccess = null;
         $this->idScope = IdScope::IdOnly;
         $this->defaultEmail = '';
         $this->created = null;
         $this->updated = null;
         //added
         $this->authorizationServerId = '';
         $this->authenticationUrl = '';
         $this->accessTokenUrl = '';
         $this->debugMode = false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveGlobalToolConsumerSettings()

ilLTIPlatform::saveGlobalToolConsumerSettings ( ilLTIDataConnector $dataConnector )

Save global consumer settings.

Parameters

ilLTIDataConnector $dataConnector

Definition at line 371 of file class.ilLTIPlatform.php.

References ilLTIDataConnector\saveGlobalToolConsumerSettings().

                                                                                      : void
     {
         $dataConnector->saveGlobalToolConsumerSettings($this);
     }

Here is the call graph for this function:

◆ saveLTI()

ilLTIPlatform::saveLTI ( ilLTIDataConnector $dataConnector )

Save the tool consumer to the database with ILIAS extension.

Parameters

ilLTIDataConnector $dataConnector

Returns: boolean True if the object was successfully saved

Definition at line 390 of file class.ilLTIPlatform.php.

References ilLTIDataConnector\saveToolConsumerILIAS().

                                                               : bool
     {
         $ok = $dataConnector->saveToolConsumerILIAS($this);
         return $ok;
     }

Here is the call graph for this function:

◆ setActive()

ilLTIPlatform::setActive ( bool $value )

Definition at line 237 of file class.ilLTIPlatform.php.

Referenced by ilLTIDataConnector\loadGlobalToolConsumerSettings().

                                           : void
     {
         $this->active = $value;
     }

Here is the caller graph for this function:

◆ setDescription()

ilLTIPlatform::setDescription ( string $description )

Definition at line 186 of file class.ilLTIPlatform.php.

References $description.

Referenced by ilLTIDataConnector\loadGlobalToolConsumerSettings().

                                                        : void
     {
         $this->description = $description;
     }

Here is the caller graph for this function:

◆ setEnabled()

ilLTIPlatform::setEnabled ( bool $a_status )

Definition at line 258 of file class.ilLTIPlatform.php.

                                               : void
     {
         $this->enabled = $a_status;
     }

◆ setExtConsumerId()

ilLTIPlatform::setExtConsumerId ( int $a_id )

Definition at line 150 of file class.ilLTIPlatform.php.

Referenced by ilLTIDataConnector\loadPlatform(), and ilLTIDataConnector\saveGlobalToolConsumerSettings().

                                                : void
     {
         $this->ext_consumer_id = $a_id;
     }

Here is the caller graph for this function:

◆ setLanguage()

ilLTIPlatform::setLanguage ( string $lang )

Parameters

string $lang

Definition at line 227 of file class.ilLTIPlatform.php.

Referenced by ilLTIDataConnector\loadGlobalToolConsumerSettings().

                                              : void
     {
         $this->user_language = $lang;
     }

Here is the caller graph for this function:

◆ setPrefix()

ilLTIPlatform::setPrefix ( string $prefix )

Definition at line 196 of file class.ilLTIPlatform.php.

References $prefix.

Referenced by ilLTIDataConnector\loadGlobalToolConsumerSettings().

                                              : void
     {
         $this->prefix = $prefix;
     }

Here is the caller graph for this function:

◆ setRefId()

ilLTIPlatform::setRefId ( int $a_ref_id )

Definition at line 160 of file class.ilLTIPlatform.php.

Referenced by ilLTIDataConnector\loadPlatform().

                                            : void
     {
         $this->ref_id = $a_ref_id;
     }

Here is the caller graph for this function:

◆ setRole()

ilLTIPlatform::setRole ( int $role_id )

Definition at line 247 of file class.ilLTIPlatform.php.

Referenced by ilLTIDataConnector\loadGlobalToolConsumerSettings().

                                          : void
     {
         $this->role = $role_id;
     }

Here is the caller graph for this function:

◆ setSecret()

ilLTIPlatform::setSecret ( string $secret )

Definition at line 206 of file class.ilLTIPlatform.php.

Referenced by createSecret().

                                              : void
     {
         $this->secret = $secret;
     }

Here is the caller graph for this function:

◆ setTitle()

ilLTIPlatform::setTitle ( string $title )

Definition at line 175 of file class.ilLTIPlatform.php.

References $title.

Referenced by ilLTIDataConnector\loadGlobalToolConsumerSettings().

                                            : void
     {
         $this->title = $title;
         // $this->consumerName = $title;
     }

Here is the caller graph for this function:

Field Documentation

◆ $active

bool ilLTIPlatform::$active = false

protected

Definition at line 72 of file class.ilLTIPlatform.php.

Referenced by getActive().

◆ $description

string ilLTIPlatform::$description = ''

protected

Definition at line 52 of file class.ilLTIPlatform.php.

Referenced by getDescription(), and setDescription().

◆ $ext_consumer_id

int ilLTIPlatform::$ext_consumer_id = 0

protected

Definition at line 42 of file class.ilLTIPlatform.php.

Referenced by getExtConsumerId().

◆ $id

int null ilLTIPlatform::$id = null

private

System ID value.

Definition at line 86 of file class.ilLTIPlatform.php.

◆ $key

string null ilLTIPlatform::$key = null

private

Consumer key/client ID value.

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

◆ $prefix

string ilLTIPlatform::$prefix = ''

protected

Definition at line 57 of file class.ilLTIPlatform.php.

Referenced by getPrefix(), and setPrefix().

◆ $ref_id

int ilLTIPlatform::$ref_id = 0

protected

Definition at line 37 of file class.ilLTIPlatform.php.

Referenced by getRefId().

◆ $role

int ilLTIPlatform::$role = 0

protected

Definition at line 67 of file class.ilLTIPlatform.php.

Referenced by getRole().

◆ $settings

array ilLTIPlatform::$settings = null

private

Setting values (LTI parameters, custom parameters and local parameters).

Definition at line 79 of file class.ilLTIPlatform.php.

◆ $title

string ilLTIPlatform::$title = ''

protected

Definition at line 47 of file class.ilLTIPlatform.php.

Referenced by getTitle(), and setTitle().

◆ $user_language

string ilLTIPlatform::$user_language = ''

protected

Definition at line 62 of file class.ilLTIPlatform.php.

Referenced by getLanguage().

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

components/ILIAS/LTIProvider/classes/InternalProvider/class.ilLTIPlatform.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createSecret()

◆ deleteGlobalToolConsumerSettings()

◆ fromConsumerKey()

◆ fromExternalConsumerId()

◆ fromGlobalSettingsAndRefId()

◆ fromPlatformId()

◆ fromRecordId()

◆ getActive()

◆ getDescription()

◆ getEnabled()

◆ getExtConsumerId()

◆ getLanguage()

◆ getPrefix()

◆ getRefId()

◆ getRole()

◆ getSecret()

◆ getTitle()

◆ initialize()

◆ saveGlobalToolConsumerSettings()

◆ saveLTI()

◆ setActive()

◆ setDescription()

◆ setEnabled()

◆ setExtConsumerId()

◆ setLanguage()

◆ setPrefix()

◆ setRefId()

◆ setRole()

◆ setSecret()

◆ setTitle()

Field Documentation

◆ $active

◆ $description

◆ $ext_consumer_id

◆ $id

◆ $key

◆ $prefix

◆ $ref_id

◆ $role

◆ $settings

◆ $title

◆ $user_language