LTI provider for LTI launch. More...

Inheritance diagram for ilLTIToolConsumer:

Collaboration diagram for ilLTIToolConsumer:

Public Member Functions
	setExtConsumerId ($a_id)

	getExtConsumerId ()

	setRefId ($a_ref_id)

	getRefId ()

	getId ()

	setTitle ($title)

	getTitle ()

	setDescription ($description)

	getDescription ()

	setPrefix ($prefix)

	getPrefix ()

	setSecret ($secret)

	getSecret ()

	createSecret ()
	Create a secret. More...

	setLanguage ($lang)

	getLanguage ()

	setActive ($value)

	getActive ()

	setRole ($role_id)

	getRole ()

	setEnabled ($a_status)

	getEnabled ()

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

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

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

Static Public Member Functions
static	fromRecordId ($id, $dataConnector)
	Load the tool consumer from the database by its record ID. More...

static	fromExternalConsumerId ($id, $dataConnector)

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

Protected Attributes
	$ref_id

	$ext_consumer_id = 0

	$title = ''

	$description = ''

	$prefix = ''

	$user_language = ''

	$role = 0

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 13 of file class.ilLTIToolConsumer.php.

Member Function Documentation

◆ createSecret()

ilLTIToolConsumer::createSecret ( )

Create a secret.

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

References setSecret().

     {
         $this->setSecret(\IMSGlobal\LTI\ToolProvider\DataConnector\DataConnector::getRandomString(12));
     }

Here is the call graph for this function:

◆ deleteGlobalToolConsumerSettings()

ilLTIToolConsumer::deleteGlobalToolConsumerSettings ( ilLTIDataConnector $dataConnector )

Delete global tool consumer settings.

Parameters

ilLTIDataConnector $dataConnector

Definition at line 292 of file class.ilLTIToolConsumer.php.

References ilLTIDataConnector\deleteGlobalToolConsumerSettings().

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

Here is the call graph for this function:

◆ fromExternalConsumerId()

static ilLTIToolConsumer::fromExternalConsumerId	(	$id,
		$dataConnector
	)

static

Parameters

type	$id
type	$dataConnector

Definition at line 244 of file class.ilLTIToolConsumer.php.

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

     {
         $toolConsumer = new ilLTIToolConsumer(null, $dataConnector);
         $toolConsumer->initialize();
         $toolConsumer->setExtConsumerId($id);
         if (!$dataConnector->loadGlobalToolConsumerSettings($toolConsumer)) {
             $toolConsumer->initialize();
         }
         return $toolConsumer;
     }

Here is the caller graph for this function:

◆ fromGlobalSettingsAndRefId()

static ilLTIToolConsumer::fromGlobalSettingsAndRefId	(		$a_ext_consumer_id,
			$a_ref_id,
		ilLTIDataConnector	$a_data_connector
	)

static

Load consumer from global settings and ref_id.

Parameters

type	$a_ext_consumer_id
type	$a_ref_id
ilLTIDataConnector	$a_data_connector	ilLTIToolConsumer

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

References ilLTIDataConnector\lookupRecordIdByGlobalSettingsAndRefId().

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

     {
         $toolConsumer = new ilLTIToolConsumer(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) {
             return self::fromRecordId($consumer_pk, $a_data_connector);
         }
         $toolConsumer->initialize();
         return $toolConsumer;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fromRecordId()

static ilLTIToolConsumer::fromRecordId	(	$id,
		$dataConnector
	)

static

Load the tool consumer from the database by its record ID.

Parameters

int	$id	The consumer key record ID
DataConnector	$dataConnector	Database connection object

Returns: object ToolConsumer The tool consumer object

Definition at line 223 of file class.ilLTIToolConsumer.php.

References ilLoggerFactory\getLogger().

Referenced by ilAuthProviderLTI\lookupConsumer().

     {
         $toolConsumer = new ilLTIToolConsumer(null, $dataConnector);
 
         $toolConsumer->initialize();
         $toolConsumer->setRecordId($id);
         if (!$dataConnector->loadToolConsumerILIAS($toolConsumer)) {
             $toolConsumer->initialize();
         }
         $toolConsumer->setRecordId($id);
 
         ilLoggerFactory::getLogger('lti')->info('Loading with record id: ' . $toolConsumer->getRecordId());
 
         return $toolConsumer;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getActive()

ilLTIToolConsumer::getActive ( )

Returns: integer

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

Referenced by ilLTIDataConnector\saveGlobalToolConsumerSettings().

     {
         return $this->active;
     }

Here is the caller graph for this function:

◆ getDescription()

ilLTIToolConsumer::getDescription ( )

Returns: string

Definition at line 108 of file class.ilLTIToolConsumer.php.

References $description.

Referenced by ilLTIDataConnector\saveGlobalToolConsumerSettings().

     {
         return $this->description;
     }

Here is the caller graph for this function:

◆ getEnabled()

ilLTIToolConsumer::getEnabled ( )

Definition at line 208 of file class.ilLTIToolConsumer.php.

     {
         return $this->enabled;
     }

◆ getExtConsumerId()

ilLTIToolConsumer::getExtConsumerId ( )

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

References $ext_consumer_id.

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

     {
         return $this->ext_consumer_id;
     }

Here is the caller graph for this function:

◆ getId()

ilLTIToolConsumer::getId ( )

Returns: integer

Definition at line 75 of file class.ilLTIToolConsumer.php.

     {
         return $this->getRecordId();
     }

◆ getLanguage()

ilLTIToolConsumer::getLanguage ( )

Returns: string

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

References $user_language.

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

     {
         return $this->user_language;
     }

Here is the caller graph for this function:

◆ getPrefix()

ilLTIToolConsumer::getPrefix ( )

Returns: string

Definition at line 124 of file class.ilLTIToolConsumer.php.

References $prefix.

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

     {
         return $this->prefix;
     }

Here is the caller graph for this function:

◆ getRefId()

ilLTIToolConsumer::getRefId ( )

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

References $ref_id.

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

     {
         return $this->ref_id;
     }

Here is the caller graph for this function:

◆ getRole()

ilLTIToolConsumer::getRole ( )

Returns: integer

Definition at line 197 of file class.ilLTIToolConsumer.php.

References $role.

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

     {
         return $this->role;
     }

Here is the caller graph for this function:

◆ getSecret()

ilLTIToolConsumer::getSecret ( )

Returns: string

Definition at line 140 of file class.ilLTIToolConsumer.php.

     {
         return $this->secret;
     }

◆ getTitle()

ilLTIToolConsumer::getTitle ( )

Returns: string

Definition at line 92 of file class.ilLTIToolConsumer.php.

References $title.

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

     {
         return $this->title;
     }

Here is the caller graph for this function:

◆ saveGlobalToolConsumerSettings()

ilLTIToolConsumer::saveGlobalToolConsumerSettings ( ilLTIDataConnector $dataConnector )

Save global consumer settings.

Parameters

ilLTIDataConnector $dataConnector

Definition at line 283 of file class.ilLTIToolConsumer.php.

References ilLTIDataConnector\saveGlobalToolConsumerSettings().

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

Here is the call graph for this function:

◆ saveLTI()

ilLTIToolConsumer::saveLTI ( $dataConnector )

Save the tool consumer to the database with ILIAS extension.

Returns: boolean True if the object was successfully saved

Definition at line 303 of file class.ilLTIToolConsumer.php.

References $ok.

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

◆ setActive()

ilLTIToolConsumer::setActive ( $value )

Parameters

integer $value

Definition at line 173 of file class.ilLTIToolConsumer.php.

Referenced by ilLTIDataConnector\loadGlobalToolConsumerSettings(), and ilLTIDataConnector\loadObjectToolConsumerSettings().

     {
         $this->active = $value;
     }

Here is the caller graph for this function:

◆ setDescription()

ilLTIToolConsumer::setDescription ( $description )

Parameters

string $description

Definition at line 100 of file class.ilLTIToolConsumer.php.

References $description.

Referenced by ilLTIDataConnector\loadGlobalToolConsumerSettings(), and ilLTIDataConnector\loadObjectToolConsumerSettings().

     {
         $this->description = $description;
     }

Here is the caller graph for this function:

◆ setEnabled()

ilLTIToolConsumer::setEnabled ( $a_status )

Definition at line 203 of file class.ilLTIToolConsumer.php.

     {
         $this->enabled = $a_status;
     }

◆ setExtConsumerId()

ilLTIToolConsumer::setExtConsumerId ( $a_id )

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

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

     {
         $this->ext_consumer_id = $a_id;
     }

Here is the caller graph for this function:

◆ setLanguage()

ilLTIToolConsumer::setLanguage ( $lang )

Parameters

string $lang (int?)

Definition at line 157 of file class.ilLTIToolConsumer.php.

References $lang.

Referenced by ilLTIDataConnector\loadGlobalToolConsumerSettings(), and ilLTIDataConnector\loadObjectToolConsumerSettings().

     {
         $this->user_language = $lang;
     }

Here is the caller graph for this function:

◆ setPrefix()

ilLTIToolConsumer::setPrefix ( $prefix )

Parameters

string $prefix

Definition at line 116 of file class.ilLTIToolConsumer.php.

References $prefix.

Referenced by ilLTIDataConnector\loadGlobalToolConsumerSettings(), and ilLTIDataConnector\loadObjectToolConsumerSettings().

     {
         $this->prefix = $prefix;
     }

Here is the caller graph for this function:

◆ setRefId()

ilLTIToolConsumer::setRefId ( $a_ref_id )

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

Referenced by ilLTIDataConnector\loadToolConsumerILIAS().

     {
         $this->ref_id = $a_ref_id;
     }

Here is the caller graph for this function:

◆ setRole()

ilLTIToolConsumer::setRole ( $role_id )

Parameters

integer $role_id

Definition at line 189 of file class.ilLTIToolConsumer.php.

Referenced by ilLTIDataConnector\loadGlobalToolConsumerSettings(), and ilLTIDataConnector\loadObjectToolConsumerSettings().

     {
         $this->role = $role_id;
     }

Here is the caller graph for this function:

◆ setSecret()

ilLTIToolConsumer::setSecret ( $secret )

Parameters

string $secret

Definition at line 132 of file class.ilLTIToolConsumer.php.

Referenced by createSecret().

     {
         $this->secret = $secret;
     }

Here is the caller graph for this function:

◆ setTitle()

ilLTIToolConsumer::setTitle ( $title )

Parameters

string $title

Definition at line 83 of file class.ilLTIToolConsumer.php.

References $title.

Referenced by ilLTIDataConnector\loadGlobalToolConsumerSettings(), and ilLTIDataConnector\loadObjectToolConsumerSettings().

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

Here is the caller graph for this function:

Field Documentation

◆ $description

ilLTIToolConsumer::$description = ''

protected

Definition at line 34 of file class.ilLTIToolConsumer.php.

Referenced by getDescription(), and setDescription().

◆ $ext_consumer_id

ilLTIToolConsumer::$ext_consumer_id = 0

protected

Definition at line 24 of file class.ilLTIToolConsumer.php.

Referenced by getExtConsumerId().

◆ $prefix

ilLTIToolConsumer::$prefix = ''

protected

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

Referenced by getPrefix(), and setPrefix().

◆ $ref_id

ilLTIToolConsumer::$ref_id

protected

Definition at line 18 of file class.ilLTIToolConsumer.php.

Referenced by getRefId().

◆ $role

ilLTIToolConsumer::$role = 0

protected

Definition at line 49 of file class.ilLTIToolConsumer.php.

Referenced by getRole().

◆ $title

ilLTIToolConsumer::$title = ''

protected

Definition at line 29 of file class.ilLTIToolConsumer.php.

Referenced by getTitle(), and setTitle().

◆ $user_language

ilLTIToolConsumer::$user_language = ''

protected

Definition at line 44 of file class.ilLTIToolConsumer.php.

Referenced by getLanguage().

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

Services/LTI/classes/InternalProvider/class.ilLTIToolConsumer.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ createSecret()

◆ deleteGlobalToolConsumerSettings()

◆ fromExternalConsumerId()

◆ fromGlobalSettingsAndRefId()

◆ fromRecordId()

◆ getActive()

◆ getDescription()

◆ getEnabled()

◆ getExtConsumerId()

◆ getId()

◆ getLanguage()

◆ getPrefix()

◆ getRefId()

◆ getRole()

◆ getSecret()

◆ getTitle()

◆ saveGlobalToolConsumerSettings()

◆ saveLTI()

◆ setActive()

◆ setDescription()

◆ setEnabled()

◆ setExtConsumerId()

◆ setLanguage()

◆ setPrefix()

◆ setRefId()

◆ setRole()

◆ setSecret()

◆ setTitle()

Field Documentation

◆ $description

◆ $ext_consumer_id

◆ $prefix

◆ $ref_id

◆ $role

◆ $title

◆ $user_language