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 ($activationLimited)

	getActivationStartingTime ()

	setActivationStartingTime ($activationStartingTime)

	getActivationEndingTime ()

	setActivationEndingTime ($activationEndingTime)

	getActivationVisibility ()

	setActivationVisibility ($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)

	getLaunchKey ()

	getLaunchSecret ()

	getUseXapi ()

	setUseXapi (bool $use_xapi)

	getCustomActivityId ()

	setCustomActivityId (string $custom_activity_id)

	getActivityId ()

	isStatementsReportEnabled ()

	setStatementsReportEnabled ($statementsReportEnabled)

	doRead ()

	load ()

	doUpdate ()

	save ()

	setHighscoreEnabled ($a_enabled)
	Sets if the highscore feature should be enabled. More...

	getHighscoreEnabled ()
	Gets the setting which determines if the highscore feature is enabled. More...

	setHighscoreAchievedTS ($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 ($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 ($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 ($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 ($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 ($a_top_num)
	Sets the number of entries which are to be shown in the top-rankings table. More...

	getHighscoreTopNum ($a_retval=10)
	Gets the number of entries which are to be shown in the top-rankings table. More...

	getHighscoreMode ()

	setHighscoreMode ($mode)

	buildLaunchParameters (ilCmiXapiUser $cmixUser, $token, $contextType, $contextId, $contextTitle, $returnUrl='')

Public Member Functions inherited from ilObject2
	__construct ($a_id=0, $a_reference=true)
	Constructor @access public. More...

	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not) More...

	read ()
	Read data from db. More...

	setRefId ($a_id)
	set reference id @access public More...

	getRefId ()
	get reference id @access public More...

	getType ()
	get object type @access public More...

	setType ($a_type)
	set object type @access public More...

	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...

	getTitle ()
	get object title @access public More...

	getUntranslatedTitle ()
	get untranslated object title @access public More...

	setTitle ($a_title)
	set object title More...

	getDescription ()
	get object description More...

	setDescription ($a_desc)
	set object description More...

	getLongDescription ()
	get object long description (stored in object_description) More...

	getImportId ()
	get import id More...

	setImportId ($a_import_id)
	set import id More...

	getOwner ()
	get object owner More...

	getOwnerName ()

	setOwner ($a_owner)
	set object owner More...

	getCreateDate ()
	get create date @access public More...

	getLastUpdateDate ()
	get last update date @access public More...

	create ($a_clone_mode=false)

	update ()
	update object in db More...

	MDUpdateListener ($a_element)
	Meta data update listener. More...

	createMetaData ()
	create meta data entry More...

	updateMetaData ()
	update meta data entry More...

	deleteMetaData ()
	delete meta data entry More...

	updateOwner ()
	update owner of object in db More...

	putInTree ($a_parent_ref)
	maybe this method should be in tree object!? More...

	setPermissions ($a_parent_ref)
	set permissions of object More...

	createReference ()
	creates reference for object More...

	countReferences ()
	count references of object More...

	delete ()

	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 If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) @access public More...

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneMetaData ($target_obj)
	Copy meta data. More...

	cloneObject ($a_target_id, $a_copy_id=null, $a_omit_tree=false)

	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies. More...

Public Member Functions inherited from ilObject
	__construct ($a_id=0, $a_reference=true)
	Constructor @access public. More...

	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not) More...

	read ()
	read object data from db into object More...

	getId ()
	get object id @access public More...

	setId ($a_id)
	set object id @access public More...

	setRefId ($a_id)
	set reference id @access public More...

	getRefId ()
	get reference id @access public More...

	getType ()
	get object type @access public More...

	setType ($a_type)
	set object type @access public More...

	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...

	getTitle ()
	get object title @access public More...

	getUntranslatedTitle ()
	get untranslated object title @access public More...

	setTitle ($a_title)
	set object title More...

	getDescription ()
	get object description More...

	setDescription ($a_desc)
	set object description More...

	getLongDescription ()
	get object long description (stored in object_description) More...

	getImportId ()
	get import id More...

	setImportId ($a_import_id)
	set import id More...

	setOfflineStatus ($a_status)
	Set offline status. More...

	getOfflineStatus ()
	Get offline status. More...

	supportsOfflineHandling ()
	Check whether object supports offline handling. More...

	getOwner ()
	get object owner More...

	getOwnerName ()

	setOwner ($a_owner)
	set object owner More...

	getCreateDate ()
	get create date @access public More...

	getLastUpdateDate ()
	get last update date @access public More...

	getDiskUsage ()
	Gets the disk usage of the object in bytes. More...

	create ()
	create More...

	update ()
	update object in db More...

	MDUpdateListener ($a_element)
	Meta data update listener. More...

	createMetaData ()
	create meta data entry More...

	updateMetaData ()
	update meta data entry More...

	deleteMetaData ()
	delete meta data entry More...

	updateOwner ()
	update owner of object in db More...

	putInTree ($a_parent_ref)
	maybe this method should be in tree object!? More...

	setPermissions ($a_parent_ref)
	set permissions of object More...

	setParentRolePermissions ($a_parent_ref)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates. More...

	createReference ()
	creates reference for object More...

	countReferences ()
	count references of object 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 If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) @access public More...

	applyDidacticTemplate ($a_tpl_id)
	Apply template. More...

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	getXMLZip ()

	getHTMLDirectory ()

	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies. More...

	cloneMetaData ($target_obj)
	Copy meta data. More...

	getPossibleSubObjects ($a_filter=true)
	get all possible subobjects of this type the object can decide which types of subobjects are possible jut in time overwrite if the decision distinguish from standard model More...

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

Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title More...

const	DESC_LENGTH = 128

	$lng

	$id

	$ref_id

	$type

	$title

	$untranslatedTitle

	$desc

	$long_desc

	$owner

	$create_date

	$last_update

	$import_id

	$register = false

	$referenced

	$objectList

	$max_title

	$max_desc

	$add_dots

Protected Member Functions
	initType ()

	loadRepositoryActivationSettings ()

	saveRepositoryActivationSettings ()

	dbTableName ()

Protected Member Functions inherited from ilObject2
	initType ()

	doRead ()

	doCreate ()

	beforeCreate ()

	doUpdate ()

	beforeUpdate ()

	doMDUpdateListener ($a_element)

	beforeMDUpdateListener ($a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDelete ()

	beforeDelete ()

	doCloneObject ($new_obj, $a_target_id, $a_copy_id=null)

	beforeCloneObject ()

Protected Attributes
	$activationLimited
	repository object activation settings (handled by ilObject) More...

	$activationStartingTime

	$activationEndingTime

	$activationVisibility

	$providerId = 0

	$provider = null

	$use_xapi = false

	$custom_activity_id = ''

	$statementsReportEnabled = false

	$mastery_score = 0.5

	$launchMethod = self::LAUNCH_METHOD_NEW_WIN

	$customLaunchKey = ''

	$customLaunchSecret = ''

	$_highscore_enabled = 0

	$anonymity = 0

	$_highscore_achieved_ts = 1

	$_highscore_percentage = 1

	$_highscore_wtime = 1

	$_highscore_own_table = 1

	$_highscore_top_table = 1

	$_highscore_top_num = 10

Protected Attributes inherited from ilObject
	$objDefinition

	$db

	$log

	$error

	$tree

	$app_event_handler

	$rbacadmin

	$rbacreview

Private Member Functions
	getCustomParams ()

Additional Inherited Members
Static Public Member Functions inherited from ilObject2
static	_lookupObjIdByImportId ($a_import_id)

static	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...

static	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...

static	_getAllReferences ($a_id)
	get all reference ids of object More...

static	_lookupTitle ($a_id)
	lookup object title More...

static	_lookupOwner ($a_id)
	lookup object owner More...

static	_getIdsForTitle ($title, $type='', $partialmatch=false)

static	_lookupDescription ($a_id)
	lookup object description More...

static	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...

static	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...

static	_lookupObjId ($a_id)

static	_setDeletedDate ($a_ref_id, $a_deleted_by)

static	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...

static	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...

static	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...

static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...

static	_isInTrash ($a_ref_id)
	checks wether object is in trash More...

static	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash More...

static	_lookupObjectId ($a_ref_id)
	lookup object id More...

static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type More...

static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data@access public More...

static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type. More...

static	_prepareCloneSelection ($a_ref_ids, $new_type, $a_show_path=true)
	Prepare copy wizard object selection. More...

static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)

Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)

static	_lookupImportId ($a_obj_id)

static	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...

static	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...

static	_getAllReferences ($a_id)
	get all reference ids of object More...

static	_lookupTitle ($a_id)
	lookup object title More...

static	lookupOfflineStatus ($a_obj_id)
	Lookup offline status using objectDataCache. More...

static	_lookupOwner ($a_id)
	lookup object owner More...

static	_getIdsForTitle ($title, $type='', $partialmatch=false)

static	_lookupDescription ($a_id)
	lookup object description More...

static	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...

static	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...

static	_lookupObjId ($a_id)

static	_setDeletedDate ($a_ref_id, $a_deleted_by)

static	setDeletedDates ($a_ref_ids, $a_user_id)
	Set deleted date. More...

static	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...

static	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...

static	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...

static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...

static	_isInTrash ($a_ref_id)
	checks wether object is in trash More...

static	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash More...

static	_lookupObjectId ($a_ref_id)
	lookup object id More...

static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type More...

static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data@access public More...

static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type. More...

static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection. More...

static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $a_obj_ids)
	Get long description data. More...

static	getAllOwnedRepositoryObjects ($a_user_id)
	Get all ids of objects user owns. More...

static	fixMissingTitles ($a_type, array &$a_obj_title_map)
	Try to fix missing object titles. More...

static	_lookupCreationDate ($a_id)
	Lookup creation date. More...

static	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course. More...

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

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

ilObjLTIConsumer constructor.

Parameters

int	$a_id
bool	$a_reference

Definition at line 65 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

◆ buildLaunchParameters()

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

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

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        
        $roles = $DIC->access()->checkAccess('write', '', $this->getRefId()) ? "Instructor" : "Learner";
        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 = ILIAS_HTTP_PATH . "/" . $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);
        
        $custom_params = $this->getCustomParams();
 
        $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" => $value = CLIENT_ID . "." . implode(".", array_reverse(explode("/", parse_url(ILIAS_HTTP_PATH)["path"]))) . parse_url(ILIAS_HTTP_PATH)["host"],
            "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" => $DIC->settings()->get("ilias_version"),
            "lis_result_sourcedid" => $token,
            "lis_outcome_service_url" => ILIAS_HTTP_PATH . "/Modules/LTIConsumer/result.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" => "",
            "data" => ($launch_vars + $custom_params)
        ];
        
        $launchParameters = ilLTIConsumerLaunch::signOAuth($OAuthParams);
        
        return $launchParameters;
    }

References $DIC, $token, ilLink\_getLink(), ilLTIConsumerResult\getByKeys(), getCustomParams(), ilObject2\getDescription(), ilObject\getId(), ilCmiXapiUser\getIdentAsId(), getLaunchKey(), getLaunchMethod(), getLaunchSecret(), getProvider(), ilObject2\getRefId(), ilObject2\getTitle(), ilCmiXapiUser\getUsrIdent(), ILIAS_HTTP_PATH, ilLTIConsumeProvider\PRIVACY_NAME_FIRSTNAME, ilLTIConsumeProvider\PRIVACY_NAME_FULLNAME, ilLTIConsumeProvider\PRIVACY_NAME_LASTNAME, and ilLTIConsumerLaunch\signOAuth().

Here is the call graph for this function:

◆ dbTableName()

ilObjLTIConsumer::dbTableName ( )

protected

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

    {
        return self::DB_TABLE_NAME;
    }

References DB_TABLE_NAME.

Referenced by save().

Here is the caller graph for this function:

◆ doRead()

ilObjLTIConsumer::doRead ( )

Reimplemented from ilObject2.

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

    {
        $this->load();
    }

References load().

Here is the call graph for this function:

◆ doUpdate()

ilObjLTIConsumer::doUpdate ( )

Reimplemented from ilObject2.

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

    {
        $this->save();
    }

References save().

Here is the call graph for this function:

◆ getActivationEndingTime()

ilObjLTIConsumer::getActivationEndingTime ( )

Returns: int

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

    {
        return $this->activationEndingTime;
    }

References $activationEndingTime.

Referenced by saveRepositoryActivationSettings().

Here is the caller graph for this function:

◆ getActivationStartingTime()

ilObjLTIConsumer::getActivationStartingTime ( )

Returns: int

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

    {
        return $this->activationStartingTime;
    }

References $activationStartingTime.

Referenced by saveRepositoryActivationSettings().

Here is the caller graph for this function:

◆ getActivationVisibility()

ilObjLTIConsumer::getActivationVisibility ( )

Returns: bool

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

    {
        return $this->activationVisibility;
    }

References $activationVisibility.

Referenced by saveRepositoryActivationSettings().

Here is the caller graph for this function:

◆ getActivityId()

ilObjLTIConsumer::getActivityId ( )

Returns: string

Definition at line 331 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:

◆ getCustomActivityId()

ilObjLTIConsumer::getCustomActivityId ( )

Returns: string

Definition at line 315 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 ( )

Returns: string

Definition at line 243 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 ( )

Returns: string

Definition at line 259 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 ( )

private

Returns: string[]

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

                                       : array
    {
        $paramsAsArray = [];
 
        $params = $this->getProvider()->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, and getProvider().

Referenced by buildLaunchParameters().

Here is the call graph for this function:

Here is the caller 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 582 of file class.ilObjLTIConsumer.php.

    {
        return (bool) $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 561 of file class.ilObjLTIConsumer.php.

    {
        return (bool) $this->_highscore_enabled;
    }

References $_highscore_enabled.

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

Here is the caller graph for this function:

◆ getHighscoreMode()

ilObjLTIConsumer::getHighscoreMode ( )

Returns: int

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

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

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 642 of file class.ilObjLTIConsumer.php.

    {
        return (bool) $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 602 of file class.ilObjLTIConsumer.php.

    {
        return (bool) $this->_highscore_percentage;
    }

References $_highscore_percentage.

Referenced by save().

Here is the caller graph for this function:

◆ getHighscoreTopNum()

ilObjLTIConsumer::getHighscoreTopNum ( $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 686 of file class.ilObjLTIConsumer.php.

    {
        $retval = $a_retval;
        if ((int) $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 662 of file class.ilObjLTIConsumer.php.

    {
        return (bool) $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 622 of file class.ilObjLTIConsumer.php.

    {
        return (bool) $this->_highscore_wtime;
    }

References $_highscore_wtime.

Referenced by save().

Here is the caller graph for this function:

◆ getLaunchKey()

ilObjLTIConsumer::getLaunchKey ( )

Returns: string

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

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

References getCustomLaunchKey(), and getProvider().

Referenced by buildLaunchParameters().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLaunchMethod()

ilObjLTIConsumer::getLaunchMethod ( )

Returns: string

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

                                      : string
    {
        return $this->launchMethod;
    }

References $launchMethod.

Referenced by buildLaunchParameters(), and save().

Here is the caller graph for this function:

◆ getLaunchSecret()

ilObjLTIConsumer::getLaunchSecret ( )

Returns: string

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

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

References getCustomLaunchSecret(), and getProvider().

Referenced by buildLaunchParameters().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMasteryScore()

ilObjLTIConsumer::getMasteryScore ( )

Returns: float

Definition at line 142 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 ( )

Returns: float

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

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

Referenced by ilLTIConsumerPlaceholderValues\getMasteryScore().

Here is the caller graph for this function:

◆ getProvider()

ilObjLTIConsumer::getProvider ( )

Returns: ilLTIConsumeProvider

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

                                  : ilLTIConsumeProvider
    {
        return $this->provider;
    }

References $provider.

Referenced by buildLaunchParameters(), getActivityId(), getCustomParams(), getLaunchKey(), getLaunchSecret(), and ilLTIConsumerSettingsFormGUI\initObject().

Here is the caller graph for this function:

◆ getProviderId()

ilObjLTIConsumer::getProviderId ( )

Returns: int

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:

◆ getUseXapi()

ilObjLTIConsumer::getUseXapi ( )

Returns: bool

Definition at line 299 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 187 of file class.ilObjLTIConsumer.php.

    {
        $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 70 of file class.ilObjLTIConsumer.php.

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

◆ isActivationLimited()

ilObjLTIConsumer::isActivationLimited ( )

Returns: bool

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

    {
        return $this->activationLimited;
    }

References $activationLimited.

Referenced by saveRepositoryActivationSettings().

Here is the caller graph for this function:

◆ isLaunchMethodEmbedded()

ilObjLTIConsumer::isLaunchMethodEmbedded ( )

Returns: bool

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

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

References LAUNCH_METHOD_EMBEDDED.

◆ isLaunchMethodOwnWin()

ilObjLTIConsumer::isLaunchMethodOwnWin ( )

Returns: bool

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

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

References LAUNCH_METHOD_OWN_WIN.

◆ isStatementsReportEnabled()

ilObjLTIConsumer::isStatementsReportEnabled ( )

Returns: bool

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

    {
        return $this->statementsReportEnabled;
    }

References $statementsReportEnabled.

Referenced by save().

Here is the caller graph for this function:

◆ load()

ilObjLTIConsumer::load ( )

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

    {
        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->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, $query, $res, ilObject\getId(), loadRepositoryActivationSettings(), setCustomActivityId(), setCustomLaunchKey(), setCustomLaunchSecret(), 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 452 of file class.ilObjLTIConsumer.php.

    {
        if ($this->ref_id) {
            include_once "./Services/Object/classes/class.ilObjectActivation.php";
            $activation = ilObjectActivation::getItem($this->ref_id);
            switch ($activation["timing_type"]) {
                case ilObjectActivation::TIMINGS_ACTIVATION:
                    $this->setActivationLimited(true);
                    $this->setActivationStartingTime($activation["timing_start"]);
                    $this->setActivationEndingTime($activation["timing_end"]);
                    $this->setActivationVisibility($activation["visible"]);
                    break;
                
                default:
                    $this->setActivationLimited(false);
                    break;
            }
        }
    }

References ilObjectActivation\getItem(), 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:

◆ save()

ilObjLTIConsumer::save ( )

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

    {
        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()],
            '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', (int) $this->getHighscoreTopNum()],
            'mastery_score' => ['float', (float) $this->getMasteryScore()]
        ]);
        
        $this->saveRepositoryActivationSettings();
    }

References $DIC, dbTableName(), getCustomActivityId(), getCustomLaunchKey(), getCustomLaunchSecret(), 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 472 of file class.ilObjLTIConsumer.php.

    {
        if ($this->ref_id) {
            include_once "./Services/Object/classes/class.ilObjectActivation.php";
            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\setTimingType(), 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:

◆ setActivationEndingTime()

ilObjLTIConsumer::setActivationEndingTime ( $activationEndingTime )

Parameters

int $activationEndingTime

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

    {
        $this->activationEndingTime = $activationEndingTime;
    }

References $activationEndingTime.

Referenced by loadRepositoryActivationSettings().

Here is the caller graph for this function:

◆ setActivationLimited()

ilObjLTIConsumer::setActivationLimited ( $activationLimited )

Parameters

bool $activationLimited

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

    {
        $this->activationLimited = $activationLimited;
    }

References $activationLimited.

Referenced by loadRepositoryActivationSettings().

Here is the caller graph for this function:

◆ setActivationStartingTime()

ilObjLTIConsumer::setActivationStartingTime ( $activationStartingTime )

Parameters

int $activationStartingTime

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

    {
        $this->activationStartingTime = $activationStartingTime;
    }

References $activationStartingTime.

Referenced by loadRepositoryActivationSettings().

Here is the caller graph for this function:

◆ setActivationVisibility()

ilObjLTIConsumer::setActivationVisibility ( $activationVisibility )

Parameters

bool $activationVisibility

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

    {
        $this->activationVisibility = $activationVisibility;
    }

References $activationVisibility.

Referenced by loadRepositoryActivationSettings().

Here is the caller graph for this function:

◆ setCustomActivityId()

ilObjLTIConsumer::setCustomActivityId ( string $custom_activity_id )

Parameters

string $custom_activity_id

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

    {
        $this->custom_activity_id = $custom_activity_id;
    }

References $custom_activity_id.

Referenced by load().

Here is the caller graph for this function:

◆ setCustomLaunchKey()

ilObjLTIConsumer::setCustomLaunchKey ( string $customLaunchKey )

Parameters

string $customLaunchKey

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

    {
        $this->customLaunchKey = $customLaunchKey;
    }

References $customLaunchKey.

Referenced by load().

Here is the caller graph for this function:

◆ setCustomLaunchSecret()

ilObjLTIConsumer::setCustomLaunchSecret ( string $customLaunchSecret )

Parameters

string $customLaunchSecret

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

    {
        $this->customLaunchSecret = $customLaunchSecret;
    }

References $customLaunchSecret.

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

Here is the caller graph for this function:

◆ setHighscoreAchievedTS()

ilObjLTIConsumer::setHighscoreAchievedTS ( $a_achieved_ts )

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

Parameters

bool $a_achieved_ts

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

    {
        $this->_highscore_achieved_ts = (bool) $a_achieved_ts;
    }

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

Here is the caller graph for this function:

◆ setHighscoreEnabled()

ilObjLTIConsumer::setHighscoreEnabled ( $a_enabled )

Sets if the highscore feature should be enabled.

Parameters

bool $a_enabled

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

    {
        $this->_highscore_enabled = (bool) $a_enabled;
    }

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

Here is the caller graph for this function:

◆ setHighscoreMode()

ilObjLTIConsumer::setHighscoreMode ( $mode )

Parameters

$mode int

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

    {
        switch ($mode) {
            case self::HIGHSCORE_SHOW_ALL_TABLES:
                $this->setHighscoreTopTable(1);
                $this->setHighscoreOwnTable(1);
                break;
 
            case self::HIGHSCORE_SHOW_TOP_TABLE:
                $this->setHighscoreTopTable(1);
                $this->setHighscoreOwnTable(0);
                break;
 
            case self::HIGHSCORE_SHOW_OWN_TABLE:
            default:
                $this->setHighscoreTopTable(0);
                $this->setHighscoreOwnTable(1);
                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 ( $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 632 of file class.ilObjLTIConsumer.php.

    {
        $this->_highscore_own_table = (bool) $a_own_table;
    }

Referenced by load(), and setHighscoreMode().

Here is the caller graph for this function:

◆ setHighscorePercentage()

ilObjLTIConsumer::setHighscorePercentage ( $a_percentage )

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

Parameters

bool $a_percentage

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

    {
        $this->_highscore_percentage = (bool) $a_percentage;
    }

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

Here is the caller graph for this function:

◆ setHighscoreTopNum()

ilObjLTIConsumer::setHighscoreTopNum ( $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 673 of file class.ilObjLTIConsumer.php.

    {
        $this->_highscore_top_num = (int) $a_top_num;
    }

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

Here is the caller graph for this function:

◆ setHighscoreTopTable()

ilObjLTIConsumer::setHighscoreTopTable ( $a_top_table )

Sets if the top-rankings table should be shown.

Parameters

bool $a_top_table

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

    {
        $this->_highscore_top_table = (bool) $a_top_table;
    }

Referenced by load(), and setHighscoreMode().

Here is the caller graph for this function:

◆ setHighscoreWTime()

ilObjLTIConsumer::setHighscoreWTime ( $a_wtime )

Sets if the workingtime of the scores should be shown.

Parameters

bool $a_wtime

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

    {
        $this->_highscore_wtime = (bool) $a_wtime;
    }

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

Here is the caller graph for this function:

◆ setLaunchMethod()

ilObjLTIConsumer::setLaunchMethod ( string $launchMethod )

Parameters

string $launchMethod

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

    {
        $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 )

Parameters

float $mastery_score

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

    {
        $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 )

Parameters

float $mastery_score_percent

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

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

◆ setProvider()

ilObjLTIConsumer::setProvider ( ilLTIConsumeProvider $provider )

Parameters

ilLTIConsumeProvider $provider

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

    {
        $this->provider = $provider;
    }

References $provider.

Referenced by load().

Here is the caller graph for this function:

◆ setProviderId()

ilObjLTIConsumer::setProviderId ( int $providerId )

Parameters

int $providerId

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

    {
        $this->providerId = $providerId;
    }

References $providerId.

Referenced by load().

Here is the caller graph for this function:

◆ setStatementsReportEnabled()

ilObjLTIConsumer::setStatementsReportEnabled ( $statementsReportEnabled )

Parameters

bool $statementsReportEnabled

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

    {
        $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 )

Parameters

bool $use_xapi

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

    {
        $this->use_xapi = $use_xapi;
    }

References $use_xapi.

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

Here is the caller graph for this function:

Field Documentation

◆ $_highscore_achieved_ts

ilObjLTIConsumer::$_highscore_achieved_ts = 1

protected

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

Referenced by getHighscoreAchievedTS().

◆ $_highscore_enabled

ilObjLTIConsumer::$_highscore_enabled = 0

protected

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

Referenced by getHighscoreEnabled().

◆ $_highscore_own_table

ilObjLTIConsumer::$_highscore_own_table = 1

protected

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

Referenced by getHighscoreOwnTable().

◆ $_highscore_percentage

ilObjLTIConsumer::$_highscore_percentage = 1

protected

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

Referenced by getHighscorePercentage().

◆ $_highscore_top_num

ilObjLTIConsumer::$_highscore_top_num = 10

protected

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

Referenced by getHighscoreTopNum().

◆ $_highscore_top_table

ilObjLTIConsumer::$_highscore_top_table = 1

protected

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

Referenced by getHighscoreTopTable().

◆ $_highscore_wtime

ilObjLTIConsumer::$_highscore_wtime = 1

protected

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

Referenced by getHighscoreWTime().

◆ $activationEndingTime

ilObjLTIConsumer::$activationEndingTime

protected

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

Referenced by getActivationEndingTime(), and setActivationEndingTime().

◆ $activationLimited

ilObjLTIConsumer::$activationLimited

protected

repository object activation settings (handled by ilObject)

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

Referenced by isActivationLimited(), and setActivationLimited().

◆ $activationStartingTime

ilObjLTIConsumer::$activationStartingTime

protected

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

Referenced by getActivationStartingTime(), and setActivationStartingTime().

◆ $activationVisibility

ilObjLTIConsumer::$activationVisibility

protected

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

Referenced by getActivationVisibility(), and setActivationVisibility().

◆ $anonymity

ilObjLTIConsumer::$anonymity = 0

protected

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

◆ $custom_activity_id

ilObjLTIConsumer::$custom_activity_id = ''

protected

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

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

◆ $customLaunchKey

ilObjLTIConsumer::$customLaunchKey = ''

protected

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

Referenced by getCustomLaunchKey(), and setCustomLaunchKey().

◆ $customLaunchSecret

ilObjLTIConsumer::$customLaunchSecret = ''

protected

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

Referenced by getCustomLaunchSecret(), and setCustomLaunchSecret().

◆ $launchMethod

ilObjLTIConsumer::$launchMethod = self::LAUNCH_METHOD_NEW_WIN

protected

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

Referenced by getLaunchMethod(), and setLaunchMethod().

◆ $mastery_score

ilObjLTIConsumer::$mastery_score = 0.5

protected

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

Referenced by getMasteryScore(), and setMasteryScore().

◆ $provider

ilObjLTIConsumer::$provider = null

protected

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

Referenced by getProvider(), and setProvider().

◆ $providerId

ilObjLTIConsumer::$providerId = 0

protected

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

Referenced by getProviderId(), and setProviderId().

◆ $statementsReportEnabled

ilObjLTIConsumer::$statementsReportEnabled = false

protected

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

Referenced by isStatementsReportEnabled(), and setStatementsReportEnabled().

◆ $use_xapi

ilObjLTIConsumer::$use_xapi = false

protected

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

Referenced by getUseXapi(), and setUseXapi().

◆ DB_TABLE_NAME

const ilObjLTIConsumer::DB_TABLE_NAME = 'lti_consumer_settings'

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

Referenced by dbTableName().

◆ HIGHSCORE_SHOW_ALL_TABLES

const ilObjLTIConsumer::HIGHSCORE_SHOW_ALL_TABLES = 1

Definition at line 540 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 542 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 541 of file class.ilObjLTIConsumer.php.

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

◆ LAUNCH_METHOD_EMBEDDED

const ilObjLTIConsumer::LAUNCH_METHOD_EMBEDDED = 'embedded'

Definition at line 38 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 37 of file class.ilObjLTIConsumer.php.

Referenced by ilLTIConsumerSettingsFormGUI\initForm().

◆ LAUNCH_METHOD_OWN_WIN

const ilObjLTIConsumer::LAUNCH_METHOD_OWN_WIN = 'ownWin'

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

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

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

Modules/LTIConsumer/classes/class.ilObjLTIConsumer.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildLaunchParameters()

◆ dbTableName()

◆ doRead()

◆ doUpdate()

◆ getActivationEndingTime()

◆ getActivationStartingTime()

◆ getActivationVisibility()

◆ getActivityId()

◆ getCustomActivityId()

◆ getCustomLaunchKey()

◆ getCustomLaunchSecret()

◆ getCustomParams()

◆ getHighscoreAchievedTS()

◆ getHighscoreEnabled()

◆ getHighscoreMode()

◆ getHighscoreOwnTable()

◆ getHighscorePercentage()

◆ getHighscoreTopNum()

◆ getHighscoreTopTable()

◆ getHighscoreWTime()

◆ getLaunchKey()

◆ getLaunchMethod()

◆ getLaunchSecret()

◆ getMasteryScore()

◆ getMasteryScorePercent()

◆ getProvider()

◆ getProviderId()

◆ getUseXapi()

◆ initProvider()

◆ initType()

◆ isActivationLimited()

◆ isLaunchMethodEmbedded()

◆ isLaunchMethodOwnWin()

◆ isStatementsReportEnabled()

◆ load()

◆ loadRepositoryActivationSettings()

◆ save()

◆ saveRepositoryActivationSettings()

◆ setActivationEndingTime()

◆ setActivationLimited()

◆ setActivationStartingTime()

◆ setActivationVisibility()

◆ setCustomActivityId()

◆ setCustomLaunchKey()

◆ setCustomLaunchSecret()

◆ setHighscoreAchievedTS()

◆ setHighscoreEnabled()

◆ setHighscoreMode()

◆ setHighscoreOwnTable()

◆ setHighscorePercentage()

◆ setHighscoreTopNum()

◆ setHighscoreTopTable()

◆ setHighscoreWTime()

◆ setLaunchMethod()

◆ setMasteryScore()

◆ setMasteryScorePercent()

◆ setProvider()

◆ setProviderId()

◆ setStatementsReportEnabled()

◆ setUseXapi()

Field Documentation

◆ $_highscore_achieved_ts

◆ $_highscore_enabled

◆ $_highscore_own_table

◆ $_highscore_percentage

◆ $_highscore_top_num

◆ $_highscore_top_table

◆ $_highscore_wtime

◆ $activationEndingTime

◆ $activationLimited