ilObjLTIConsumer Class Reference

Inheritance diagram for ilObjLTIConsumer:

Collaboration diagram for ilObjLTIConsumer:

Public Member Functions
	__construct (int $a_id=0, bool $a_reference=true)
	ilObjLTIConsumer constructor. More...
	isActivationLimited ()
	setActivationLimited (bool $activationLimited)
	getActivationStartingTime ()
	setActivationStartingTime (?int $activationStartingTime=null)
	getActivationEndingTime ()
	setActivationEndingTime (?int $activationEndingTime=null)
	getActivationVisibility ()
	setActivationVisibility (bool $activationVisibility)
	getMasteryScore ()
	setMasteryScore (float $mastery_score)
	getMasteryScorePercent ()
	setMasteryScorePercent (float $mastery_score_percent)
	getProviderId ()
	setProviderId (int $providerId)
	initProvider ()
	getProvider ()
	setProvider (ilLTIConsumeProvider $provider)
	isLaunchMethodOwnWin ()
	isLaunchMethodEmbedded ()
	getLaunchMethod ()
	setLaunchMethod (string $launchMethod)
	getCustomLaunchKey ()
	setCustomLaunchKey (string $customLaunchKey)
	getCustomLaunchSecret ()
	setCustomLaunchSecret (string $customLaunchSecret)
	getCustomParams ()
	setCustomParams (string $customParams)
	getLaunchKey ()
	getLaunchSecret ()
	getUseXapi ()
	setUseXapi (bool $use_xapi)
	getCustomActivityId ()
	setCustomActivityId (string $custom_activity_id)
	getActivityId ()
	isStatementsReportEnabled ()
	setStatementsReportEnabled (bool $statementsReportEnabled)
	getCustomParamsArray ()
	load ()
	save ()
	setHighscoreEnabled (bool $a_enabled)
	HIGHSCORE. More...
	getHighscoreEnabled ()
	Gets the setting which determines if the highscore feature is enabled. More...
	setHighscoreAchievedTS (bool $a_achieved_ts)
	Sets if the date and time of the scores achievement should be displayed. More...
	getHighscoreAchievedTS ()
	Returns if date and time of the scores achievement should be displayed. More...
	setHighscorePercentage (bool $a_percentage)
	Sets if the percentages of the scores pass should be shown. More...
	getHighscorePercentage ()
	Gets if the percentage column should be shown. More...
	setHighscoreWTime (bool $a_wtime)
	Sets if the workingtime of the scores should be shown. More...
	getHighscoreWTime ()
	Gets if the column with the workingtime should be shown. More...
	setHighscoreOwnTable (bool $a_own_table)
	Sets if the table with the own ranking should be shown. More...
	getHighscoreOwnTable ()
	Gets if the own rankings table should be shown. More...
	setHighscoreTopTable (bool $a_top_table)
	Sets if the top-rankings table should be shown. More...
	getHighscoreTopTable ()
	Gets, if the top-rankings table should be shown. More...
	setHighscoreTopNum (int $a_top_num)
	Sets the number of entries which are to be shown in the top-rankings table. More...
	getHighscoreTopNum (int $a_retval=10)
	Gets the number of entries which are to be shown in the top-rankings table. More...
	getHighscoreMode ()
	setHighscoreMode (int $mode)
	buildLaunchParameters (ilCmiXapiUser $cmixUser, string $token, string $contextType, string $contextId, string $contextTitle, ?string $returnUrl='')
	buildLaunchParametersLTI13 (ilCmiXapiUser $cmixUser, string $token, string $endpoint, string $clientId, int $deploymentId, string $nonce, string $contextType, string $contextId, string $contextTitle, ?string $returnUrl='')
	isMixedContentType ()
Public Member Functions inherited from ilObject2
	__construct (int $a_id=0, bool $a_reference=true)
	Constructor. More...
	read ()
	create (bool $a_clone_mode=false)
	update ()
	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...
	cloneMetaData (ilObject $target_obj)
	Copy meta data. More...
	cloneObject (int $target_id, int $copy_id=0, bool $omit_tree=false)
Public Member Functions inherited from ilObject
	getObjectProperties ()
	flushObjectProperties ()
	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...
	processAutoRating ()
	read ()
	getId ()
	setId (int $id)
	setRefId (int $ref_id)
	getRefId ()
	getType ()
	setType (string $type)
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...
	getTitle ()
	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...
	setTitle (string $title)
	getDescription ()
	setDescription (string $description)
	getLongDescription ()
	get object long description (stored in object_description) More...
	getImportId ()
	setImportId (string $import_id)
	setOfflineStatus (bool $status)
	getOfflineStatus ()
	supportsOfflineHandling ()
	getOwner ()
	getOwnerName ()
	get full name of object owner More...
	setOwner (int $usr_id)
	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...
	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...
	create ()
	note: title, description and type should be set when this function is called More...
	update ()
	MDUpdateListener (string $element)
	Metadata update listener. More...
	createMetaData ()
	updateMetaData ()
	deleteMetaData ()
	updateOwner ()
	update owner of object in db More...
	putInTree (int $parent_ref_id)
	maybe this method should be in tree object!? More...
	setPermissions (int $parent_ref_id)
	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...
	createReference ()
	creates reference for object More...
	countReferences ()
	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...
	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type. More...
	applyDidacticTemplate (int $tpl_id)
	getXMLZip ()
	getHTMLDirectory ()
	appendCopyInfo (int $target_id, int $copy_id, int $new_obj_id)
	Prepend Copy info if object with same name exists in that container. More...
	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...
	cloneMetaData (ilObject $target_obj)
	Copy meta data. More...
	selfOrParentWithRatingEnabled ()
	getPossibleSubObjects (bool $filter=true)
	get all possible sub objects of this type the object can decide which types of sub objects are possible jut in time overwrite if the decision distinguish from standard model More...

Static Public Member Functions
static	getProviderCustomParamsArray (ilLTIConsumeProvider $provider)
static	buildContentSelectionParameters (ilLTIConsumeProvider $provider, int $refId, string $returnUrl, string $nonce)
static	LTISignJWT (array $parms, string $endpoint, string $oAuthConsumerKey, $typeId=0, string $nonce='')
static	getPrivateKey ()
static	verifyPrivateKey ()
static	getPublicKey ()
static	getJwks ()
static	getIliasHttpPath ()
static	getPlattformId ()
static	getAuthenticationRequestUrl ()
static	getAccessTokenUrl ()
static	getPublicKeysetUrl ()
static	getRegistrationUrl ()
static	getRegistrationStartUrl ()
static	getRegistrationEndUrl ()
static	getOpenidConfigUrl ()
static	getOpenidConfig ()
static	registerClient (array $data, object $tokenObj)
static	getNewClientId ()
static	sendResponseError (int $code, string $message, $log=true)
static	sendResponseJson (array $obj)
static	getInstance (int $a_id=0, bool $a_reference=true)
static	getRawData ()
static	getTokenObject (string $token)
static	verifyToken ()
static	getLogger ()
Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId (string $import_id)
	Get (latest) object id for an import id. More...
static	_lookupImportId (int $obj_id)
static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...
static	_getIdForImportId (string $import_id)
static	_getAllReferences (int $id)
	get all reference ids for object ID More...
static	_lookupTitle (int $obj_id)
static	lookupOfflineStatus (int $obj_id)
	Lookup offline status using objectDataCache. More...
static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...
static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)
static	_lookupDescription (int $obj_id)
static	_lookupLastUpdate (int $obj_id, bool $formatted=false)
static	_getLastUpdateOfObjects (array $obj_ids)
static	_lookupObjId (int $ref_id)
static	_setDeletedDate (int $ref_id, int $deleted_by)
static	setDeletedDates (array $ref_ids, int $user_id)
static	_resetDeletedDate (int $ref_id)
static	_lookupDeletedDate (int $ref_id)
static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...
static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...
static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...
static	_lookupType (int $id, bool $reference=false)
static	_isInTrash (int $ref_id)
static	_hasUntrashedReference (int $obj_id)
	checks whether an object has at least one reference that is not in trash More...
static	_lookupObjectId (int $ref_id)
static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...
static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...
static	_getObjectsByType (string $obj_type="", ?int $owner=null)
static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...
static	getIconForType (string $type)
static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...
static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...
static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...
static	getLongDescriptions (array $obj_ids)
static	getAllOwnedRepositoryObjects (int $user_id)
static	fixMissingTitles ($type, array &$obj_title_map)
	Try to fix missing object titles. More...
static	_lookupCreationDate (int $obj_id)
static	_getObjectTypeIdByTitle (string $type, ?\ilDBInterface $ilDB=null)

Data Fields
const	DB_TABLE_NAME = 'lti_consumer_settings'
const	LAUNCH_METHOD_OWN_WIN = 'ownWin'
const	LAUNCH_METHOD_NEW_WIN = 'newWin'
const	LAUNCH_METHOD_EMBEDDED = 'embedded'
const	HIGHSCORE_SHOW_ALL_TABLES = 1
const	HIGHSCORE_SHOW_TOP_TABLE = 2
const	HIGHSCORE_SHOW_OWN_TABLE = 3
const	LTI_JWT_CLAIM_PREFIX = 'https://purl.imsglobal.org/spec/lti'
const	LTI_1_3_KID = 'lti_1_3_kid'
const	LTI_1_3_PRIVATE_KEY = 'lti_1_3_privatekey'
const	ERROR_OPEN_SSL_CONF = 'error openssl config invalid'
const	OPENSSL_KEYTYPE_RSA = ''
const	REG_TOKEN_OP_NEW_REG = 'reg'
const	REG_TOKEN_OP_UPDATE_REG = 'reg-update'
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
const	DESC_LENGTH = 128
const	LONG_DESC_LENGTH = 4000
const	TABLE_OBJECT_DATA = "object_data"
array	$objectList
string	$untranslatedTitle

Protected Member Functions
	initType ()
	doRead ()
	doUpdate ()
	loadRepositoryActivationSettings ()
	saveRepositoryActivationSettings ()
	dbTableName ()
	doCloneObject (ilObject2 $new_obj, int $a_target_id, ?int $a_copy_id=null)
Protected Member Functions inherited from ilObject2
	initType ()
	doRead ()
	doCreate (bool $clone_mode=false)
	beforeCreate ()
	If overwritten this method should return true, there is currently no "abort" handling for cases where "false" is returned. More...
	doUpdate ()
	beforeUpdate ()
	doDelete ()
	beforeDelete ()
	doCloneObject (ilObject2 $new_obj, int $a_target_id, ?int $a_copy_id=null)
	beforeCloneObject ()
Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)
	beforeMDUpdateListener (string $a_element)
	doCreateMetaData ()
	beforeCreateMetaData ()
	doUpdateMetaData ()
	beforeUpdateMetaData ()
	doDeleteMetaData ()
	beforeDeleteMetaData ()
	handleAutoRating ()
	hasAutoRating ()

Protected Attributes
bool	$activationLimited = false
	repository object activation settings (handled by ilObject) More...
int	$activationStartingTime = null
int	$activationEndingTime = null
bool	$activationVisibility = null
int	$providerId = 0
ilLTIConsumeProvider	$provider = null
bool	$use_xapi = false
string	$custom_activity_id = ''
bool	$statementsReportEnabled = false
float	$mastery_score = 0.5
string	$launchMethod = self::LAUNCH_METHOD_NEW_WIN
string	$customLaunchKey = ''
string	$customLaunchSecret = ''
string	$customParams = ''
int	$ref_id = 0
bool	$_highscore_enabled = false
int	$anonymity = 0
bool	$_highscore_achieved_ts = true
bool	$_highscore_percentage = true
bool	$_highscore_wtime = true
bool	$_highscore_own_table = true
bool	$_highscore_top_table = true
int	$_highscore_top_num = 10
Protected Attributes inherited from ilObject
ilLogger	$obj_log
ILIAS	$ilias
ilObjectDefinition	$obj_definition
ilDBInterface	$db
ilLogger	$log
ilErrorHandling	$error
ilTree	$tree
ilAppEventHandler	$app_event_handler
ilRbacAdmin	$rbac_admin
ilRbacReview	$rbac_review
ilObjUser	$user
ilLanguage	$lng
LOMServices	$lom_services
bool	$call_by_reference
int	$max_title = self::TITLE_LENGTH
int	$max_desc = self::DESC_LENGTH
bool	$add_dots = true
int	$ref_id = null
string	$type = ""
string	$title = ""
string	$desc = ""
string	$long_desc = ""
int	$owner = 0
string	$create_date = ""
string	$last_update = ""
string	$import_id = ""
bool	$register = false

Private Member Functions
	determineLTIRole (int $a_user_id, int $a_ref_id, ilRbacReview $rbac_review_instance)

Detailed Description

Definition at line 35 of file class.ilObjLTIConsumer.php.

Constructor & Destructor Documentation

__construct()

ilObjLTIConsumer::__construct	(	int	$a_id = 0,
		bool	$a_reference = true
	)

ilObjLTIConsumer constructor.

Reimplemented from ilObject2.

Definition at line 104 of file class.ilObjLTIConsumer.php.

    {
        parent::__construct($a_id, $a_reference);
    }

References ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

buildContentSelectionParameters()

static ilObjLTIConsumer::buildContentSelectionParameters ( ilLTIConsumeProvider  $provider, int  $refId, string  $returnUrl, string  $nonce  )

static

Exceptions

ilWACException

Definition at line 941 of file class.ilObjLTIConsumer.php.

     : ?array {
        global $DIC;
 
        $clientId = $provider->getClientId();
        $deploymentId = $provider->getId();
        $ilLTIConsumerLaunch = new ilLTIConsumerLaunch($refId);
        $context = $ilLTIConsumerLaunch->getContext();
        $contextType = $ilLTIConsumerLaunch::getLTIContextType($context["type"]);
        $contextId = $context["id"];
        $contextTitle = $context["title"];
 
        $roles = "Instructor";
        $usrImage = '';
        if ($provider->getIncludeUserPicture()) {
            $usrImage = self::getIliasHttpPath() . "/" . $DIC->user()->getPersonalPicturePath("small");
        }
        $documentTarget = "window";
        if ($provider->getLaunchMethod() == self::LAUNCH_METHOD_EMBEDDED) {
            $documentTarget = "iframe";
        }
        $nameGiven = '-';
        $nameFamily = '-';
        $nameFull = '-';
        switch ($provider->getPrivacyName()) {
            case ilLTIConsumeProvider::PRIVACY_NAME_FIRSTNAME:
                $nameGiven = $DIC->user()->getFirstname();
                $nameFull = $DIC->user()->getFirstname();
                break;
            case ilLTIConsumeProvider::PRIVACY_NAME_LASTNAME:
                $usrName = $DIC->user()->getUTitle() ? $DIC->user()->getUTitle() . ' ' : '';
                $usrName .= $DIC->user()->getLastname();
                $nameFamily = $usrName;
                $nameFull = $usrName;
                break;
            case ilLTIConsumeProvider::PRIVACY_NAME_FULLNAME:
                $nameGiven = $DIC->user()->getFirstname();
                $nameFamily = $DIC->user()->getLastname();
                $nameFull = $DIC->user()->getFullname();
                break;
        }
 
        $userIdLTI = ilCmiXapiUser::getIdentAsId($provider->getPrivacyIdent(), $DIC->user());
        $emailPrimary = ilCmiXapiUser::getIdent($provider->getPrivacyIdent(), $DIC->user());
        $toolConsumerInstanceGuid = CLIENT_ID . ".";
        $parseIliasUrl = parse_url(self::getIliasHttpPath());
        if (array_key_exists("path", $parseIliasUrl)) {
            $toolConsumerInstanceGuid .= implode(".", array_reverse(explode("/", $parseIliasUrl["path"])));
        }
        $toolConsumerInstanceGuid .= $parseIliasUrl["host"];
 
        $content_select_vars = [
            "lti_message_type" => "ContentItemSelectionRequest",
            "lti_version" => "1.3.0",
            "user_id" => (string) $userIdLTI,
            "user_image" => $usrImage,
            "roles" => $roles,
            "lis_person_name_given" => $nameGiven,
            "lis_person_name_family" => $nameFamily,
            "lis_person_name_full" => $nameFull,
            "lis_person_contact_email_primary" => $emailPrimary,
            "context_id" => (string) $contextId,
            "context_type" => $contextType,
            "context_title" => $contextTitle,
            "context_label" => $contextType . " " . $contextId,
            "launch_presentation_locale" => $DIC->language()->getLangKey(),
            "launch_presentation_document_target" => $documentTarget,
            "launch_presentation_width" => "",
            //recommended
            "launch_presentation_height" => "",
            //recommended
            "tool_consumer_instance_guid" => $toolConsumerInstanceGuid,
            "tool_consumer_instance_name" => $DIC->settings()->get("short_inst_name") ? $DIC->settings()->get(
                "short_inst_name"
            ) : CLIENT_ID,
            "tool_consumer_instance_description" => ilObjSystemFolder::_getHeaderTitle(),
            "tool_consumer_instance_url" => ilLink::_getLink(ROOT_FOLDER_ID, "root"),
            //ToDo? "https://vb52p70.example.com/release_5-3/goto.php?target=root_1&client_id=inno",
            "tool_consumer_instance_contact_email" => $DIC->settings()->get("admin_email"),
            "tool_consumer_info_product_family_code" => "ilias",
            "tool_consumer_info_version" => ILIAS_VERSION,
            "content_item_return_url" => $returnUrl,
            "accept_types" => "ltiResourceLink",
            "accept_presentation_document_targets" => "iframe,window,embed",
            "accept_multiple" => true,
            "auto_create" => true,
        ];
        $provider_custom_params = self::getProviderCustomParamsArray($provider);
        foreach ($provider_custom_params as $key => $value) {
            $content_select_vars['custom_' . $key] = $value;
        }
 
        if (!empty(self::verifyPrivateKey())) {
            $DIC->ui()->mainTemplate()->setOnScreenMessage('failure', 'ERROR_OPEN_SSL_CONF', true);
            return null;
        }
        return self::LTISignJWT($content_select_vars, '', $clientId, $deploymentId, $nonce);
    }

Referenced by ilObjLTIConsumerGUI\contentSelectionRequest().

Here is the caller graph for this function:

buildLaunchParameters()

ilObjLTIConsumer::buildLaunchParameters	(	ilCmiXapiUser	$cmixUser,
		string	$token,
		string	$contextType,
		string	$contextId,
		string	$contextTitle,
		?string	$returnUrl = ''
	)

Exceptions

ilWACException

Definition at line 661 of file class.ilObjLTIConsumer.php.

     : array {
        global $DIC;
        /* @var \ILIAS\DI\Container $DIC */
        $DIC->user()->setExternalAccount($cmixUser->getUsrIdent());
 
        $roles = $DIC->access()->checkAccess('write', '', $this->getRefId()) ? "Instructor" : "Learner";
        //todo if object is in course or group, roles would have to be taken from there s. Mantis 35435 - if necessary Jour Fixe topic
        //$roles = "Administrator";
 
        if ($this->getProvider()->getAlwaysLearner() == true) {
            $roles = "Learner";
        }
 
        $resource_link_id = $this->getRefId();
        if ($this->getProvider()->getUseProviderId() == true) {
            $resource_link_id = 'p' . $this->getProvider()->getId();
        }
 
        $usrImage = '';
        if ($this->getProvider()->getIncludeUserPicture()) {
            $usrImage = self::getIliasHttpPath() . "/" . $DIC->user()->getPersonalPicturePath("small");
        }
 
        $documentTarget = "window";
        if ($this->getLaunchMethod() == self::LAUNCH_METHOD_EMBEDDED) {
            $documentTarget = "iframe";
        }
 
        $nameGiven = '-';
        $nameFamily = '-';
        $nameFull = '-';
        switch ($this->getProvider()->getPrivacyName()) {
            case ilLTIConsumeProvider::PRIVACY_NAME_FIRSTNAME:
                $nameGiven = $DIC->user()->getFirstname();
                $nameFull = $DIC->user()->getFirstname();
                break;
            case ilLTIConsumeProvider::PRIVACY_NAME_LASTNAME:
                $usrName = $DIC->user()->getUTitle() ? $DIC->user()->getUTitle() . ' ' : '';
                $usrName .= $DIC->user()->getLastname();
                $nameFamily = $usrName;
                $nameFull = $usrName;
                break;
            case ilLTIConsumeProvider::PRIVACY_NAME_FULLNAME:
                $nameGiven = $DIC->user()->getFirstname();
                $nameFamily = $DIC->user()->getLastname();
                $nameFull = $DIC->user()->getFullname();
                break;
        }
 
        $userIdLTI = ilCmiXapiUser::getIdentAsId($this->getProvider()->getPrivacyIdent(), $DIC->user());
 
        $emailPrimary = $cmixUser->getUsrIdent();
        if ($this->getProvider()->getPrivacyIdent() == ilObjCmiXapi::PRIVACY_IDENT_IL_UUID_RANDOM) {
            $userIdLTI = strstr($emailPrimary, '@' . ilCmiXapiUser::getIliasUuid(), true);
        }
 
        ilLTIConsumerResult::getByKeys($this->getId(), $DIC->user()->getId(), true);
 
        //ToDo: Check!
        $provider_custom_params = self::getProviderCustomParamsArray($this->getProvider());
        $custom_params = $this->getCustomParamsArray();
        $merged_params = array_merge($provider_custom_params, $custom_params);
 
        $toolConsumerInstanceGuid = CLIENT_ID . ".";
        $parseIliasUrl = parse_url(self::getIliasHttpPath());
        if (array_key_exists("path", $parseIliasUrl)) {
            $toolConsumerInstanceGuid .= implode(".", array_reverse(explode("/", $parseIliasUrl["path"])));
        }
        $toolConsumerInstanceGuid .= $parseIliasUrl["host"];
 
        $launch_vars = [
            "lti_message_type" => "basic-lti-launch-request",
            "lti_version" => "LTI-1p0",
            "resource_link_id" => $resource_link_id,
            "resource_link_title" => $this->getTitle(),
            "resource_link_description" => $this->getDescription(),
            "user_id" => $userIdLTI,
            "user_image" => $usrImage,
            "roles" => $roles,
            "lis_person_name_given" => $nameGiven,
            "lis_person_name_family" => $nameFamily,
            "lis_person_name_full" => $nameFull,
            "lis_person_contact_email_primary" => $emailPrimary,
            "context_id" => $contextId,
            "context_type" => $contextType,
            "context_title" => $contextTitle,
            "context_label" => $contextType . " " . $contextId,
            "launch_presentation_locale" => $this->lng->getLangKey(),
            "launch_presentation_document_target" => $documentTarget,
            //"launch_presentation_width" => "",
            //recommended
            //"launch_presentation_height" => "",
            //recommended
            "launch_presentation_return_url" => $returnUrl,
            "tool_consumer_instance_guid" => $toolConsumerInstanceGuid,
            "tool_consumer_instance_name" => $DIC->settings()->get("short_inst_name") ? $DIC->settings()->get(
                "short_inst_name"
            ) : CLIENT_ID,
            "tool_consumer_instance_description" => ilObjSystemFolder::_getHeaderTitle(),
            "tool_consumer_instance_url" => ilLink::_getLink(ROOT_FOLDER_ID, "root"),
            //ToDo? "https://vb52p70.example.com/release_5-3/goto.php?target=root_1&client_id=inno",
            "tool_consumer_instance_contact_email" => $DIC->settings()->get("admin_email"),
            "launch_presentation_css_url" => "",
            "tool_consumer_info_product_family_code" => "ilias",
            "tool_consumer_info_version" => ILIAS_VERSION,
            "lis_result_sourcedid" => $token,
            "lis_outcome_service_url" => self::getIliasHttpPath(
            ) . "/ltiresult.php?client_id=" . CLIENT_ID,
            "role_scope_mentor" => ""
        ];
 
        $OAuthParams = [
            "url" => $this->getProvider()->getProviderUrl(),
            "key" => $this->getLaunchKey(),
            "secret" => $this->getLaunchSecret(),
            "callback" => "about:blank",
            "http_method" => "POST",
            "sign_method" => "HMAC_SHA1",
            "token" => null,
            "data" => ($launch_vars + $merged_params)
        ];
 
        return ilLTIConsumerLaunch::signOAuth($OAuthParams);
    }

buildLaunchParametersLTI13()

ilObjLTIConsumer::buildLaunchParametersLTI13	(	ilCmiXapiUser	$cmixUser,
		string	$token,
		string	$endpoint,
		string	$clientId,
		int	$deploymentId,
		string	$nonce,
		string	$contextType,
		string	$contextId,
		string	$contextTitle,
		?string	$returnUrl = ''
	)

Exceptions

ilWACException

Definition at line 797 of file class.ilObjLTIConsumer.php.

     : ?array {
        global $DIC;
        /* @var \ILIAS\DI\Container $DIC */
        $roles = $this->determineLTIRole($DIC->user()->getId(), $this->getRefId(), $DIC->rbac()->review());
 
        if ($this->getProvider()->getAlwaysLearner() == true) {
            $roles = 'Learner';
        }
 
 
 
        $resource_link_id = $this->getRefId();
        if ($this->getProvider()->getUseProviderId() == true) {
            $resource_link_id = 'p' . $this->getProvider()->getId();
        }
 
        $usrImage = '';
        if ($this->getProvider()->getIncludeUserPicture()) {
            $usrImage = self::getIliasHttpPath() . "/" . $DIC->user()->getPersonalPicturePath("small");
        }
 
        $documentTarget = "window";
        if ($this->getLaunchMethod() == self::LAUNCH_METHOD_EMBEDDED) {
            $documentTarget = "iframe";
        }
 
        $nameGiven = '-';
        $nameFamily = '-';
        $nameFull = '-';
        switch ($this->getProvider()->getPrivacyName()) {
            case ilLTIConsumeProvider::PRIVACY_NAME_FIRSTNAME:
                $nameGiven = $DIC->user()->getFirstname();
                $nameFull = $DIC->user()->getFirstname();
                break;
            case ilLTIConsumeProvider::PRIVACY_NAME_LASTNAME:
                $usrName = $DIC->user()->getUTitle() ? $DIC->user()->getUTitle() . ' ' : '';
                $usrName .= $DIC->user()->getLastname();
                $nameFamily = $usrName;
                $nameFull = $usrName;
                break;
            case ilLTIConsumeProvider::PRIVACY_NAME_FULLNAME:
                $nameGiven = $DIC->user()->getFirstname();
                $nameFamily = $DIC->user()->getLastname();
                $nameFull = $DIC->user()->getFullname();
                break;
        }
 
        $userIdLTI = ilCmiXapiUser::getIdentAsId($this->getProvider()->getPrivacyIdent(), $DIC->user());
 
        $emailPrimary = $cmixUser->getUsrIdent();
 
        ilLTIConsumerResult::getByKeys($this->getId(), $DIC->user()->getId(), true);
 
        $toolConsumerInstanceGuid = CLIENT_ID . ".";
        $parseIliasUrl = parse_url(self::getIliasHttpPath());
        if (array_key_exists("path", $parseIliasUrl)) {
            $toolConsumerInstanceGuid .= implode(".", array_reverse(explode("/", $parseIliasUrl["path"])));
        }
        $toolConsumerInstanceGuid .= $parseIliasUrl["host"];
        $launch_vars = [
            "lti_message_type" => "basic-lti-launch-request",
            "lti_version" => "1.3.0",
            "resource_link_id" => (string) $resource_link_id,
            "resource_link_title" => $this->getTitle(),
            "resource_link_description" => $this->getDescription(),
            "user_id" => (string) $userIdLTI,
            "user_image" => $usrImage,
            "roles" => $roles,
            "lis_person_name_given" => $nameGiven,
            "lis_person_name_family" => $nameFamily,
            "lis_person_name_full" => $nameFull,
            "lis_person_contact_email_primary" => $emailPrimary,
            "context_id" => $contextId,
            "context_type" => $contextType,
            "context_title" => $contextTitle,
            "context_label" => $contextType . " " . $contextId,
            "launch_presentation_locale" => $this->lng->getLangKey(),
            "launch_presentation_document_target" => $documentTarget,
            //"launch_presentation_width" => "",
            //recommended
            //"launch_presentation_height" => "",
            //recommended
            "launch_presentation_return_url" => $returnUrl,
            "tool_consumer_instance_guid" => $toolConsumerInstanceGuid,
            "tool_consumer_instance_name" => $DIC->settings()->get("short_inst_name") ? $DIC->settings()->get(
                "short_inst_name"
            ) : CLIENT_ID,
            "tool_consumer_instance_description" => ilObjSystemFolder::_getHeaderTitle(),
            "tool_consumer_instance_url" => ilLink::_getLink(ROOT_FOLDER_ID, "root"),
            //ToDo? "https://vb52p70.example.com/release_5-3/goto.php?target=root_1&client_id=inno",
            "tool_consumer_instance_contact_email" => $DIC->settings()->get("admin_email"),
            "launch_presentation_css_url" => "",
            "tool_consumer_info_product_family_code" => "ilias",
            "tool_consumer_info_version" => ILIAS_VERSION,
            "lis_result_sourcedid" => $token,
            "lis_outcome_service_url" => self::getIliasHttpPath(
            ) . "/ltiresult.php?client_id=" . CLIENT_ID,
            "role_scope_mentor" => ""
        ];
 
        $provider_custom_params = self::getProviderCustomParamsArray($this->getProvider());
        $custom_params = $this->getCustomParamsArray();
        $merged_params = array_merge($provider_custom_params, $custom_params);
        foreach ($merged_params as $key => $value) {
            $launch_vars['custom_' . $key] = $value;
        }
 
        if ($this->getProvider()->isGradeSynchronization()) {
            $gradeservice = new ilLTIConsumerGradeService();
            $launch_vars['custom_lineitem_url'] = self::getIliasHttpPath(
            ) . "/ltiservices.php/gradeservice/" . $contextId . "/lineitems/" . $this->id . "/lineitem";
 
            // ! Moodle as tool provider requires a custom_lineitems_url even though this should be optional in launch request, especially if only posting score scope is permitted by platform
            // http://www.imsglobal.org/spec/lti-ags/v2p0#example-link-has-a-single-line-item-tool-can-only-post-score
            $launch_vars['custom_lineitems_url'] = self::getIliasHttpPath(
            ) . "/ltiservices.php/gradeservice/" . $contextId . "/linetitems/";
 
            $launch_vars['custom_ags_scopes'] = implode(",", $gradeservice->getPermittedScopes());
        }
 
        if (!empty(self::verifyPrivateKey())) {
            $DIC->ui()->mainTemplate()->setOnScreenMessage('failure', 'ERROR_OPEN_SSL_CONF', true);
            return null;
        }
        return self::LTISignJWT($launch_vars, $endpoint, $clientId, $deploymentId, $nonce);
    }

dbTableName()

ilObjLTIConsumer::dbTableName ( )

protected

Definition at line 472 of file class.ilObjLTIConsumer.php.

                                    : string
    {
        return self::DB_TABLE_NAME;
    }

References DB_TABLE_NAME.

Referenced by save().

Here is the caller graph for this function:

determineLTIRole()

ilObjLTIConsumer::determineLTIRole ( int  $a_user_id, int  $a_ref_id, ilRbacReview  $rbac_review_instance  )

private

Definition at line 1470 of file class.ilObjLTIConsumer.php.

                                                                                                        : string
    {
        global $DIC;
 
        $global_roles = $rbac_review_instance->assignedGlobalRoles($a_user_id);
        if (in_array(SYSTEM_ROLE_ID, $global_roles)) {
            return 'Administrator';
        }
 
        $user_assigned_roles = $rbac_review_instance->assignedRoles($a_user_id);
        $parent_roles_data = $rbac_review_instance->getParentRoleIds($a_ref_id, true);
        $roles_in_path_ids = array_keys($parent_roles_data);
        $effective_roles_in_context = array_intersect($user_assigned_roles, $roles_in_path_ids);
 
        if (!empty($effective_roles_in_context)) {
            $parent_ref_id = $DIC->repositoryTree()->getParentId($a_ref_id);
            $context_obj_type = ilObject::_lookupType($parent_ref_id, true);
 
            $instructor_base_titles = [
                'il_' . $context_obj_type . '_admin',
                'il_' . $context_obj_type . '_tutor'
            ];
 
            foreach ($effective_roles_in_context as $role_id) {
                $role_title = ilObject::_lookupTitle($role_id);
 
                foreach ($instructor_base_titles as $base_title) {
                    if (str_starts_with((string) $role_title, $base_title)) {
                        return 'Instructor';
                    }
                }
            }
        }
 
        return 'Learner';
    }

References $DIC, ilObject\_lookupTitle(), ilObject\_lookupType(), ilRbacReview\assignedGlobalRoles(), ilRbacReview\assignedRoles(), ilRbacReview\getParentRoleIds(), and SYSTEM_ROLE_ID.

Here is the call graph for this function:

doCloneObject()

ilObjLTIConsumer::doCloneObject ( ilObject2  $new_obj, int  $a_target_id, ?int  $a_copy_id = null  )

protected

Reimplemented from ilObject2.

Definition at line 1436 of file class.ilObjLTIConsumer.php.

                                                                                                  : void
    {
        // LTI specific properties
        $new_obj->setProviderId($this->getProviderId());
        $new_obj->setLaunchMethod($this->getLaunchMethod());
        $new_obj->setCustomLaunchKey($this->getCustomLaunchKey());
        $new_obj->setCustomLaunchSecret($this->getCustomLaunchSecret());
        $new_obj->setCustomParams($this->getCustomParams());
        $new_obj->setUseXapi($this->getUseXapi());
        $new_obj->setCustomActivityId($this->getCustomActivityId());
        $new_obj->setStatementsReportEnabled($this->isStatementsReportEnabled());
        $new_obj->setMasteryScore($this->getMasteryScore());
 
        // Highscore configuration
        $new_obj->setHighscoreEnabled($this->getHighscoreEnabled());
        $new_obj->setHighscoreAchievedTS($this->getHighscoreAchievedTS());
        $new_obj->setHighscorePercentage($this->getHighscorePercentage());
        $new_obj->setHighscoreWTime($this->getHighscoreWTime());
        $new_obj->setHighscoreOwnTable($this->getHighscoreOwnTable());
        $new_obj->setHighscoreTopTable($this->getHighscoreTopTable());
        $new_obj->setHighscoreTopNum($this->getHighscoreTopNum());
 
        // Activation settings
        $new_obj->setActivationLimited($this->isActivationLimited());
        $new_obj->setActivationStartingTime($this->getActivationStartingTime());
        $new_obj->setActivationEndingTime($this->getActivationEndingTime());
 
        if ($this->isActivationLimited() && $this->getActivationVisibility() !== null) {
            $new_obj->setActivationVisibility($this->getActivationVisibility());
        }
 
        $new_obj->save();
    }

doRead()

ilObjLTIConsumer::doRead ( )

protected

Reimplemented from ilObject2.

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

                               : void
    {
        $this->load();
    }

References load().

Here is the call graph for this function:

doUpdate()

ilObjLTIConsumer::doUpdate ( )

protected

Reimplemented from ilObject2.

Definition at line 394 of file class.ilObjLTIConsumer.php.

                                 : void
    {
        $this->save();
    }

References save().

Here is the call graph for this function:

getAccessTokenUrl()

static ilObjLTIConsumer::getAccessTokenUrl ( )

static

Definition at line 1249 of file class.ilObjLTIConsumer.php.

                                              : string
    {
        return self::getIliasHttpPath() . "/ltitoken.php";
    }

Referenced by ilLTIConsumeProviderFormGUI\initForm(), and ilLTIConsumeProviderFormGUI\initToolConfigForm().

Here is the caller graph for this function:

getActivationEndingTime()

ilObjLTIConsumer::getActivationEndingTime

(

)

Definition at line 134 of file class.ilObjLTIConsumer.php.

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

References $activationEndingTime.

Referenced by saveRepositoryActivationSettings().

Here is the caller graph for this function:

getActivationStartingTime()

ilObjLTIConsumer::getActivationStartingTime

(

)

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

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

References $activationStartingTime.

Referenced by saveRepositoryActivationSettings().

Here is the caller graph for this function:

getActivationVisibility()

ilObjLTIConsumer::getActivationVisibility

(

)

Definition at line 144 of file class.ilObjLTIConsumer.php.

                                             : ?bool
    {
        return $this->activationVisibility;
    }

References $activationVisibility.

Referenced by saveRepositoryActivationSettings().

Here is the caller graph for this function:

getActivityId()

ilObjLTIConsumer::getActivityId

(

)

Definition at line 287 of file class.ilObjLTIConsumer.php.

                                   : string
    {
        if (strlen($this->getProvider()->getXapiActivityId())) {
            return $this->getProvider()->getXapiActivityId();
        }
 
        return $this->custom_activity_id;
    }

References $custom_activity_id, and getProvider().

Here is the call graph for this function:

getAuthenticationRequestUrl()

static ilObjLTIConsumer::getAuthenticationRequestUrl ( )

static

Definition at line 1244 of file class.ilObjLTIConsumer.php.

                                                        : string
    {
        return self::getIliasHttpPath() . "/ltiauth.php";
    }

Referenced by ilLTIConsumeProviderFormGUI\initForm(), and ilLTIConsumeProviderFormGUI\initToolConfigForm().

Here is the caller graph for this function:

getCustomActivityId()

ilObjLTIConsumer::getCustomActivityId

(

)

Definition at line 277 of file class.ilObjLTIConsumer.php.

                                         : string
    {
        return $this->custom_activity_id;
    }

References $custom_activity_id.

Referenced by save().

Here is the caller graph for this function:

getCustomLaunchKey()

ilObjLTIConsumer::getCustomLaunchKey

(

)

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

                                        : string
    {
        return $this->customLaunchKey;
    }

References $customLaunchKey.

Referenced by getLaunchKey(), and save().

Here is the caller graph for this function:

getCustomLaunchSecret()

ilObjLTIConsumer::getCustomLaunchSecret

(

)

Definition at line 229 of file class.ilObjLTIConsumer.php.

                                           : string
    {
        return $this->customLaunchSecret;
    }

References $customLaunchSecret.

Referenced by getLaunchSecret(), and save().

Here is the caller graph for this function:

getCustomParams()

ilObjLTIConsumer::getCustomParams

(

)

Definition at line 239 of file class.ilObjLTIConsumer.php.

                                     : string
    {
        return $this->customParams;
    }

References $customParams.

Referenced by getCustomParamsArray(), and save().

Here is the caller graph for this function:

getCustomParamsArray()

ilObjLTIConsumer::getCustomParamsArray

(

)

Returns

string[]

Definition at line 309 of file class.ilObjLTIConsumer.php.

                                          : array
    {
        $paramsAsArray = [];
 
        $params = $this->getCustomParams();
        // allows   foo=bar;foo2=baz2; foo3=baz3
        $params = preg_split('/; ?/', $params);
 
        foreach ($params as $param) {
            $param = explode('=', $param);
            // empty field, duplicate/leading/trailing semicolon?
            if ($param[0] != '') {
                $value = isset($param[1]) ? $param[1] : '';
                $paramsAsArray[$param[0]] = $value;
            }
        }
 
        return $paramsAsArray;
    }

References $param, $params, and getCustomParams().

Here is the call graph for this function:

getHighscoreAchievedTS()

ilObjLTIConsumer::getHighscoreAchievedTS

(

)

Returns if date and time of the scores achievement should be displayed.

Returns

bool True, if column should be shown.

Definition at line 511 of file class.ilObjLTIConsumer.php.

                                            : bool
    {
        return $this->_highscore_achieved_ts;
    }

References $_highscore_achieved_ts.

Referenced by save().

Here is the caller graph for this function:

getHighscoreEnabled()

ilObjLTIConsumer::getHighscoreEnabled

(

)

Gets the setting which determines if the highscore feature is enabled.

Returns

bool True, if highscore is enabled.

Definition at line 493 of file class.ilObjLTIConsumer.php.

                                         : bool
    {
        return $this->_highscore_enabled;
    }

References $_highscore_enabled.

Referenced by ilLTIConsumerSettingsFormGUI\initObject(), and save().

Here is the caller graph for this function:

getHighscoreMode()

ilObjLTIConsumer::getHighscoreMode

(

)

Definition at line 619 of file class.ilObjLTIConsumer.php.

                                      : int
    {
        switch (true) {
            case $this->getHighscoreOwnTable() && $this->getHighscoreTopTable():
                return self::HIGHSCORE_SHOW_ALL_TABLES;
 
            case $this->getHighscoreTopTable():
                return self::HIGHSCORE_SHOW_TOP_TABLE;
 
            case $this->getHighscoreOwnTable():
            default:
                return self::HIGHSCORE_SHOW_OWN_TABLE;
        }
    }

References getHighscoreOwnTable(), getHighscoreTopTable(), HIGHSCORE_SHOW_ALL_TABLES, HIGHSCORE_SHOW_OWN_TABLE, and HIGHSCORE_SHOW_TOP_TABLE.

Here is the call graph for this function:

getHighscoreOwnTable()

ilObjLTIConsumer::getHighscoreOwnTable

(

)

Gets if the own rankings table should be shown.

Returns

bool True, if the own rankings table should be shown.

Definition at line 567 of file class.ilObjLTIConsumer.php.

                                          : bool
    {
        return $this->_highscore_own_table;
    }

References $_highscore_own_table.

Referenced by getHighscoreMode(), and save().

Here is the caller graph for this function:

getHighscorePercentage()

ilObjLTIConsumer::getHighscorePercentage

(

)

Gets if the percentage column should be shown.

Returns

bool True, if percentage column should be shown.

Definition at line 529 of file class.ilObjLTIConsumer.php.

                                            : bool
    {
        return $this->_highscore_percentage;
    }

References $_highscore_percentage.

Referenced by save().

Here is the caller graph for this function:

getHighscoreTopNum()

ilObjLTIConsumer::getHighscoreTopNum

(

int

$a_retval = 10

)

Gets the number of entries which are to be shown in the top-rankings table.

Default: 10 entries

Parameters

integer

$a_retval

Optional return value if nothing is set, defaults to 10.

Returns

integer Number of entries to be shown in the top-rankings table.

Definition at line 609 of file class.ilObjLTIConsumer.php.

                                                          : int
    {
        $retval = $a_retval;
        if ($this->_highscore_top_num != 0) {
            $retval = $this->_highscore_top_num;
        }
 
        return $retval;
    }

References $_highscore_top_num.

Referenced by save().

Here is the caller graph for this function:

getHighscoreTopTable()

ilObjLTIConsumer::getHighscoreTopTable

(

)

Gets, if the top-rankings table should be shown.

Returns

bool True, if top-rankings table should be shown.

Definition at line 585 of file class.ilObjLTIConsumer.php.

                                          : bool
    {
        return $this->_highscore_top_table;
    }

References $_highscore_top_table.

Referenced by getHighscoreMode(), and save().

Here is the caller graph for this function:

getHighscoreWTime()

ilObjLTIConsumer::getHighscoreWTime

(

)

Gets if the column with the workingtime should be shown.

Returns

bool True, if the workingtime column should be shown.

Definition at line 547 of file class.ilObjLTIConsumer.php.

                                       : bool
    {
        return $this->_highscore_wtime;
    }

References $_highscore_wtime.

Referenced by save().

Here is the caller graph for this function:

getIliasHttpPath()

static ilObjLTIConsumer::getIliasHttpPath ( )

static

Definition at line 1203 of file class.ilObjLTIConsumer.php.

                                             : string
    {
        global $DIC;
 
        $logger = $DIC->logger()->root();
 
        if ($DIC['https']->isDetected()) {
            $protocol = 'https://';
        } else {
            $protocol = 'http://';
        }
        $host = $_SERVER['HTTP_HOST'];
 
        $rq_uri = strip_tags($_SERVER['REQUEST_URI']);
 
        // security fix: this failed, if the URI contained "?" and following "/"
        // -> we remove everything after "?"
        if (is_int($pos = strpos($rq_uri, "?"))) {
            $rq_uri = substr($rq_uri, 0, $pos);
        }
 
        $path = pathinfo($rq_uri);
        if (isset($path['extension']) && $path['extension'] !== '') {
            $uri = dirname($rq_uri);
        } else {
            $uri = $rq_uri;
        }
        $logger->info("URI --- 1: " . $uri);
        $uri = str_replace("components/ILIAS/LTIConsumer", "", $uri);
        $logger->info("URI --- 2: " . $uri);
        $iliasHttpPath = ilContext::modifyHttpPath(implode('', [$protocol, $host, $uri]));
        $f = new \ILIAS\Data\Factory();
        $uri = $f->uri(rtrim($iliasHttpPath, "/"));
        return $uri->getBaseURI();
    }

References $_SERVER, $DIC, Vendor\Package\$f, $path, and ilContext\modifyHttpPath().

Referenced by ilObjLTIConsumerGUI\contentSelectionRequest(), ilLTIConsumerContentGUI\getEmbeddedAutoStartFormular(), ilLTIConsumerContentGUI\getStartButtonTxt11(), and ilLTIConsumerContentGUI\getStartButtonTxt13().

Here is the call graph for this function:

Here is the caller graph for this function:

getInstance()

static ilObjLTIConsumer::getInstance ( int  $a_id = 0, bool  $a_reference = true  )

static

Definition at line 1391 of file class.ilObjLTIConsumer.php.

                                                                               : \ilObjLTIConsumer
    {
        return new self($a_id, $a_reference);
    }

Referenced by ilCmiXapiStatementsReport\__construct(), ilCmiXapiAbstractReportLinkBuilder\getObj(), and ilCmiXapiHighscoreReport\initTableData().

Here is the caller graph for this function:

getJwks()

static ilObjLTIConsumer::getJwks ( )

static

Definition at line 1183 of file class.ilObjLTIConsumer.php.

                                    : array
    {
        $jwks = ['keys' => []];
 
        $privatekey = self::getPrivateKey();
        $res = openssl_pkey_get_private($privatekey['key']);
        $details = openssl_pkey_get_details($res);
 
        $jwk = [];
        $jwk['kty'] = 'RSA';
        $jwk['alg'] = 'RS256';
        $jwk['kid'] = $privatekey['kid'];
        $jwk['e'] = rtrim(strtr(base64_encode($details['rsa']['e']), '+/', '-_'), '=');
        $jwk['n'] = rtrim(strtr(base64_encode($details['rsa']['n']), '+/', '-_'), '=');
        $jwk['use'] = 'sig';
 
        $jwks['keys'][] = $jwk;
        return $jwks;
    }

References $res.

getLaunchKey()

ilObjLTIConsumer::getLaunchKey

(

)

Definition at line 249 of file class.ilObjLTIConsumer.php.

                                  : string
    {
        if ($this->getProvider()->isProviderKeyCustomizable()) {
            return $this->getCustomLaunchKey();
        }
 
        return $this->getProvider()->getProviderKey();
    }

References getCustomLaunchKey(), and getProvider().

Here is the call graph for this function:

getLaunchMethod()

ilObjLTIConsumer::getLaunchMethod

(

)

Definition at line 209 of file class.ilObjLTIConsumer.php.

                                     : string
    {
        return $this->launchMethod;
    }

References $launchMethod.

Referenced by save().

Here is the caller graph for this function:

getLaunchSecret()

ilObjLTIConsumer::getLaunchSecret

(

)

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

                                     : string
    {
        if ($this->getProvider()->isProviderKeyCustomizable()) {
            return $this->getCustomLaunchSecret();
        }
 
        return $this->getProvider()->getProviderSecret();
    }

References getCustomLaunchSecret(), and getProvider().

Here is the call graph for this function:

getLogger()

static ilObjLTIConsumer::getLogger ( )

static

Definition at line 1431 of file class.ilObjLTIConsumer.php.

                                      : ilLogger
    {
        return ilLoggerFactory::getLogger('lti');
    }

References ilLoggerFactory\getLogger().

Referenced by ilLTIConsumerGradeServiceScores\checkScore(), ilLTIConsumerGradeServiceScores\execute(), invalidRequest(), ilLTIConsumerServiceResponse\send(), sendAccessToken(), serverError(), and validateServiceToken().

Here is the call graph for this function:

Here is the caller graph for this function:

getMasteryScore()

ilObjLTIConsumer::getMasteryScore

(

)

Definition at line 154 of file class.ilObjLTIConsumer.php.

                                     : float
    {
        return $this->mastery_score;
    }

References $mastery_score.

Referenced by save().

Here is the caller graph for this function:

getMasteryScorePercent()

ilObjLTIConsumer::getMasteryScorePercent

(

)

Definition at line 164 of file class.ilObjLTIConsumer.php.

                                            : float
    {
        return $this->mastery_score * 100;
    }

Referenced by ilLTIConsumerPlaceholderValues\getMasteryScore().

Here is the caller graph for this function:

getNewClientId()

static ilObjLTIConsumer::getNewClientId ( )

static

Definition at line 1353 of file class.ilObjLTIConsumer.php.

                                           : string
    {
        return Util::getRandomString(15);
    }

Referenced by ilLTIConsumeProvider\getClientId().

Here is the caller graph for this function:

getOpenidConfig()

static ilObjLTIConsumer::getOpenidConfig ( )

static

Definition at line 1279 of file class.ilObjLTIConsumer.php.

                                            : array
    {
        $scopesSupported = array('openid');
        $gradeservice = new ilLTIConsumerGradeService();
        $scopesSupported = array_merge($scopesSupported, $gradeservice->getPermittedScopes());
        return [
            "issuer" => self::getPlattformId(),
            "authorization_endpoint" => self::getAuthenticationRequestUrl(),
            "token_endpoint" => self::getAccessTokenUrl(),
            "token_endpoint_auth_methods_supported" => ["private_key_jwt"],
            "token_endpoint_auth_signing_alg_values_supported" => ["RS256"],
            "jwks_uri" => self::getPublicKeysetUrl(),
            "registration_endpoint" => self::getRegistrationUrl(),
            "scopes_supported" => $scopesSupported,
            "response_types_supported" => ["id_token"],
            "subject_types_supported" => ["public", "pairwise"],
            "id_token_signing_alg_values_supported" => ["RS256"],
            "claims_supported" => ["iss", "aud"],
            "https://purl.imsglobal.org/spec/lti-platform-configuration" => [
                "product_family_code" => "ilias.de",
                "version" => ILIAS_VERSION,
                "messages_supported" => [
                    [
                        "type" => "LtiResourceLinkRequest",
                        "placements" => [
                        ]
                    ],
                    [
                        "type" => "LtiDeepLinkingRequest",
                        "placements" => [
                        ]
                    ]
                ]
            ]
        ];
    }

References ILIAS_VERSION.

getOpenidConfigUrl()

static ilObjLTIConsumer::getOpenidConfigUrl ( )

static

Definition at line 1274 of file class.ilObjLTIConsumer.php.

                                               : string
    {
        return self::getIliasHttpPath() . "/lticonfig.php";
    }

getPlattformId()

static ilObjLTIConsumer::getPlattformId ( )

static

Definition at line 1239 of file class.ilObjLTIConsumer.php.

                                           : string
    {
        return self::getIliasHttpPath();
    }

Referenced by ilLTIConsumeProviderFormGUI\initForm(), and ilLTIConsumeProviderFormGUI\initToolConfigForm().

Here is the caller graph for this function:

getPrivateKey()

static ilObjLTIConsumer::getPrivateKey ( )

static

Definition at line 1132 of file class.ilObjLTIConsumer.php.

                                          : array
    {
        global $ilSetting;
        $err = self::verifyPrivateKey();
        if (!empty($err)) {
            return [];
        }
        $privatekey = $ilSetting->get(self::LTI_1_3_PRIVATE_KEY);
        $kid = $ilSetting->get(self::LTI_1_3_KID);
        return [
            "key" => $privatekey,
            "kid" => $kid
        ];
    }

References $ilSetting.

Referenced by sendAccessToken().

Here is the caller graph for this function:

getProvider()

ilObjLTIConsumer::getProvider

(

)

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

                                 : ?\ilLTIConsumeProvider
    {
        return $this->provider;
    }

References $provider.

Referenced by getActivityId(), getLaunchKey(), getLaunchSecret(), ilLTIConsumeProviderSettingsGUI\initMetadata(), and ilLTIConsumerSettingsFormGUI\initObject().

Here is the caller graph for this function:

getProviderCustomParamsArray()

static ilObjLTIConsumer::getProviderCustomParamsArray ( ilLTIConsumeProvider  $provider )

static

Returns

string[]

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

                                                                                       : array
    {
        $paramsAsArray = [];
 
        $params = $provider->getCustomParams();
        // allows   foo=bar;foo2=baz2; foo3=baz3
        $params = preg_split('/; ?/', $params);
 
        foreach ($params as $param) {
            $param = explode('=', $param);
            // empty field, duplicate/leading/trailing semicolon?
            if ($param[0] != '') {
                $value = isset($param[1]) ? $param[1] : '';
                $paramsAsArray[$param[0]] = $value;
            }
        }
 
        return $paramsAsArray;
    }

References $param, $params, $provider, and ilLTIConsumeProvider\getCustomParams().

Here is the call graph for this function:

getProviderId()

ilObjLTIConsumer::getProviderId

(

)

Definition at line 174 of file class.ilObjLTIConsumer.php.

                                   : int
    {
        return $this->providerId;
    }

References $providerId.

Referenced by initProvider(), and save().

Here is the caller graph for this function:

getPublicKey()

static ilObjLTIConsumer::getPublicKey ( )

static

Definition at line 1171 of file class.ilObjLTIConsumer.php.

                                         : string
    {
        $publicKey = null;
        $privateKey = self::getPrivateKey();
        $res = openssl_pkey_get_private($privateKey['key']);
        if ($res !== false) {
            $details = openssl_pkey_get_details($res);
            $publicKey = $details['key'];
        }
        return $publicKey;
    }

References $privateKey, and $res.

getPublicKeysetUrl()

static ilObjLTIConsumer::getPublicKeysetUrl ( )

static

Definition at line 1254 of file class.ilObjLTIConsumer.php.

                                               : string
    {
        return self::getIliasHttpPath() . "/lticerts.php";
    }

Referenced by ilLTIConsumeProviderFormGUI\initForm(), and ilLTIConsumeProviderFormGUI\initToolConfigForm().

Here is the caller graph for this function:

getRawData()

static ilObjLTIConsumer::getRawData ( )

static

Definition at line 1401 of file class.ilObjLTIConsumer.php.

                                       : ?string
    {
        return file_get_contents('php://input');
    }

getRegistrationEndUrl()

static ilObjLTIConsumer::getRegistrationEndUrl ( )

static

Definition at line 1269 of file class.ilObjLTIConsumer.php.

                                                  : string
    {
        return self::getIliasHttpPath() . "/ltiregend.php";
    }

Referenced by ilLTIConsumeProviderFormGUI\getDynRegRequest().

Here is the caller graph for this function:

getRegistrationStartUrl()

static ilObjLTIConsumer::getRegistrationStartUrl ( )

static

Definition at line 1264 of file class.ilObjLTIConsumer.php.

                                                    : string
    {
        return self::getIliasHttpPath() . "/ltiregstart.php";
    }

Referenced by ilLTIConsumeProviderFormGUI\getDynRegRequest().

Here is the caller graph for this function:

getRegistrationUrl()

static ilObjLTIConsumer::getRegistrationUrl ( )

static

Definition at line 1259 of file class.ilObjLTIConsumer.php.

                                               : string
    {
        return self::getIliasHttpPath() . "/ltiregistration.php";
    }

getTokenObject()

static ilObjLTIConsumer::getTokenObject ( string  $token )

static

Definition at line 1406 of file class.ilObjLTIConsumer.php.

                                                        : ?object
    {
        try {
            $keys = JWK::parseKeySet(self::getJwks());
            return JWT::decode($token, $keys);
        } catch (Exception $e) {
            return null;
        }
    }

References Vendor\Package\$e, and $token.

getUseXapi()

ilObjLTIConsumer::getUseXapi

(

)

Definition at line 267 of file class.ilObjLTIConsumer.php.

                                : bool
    {
        return $this->use_xapi;
    }

References $use_xapi.

Referenced by ilLTIConsumerSettingsFormGUI\initObject(), and save().

Here is the caller graph for this function:

initProvider()

ilObjLTIConsumer::initProvider

(

)

Definition at line 184 of file class.ilObjLTIConsumer.php.

                                  : void
    {
        $this->provider = new ilLTIConsumeProvider($this->getProviderId());
    }

References getProviderId().

Here is the call graph for this function:

initType()

ilObjLTIConsumer::initType ( )

protected

Reimplemented from ilObject2.

Definition at line 109 of file class.ilObjLTIConsumer.php.

                                 : void
    {
        $this->type = "lti";
    }

isActivationLimited()

ilObjLTIConsumer::isActivationLimited

(

)

Definition at line 114 of file class.ilObjLTIConsumer.php.

                                         : bool
    {
        return $this->activationLimited;
    }

References $activationLimited.

Referenced by saveRepositoryActivationSettings().

Here is the caller graph for this function:

isLaunchMethodEmbedded()

ilObjLTIConsumer::isLaunchMethodEmbedded

(

)

Definition at line 204 of file class.ilObjLTIConsumer.php.

                                            : bool
    {
        return $this->launchMethod == self::LAUNCH_METHOD_EMBEDDED;
    }

References LAUNCH_METHOD_EMBEDDED.

isLaunchMethodOwnWin()

ilObjLTIConsumer::isLaunchMethodOwnWin

(

)

Definition at line 199 of file class.ilObjLTIConsumer.php.

                                          : bool
    {
        return $this->launchMethod == self::LAUNCH_METHOD_OWN_WIN;
    }

References LAUNCH_METHOD_OWN_WIN.

isMixedContentType()

ilObjLTIConsumer::isMixedContentType

(

)

Definition at line 1396 of file class.ilObjLTIConsumer.php.

                                        : bool
    {
        return true;
    }

isStatementsReportEnabled()

ilObjLTIConsumer::isStatementsReportEnabled

(

)

Definition at line 296 of file class.ilObjLTIConsumer.php.

                                               : bool
    {
        return $this->statementsReportEnabled;
    }

References $statementsReportEnabled.

Referenced by save().

Here is the caller graph for this function:

load()

ilObjLTIConsumer::load

(

)

Definition at line 357 of file class.ilObjLTIConsumer.php.

                          : void
    {
        global $DIC;
        /* @var \ILIAS\DI\Container $DIC */
 
        $query = "SELECT * FROM {$this->dbTableName()} WHERE obj_id = %s";
        $res = $DIC->database()->queryF($query, ['integer'], [$this->getId()]);
 
        while ($row = $DIC->database()->fetchAssoc($res)) {
            // if ($row['provider_id']) { //always set
            $this->setProviderId((int) $row['provider_id']);
            $this->setProvider(new ilLTIConsumeProvider((int) $row['provider_id']));
            // }
 
            $this->setLaunchMethod($row['launch_method']);
 
            $this->setCustomLaunchKey((string) $row['launch_key']);
            $this->setCustomLaunchSecret((string) $row['launch_secret']);
            $this->setCustomParams((string) $row['custom_params']);
 
            $this->setUseXapi((bool) $row['use_xapi']);
            $this->setCustomActivityId((string) $row['activity_id']);
            $this->setStatementsReportEnabled((bool) $row['show_statements']);
            $this->setHighscoreEnabled((bool) $row['highscore_enabled']);
            $this->setHighscoreAchievedTS((bool) $row['highscore_achieved_ts']);
            $this->setHighscorePercentage((bool) $row['highscore_percentage']);
            $this->setHighscoreWTime((bool) $row['highscore_wtime']);
            $this->setHighscoreOwnTable((bool) $row['highscore_own_table']);
            $this->setHighscoreTopTable((bool) $row['highscore_top_table']);
            $this->setHighscoreTopNum((int) $row['highscore_top_num']);
 
            $this->setMasteryScore((float) $row['mastery_score']);
        }
 
        $this->loadRepositoryActivationSettings();
    }

References $DIC, $res, ilObject\getId(), loadRepositoryActivationSettings(), setCustomActivityId(), setCustomLaunchKey(), setCustomLaunchSecret(), setCustomParams(), setHighscoreAchievedTS(), setHighscoreEnabled(), setHighscoreOwnTable(), setHighscorePercentage(), setHighscoreTopNum(), setHighscoreTopTable(), setHighscoreWTime(), setLaunchMethod(), setMasteryScore(), setProvider(), setProviderId(), setStatementsReportEnabled(), and setUseXapi().

Referenced by doRead().

Here is the call graph for this function:

Here is the caller graph for this function:

loadRepositoryActivationSettings()

ilObjLTIConsumer::loadRepositoryActivationSettings ( )

protected

Definition at line 428 of file class.ilObjLTIConsumer.php.

                                                         : void
    {
        if ($this->ref_id > 0) {
            $activation = ilObjectActivation::getItem($this->ref_id);
            switch ($activation["timing_type"]) {
                case ilObjectActivation::TIMINGS_ACTIVATION:
                    $this->setActivationLimited(true);
                    if (!is_null($activation["timing_start"])) {
                        $activation["timing_start"] = (int) $activation["timing_start"];
                    }
                    $this->setActivationStartingTime($activation["timing_start"]);
                    if (!is_null($activation["timing_end"])) {
                        $activation["timing_end"] = (int) $activation["timing_end"];
                    }
                    $this->setActivationEndingTime($activation["timing_end"]);
                    $this->setActivationVisibility((bool) $activation["visible"]);
                    break;
 
                default:
                    $this->setActivationLimited(false);
                    break;
            }
        }
    }

References ilObjectActivation\getItem(), ILIAS\Repository\int(), setActivationEndingTime(), setActivationLimited(), setActivationStartingTime(), setActivationVisibility(), and ilObjectActivation\TIMINGS_ACTIVATION.

Referenced by load().

Here is the call graph for this function:

Here is the caller graph for this function:

LTISignJWT()

static ilObjLTIConsumer::LTISignJWT ( array  $parms, string  $endpoint, string  $oAuthConsumerKey,   $typeId = 0, string  $nonce = ''  )

static

Definition at line 1044 of file class.ilObjLTIConsumer.php.

     : array {
        if (empty($typeId)) {
            $typeId = 0;
        }
        $messageTypeMapping = Util::MESSAGE_TYPE_MAPPING;
        if (isset($parms['lti_message_type']) && array_key_exists($parms['lti_message_type'], $messageTypeMapping)) {
            $parms['lti_message_type'] = $messageTypeMapping[$parms['lti_message_type']];
        }
        if (isset($parms['roles'])) {
            $roles = explode(',', $parms['roles']);
            $newRoles = array();
            foreach ($roles as $role) {
                if (strpos($role, 'urn:lti:role:ims/lis/') === 0) {
                    $role = 'http://purl.imsglobal.org/vocab/lis/v2/membership#' . substr($role, 21);
                } elseif (strpos($role, 'urn:lti:instrole:ims/lis/') === 0) {
                    $role = 'http://purl.imsglobal.org/vocab/lis/v2/institution/person#' . substr($role, 25);
                } elseif (strpos($role, 'urn:lti:sysrole:ims/lis/') === 0) {
                    $role = 'http://purl.imsglobal.org/vocab/lis/v2/system/person#' . substr($role, 24);
                } elseif ((strpos($role, '://') === false) && (strpos($role, 'urn:') !== 0)) {
                    $role = "http://purl.imsglobal.org/vocab/lis/v2/membership#{$role}";
                }
                $newRoles[] = $role;
            }
            $parms['roles'] = implode(',', $newRoles);
        }
        $now = time();
        if (empty($nonce)) {
            $nonce = bin2hex(openssl_random_pseudo_bytes(10));
        }
        $claimMapping = Util::JWT_CLAIM_MAPPING;
        $payLoad = array(
            'nonce' => $nonce,
            'iat' => $now,
            'exp' => $now + 60,
        );
        $payLoad['iss'] = self::getIliasHttpPath();
        $payLoad['aud'] = $oAuthConsumerKey;
        $payLoad[self::LTI_JWT_CLAIM_PREFIX . '/claim/deployment_id'] = strval($typeId);
        if (!empty($endpoint)) {  // only for launch request
            $payLoad[self::LTI_JWT_CLAIM_PREFIX . '/claim/target_link_uri'] = $endpoint;
        }
 
        foreach ($parms as $key => $value) {
            $claim = self::LTI_JWT_CLAIM_PREFIX;
            if (array_key_exists($key, $claimMapping)) {
                $mapping = $claimMapping[$key];
 
                if (isset($mapping['isArray']) && $mapping['isArray']) {
                    $value = explode(',', $value);
                    sort($value);
                } elseif (isset($mapping['isBoolean'])) {
                    $value = $mapping['isBoolean'];
                }
                if (!empty($mapping['suffix'])) {
                    $claim .= "-{$mapping['suffix']}";
                }
                $claim .= '/claim/';
                if (is_null($mapping['group'])) {
                    $payLoad[$mapping['claim']] = $value;
                } elseif (empty($mapping['group'])) {
                    $payLoad["{$claim}{$mapping['claim']}"] = $value;
                } else {
                    $claim .= $mapping['group'];
                    $payLoad[$claim][$mapping['claim']] = $value;
                }
            } elseif (strpos($key, 'custom_') === 0) {
                $payLoad["{$claim}/claim/custom"][substr($key, 7)] = $value;
            } elseif (strpos($key, 'ext_') === 0) {
                $payLoad["{$claim}/claim/ext"][substr($key, 4)] = $value;
            }
        }
        //self::getLogger()->debug(json_encode($payLoad,JSON_PRETTY_PRINT));
        if (!empty(self::verifyPrivateKey())) {
            throw new DomainException(self::ERROR_OPEN_SSL_CONF);
        }
        $privateKey = self::getPrivateKey();
        $jwt = Firebase\JWT\JWT::encode($payLoad, $privateKey['key'], 'RS256', $privateKey['kid']);
        $newParms = array();
        $newParms['id_token'] = $jwt;
        return $newParms;
    }

References $typeId.

registerClient()

static ilObjLTIConsumer::registerClient ( array  $data, object  $tokenObj  )

static

Definition at line 1316 of file class.ilObjLTIConsumer.php.

                                                                        : array
    {
        // first analyse tool_config and filter only accepted params
        // append client_id (required) and deployment_id(=provider_id in ILIAS) (optional) to tool_config response
        global $DIC;
        $reponseData = $data;
        $provider = new ilLTIConsumeProvider();
        $toolConfig = $data['https://purl.imsglobal.org/spec/lti-tool-configuration'];
        $provider->setTitle(strip_tags($data['client_name'], ilObjectGUI::ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION));
        $provider->setProviderUrl($toolConfig['target_link_uri']);
        $provider->setInitiateLogin($data['initiate_login_uri']);
        $provider->setRedirectionUris(implode(",", $data['redirect_uris']));
        if (isset($data['jwks_uri'])) {
            $provider->setPublicKeyset($data['jwks_uri']);
        }
        foreach ($toolConfig['messages'] as $message) {
            if (isset($message['type']) && $message['type'] === 'LtiDeepLinkingRequest') {
                $provider->setContentItemUrl($message['target_link_uri']);
            }
        }
        /*
        if (isset($data['logo_uri'])) { // needs to be uploaded and then assign filepath
            $provider->setProviderIconFilename($data['logo_uri']);
        }
        */
        $provider->setKeyType('JWK_KEYSET');
        $provider->setLtiVersion('1.3.0');
        $provider->setClientId((string) $tokenObj->aud); //client_id
        $provider->setCreator((int) $tokenObj->sub); // user_id
        $provider->setAvailability(ilLTIConsumeProvider::AVAILABILITY_CREATE);
        $provider->setIsGlobal(false);
        $provider->insert();
        $reponseData['client_id'] = $tokenObj->aud;
        $reponseData['https://purl.imsglobal.org/spec/lti-tool-configuration']['deployment_id'] = $provider->getId();
        return $reponseData;
    }

References $data, $DIC, $message, $provider, and ilLTIConsumeProvider\AVAILABILITY_CREATE.

save()

ilObjLTIConsumer::save

(

)

Definition at line 399 of file class.ilObjLTIConsumer.php.

                          : void
    {
        global $DIC;
        /* @var \ILIAS\DI\Container $DIC */
 
        $DIC->database()->replace($this->dbTableName(), [
            'obj_id' => ['integer', $this->getId()]
        ], [
            'provider_id' => ['integer', $this->getProviderId()],
            'launch_method' => ['text', $this->getLaunchMethod()],
            'launch_key' => ['text', $this->getCustomLaunchKey()],
            'launch_secret' => ['text', $this->getCustomLaunchSecret()],
            'custom_params' => ['text', $this->getCustomParams()],
            'use_xapi' => ['integer', $this->getUseXapi()],
            'activity_id' => ['text', $this->getCustomActivityId()],
            'show_statements' => ['integer', $this->isStatementsReportEnabled()],
            'highscore_enabled' => ['integer', (int) $this->getHighscoreEnabled()],
            'highscore_achieved_ts' => ['integer', (int) $this->getHighscoreAchievedTS()],
            'highscore_percentage' => ['integer', (int) $this->getHighscorePercentage()],
            'highscore_wtime' => ['integer', (int) $this->getHighscoreWTime()],
            'highscore_own_table' => ['integer', (int) $this->getHighscoreOwnTable()],
            'highscore_top_table' => ['integer', (int) $this->getHighscoreTopTable()],
            'highscore_top_num' => ['integer', $this->getHighscoreTopNum()],
            'mastery_score' => ['float', $this->getMasteryScore()]
        ]);
 
        $this->saveRepositoryActivationSettings();
    }

References $DIC, dbTableName(), getCustomActivityId(), getCustomLaunchKey(), getCustomLaunchSecret(), getCustomParams(), getHighscoreAchievedTS(), getHighscoreEnabled(), getHighscoreOwnTable(), getHighscorePercentage(), getHighscoreTopNum(), getHighscoreTopTable(), getHighscoreWTime(), ilObject\getId(), getLaunchMethod(), getMasteryScore(), getProviderId(), getUseXapi(), isStatementsReportEnabled(), and saveRepositoryActivationSettings().

Referenced by doUpdate().

Here is the call graph for this function:

Here is the caller graph for this function:

saveRepositoryActivationSettings()

ilObjLTIConsumer::saveRepositoryActivationSettings ( )

protected

Definition at line 453 of file class.ilObjLTIConsumer.php.

                                                         : void
    {
        if ($this->ref_id > 0) {
            ilObjectActivation::getItem($this->ref_id);
 
            $item = new ilObjectActivation();
            if (!$this->isActivationLimited()) {
                $item->setTimingType(ilObjectActivation::TIMINGS_DEACTIVATED);
            } else {
                $item->setTimingType(ilObjectActivation::TIMINGS_ACTIVATION);
                $item->setTimingStart($this->getActivationStartingTime());
                $item->setTimingEnd($this->getActivationEndingTime());
                $item->toggleVisible($this->getActivationVisibility());
            }
 
            $item->update($this->ref_id);
        }
    }

References getActivationEndingTime(), getActivationStartingTime(), getActivationVisibility(), ilObjectActivation\getItem(), isActivationLimited(), ilObjectActivation\TIMINGS_ACTIVATION, and ilObjectActivation\TIMINGS_DEACTIVATED.

Referenced by save().

Here is the call graph for this function:

Here is the caller graph for this function:

sendResponseError()

static ilObjLTIConsumer::sendResponseError ( int  $code, string  $message,   $log = true  )

static

Definition at line 1358 of file class.ilObjLTIConsumer.php.

                                                                                     : void
    {
        global $DIC;
        try {
            if ($log) {
                self::getLogger()->error("$code $message");
            }
            $DIC->http()->saveResponse(
                $DIC->http()->response()
                    ->withStatus($code)
                    ->withBody(Streams::ofString($message))
            );
            $DIC->http()->sendResponse();
            $DIC->http()->close();
        } catch (Exception $e) {
            $DIC->http()->close();
        }
    }

References $DIC, Vendor\Package\$e, $log, and $message.

Referenced by invalidRequest(), and serverError().

Here is the caller graph for this function:

sendResponseJson()

static ilObjLTIConsumer::sendResponseJson ( array  $obj )

static

Definition at line 1377 of file class.ilObjLTIConsumer.php.

                                                       : void
    {
        global $DIC;
        try {
            header('Content-Type: application/json; charset=utf-8');
            header('Cache-Control: no-store');
            header('Pragma: no-cache');
            echo json_encode($obj, JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT);
        } catch (Exception $e) {
            self::sendResponseError(500, "error in sendResponseJson");
            $DIC->http()->close();
        }
    }

References $DIC, Vendor\Package\$e, and ILIAS\UI\examples\Symbol\Glyph\Header\header().

Referenced by sendAccessToken().

Here is the call graph for this function:

Here is the caller graph for this function:

setActivationEndingTime()

ilObjLTIConsumer::setActivationEndingTime

(

?int

$activationEndingTime = null

)

Definition at line 139 of file class.ilObjLTIConsumer.php.

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

References $activationEndingTime.

Referenced by loadRepositoryActivationSettings().

Here is the caller graph for this function:

setActivationLimited()

ilObjLTIConsumer::setActivationLimited

(

bool

$activationLimited

)

Definition at line 119 of file class.ilObjLTIConsumer.php.

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

References $activationLimited.

Referenced by loadRepositoryActivationSettings().

Here is the caller graph for this function:

setActivationStartingTime()

ilObjLTIConsumer::setActivationStartingTime

(

?int

$activationStartingTime = null

)

Definition at line 129 of file class.ilObjLTIConsumer.php.

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

References $activationStartingTime.

Referenced by loadRepositoryActivationSettings().

Here is the caller graph for this function:

setActivationVisibility()

ilObjLTIConsumer::setActivationVisibility

(

bool

$activationVisibility

)

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

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

References $activationVisibility.

Referenced by loadRepositoryActivationSettings().

Here is the caller graph for this function:

setCustomActivityId()

ilObjLTIConsumer::setCustomActivityId

(

string

$custom_activity_id

)

Definition at line 282 of file class.ilObjLTIConsumer.php.

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

References $custom_activity_id.

Referenced by ilLTIConsumerSettingsFormGUI\initObject(), and load().

Here is the caller graph for this function:

setCustomLaunchKey()

ilObjLTIConsumer::setCustomLaunchKey

(

string

$customLaunchKey

)

Definition at line 224 of file class.ilObjLTIConsumer.php.

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

References $customLaunchKey.

Referenced by ilLTIConsumerSettingsFormGUI\initObject(), and load().

Here is the caller graph for this function:

setCustomLaunchSecret()

ilObjLTIConsumer::setCustomLaunchSecret

(

string

$customLaunchSecret

)

Definition at line 234 of file class.ilObjLTIConsumer.php.

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

References $customLaunchSecret.

Referenced by ilLTIConsumerSettingsFormGUI\initObject(), and load().

Here is the caller graph for this function:

setCustomParams()

ilObjLTIConsumer::setCustomParams

(

string

$customParams

)

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

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

References $customParams.

Referenced by ilLTIConsumerSettingsFormGUI\initObject(), and load().

Here is the caller graph for this function:

setHighscoreAchievedTS()

ilObjLTIConsumer::setHighscoreAchievedTS

(

bool

$a_achieved_ts

)

Sets if the date and time of the scores achievement should be displayed.

Definition at line 501 of file class.ilObjLTIConsumer.php.

                                                               : void
    {
        $this->_highscore_achieved_ts = $a_achieved_ts;
    }

Referenced by ilLTIConsumerSettingsFormGUI\initObject(), and load().

Here is the caller graph for this function:

setHighscoreEnabled()

ilObjLTIConsumer::setHighscoreEnabled

(

bool

$a_enabled

)

HIGHSCORE.

Sets if the highscore feature should be enabled.

Definition at line 483 of file class.ilObjLTIConsumer.php.

                                                        : void
    {
        $this->_highscore_enabled = $a_enabled;
    }

Referenced by ilLTIConsumerSettingsFormGUI\initObject(), and load().

Here is the caller graph for this function:

setHighscoreMode()

ilObjLTIConsumer::setHighscoreMode

(

int

$mode

)

Parameters

$mode

int

Definition at line 637 of file class.ilObjLTIConsumer.php.

                                               : void
    {
        switch ($mode) {
            case self::HIGHSCORE_SHOW_ALL_TABLES:
                $this->setHighscoreTopTable(true);
                $this->setHighscoreOwnTable(true);
                break;
 
            case self::HIGHSCORE_SHOW_TOP_TABLE:
                $this->setHighscoreTopTable(true);
                $this->setHighscoreOwnTable(false);
                break;
 
            case self::HIGHSCORE_SHOW_OWN_TABLE:
            default:
                $this->setHighscoreTopTable(false);
                $this->setHighscoreOwnTable(true);
                break;
        }
    }

References HIGHSCORE_SHOW_ALL_TABLES, HIGHSCORE_SHOW_OWN_TABLE, HIGHSCORE_SHOW_TOP_TABLE, setHighscoreOwnTable(), and setHighscoreTopTable().

Referenced by ilLTIConsumerSettingsFormGUI\initObject().

Here is the call graph for this function:

Here is the caller graph for this function:

setHighscoreOwnTable()

ilObjLTIConsumer::setHighscoreOwnTable

(

bool

$a_own_table

)

Sets if the table with the own ranking should be shown.

Parameters

bool

$a_own_table

True, if table with own ranking should be shown.

Definition at line 557 of file class.ilObjLTIConsumer.php.

                                                           : void
    {
        $this->_highscore_own_table = $a_own_table;
    }

Referenced by load(), and setHighscoreMode().

Here is the caller graph for this function:

setHighscorePercentage()

ilObjLTIConsumer::setHighscorePercentage

(

bool

$a_percentage

)

Sets if the percentages of the scores pass should be shown.

Definition at line 519 of file class.ilObjLTIConsumer.php.

                                                              : void
    {
        $this->_highscore_percentage = $a_percentage;
    }

Referenced by ilLTIConsumerSettingsFormGUI\initObject(), and load().

Here is the caller graph for this function:

setHighscoreTopNum()

ilObjLTIConsumer::setHighscoreTopNum

(

int

$a_top_num

)

Sets the number of entries which are to be shown in the top-rankings table.

Parameters

integer

$a_top_num

Number of entries in the top-rankings table.

Definition at line 596 of file class.ilObjLTIConsumer.php.

                                                      : void
    {
        $this->_highscore_top_num = $a_top_num;
    }

Referenced by ilLTIConsumerSettingsFormGUI\initObject(), and load().

Here is the caller graph for this function:

setHighscoreTopTable()

ilObjLTIConsumer::setHighscoreTopTable

(

bool

$a_top_table

)

Sets if the top-rankings table should be shown.

Definition at line 575 of file class.ilObjLTIConsumer.php.

                                                           : void
    {
        $this->_highscore_top_table = $a_top_table;
    }

Referenced by load(), and setHighscoreMode().

Here is the caller graph for this function:

setHighscoreWTime()

ilObjLTIConsumer::setHighscoreWTime

(

bool

$a_wtime

)

Sets if the workingtime of the scores should be shown.

Definition at line 537 of file class.ilObjLTIConsumer.php.

                                                    : void
    {
        $this->_highscore_wtime = $a_wtime;
    }

Referenced by ilLTIConsumerSettingsFormGUI\initObject(), and load().

Here is the caller graph for this function:

setLaunchMethod()

ilObjLTIConsumer::setLaunchMethod

(

string

$launchMethod

)

Definition at line 214 of file class.ilObjLTIConsumer.php.

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

References $launchMethod.

Referenced by ilLTIConsumerSettingsFormGUI\initObject(), and load().

Here is the caller graph for this function:

setMasteryScore()

ilObjLTIConsumer::setMasteryScore

(

float

$mastery_score

)

Definition at line 159 of file class.ilObjLTIConsumer.php.

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

References $mastery_score.

Referenced by load().

Here is the caller graph for this function:

setMasteryScorePercent()

ilObjLTIConsumer::setMasteryScorePercent

(

float

$mastery_score_percent

)

Definition at line 169 of file class.ilObjLTIConsumer.php.

                                                                        : void
    {
        $this->mastery_score = $mastery_score_percent / 100;
    }

Referenced by ilLTIConsumerSettingsFormGUI\initObject().

Here is the caller graph for this function:

setProvider()

ilObjLTIConsumer::setProvider

(

ilLTIConsumeProvider

$provider

)

Definition at line 194 of file class.ilObjLTIConsumer.php.

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

References $provider.

Referenced by load().

Here is the caller graph for this function:

setProviderId()

ilObjLTIConsumer::setProviderId

(

int

$providerId

)

Definition at line 179 of file class.ilObjLTIConsumer.php.

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

References $providerId.

Referenced by load().

Here is the caller graph for this function:

setStatementsReportEnabled()

ilObjLTIConsumer::setStatementsReportEnabled

(

bool

$statementsReportEnabled

)

Definition at line 301 of file class.ilObjLTIConsumer.php.

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

References $statementsReportEnabled.

Referenced by ilLTIConsumerSettingsFormGUI\initObject(), and load().

Here is the caller graph for this function:

setUseXapi()

ilObjLTIConsumer::setUseXapi

(

bool

$use_xapi

)

Definition at line 272 of file class.ilObjLTIConsumer.php.

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

References $use_xapi.

Referenced by ilLTIConsumerSettingsFormGUI\initObject(), and load().

Here is the caller graph for this function:

verifyPrivateKey()

static ilObjLTIConsumer::verifyPrivateKey ( )

static

Definition at line 1147 of file class.ilObjLTIConsumer.php.

                                             : string
    {
        global $ilSetting;
        $key = $ilSetting->get(self::LTI_1_3_PRIVATE_KEY);
 
        if (empty($key)) {
            $kid = bin2hex(openssl_random_pseudo_bytes(10));
            $ilSetting->set(self::LTI_1_3_KID, $kid);
            $config = array(
                "digest_alg" => "sha256",
                "private_key_bits" => 2048,
                "private_key_type" => self::OPENSSL_KEYTYPE_RSA
            );
            $res = openssl_pkey_new($config);
            openssl_pkey_export($res, $privatekey);
            if (!empty($privatekey)) {
                $ilSetting->set(self::LTI_1_3_PRIVATE_KEY, $privatekey);
            } else {
                return self::ERROR_OPEN_SSL_CONF;
            }
        }
        return '';
    }

References $ilSetting, and $res.

verifyToken()

static ilObjLTIConsumer::verifyToken ( )

static

Definition at line 1416 of file class.ilObjLTIConsumer.php.

                                        : ?object
    {
        global $DIC;
        $auth = $DIC->http()->request()->getHeader("Authorization");
        if (count($auth) < 1) {
            self::sendResponseError(405, "missing Authorization header");
        }
        preg_match('/Bearer\s+(.+)$/i', $auth[0], $matches);
        if (count($matches) != 2) {
            self::sendResponseError(405, "missing required Authorization Baerer token");
        }
        $token = $matches[1];
        return self::getTokenObject($token);
    }

References $DIC, and $token.

Referenced by ilLTIConsumerServiceBase\checkTool().

Here is the caller graph for this function:

Field Documentation

$_highscore_achieved_ts

bool ilObjLTIConsumer::$_highscore_achieved_ts = true

protected

Definition at line 76 of file class.ilObjLTIConsumer.php.

Referenced by getHighscoreAchievedTS().

$_highscore_enabled

bool ilObjLTIConsumer::$_highscore_enabled = false

protected

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

Referenced by getHighscoreEnabled().

$_highscore_own_table

bool ilObjLTIConsumer::$_highscore_own_table = true

protected

Definition at line 82 of file class.ilObjLTIConsumer.php.

Referenced by getHighscoreOwnTable().

$_highscore_percentage

bool ilObjLTIConsumer::$_highscore_percentage = true

protected

Definition at line 78 of file class.ilObjLTIConsumer.php.

Referenced by getHighscorePercentage().

$_highscore_top_num

int ilObjLTIConsumer::$_highscore_top_num = 10

protected

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

Referenced by getHighscoreTopNum().

$_highscore_top_table

bool ilObjLTIConsumer::$_highscore_top_table = true

protected

Definition at line 84 of file class.ilObjLTIConsumer.php.

Referenced by getHighscoreTopTable().

$_highscore_wtime

bool ilObjLTIConsumer::$_highscore_wtime = true

protected

Definition at line 80 of file class.ilObjLTIConsumer.php.

Referenced by getHighscoreWTime().

$activationEndingTime

int ilObjLTIConsumer::$activationEndingTime = null

protected

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

Referenced by getActivationEndingTime(), and setActivationEndingTime().

$activationLimited

bool ilObjLTIConsumer::$activationLimited = false

protected

repository object activation settings (handled by ilObject)

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

Referenced by isActivationLimited(), and setActivationLimited().

$activationStartingTime

int ilObjLTIConsumer::$activationStartingTime = null

protected

Definition at line 43 of file class.ilObjLTIConsumer.php.

Referenced by getActivationStartingTime(), and setActivationStartingTime().

$activationVisibility

bool ilObjLTIConsumer::$activationVisibility = null

protected

Definition at line 45 of file class.ilObjLTIConsumer.php.

Referenced by getActivationVisibility(), and setActivationVisibility().

$anonymity

int ilObjLTIConsumer::$anonymity = 0

protected

Definition at line 74 of file class.ilObjLTIConsumer.php.

$custom_activity_id

string ilObjLTIConsumer::$custom_activity_id = ''

protected

Definition at line 56 of file class.ilObjLTIConsumer.php.

Referenced by getActivityId(), getCustomActivityId(), and setCustomActivityId().

$customLaunchKey

string ilObjLTIConsumer::$customLaunchKey = ''

protected

Definition at line 63 of file class.ilObjLTIConsumer.php.

Referenced by getCustomLaunchKey(), and setCustomLaunchKey().

$customLaunchSecret

string ilObjLTIConsumer::$customLaunchSecret = ''

protected

Definition at line 65 of file class.ilObjLTIConsumer.php.

Referenced by getCustomLaunchSecret(), and setCustomLaunchSecret().

$customParams

string ilObjLTIConsumer::$customParams = ''

protected

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

Referenced by getCustomParams(), and setCustomParams().

$launchMethod

string ilObjLTIConsumer::$launchMethod = self::LAUNCH_METHOD_NEW_WIN

protected

Definition at line 61 of file class.ilObjLTIConsumer.php.

Referenced by getLaunchMethod(), and setLaunchMethod().

$mastery_score

float ilObjLTIConsumer::$mastery_score = 0.5

protected

Definition at line 59 of file class.ilObjLTIConsumer.php.

Referenced by getMasteryScore(), and setMasteryScore().

$provider

ilLTIConsumeProvider ilObjLTIConsumer::$provider = null

protected

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

Referenced by getProvider(), getProviderCustomParamsArray(), and setProvider().

$providerId

int ilObjLTIConsumer::$providerId = 0

protected

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

Referenced by getProviderId(), and setProviderId().

$ref_id

int ilObjLTIConsumer::$ref_id = 0

protected

Definition at line 69 of file class.ilObjLTIConsumer.php.

$statementsReportEnabled

bool ilObjLTIConsumer::$statementsReportEnabled = false

protected

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

Referenced by isStatementsReportEnabled(), and setStatementsReportEnabled().

$use_xapi

bool ilObjLTIConsumer::$use_xapi = false

protected

Definition at line 55 of file class.ilObjLTIConsumer.php.

Referenced by getUseXapi(), and setUseXapi().

DB_TABLE_NAME

const ilObjLTIConsumer::DB_TABLE_NAME = 'lti_consumer_settings'

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

Referenced by dbTableName().

ERROR_OPEN_SSL_CONF

const ilObjLTIConsumer::ERROR_OPEN_SSL_CONF = 'error openssl config invalid'

Definition at line 95 of file class.ilObjLTIConsumer.php.

HIGHSCORE_SHOW_ALL_TABLES

const ilObjLTIConsumer::HIGHSCORE_SHOW_ALL_TABLES = 1

Definition at line 88 of file class.ilObjLTIConsumer.php.

Referenced by getHighscoreMode(), ilLTIConsumerSettingsFormGUI\initForm(), and setHighscoreMode().

HIGHSCORE_SHOW_OWN_TABLE

const ilObjLTIConsumer::HIGHSCORE_SHOW_OWN_TABLE = 3

Definition at line 90 of file class.ilObjLTIConsumer.php.

Referenced by getHighscoreMode(), ilLTIConsumerSettingsFormGUI\initForm(), and setHighscoreMode().

HIGHSCORE_SHOW_TOP_TABLE

const ilObjLTIConsumer::HIGHSCORE_SHOW_TOP_TABLE = 2

Definition at line 89 of file class.ilObjLTIConsumer.php.

Referenced by getHighscoreMode(), ilLTIConsumerSettingsFormGUI\initForm(), and setHighscoreMode().

LAUNCH_METHOD_EMBEDDED

const ilObjLTIConsumer::LAUNCH_METHOD_EMBEDDED = 'embedded'

Definition at line 53 of file class.ilObjLTIConsumer.php.

Referenced by ilLTIConsumerSettingsFormGUI\initForm(), and isLaunchMethodEmbedded().

LAUNCH_METHOD_NEW_WIN

const ilObjLTIConsumer::LAUNCH_METHOD_NEW_WIN = 'newWin'

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

Referenced by ilLTIConsumerSettingsFormGUI\initForm().

LAUNCH_METHOD_OWN_WIN

const ilObjLTIConsumer::LAUNCH_METHOD_OWN_WIN = 'ownWin'

Definition at line 51 of file class.ilObjLTIConsumer.php.

Referenced by ilLTIConsumerSettingsFormGUI\initForm(), and isLaunchMethodOwnWin().

LTI_1_3_KID

const ilObjLTIConsumer::LTI_1_3_KID = 'lti_1_3_kid'

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

LTI_1_3_PRIVATE_KEY

const ilObjLTIConsumer::LTI_1_3_PRIVATE_KEY = 'lti_1_3_privatekey'

Definition at line 94 of file class.ilObjLTIConsumer.php.

LTI_JWT_CLAIM_PREFIX

const ilObjLTIConsumer::LTI_JWT_CLAIM_PREFIX = 'https://purl.imsglobal.org/spec/lti'

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

OPENSSL_KEYTYPE_RSA

const ilObjLTIConsumer::OPENSSL_KEYTYPE_RSA = ''

Definition at line 96 of file class.ilObjLTIConsumer.php.

REG_TOKEN_OP_NEW_REG

const ilObjLTIConsumer::REG_TOKEN_OP_NEW_REG = 'reg'

Definition at line 98 of file class.ilObjLTIConsumer.php.

REG_TOKEN_OP_UPDATE_REG

const ilObjLTIConsumer::REG_TOKEN_OP_UPDATE_REG = 'reg-update'

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

---

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

• components/ILIAS/LTIConsumer/classes/class.ilObjLTIConsumer.php