Inheritance diagram for ilObjCmiXapi:

Collaboration diagram for ilObjCmiXapi:

Public Member Functions
	__construct (int $a_id=0, bool $a_reference=true)
	ilObjCmiXapi constructor. More...

	getLrsTypeId ()

	setLrsTypeId (int $lrsTypeId)

	getLrsType ()

	setLrsType (\ilCmiXapiLrsType $lrsType)

	initLrsType ()

	getContentType ()

	setContentType (string $contentType)

	isMixedContentType ()

	getSourceType ()

	isSourceTypeRemote ()

	isSourceTypeExternal ()

	setSourceType (string $sourceType)

	getActivityId ()

	setActivityId (string $activityId)

	getPublisherId ()

	setPublisherId (string $publisherId)

	getInstructions ()

	setInstructions (string $instructions)

	getLaunchUrl ()

	setLaunchUrl (string $launchUrl)

	getLaunchParameters ()

	setLaunchParameters (string $launchParameters)

	getMoveOn ()
	Attention: this is the original imported moveOn for using in LaunchData and LaunchStatement use getLMSMoveOn! More...

	setMoveOn (string $moveOn)
	Attention: this is the original moveOn from course import should only be set on import! More...

	getLPMode ()
	only for internal LMS usage More...

	getLMSMoveOn ()
	for CMI5 statements \| state moveOn values More...

	getEntitlementKey ()

	setEntitlementKey (string $entitlementKey)

	isAuthFetchUrlEnabled ()

	setAuthFetchUrlEnabled (bool $authFetchUrlEnabled)

	getLaunchMethod ()

	setLaunchMethod (string $launchMethod)

	getLaunchMode ()

	setLaunchMode (string $launchMode)

	isSwitchToReviewEnabled ()

	getSwitchToReviewEnabled ()

	setSwitchToReviewEnabled (bool $switchToReviewEnabled)

	getMasteryScore ()

	setMasteryScore (float $masteryScore)

	getMasteryScorePercent ()

	setMasteryScorePercent (float $masteryScorePercent)

	isKeepLpStatusEnabled ()

	setKeepLpStatusEnabled (bool $keepLpStatusEnabled)

	getPrivacyIdent ()

	setPrivacyIdent (int $userIdent)

	getPrivacyName ()

	setPrivacyName (int $userName)

	getOnlyMoveon ()

	setOnlyMoveon (bool $only_moveon)

	getAchieved ()

	setAchieved (bool $achieved)

	getAnswered ()

	setAnswered (bool $answered)

	getCompleted ()

	setCompleted (bool $completed)

	getFailed ()

	setFailed (bool $failed)

	getInitialized ()

	setInitialized (bool $initialized)

	getPassed ()

	setPassed (bool $passed)

	getProgressed ()

	setProgressed (bool $progressed)

	getSatisfied ()

	setSatisfied (bool $satisfied)

	getTerminated ()

	setTerminated (bool $terminated)

	getHideData ()

	setHideData (bool $hide_data)

	getTimestamp ()

	setTimestamp (bool $timestamp)

	getDuration ()

	setDuration (bool $duration)

	getNoSubstatements ()

	setNoSubstatements (bool $no_substatements)

	getUserPrivacyComment ()

	setUserPrivacyComment (string $userPrivacyComment)

	isStatementsReportEnabled ()

	setStatementsReportEnabled (bool $statementsReportEnabled)

	getXmlManifest ()

	setXmlManifest (string $xmlManifest)

	getVersion ()

	setVersion (int $version)

	isBypassProxyEnabled ()

	setBypassProxyEnabled (bool $bypassProxyEnabled)

	save ()

	setHighscoreEnabled (bool $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 (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)

	getDataSetMapping ()

	getCurrentCmixUser ()

	getSessionId (?ilCmiXapiUser $cmixUser=null)

	getLaunchData (?ilCmiXapiUser $cmixUser=null, string $lang='en', ?int $launchedByRefId=null)
	LMS.LaunchData. More...

	getLaunchedContextTemplate (?ilCmiXapiUser $cmixUser=null)

	getStatement (string $verb, ?ilCmiXapiUser $cmixUser=null)
	blueprint statement More...

	getStatementActor (?ilCmiXapiUser $cmixUser=null)
	statement actor More...

	getStatementExtensions (?ilCmiXapiUser $cmixUser=null)
	Minimal extensions. More...

	getStatementContextActivities ()
	Minimal statementActivities. More...

	getStatementObject ()

	getLaunchedStatement (?ilCmiXapiUser $cmixUser=null)

	getAbandonedStatement (?string $sessionId, ?string $duration, ?ilCmiXapiUser $cmixUser=null)

	getSatisfiedStatement (?ilCmiXapiUser $cmixUser=null)

	getLastStatement (string $sess)
	get latest statement from session More...

	getLastStatementPipline (string $sess)

	isActivationLimited ()

	setActivationLimited (bool $activationLimited)

	getActivationStartingTime ()

	setActivationStartingTime (?int $activationStartingTime=null)

	getActivationEndingTime ()

	setActivationEndingTime (?int $activationEndingTime=null)

	getActivationVisibility ()

	setActivationVisibility (bool $activationVisibility)

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
	__construct (int $id=0, bool $reference=true)

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

	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)
	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	getInstance (int $a_id=0, bool $a_reference=true)

static	updatePrivacySettingsFromLrsType (ilCmiXapiLrsType $lrsType)

static	updateByPassProxyFromLrsType (ilCmiXapiLrsType $lrsType)

static	getObjectsHavingBypassProxyEnabledAndRegisteredUsers ()

static	guidv4 (?string $data=null)

static	iliasUrl ()

static	log ()

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	_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	PLUGIN = false

const	DB_TABLE_NAME = 'cmix_settings'

const	DB_USERS_TABLE_NAME = 'cmix_users'

const	DB_RESULTS_TABLE_NAME = 'cmix_results'

const	CONT_TYPE_GENERIC = 'generic'

const	CONT_TYPE_CMI5 = 'cmi5'

const	SRC_TYPE_REMOTE = 'remoteSource'

const	SRC_TYPE_LOCAL = 'localSource'

const	SRC_TYPE_EXTERNAL = 'externalSource'

const	ANONYMOUS_HOMEPAGE = 'https://example.org'

const	LAUNCH_METHOD_OWN_WIN = 'ownWin'

const	LAUNCH_METHOD_NEW_WIN = 'newWin'

const	LAUNCH_METHOD_IFRAME = 'iframe'

const	LAUNCH_MODE_NORMAL = 'Normal'

const	LAUNCH_MODE_BROWSE = 'Browse'

const	LAUNCH_MODE_REVIEW = 'Review'

const	LMS_MASTERY_SCORE = 0.7

const	PRIVACY_IDENT_IL_UUID_USER_ID = 0

const	PRIVACY_IDENT_IL_UUID_EXT_ACCOUNT = 1

const	PRIVACY_IDENT_IL_UUID_LOGIN = 2

const	PRIVACY_IDENT_REAL_EMAIL = 3

const	PRIVACY_IDENT_IL_UUID_RANDOM = 4

const	PRIVACY_IDENT_IL_UUID_SHA256 = 5

const	PRIVACY_IDENT_IL_UUID_SHA256URL = 6

const	PRIVACY_NAME_NONE = 0

const	PRIVACY_NAME_FIRSTNAME = 1

const	PRIVACY_NAME_LASTNAME = 2

const	PRIVACY_NAME_FULLNAME = 3

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

const	DESC_LENGTH = 128

const	LONG_DESC_LENGTH = 4000

const	TABLE_OBJECT_DATA = "object_data"

array	$objectList

string	$untranslatedTitle

Protected Member Functions
	initType ()

	doRead ()

	load ()

	doUpdate ()

	loadRepositoryActivationSettings ()

	saveRepositoryActivationSettings ()

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

	doDelete ()

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 = null
	repository object activation settings (handled by ilObject) More...

int	$activationStartingTime = null

int	$activationEndingTime = null

bool	$activationVisibility = null

int	$lrsTypeId

ilCmiXapiLrsType	$lrsType

string	$contentType

string	$sourceType

string	$activityId

string	$publisherId

string	$instructions

string	$launchUrl

string	$launchParameters

string	$moveOn

string	$entitlementKey

bool	$authFetchUrlEnabled = false

bool	$anonymousHomePage = false

string	$launchMethod

string	$launchMode

bool	$switchToReviewEnabled = false

float	$masteryScore

bool	$keepLpStatusEnabled = false

int	$userIdent

int	$userName

string	$userPrivacyComment = ""

bool	$statementsReportEnabled = false

string	$xmlManifest = ""

int	$version

bool	$bypassProxyEnabled = false

bool	$only_moveon = false

bool	$achieved = true

bool	$answered = true

bool	$completed = true

bool	$failed = true

bool	$initialized = true

bool	$passed = true

bool	$progressed = true

bool	$satisfied = true

bool	$terminated = true

bool	$hide_data = false

bool	$timestamp = false

bool	$duration = true

bool	$no_substatements = false

ilCmiXapiUser	$currentCmixUser = null

bool	$_highscore_enabled = false
	HIGHSCORE. More...

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

int	$id

bool	$referenced

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 = ""

bool	$offline = false

string	$desc = ""

string	$long_desc = ""

int	$owner = 0

string	$create_date = ""

string	$last_update = ""

string	$import_id = ""

bool	$register = false

Private Attributes
ilDBInterface	$database

Detailed Description

Definition at line 30 of file class.ilObjCmiXapi.php.

Constructor & Destructor Documentation

◆ __construct()

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

ilObjCmiXapi constructor.

Reimplemented from ilObject2.

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

    {
        global $DIC;
        $this->database = $DIC->database();
 
        $this->lrsTypeId = 0;
 
        $this->contentType = self::CONT_TYPE_GENERIC;
        $this->sourceType = self::SRC_TYPE_REMOTE;
 
        $this->activityId = '';
 
        $this->publisherId = '';
 
        $this->instructions = '';
 
        $this->launchUrl = '';
        $this->launchParameters = '';
        $this->moveOn = '';
        $this->entitlementKey = '';
 
        $this->authFetchUrlEnabled = false;
 
        $this->launchMethod = self::LAUNCH_METHOD_NEW_WIN;
        $this->launchMode = self::LAUNCH_MODE_NORMAL;
 
        $this->switchToReviewEnabled = true;
 
        $this->masteryScore = self::LMS_MASTERY_SCORE;
        $this->keepLpStatusEnabled = true;
 
        $this->userIdent = self::PRIVACY_IDENT_IL_UUID_USER_ID;
        $this->userName = self::PRIVACY_NAME_NONE;
        $this->userPrivacyComment = '';
 
        $this->currentCmixUser = null;
 
        $this->statementsReportEnabled = false;
 
        $this->xmlManifest = '';
        $this->version = 0;
 
        $this->bypassProxyEnabled = false;
 
        parent::__construct($a_id, $a_reference);
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), CONT_TYPE_GENERIC, LAUNCH_METHOD_NEW_WIN, LAUNCH_MODE_NORMAL, LMS_MASTERY_SCORE, PRIVACY_IDENT_IL_UUID_USER_ID, PRIVACY_NAME_NONE, and SRC_TYPE_REMOTE.

Here is the call graph for this function:

Member Function Documentation

◆ doCloneObject()

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

protected

Exceptions

ILIAS\Filesystem\Exception\DirectoryNotFoundException

Exceptions

ILIAS\Filesystem\Exception\FileNotFoundException

Exceptions

ILIAS\Filesystem\Exception\IOException

Reimplemented from ilObject2.

Definition at line 1228 of file class.ilObjCmiXapi.php.

                                                                                                  : void
    {
        assert($new_obj instanceof ilObjCmiXapi);
 
        $this->cloneMetaData($new_obj);
 
        $new_obj->setLrsTypeId($this->getLrsTypeId());
        $new_obj->setContentType($this->getContentType());
        $new_obj->setSourceType($this->getSourceType());
        $new_obj->setActivityId($this->getActivityId());
        $new_obj->setPublisherId($this->getPublisherId());
        $new_obj->setInstructions($this->getInstructions());
        $new_obj->setLaunchUrl($this->getLaunchUrl());
        $new_obj->setLaunchParameters($this->getLaunchParameters());
        $new_obj->setMoveOn($this->getMoveOn());
        $new_obj->setEntitlementKey($this->getEntitlementKey());
        $new_obj->setAuthFetchUrlEnabled($this->isAuthFetchUrlEnabled());
        $new_obj->setLaunchMethod($this->getLaunchMethod());
        $new_obj->setLaunchMode($this->getLaunchMode());
        $new_obj->setSwitchToReviewEnabled($this->isSwitchToReviewEnabled());
        $new_obj->setMasteryScore($this->getMasteryScore());
        $new_obj->setKeepLpStatusEnabled($this->isKeepLpStatusEnabled());
        $new_obj->setPrivacyIdent($this->getPrivacyIdent());
        $new_obj->setPrivacyName($this->getPrivacyName());
        $new_obj->setUserPrivacyComment($this->getUserPrivacyComment());
        $new_obj->setStatementsReportEnabled($this->isStatementsReportEnabled());
        $new_obj->setXmlManifest($this->getXmlManifest());
        $new_obj->setVersion($this->getVersion());
        $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());
        $new_obj->setBypassProxyEnabled($this->isBypassProxyEnabled());
        $new_obj->setOnlyMoveon($this->getOnlyMoveon());
        $new_obj->setAchieved($this->getAchieved());
        $new_obj->setAnswered($this->getAnswered());
        $new_obj->setCompleted($this->getCompleted());
        $new_obj->setFailed($this->getFailed());
        $new_obj->setInitialized($this->getInitialized());
        $new_obj->setPassed($this->getPassed());
        $new_obj->setProgressed($this->getProgressed());
        $new_obj->setSatisfied($this->getSatisfied());
        $new_obj->setTerminated($this->getTerminated());
        $new_obj->setHideData($this->getHideData());
        $new_obj->setTimestamp($this->getTimestamp());
        $new_obj->setDuration($this->getDuration());
        $new_obj->setNoSubstatements($this->getNoSubstatements());
        $new_obj->update();
 
        if ($this->getSourceType() == self::SRC_TYPE_LOCAL) {
            $dirUtil = new ilCmiXapiContentUploadImporter($new_obj);
            $dirUtil->ensureCreatedObjectDirectory();
            $newDir = implode(DIRECTORY_SEPARATOR, [ilFileUtils::getWebspaceDir(), $dirUtil->getWebDataDirRelativeObjectDirectory()]);
            $dirUtil = new ilCmiXapiContentUploadImporter($this);
            $thisDir = implode(DIRECTORY_SEPARATOR, [ilFileUtils::getWebspaceDir(), $dirUtil->getWebDataDirRelativeObjectDirectory()]);
            ilFileUtils::rCopy($thisDir, $newDir);
        }
    }

References ilObject2\cloneMetaData(), getAchieved(), getActivityId(), getAnswered(), getCompleted(), getContentType(), getDuration(), getEntitlementKey(), getFailed(), getHideData(), getHighscoreAchievedTS(), getHighscoreEnabled(), getHighscoreOwnTable(), getHighscorePercentage(), getHighscoreTopNum(), getHighscoreTopTable(), getHighscoreWTime(), getInitialized(), getInstructions(), getLaunchMethod(), getLaunchMode(), getLaunchParameters(), getLaunchUrl(), getLrsTypeId(), getMasteryScore(), getMoveOn(), getNoSubstatements(), getOnlyMoveon(), getPassed(), getPrivacyIdent(), getPrivacyName(), getProgressed(), getPublisherId(), getSatisfied(), getSourceType(), getTerminated(), getTimestamp(), getUserPrivacyComment(), getVersion(), ilFileUtils\getWebspaceDir(), getXmlManifest(), isAuthFetchUrlEnabled(), isBypassProxyEnabled(), isKeepLpStatusEnabled(), isStatementsReportEnabled(), isSwitchToReviewEnabled(), ilFileUtils\rCopy(), and ilObject2\update().

Here is the call graph for this function:

◆ doDelete()

ilObjCmiXapi::doDelete ( )

protected

Reimplemented from ilObject2.

Definition at line 1290 of file class.ilObjCmiXapi.php.

                                 : void
    {
        // delete file data entry
        $query = "DELETE FROM " . self::DB_TABLE_NAME . " WHERE obj_id = " . $this->database->quote($this->getId(), 'integer');
        $this->database->manipulate($query);
        ilHistory::_removeEntriesForObject($this->getId());
 
        // delete entire directory and its content
        $dirUtil = new ilCmiXapiContentUploadImporter($this);
        $thisDir = implode(DIRECTORY_SEPARATOR, [ilFileUtils::getWebspaceDir(), $dirUtil->getWebDataDirRelativeObjectDirectory()]);
        if (is_dir($thisDir)) {
            ilFileUtils::delDir($thisDir);
        }
 
        // delete meta data
        $this->deleteMetaData();
 
        //delete results
        $query = "DELETE FROM " . self::DB_RESULTS_TABLE_NAME .
                " WHERE obj_id = " . $this->database->quote($this->getId(), 'integer');
        $this->database->manipulate($query);
 
        // TODO check xapidel
    }

References $query, ilHistory\_removeEntriesForObject(), ilFileUtils\delDir(), ilObject\deleteMetaData(), ilObject\getId(), and ilFileUtils\getWebspaceDir().

Here is the call graph for this function:

◆ doRead()

ilObjCmiXapi::doRead ( )

protected

Reimplemented from ilObject2.

Definition at line 681 of file class.ilObjCmiXapi.php.

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

References load().

Referenced by getDataSetMapping().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doUpdate()

ilObjCmiXapi::doUpdate ( )

protected

Reimplemented from ilObject2.

Definition at line 757 of file class.ilObjCmiXapi.php.

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

References save().

Here is the call graph for this function:

◆ getAbandonedStatement()

ilObjCmiXapi::getAbandonedStatement	(	?string	$sessionId,
		?string	$duration,
		?ilCmiXapiUser	$cmixUser = `null`
	)

Returns: array<string, mixed>

Exceptions

Exception

Definition at line 1647 of file class.ilObjCmiXapi.php.

                                                                                                                 : array
    {
        if (null === $cmixUser) {
            $cmixUser = $this->getCurrentCmixUser();
        }
        $statement = $this->getStatement('abandoned', $cmixUser);
        // overwrite session with abandoned oldSession
        $statement['context']['extensions']['https://w3id.org/xapi/cmi5/context/extensions/sessionid'] = $sessionId;
        $statement['result'] = array(
            'duration' => $duration
        );
        return $statement;
    }

References $duration, getCurrentCmixUser(), and getStatement().

Here is the call graph for this function:

◆ getAchieved()

ilObjCmiXapi::getAchieved ( )

Definition at line 500 of file class.ilObjCmiXapi.php.

                                 : bool
    {
        return $this->achieved;
    }

References $achieved.

Referenced by doCloneObject(), getDataSetMapping(), and save().

Here is the caller graph for this function:

◆ getActivationEndingTime()

ilObjCmiXapi::getActivationEndingTime ( )

Definition at line 1814 of file class.ilObjCmiXapi.php.

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

References $activationEndingTime.

Referenced by saveRepositoryActivationSettings().

Here is the caller graph for this function:

◆ getActivationStartingTime()

ilObjCmiXapi::getActivationStartingTime ( )

Definition at line 1804 of file class.ilObjCmiXapi.php.

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

References $activationStartingTime.

Referenced by saveRepositoryActivationSettings().

Here is the caller graph for this function:

◆ getActivationVisibility()

ilObjCmiXapi::getActivationVisibility ( )

Definition at line 1824 of file class.ilObjCmiXapi.php.

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

References $activationVisibility.

Referenced by saveRepositoryActivationSettings().

Here is the caller graph for this function:

◆ getActivityId()

ilObjCmiXapi::getActivityId ( )

Definition at line 280 of file class.ilObjCmiXapi.php.

                                   : string
    {
        return $this->activityId;
    }

References $activityId.

Referenced by doCloneObject(), getDataSetMapping(), getLastStatementPipline(), getStatementContextActivities(), getStatementExtensions(), getStatementObject(), and save().

Here is the caller graph for this function:

◆ getAnswered()

ilObjCmiXapi::getAnswered ( )

Definition at line 510 of file class.ilObjCmiXapi.php.

                                 : bool
    {
        return $this->answered;
    }

References $answered.

Referenced by doCloneObject(), getDataSetMapping(), and save().

Here is the caller graph for this function:

◆ getCompleted()

ilObjCmiXapi::getCompleted ( )

Definition at line 520 of file class.ilObjCmiXapi.php.

                                  : bool
    {
        return $this->completed;
    }

References $completed.

Referenced by doCloneObject(), getDataSetMapping(), and save().

Here is the caller graph for this function:

◆ getContentType()

ilObjCmiXapi::getContentType ( )

Definition at line 238 of file class.ilObjCmiXapi.php.

                                    : string
    {
        return $this->contentType;
    }

References $contentType.

Referenced by doCloneObject(), getDataSetMapping(), getLastStatementPipline(), getStatementActor(), isMixedContentType(), and save().

Here is the caller graph for this function:

◆ getCurrentCmixUser()

ilObjCmiXapi::getCurrentCmixUser ( )

Definition at line 1351 of file class.ilObjCmiXapi.php.

                                        : \ilCmiXapiUser
    {
        global $DIC;
        if (null === $this->currentCmixUser) {
            $this->currentCmixUser = new ilCmiXapiUser($this->getId(), $DIC->user()->getId(), $this->getPrivacyIdent());
        }
        return $this->currentCmixUser;
    }

References $currentCmixUser, $DIC, and ilObject\getId().

Referenced by getAbandonedStatement(), getLaunchData(), getLaunchedContextTemplate(), getLaunchedStatement(), getSatisfiedStatement(), getSessionId(), getStatement(), getStatementActor(), and getStatementExtensions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDataSetMapping()

ilObjCmiXapi::getDataSetMapping ( )

Returns: array<string, float>|array<string, int>|array<string, string>

Definition at line 1169 of file class.ilObjCmiXapi.php.

                                       : array
    {
        if (null === ($lrsTypeId = $this->getLrsTypeId())) {
            $this->doRead();
        }
        return [
            'obj_id' => $this->getId(),
            'lrs_type_id' => $this->getLrsTypeId(),
            'content_type' => $this->getContentType(),
            'source_type' => $this->getSourceType(),
            'activity_id' => $this->getActivityId(),
            'publisher_id' => $this->getPublisherId(),
            'instructions' => $this->getInstructions(),
            'launch_url' => $this->getLaunchUrl(),
            'launch_parameters' => $this->getLaunchParameters(),
            'moveon' => $this->getMoveOn(),
            'entitlement_key' => $this->getEntitlementKey(),
            'auth_fetch_url' => (int) $this->isAuthFetchUrlEnabled(),
            'launch_method' => $this->getLaunchMethod(),
            'launch_mode' => $this->getLaunchMode(),
            'switch_to_review' => (int) $this->isSwitchToReviewEnabled(),
            'mastery_score' => $this->getMasteryScore(),
            'keep_lp' => (int) $this->isKeepLpStatusEnabled(),
            'privacy_ident' => $this->getPrivacyIdent(),
            'privacy_name' => $this->getPrivacyName(),
            'usr_privacy_comment' => $this->getUserPrivacyComment(),
            'show_statements' => (int) $this->isStatementsReportEnabled(),
            'xml_manifest' => $this->getXmlManifest(),
            'version' => $this->getVersion(),
            'highscore_enabled' => (int) $this->getHighscoreEnabled(),
            'highscore_achieved_ts' => (int) $this->getHighscoreAchievedTS(),
            'highscore_percentage' => (int) $this->getHighscorePercentage(),
            'highscore_wtime' => (int) $this->getHighscoreWTime(),
            'highscore_own_table' => (int) $this->getHighscoreOwnTable(),
            'highscore_top_table' => (int) $this->getHighscoreTopTable(),
            'highscore_top_num' => $this->getHighscoreTopNum(),
            'only_moveon' => (int) $this->getOnlyMoveon(),
            'achieved' => (int) $this->getAchieved(),
            'answered' => (int) $this->getAnswered(),
            'completed' => (int) $this->getCompleted(),
            'failed' => (int) $this->getFailed(),
            'initialized' => (int) $this->getInitialized(),
            'passed' => (int) $this->getPassed(),
            'progressed' => (int) $this->getProgressed(),
            'satisfied' => (int) $this->getSatisfied(),
            'c_terminated' => (int) $this->getTerminated(),
            'hide_data' => (int) $this->getHideData(),
            'c_timestamp' => (int) $this->getTimestamp(),
            'duration' => (int) $this->getDuration(),
            'no_substatements' => (int) $this->getNoSubstatements()
            //'bypass_proxy' => (int) $this->isBypassProxyEnabled()
        ];
    }

References $lrsTypeId, doRead(), getAchieved(), getActivityId(), getAnswered(), getCompleted(), getContentType(), getDuration(), getEntitlementKey(), getFailed(), getHideData(), getHighscoreAchievedTS(), getHighscoreEnabled(), getHighscoreOwnTable(), getHighscorePercentage(), getHighscoreTopNum(), getHighscoreTopTable(), getHighscoreWTime(), ilObject\getId(), getInitialized(), getInstructions(), getLaunchMethod(), getLaunchMode(), getLaunchParameters(), getLaunchUrl(), getLrsTypeId(), getMasteryScore(), getMoveOn(), getNoSubstatements(), getOnlyMoveon(), getPassed(), getPrivacyIdent(), getPrivacyName(), getProgressed(), getPublisherId(), getSatisfied(), getSourceType(), getTerminated(), getTimestamp(), getUserPrivacyComment(), getVersion(), getXmlManifest(), ILIAS\Repository\int(), isAuthFetchUrlEnabled(), isKeepLpStatusEnabled(), isStatementsReportEnabled(), and isSwitchToReviewEnabled().

Here is the call graph for this function:

◆ getDuration()

ilObjCmiXapi::getDuration ( )

Definition at line 610 of file class.ilObjCmiXapi.php.

                                 : bool
    {
        return $this->duration;
    }

References $duration.

Referenced by doCloneObject(), getDataSetMapping(), and save().

Here is the caller graph for this function:

◆ getEntitlementKey()

ilObjCmiXapi::getEntitlementKey ( )

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

                                       : string
    {
        return $this->entitlementKey;
    }

References $entitlementKey.

Referenced by doCloneObject(), getDataSetMapping(), getLaunchData(), and save().

Here is the caller graph for this function:

◆ getFailed()

ilObjCmiXapi::getFailed ( )

Definition at line 530 of file class.ilObjCmiXapi.php.

                               : bool
    {
        return $this->failed;
    }

References $failed.

Referenced by doCloneObject(), getDataSetMapping(), and save().

Here is the caller graph for this function:

◆ getHideData()

ilObjCmiXapi::getHideData ( )

Definition at line 590 of file class.ilObjCmiXapi.php.

                                 : bool
    {
        return $this->hide_data;
    }

References $hide_data.

Referenced by doCloneObject(), getDataSetMapping(), and save().

Here is the caller graph for this function:

◆ getHighscoreAchievedTS()

ilObjCmiXapi::getHighscoreAchievedTS ( )

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

Returns: bool True, if column should be shown.

Definition at line 1027 of file class.ilObjCmiXapi.php.

                                            : bool
    {
        return $this->_highscore_achieved_ts;
    }

References $_highscore_achieved_ts.

Referenced by doCloneObject(), getDataSetMapping(), and save().

Here is the caller graph for this function:

◆ getHighscoreEnabled()

ilObjCmiXapi::getHighscoreEnabled ( )

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

Returns: bool True, if highscore is enabled.

Definition at line 1010 of file class.ilObjCmiXapi.php.

                                         : bool
    {
        return $this->_highscore_enabled;
    }

References $_highscore_enabled.

Referenced by doCloneObject(), getDataSetMapping(), and save().

Here is the caller graph for this function:

◆ getHighscoreMode()

ilObjCmiXapi::getHighscoreMode ( )

Definition at line 1127 of file class.ilObjCmiXapi.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()

ilObjCmiXapi::getHighscoreOwnTable ( )

Gets if the own rankings table should be shown.

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

Definition at line 1079 of file class.ilObjCmiXapi.php.

                                          : bool
    {
        return $this->_highscore_own_table;
    }

References $_highscore_own_table.

Referenced by doCloneObject(), getDataSetMapping(), getHighscoreMode(), and save().

Here is the caller graph for this function:

◆ getHighscorePercentage()

ilObjCmiXapi::getHighscorePercentage ( )

Gets if the percentage column should be shown.

Returns: bool True, if percentage column should be shown.

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

                                            : bool
    {
        return $this->_highscore_percentage;
    }

References $_highscore_percentage.

Referenced by doCloneObject(), getDataSetMapping(), and save().

Here is the caller graph for this function:

◆ getHighscoreTopNum()

ilObjCmiXapi::getHighscoreTopNum ( ?int $a_retval = 10 )

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

Default: 10 entries

Parameters

int | null $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 1117 of file class.ilObjCmiXapi.php.

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

References $_highscore_top_num.

Referenced by doCloneObject(), getDataSetMapping(), and save().

Here is the caller graph for this function:

◆ getHighscoreTopTable()

ilObjCmiXapi::getHighscoreTopTable ( )

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

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

Definition at line 1096 of file class.ilObjCmiXapi.php.

                                          : bool
    {
        return $this->_highscore_top_table;
    }

References $_highscore_top_table.

Referenced by doCloneObject(), getDataSetMapping(), getHighscoreMode(), and save().

Here is the caller graph for this function:

◆ getHighscoreWTime()

ilObjCmiXapi::getHighscoreWTime ( )

Gets if the column with the workingtime should be shown.

Returns: bool True, if the workingtime column should be shown.

Definition at line 1061 of file class.ilObjCmiXapi.php.

                                       : bool
    {
        return $this->_highscore_wtime;
    }

References $_highscore_wtime.

Referenced by doCloneObject(), getDataSetMapping(), and save().

Here is the caller graph for this function:

◆ getInitialized()

ilObjCmiXapi::getInitialized ( )

Definition at line 540 of file class.ilObjCmiXapi.php.

                                    : bool
    {
        return $this->initialized;
    }

References $initialized.

Referenced by doCloneObject(), getDataSetMapping(), and save().

Here is the caller graph for this function:

◆ getInstance()

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

static

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

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

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

Here is the caller graph for this function:

◆ getInstructions()

ilObjCmiXapi::getInstructions ( )

Definition at line 300 of file class.ilObjCmiXapi.php.

                                     : string
    {
        return $this->instructions;
    }

References $instructions.

Referenced by doCloneObject(), getDataSetMapping(), and save().

Here is the caller graph for this function:

◆ getLastStatement()

ilObjCmiXapi::getLastStatement ( string $sess )

get latest statement from session

Returns: mixed|null

Definition at line 1683 of file class.ilObjCmiXapi.php.

    {
        global $DIC;
        $lrsType = $this->getLrsType();
 
        //$this->getLrsEndpoint())) . '/api/' . self::ENDPOINT_AGGREGATE_SUFFIX;
        $defaultLrs = $lrsType->getLrsEndpointStatementsAggregationLink();
        //$fallbackLrs = $lrsType->getLrsFallbackEndpoint();
        $defaultBasicAuth = $lrsType->getBasicAuth();
        //$fallbackBasicAuth = $lrsType->getFallbackBasicAuth();
        $defaultHeaders = [
            'X-Experience-API-Version' => '1.0.3',
            'Authorization' => $defaultBasicAuth,
            'Cache-Control' => 'no-cache, no-store, must-revalidate'
        ];
        /*
        $fallbackHeaders = [
            'X-Experience-API-Version' => '1.0.3',
            'Authorization' => $fallbackBasicAuth,
            'Content-Type' => 'application/json;charset=utf-8',
            'Cache-Control' => 'no-cache, no-store, must-revalidate'
        ];
        */
        $pipeline = json_encode($this->getLastStatementPipline($sess));
        $defaultLastStatementUrl = $defaultLrs . "?pipeline=" . urlencode($pipeline);
        $client = new GuzzleHttp\Client();
        $req_opts = array(
            GuzzleHttp\RequestOptions::VERIFY => true,
            GuzzleHttp\RequestOptions::CONNECT_TIMEOUT => 10,
            GuzzleHttp\RequestOptions::HTTP_ERRORS => false
        );
        $defaultLastStatementRequest = new GuzzleHttp\Psr7\Request(
            'GET',
            $defaultLastStatementUrl,
            $defaultHeaders
        );
        $promises = array();
        $promises['defaultLastStatement'] = $client->sendAsync($defaultLastStatementRequest, $req_opts);
        try {
            $responses = GuzzleHttp\Promise\Utils::settle($promises)->wait();
            $body = '';
            ilCmiXapiAbstractRequest::checkResponse($responses['defaultLastStatement'], $body, [200]);
            return json_decode($body, (bool) JSON_OBJECT_AS_ARRAY);
        } catch (Exception $e) {
            $this->log()->error('error:' . $e->getMessage());
            return null;
        }
    }

References $client, $DIC, Vendor\Package\$e, $lrsType, ilCmiXapiAbstractRequest\checkResponse(), ilCmiXapiLrsType\getBasicAuth(), getLastStatementPipline(), ilCmiXapiLrsType\getLrsEndpointStatementsAggregationLink(), getLrsType(), and log().

Here is the call graph for this function:

◆ getLastStatementPipline()

ilObjCmiXapi::getLastStatementPipline ( string $sess )

Returns: array<int, mixed[]>

Definition at line 1735 of file class.ilObjCmiXapi.php.

                                                         : array
    {
        global $DIC;
        $pipeline = array();
 
        // filter activityId
        $match = array();
        $match['statement.object.objectType'] = 'Activity';
        $match['statement.actor.objectType'] = 'Agent';
 
        $activityId = array();
 
        if ($this->getContentType() == ilObjCmiXapi::CONT_TYPE_CMI5 && !$this->isMixedContentType()) {
            // https://github.com/AICC/CMI-5_Spec_Current/blob/quartz/cmi5_spec.md#963-extensions
            $activityId['statement.context.extensions.https://ilias&46;de/cmi5/activityid'] = $this->getActivityId();
        } else {
            $activityQuery = [
                '$regex' => '^' . preg_quote($this->getActivityId()) . ''
            ];
            $activityId['$or'] = [];
            $activityId['$or'][] = ['statement.object.id' => $activityQuery];
            $activityId['$or'][] = ['statement.context.contextActivities.parent.id' => $activityQuery];
        }
 
        $sessionId = array();
        $sessionId['statement.context.extensions.https://w3id&46;org/xapi/cmi5/context/extensions/sessionid'] = $sess;
        $match['$and'] = array();
        $match['$and'][] = $activityId;
        $match['$and'][] = $sessionId;
        $sort = array('statement.timestamp' => -1);
        $project = array('statement.timestamp' => 1, 'statement.verb.id' => 1);
        $pipeline[] = array('$match' => $match);
        $pipeline[] = array('$sort' => $sort);
        $pipeline[] = array('$limit' => 1);
        $pipeline[] = array('$project' => $project);
 
        return $pipeline;
    }

References $activityId, $DIC, CONT_TYPE_CMI5, getActivityId(), getContentType(), and isMixedContentType().

Referenced by getLastStatement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLaunchData()

ilObjCmiXapi::getLaunchData	(	?ilCmiXapiUser	$cmixUser = `null`,
		string	$lang = `'en'`,
		?int	$launchedByRefId = `null`
	)

LMS.LaunchData.

Returns: array<string, mixed>

Definition at line 1375 of file class.ilObjCmiXapi.php.

                                                                                                                     : array
    {
        global $DIC;
        if (null === $cmixUser) {
            $cmixUser = $this->getCurrentCmixUser();
        }
        // ToDo
        $moveOn = $this->getLMSMoveOn();
        if (!$moveOn || $moveOn == '') {
            $moveOn = 'Completed';
        }
        $launchMode = $this->getLaunchMode();
        // only check switch if self::LAUNCH_MODE_NORMAL
        if ($launchMode == self::LAUNCH_MODE_NORMAL) {
            if ($cmixUser->getSatisfied() && $this->isSwitchToReviewEnabled()) {
                $launchMode = self::LAUNCH_MODE_REVIEW;
            }
        }
        $ctxTemplate = [
            "contextTemplate" => $this->getLaunchedContextTemplate($cmixUser),
            "launchMode" => ucfirst($launchMode),
            "launchMethod" => "OwnWindow",
            "moveOn" => $moveOn
        ];
        $lmsLaunchMethod = $this->getLaunchMethod();
        if ($lmsLaunchMethod === "ownWin") {
            if (is_int($launchedByRefId)) {
                $href = ilLink::_getStaticLink(
                    $launchedByRefId,
                    ilObject::_lookupType(ilObject::_lookupObjId($launchedByRefId))
                );
            } else {
                $href = ilLink::_getStaticLink(
                    $this->getRefId(),
                    $this->getType()
                );
            }
            $ctxTemplate['returnURL'] = $href;
        } else {
            $ctxTemplate['returnURL'] = ILIAS_HTTP_PATH . "/Modules/CmiXapi/xapiexit.php?lang={$lang}";
        }
        if (!empty($this->getMasteryScore())) {
            $ctxTemplate['masteryScore'] = $this->getMasteryScore();
        }
        if (!empty($this->getLaunchParameters())) {
            $ctxTemplate['launchParameters'] = $this->getLaunchParameters();
        }
        if (!empty($this->getEntitlementKey())) {
            $ctxTemplate['entitlementKey'] = array("courseStructure" => $this->getEntitlementKey());
        }
        return $ctxTemplate;
    }

References $DIC, $launchMode, $moveOn, ilLink\_getStaticLink(), ilObject\_lookupObjId(), ilObject\_lookupType(), getCurrentCmixUser(), getEntitlementKey(), getLaunchedContextTemplate(), getLaunchMethod(), getLaunchMode(), getLaunchParameters(), getLMSMoveOn(), getMasteryScore(), ilObject\getRefId(), ilObject\getType(), and LAUNCH_MODE_REVIEW.

Here is the call graph for this function:

◆ getLaunchedContextTemplate()

ilObjCmiXapi::getLaunchedContextTemplate ( ?ilCmiXapiUser $cmixUser = null )

Returns: array<string, mixed>

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

                                                                               : array
    {
        if (null === $cmixUser) {
            $cmixUser = $this->getCurrentCmixUser();
        }
        $launchMode = $this->getLaunchMode();
        // only check switch if self::LAUNCH_MODE_NORMAL
        if ($launchMode == self::LAUNCH_MODE_NORMAL) {
            if ($cmixUser->getSatisfied() && $this->isSwitchToReviewEnabled()) {
                $launchMode = self::LAUNCH_MODE_REVIEW;
            }
        }
        $extensions = $this->getStatementExtensions($cmixUser);
        $extensions['https://w3id.org/xapi/cmi5/context/extensions/launchmode'] = $launchMode;
        if (!empty($this->getLMSMoveOn())) {
            $extensions['https://w3id.org/xapi/cmi5/context/extensions/moveon'] = $this->getLMSMoveOn();
        }
        if (!empty($this->getLaunchParameters())) {
            $extensions['https://w3id.org/xapi/cmi5/context/extensions/launchparameters'] = $this->getLaunchParameters();
        }
        if (!empty($this->getMasteryScore())) {
            $extensions['https://w3id.org/xapi/cmi5/context/extensions/masteryscore'] = $this->getMasteryScore();
        }
        return array(
            "contextActivities" => $this->getStatementContextActivities(),
            "extensions" => $extensions
        );
    }

References $launchMode, getCurrentCmixUser(), getLaunchMode(), getLaunchParameters(), getLMSMoveOn(), getMasteryScore(), getStatementContextActivities(), getStatementExtensions(), and LAUNCH_MODE_REVIEW.

Referenced by getLaunchData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLaunchedStatement()

ilObjCmiXapi::getLaunchedStatement ( ?ilCmiXapiUser $cmixUser = null )

Returns: array<string, mixed>

Exceptions

Exception

Definition at line 1616 of file class.ilObjCmiXapi.php.

                                                                         : array
    {
        if (null === $cmixUser) {
            $cmixUser = $this->getCurrentCmixUser();
        }
        $launchMode = $this->getLaunchMode();
        // only check switch if self::LAUNCH_MODE_NORMAL
        if ($launchMode == self::LAUNCH_MODE_NORMAL) {
            if ($cmixUser->getSatisfied() && $this->isSwitchToReviewEnabled()) {
                $launchMode = self::LAUNCH_MODE_REVIEW;
            }
        }
 
        $statement = $this->getStatement('launched', $cmixUser);
        $statement['context']['extensions']['https://w3id.org/xapi/cmi5/context/extensions/launchmode'] = $launchMode;
        if (!empty($this->getLMSMoveOn())) {
            $statement['context']['extensions']['https://w3id.org/xapi/cmi5/context/extensions/moveon'] = $this->getLMSMoveOn();
        }
        if (!empty($this->getLaunchParameters())) {
            $statement['context']['extensions']['https://w3id.org/xapi/cmi5/context/extensions/launchparameters'] = $this->getLaunchParameters();
        }
        if (!empty($this->getMasteryScore())) {
            $statement['context']['extensions']['https://w3id.org/xapi/cmi5/context/extensions/masteryscore'] = $this->getMasteryScore();
        }
        return $statement;
    }

References $launchMode, getCurrentCmixUser(), getLaunchMode(), getLaunchParameters(), getLMSMoveOn(), getMasteryScore(), getStatement(), and LAUNCH_MODE_REVIEW.

Here is the call graph for this function:

◆ getLaunchMethod()

ilObjCmiXapi::getLaunchMethod ( )

Definition at line 405 of file class.ilObjCmiXapi.php.

                                     : string
    {
        return $this->launchMethod;
    }

References $launchMethod.

Referenced by doCloneObject(), getDataSetMapping(), getLaunchData(), and save().

Here is the caller graph for this function:

◆ getLaunchMode()

ilObjCmiXapi::getLaunchMode ( )

Definition at line 415 of file class.ilObjCmiXapi.php.

                                   : string
    {
        return ucfirst($this->launchMode);
    }

Referenced by doCloneObject(), getDataSetMapping(), getLaunchData(), getLaunchedContextTemplate(), getLaunchedStatement(), and save().

Here is the caller graph for this function:

◆ getLaunchParameters()

ilObjCmiXapi::getLaunchParameters ( )

Definition at line 320 of file class.ilObjCmiXapi.php.

                                         : string
    {
        return $this->launchParameters;
    }

References $launchParameters.

Referenced by doCloneObject(), getDataSetMapping(), getLaunchData(), getLaunchedContextTemplate(), getLaunchedStatement(), and save().

Here is the caller graph for this function:

◆ getLaunchUrl()

ilObjCmiXapi::getLaunchUrl ( )

Definition at line 310 of file class.ilObjCmiXapi.php.

                                  : string
    {
        return $this->launchUrl;
    }

References $launchUrl.

Referenced by doCloneObject(), getDataSetMapping(), and save().

Here is the caller graph for this function:

◆ getLMSMoveOn()

ilObjCmiXapi::getLMSMoveOn ( )

for CMI5 statements | state moveOn values

Returns: string ilCmiXapiLP::const

Definition at line 362 of file class.ilObjCmiXapi.php.

                                  : string
    {
        $moveOn = ilCmiXapiLP::MOVEON_NOT_APPLICABLE;
        switch ($this->getLPMode()) {
            case ilLPObjSettings::LP_MODE_DEACTIVATED:
                $moveOn = ilCmiXapiLP::MOVEON_NOT_APPLICABLE;
                break;
            case ilLPObjSettings::LP_MODE_CMIX_COMPLETED:
            case ilLPObjSettings::LP_MODE_CMIX_COMPL_WITH_FAILED:
                $moveOn = ilCmiXapiLP::MOVEON_COMPLETED;
                break;
            case ilLPObjSettings::LP_MODE_CMIX_PASSED:
            case ilLPObjSettings::LP_MODE_CMIX_PASSED_WITH_FAILED:
                $moveOn = ilCmiXapiLP::MOVEON_PASSED;
                break;
            case ilLPObjSettings::LP_MODE_CMIX_COMPLETED_OR_PASSED:
            case ilLPObjSettings::LP_MODE_CMIX_COMPL_OR_PASSED_WITH_FAILED:
                $moveOn = ilCmiXapiLP::MOVEON_COMPLETED_OR_PASSED;
                break;
        }
        return $moveOn;
    }

References $moveOn, getLPMode(), ilLPObjSettings\LP_MODE_CMIX_COMPL_OR_PASSED_WITH_FAILED, ilLPObjSettings\LP_MODE_CMIX_COMPL_WITH_FAILED, ilLPObjSettings\LP_MODE_CMIX_COMPLETED, ilLPObjSettings\LP_MODE_CMIX_COMPLETED_OR_PASSED, ilLPObjSettings\LP_MODE_CMIX_PASSED, ilLPObjSettings\LP_MODE_CMIX_PASSED_WITH_FAILED, ilLPObjSettings\LP_MODE_DEACTIVATED, ilCmiXapiLP\MOVEON_COMPLETED, ilCmiXapiLP\MOVEON_COMPLETED_OR_PASSED, ilCmiXapiLP\MOVEON_NOT_APPLICABLE, and ilCmiXapiLP\MOVEON_PASSED.

Referenced by getLaunchData(), getLaunchedContextTemplate(), and getLaunchedStatement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLPMode()

ilObjCmiXapi::getLPMode ( )

only for internal LMS usage

Returns: int ilLPObjSettings::const

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

                               : int
    {
        $olp = ilObjectLP::getInstance($this->getId());
        return $olp->getCurrentMode();
    }

References ilObject\getId(), and ilObjectLP\getInstance().

Referenced by getLMSMoveOn().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLrsType()

ilObjCmiXapi::getLrsType ( )

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

                                : \ilCmiXapiLrsType
    {
        return $this->lrsType;
    }

References $lrsType.

Referenced by ilXapiCompliantStatementsReportLinkBuilder\__construct(), and getLastStatement().

Here is the caller graph for this function:

◆ getLrsTypeId()

ilObjCmiXapi::getLrsTypeId ( )

Definition at line 213 of file class.ilObjCmiXapi.php.

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

References $lrsTypeId.

Referenced by doCloneObject(), getDataSetMapping(), initLrsType(), and save().

Here is the caller graph for this function:

◆ getMasteryScore()

ilObjCmiXapi::getMasteryScore ( )

Definition at line 440 of file class.ilObjCmiXapi.php.

                                     : float
    {
        return $this->masteryScore;
    }

References $masteryScore.

Referenced by doCloneObject(), getDataSetMapping(), getLaunchData(), getLaunchedContextTemplate(), getLaunchedStatement(), and save().

Here is the caller graph for this function:

◆ getMasteryScorePercent()

ilObjCmiXapi::getMasteryScorePercent ( )

Definition at line 450 of file class.ilObjCmiXapi.php.

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

◆ getMoveOn()

ilObjCmiXapi::getMoveOn ( )

Attention: this is the original imported moveOn for using in LaunchData and LaunchStatement use getLMSMoveOn!

Definition at line 334 of file class.ilObjCmiXapi.php.

                               : string
    {
        return $this->moveOn;
    }

References $moveOn.

Referenced by doCloneObject(), getDataSetMapping(), and save().

Here is the caller graph for this function:

◆ getNoSubstatements()

ilObjCmiXapi::getNoSubstatements ( )

Definition at line 620 of file class.ilObjCmiXapi.php.

                                        : bool
    {
        return $this->no_substatements;
    }

References $no_substatements.

Referenced by doCloneObject(), getDataSetMapping(), and save().

Here is the caller graph for this function:

◆ getObjectsHavingBypassProxyEnabledAndRegisteredUsers()

static ilObjCmiXapi::getObjectsHavingBypassProxyEnabledAndRegisteredUsers ( )

static

Returns: mixed[]

Definition at line 952 of file class.ilObjCmiXapi.php.

                                                                                 : array
    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        // not possible: Move Global Access to Constructor
        $query = "
                        SELECT DISTINCT s.obj_id FROM " . self::DB_TABLE_NAME . " s
                        INNER JOIN " . self::DB_USERS_TABLE_NAME . " u ON u.obj_id = s.obj_id
                        WHERE bypass_proxy = %s
                ";
 
        $res = $DIC->database()->queryF($query, array('integer'), array(1));
 
        $objects = array();
 
        while ($row = $DIC->database()->fetchAssoc($res)) {
            $objects[] = (int) $row['obj_id'];
        }
 
        return $objects;
    }

References $DIC, $query, $res, and ILIAS\Repository\int().

Referenced by ilXapiResultsCronjob\getObjectsToBeReported().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOnlyMoveon()

ilObjCmiXapi::getOnlyMoveon ( )

Definition at line 490 of file class.ilObjCmiXapi.php.

                                   : bool
    {
        return $this->only_moveon;
    }

References $only_moveon.

Referenced by doCloneObject(), getDataSetMapping(), and save().

Here is the caller graph for this function:

◆ getPassed()

ilObjCmiXapi::getPassed ( )

Definition at line 550 of file class.ilObjCmiXapi.php.

                               : bool
    {
        return $this->passed;
    }

References $passed.

Referenced by doCloneObject(), getDataSetMapping(), and save().

Here is the caller graph for this function:

◆ getPrivacyIdent()

ilObjCmiXapi::getPrivacyIdent ( )

Definition at line 470 of file class.ilObjCmiXapi.php.

                                     : int
    {
        return $this->userIdent;
    }

References $userIdent.

Referenced by ilCmiXapiRegistrationGUI\__construct(), doCloneObject(), getDataSetMapping(), and save().

Here is the caller graph for this function:

◆ getPrivacyName()

ilObjCmiXapi::getPrivacyName ( )

Definition at line 480 of file class.ilObjCmiXapi.php.

                                    : int
    {
        return $this->userName;
    }

References $userName.

Referenced by doCloneObject(), getDataSetMapping(), getStatementActor(), and save().

Here is the caller graph for this function:

◆ getProgressed()

ilObjCmiXapi::getProgressed ( )

Definition at line 560 of file class.ilObjCmiXapi.php.

                                   : bool
    {
        return $this->progressed;
    }

References $progressed.

Referenced by doCloneObject(), getDataSetMapping(), and save().

Here is the caller graph for this function:

◆ getPublisherId()

ilObjCmiXapi::getPublisherId ( )

Definition at line 290 of file class.ilObjCmiXapi.php.

                                    : string
    {
        return $this->publisherId;
    }

References $publisherId.

Referenced by doCloneObject(), getDataSetMapping(), getStatementContextActivities(), isMixedContentType(), and save().

Here is the caller graph for this function:

◆ getSatisfied()

ilObjCmiXapi::getSatisfied ( )

Definition at line 570 of file class.ilObjCmiXapi.php.

                                  : bool
    {
        return $this->satisfied;
    }

References $satisfied.

Referenced by doCloneObject(), getDataSetMapping(), and save().

Here is the caller graph for this function:

◆ getSatisfiedStatement()

ilObjCmiXapi::getSatisfiedStatement ( ?ilCmiXapiUser $cmixUser = null )

Returns: array<string, mixed>

Exceptions

Exception

Definition at line 1665 of file class.ilObjCmiXapi.php.

                                                                          : array
    {
        if (null === $cmixUser) {
            $cmixUser = $this->getCurrentCmixUser();
        }
        $statement = $this->getStatement('satisfied', $cmixUser);
        // add type, see https://aicc.github.io/CMI-5_Spec_Current/samples/scenarios/16-not_applicable-no_launch/#satisfied-statement
        // see also: https://github.com/AICC/CMI-5_Spec_Current/blob/quartz/cmi5_spec.md#verbs_satisfied
        $type = "https://w3id.org/xapi/cmi5/activitytype/course";
        $statement['object']['definition']['type'] = $type;
        $statement['context']['contextActivities']['grouping'][0]['definition']['type'] = $type;
        return $statement;
    }

References ilObject\$type, getCurrentCmixUser(), and getStatement().

Here is the call graph for this function:

◆ getSessionId()

ilObjCmiXapi::getSessionId ( ?ilCmiXapiUser $cmixUser = null )

Exceptions

ilCmiXapiException

Definition at line 1363 of file class.ilObjCmiXapi.php.

                                                                 : string
    {
        if (null === $cmixUser) {
            $cmixUser = $this->getCurrentCmixUser();
        }
        return ilCmiXapiAuthToken::getCmi5SessionByUsrIdAndObjIdAndRefId($cmixUser->getUsrId(), $this->getId(), $this->getRefId());
    }

References ilCmiXapiAuthToken\getCmi5SessionByUsrIdAndObjIdAndRefId(), and getCurrentCmixUser().

Referenced by getStatementExtensions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSourceType()

ilObjCmiXapi::getSourceType ( )

Definition at line 260 of file class.ilObjCmiXapi.php.

                                   : string
    {
        return $this->sourceType;
    }

References $sourceType.

Referenced by doCloneObject(), getDataSetMapping(), and save().

Here is the caller graph for this function:

◆ getStatement()

ilObjCmiXapi::getStatement	(	string	$verb,
		?ilCmiXapiUser	$cmixUser = `null`
	)

blueprint statement

Returns: array<string, mixed>

Exceptions

Exception

Definition at line 1465 of file class.ilObjCmiXapi.php.

                                                                               : array
    {
        if (null === $cmixUser) {
            $cmixUser = $this->getCurrentCmixUser();
        }
        $id = self::guidv4();
        $actor = $this->getStatementActor($cmixUser);
        $verbUri = ilCmiXapiVerbList::getInstance()->getVerbUri($verb);
        $extensions = $this->getStatementExtensions($cmixUser);
        $registration = $cmixUser->getRegistration();
        $contextActivities = $this->getStatementContextActivities();
        $object = $this->getStatementObject();
        return array(
            'id' => $id,
            'actor' => $actor,
            'verb' =>
            array(
                'id' => $verbUri
            ),
            'context' =>
            array(
                'extensions' => $extensions,
                'registration' => $registration,
                'contextActivities' => $contextActivities
            ),
            'object' => $object
        );
    }

References ilObject\$id, getCurrentCmixUser(), ilCmiXapiVerbList\getInstance(), getStatementActor(), getStatementContextActivities(), getStatementExtensions(), getStatementObject(), and guidv4().

Referenced by getAbandonedStatement(), getLaunchedStatement(), and getSatisfiedStatement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStatementActor()

ilObjCmiXapi::getStatementActor ( ?ilCmiXapiUser $cmixUser = null )

statement actor

Returns: array<string, mixed[]>

Definition at line 1498 of file class.ilObjCmiXapi.php.

                                                                      : array
    {
        global $DIC;
        if (null === $cmixUser) {
            $cmixUser = $this->getCurrentCmixUser();
        }
        $user = new ilObjUser($cmixUser->getUsrId()); // ToDo: Caching Names
        $name = ilCmiXapiUser::getName($this->getPrivacyName(), $user);
        if ($name == '') {
            $this->log()->error('error: no name in cmixuser');
            $name = 'UNDEFINED';
        }
        $homePage = ($this->anonymousHomePage == true) ? self::ANONYMOUS_HOMEPAGE : self::iliasUrl();
        if ($this->getContentType() == self::CONT_TYPE_CMI5) {
            $actor = [
                'objectType' => 'Agent',
                'account' => [
                    'homePage' => $homePage,
                    'name' => $cmixUser->getUsrIdent()
                ]
            ];
            if ($name !== '') {
                $actor['name'] = $name;
            }
        } else {
            $actor = [
                'objectType' => 'Agent',
                'mbox' => 'mailto:' . $cmixUser->getUsrIdent()
            ];
            if ($name !== '') {
                $actor['name'] = $name;
            }
        }
        return $actor;
    }

References $DIC, $name, ilObject\$user, CONT_TYPE_CMI5, getContentType(), getCurrentCmixUser(), ilCmiXapiUser\getName(), getPrivacyName(), and log().

Referenced by getStatement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStatementContextActivities()

ilObjCmiXapi::getStatementContextActivities ( )

Minimal statementActivities.

Returns: array<string, array<int, array<string, array<string, array<string, string>>|string>>>

Definition at line 1554 of file class.ilObjCmiXapi.php.

                                                   : array
    {
        $publisherId = $this->getPublisherId();
        $activityId = $this->getActivityId();
        if (empty($publisherId)) {
            $publisherId = $activityId;
        }
        return array(
            "grouping" => [
                [
                "objectType" => "Activity",
                "id" => "{$publisherId}",
                'definition' =>
                array(
                    'name' =>
                    array(
                        'de-DE' => $this->getTitle(),
                        'en-US' => $this->getTitle()
                    ),
                    'description' =>
                    array(
                        'de-DE' => $this->getDescription(),
                        'en-US' => $this->getDescription()
                    )
                )]
            ],
            "category" => [
                [
                    "id" => "https://w3id.org/xapi/cmi5/context/categories/cmi5",
                    "objectType" => "Activity"
                ]
            ]
        );
    }

References $activityId, $publisherId, getActivityId(), ilObject\getDescription(), getPublisherId(), and ilObject\getTitle().

Referenced by getLaunchedContextTemplate(), and getStatement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStatementExtensions()

ilObjCmiXapi::getStatementExtensions ( ?ilCmiXapiUser $cmixUser = null )

Minimal extensions.

Returns: array<string, mixed>

Exceptions

ilCmiXapiException

Definition at line 1539 of file class.ilObjCmiXapi.php.

                                                                           : array
    {
        if (null === $cmixUser) {
            $cmixUser = $this->getCurrentCmixUser();
        }
        return array(
            'https://w3id.org/xapi/cmi5/context/extensions/sessionid' => $this->getSessionId($cmixUser),
            'https://ilias.de/cmi5/activityid' => $this->getActivityId()
        );
    }

References getActivityId(), getCurrentCmixUser(), and getSessionId().

Referenced by getLaunchedContextTemplate(), and getStatement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStatementObject()

ilObjCmiXapi::getStatementObject ( )

Returns: array<string, mixed[]>

Definition at line 1592 of file class.ilObjCmiXapi.php.

                                        : array
    {
        return array(
                'id' => $this->getActivityId(),
                'definition' =>
                array(
                    'name' =>
                    array(
                        'de-DE' => $this->getTitle(),
                        'en-US' => $this->getTitle()
                    ),
                    'description' =>
                    array(
                        'de-DE' => $this->getDescription(),
                        'en-US' => $this->getDescription()
                    )
                )
            );
    }

References getActivityId(), ilObject\getDescription(), and ilObject\getTitle().

Referenced by getStatement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSwitchToReviewEnabled()

ilObjCmiXapi::getSwitchToReviewEnabled ( )

Definition at line 430 of file class.ilObjCmiXapi.php.

                                              : bool
    {
        return $this->switchToReviewEnabled;
    }

References $switchToReviewEnabled.

◆ getTerminated()

ilObjCmiXapi::getTerminated ( )

Definition at line 580 of file class.ilObjCmiXapi.php.

                                   : bool
    {
        return $this->terminated;
    }

References $terminated.

Referenced by doCloneObject(), getDataSetMapping(), and save().

Here is the caller graph for this function:

◆ getTimestamp()

ilObjCmiXapi::getTimestamp ( )

Definition at line 600 of file class.ilObjCmiXapi.php.

                                  : bool
    {
        return $this->timestamp;
    }

References $timestamp.

Referenced by doCloneObject(), getDataSetMapping(), and save().

Here is the caller graph for this function:

◆ getUserPrivacyComment()

ilObjCmiXapi::getUserPrivacyComment ( )

Definition at line 630 of file class.ilObjCmiXapi.php.

                                           : string
    {
        return $this->userPrivacyComment;
    }

References $userPrivacyComment.

Referenced by doCloneObject(), getDataSetMapping(), and save().

Here is the caller graph for this function:

◆ getVersion()

ilObjCmiXapi::getVersion ( )

Definition at line 660 of file class.ilObjCmiXapi.php.

                                : int
    {
        return $this->version;
    }

References $version.

Referenced by doCloneObject(), getDataSetMapping(), and save().

Here is the caller graph for this function:

◆ getXmlManifest()

ilObjCmiXapi::getXmlManifest ( )

Definition at line 650 of file class.ilObjCmiXapi.php.

                                    : string
    {
        return $this->xmlManifest;
    }

References $xmlManifest.

Referenced by doCloneObject(), getDataSetMapping(), and save().

Here is the caller graph for this function:

◆ guidv4()

static ilObjCmiXapi::guidv4 ( ?string $data = null )

static

Exceptions

Exception

Definition at line 1336 of file class.ilObjCmiXapi.php.

                                                       : string
    {
        // Generate 16 bytes (128 bits) of random data or use the data passed into the function.
        $data ??= random_bytes(16);
        assert(strlen($data) == 16);
 
        // Set version to 0100
        $data[6] = chr(ord($data[6]) & 0x0f | 0x40);
        // Set bits 6-7 to 10
        $data[8] = chr(ord($data[8]) & 0x3f | 0x80);
 
        // Output the 36 character UUID.
        return vsprintf('%s%s-%s-%s-%s-%s%s%s', str_split(bin2hex($data), 4));
    }

References $data.

Referenced by ilCmiXapiLaunchGUI\CMI5preLaunch(), and getStatement().

Here is the caller graph for this function:

◆ iliasUrl()

static ilObjCmiXapi::iliasUrl ( )

static

Definition at line 1774 of file class.ilObjCmiXapi.php.

                                     : string
    {
        global $DIC;
        $regex = '/^(https?:\/\/[^\/]+).*/';
        preg_match($regex, (string) $DIC->http()->request()->getUri(), $request_parts);
        return $request_parts[1];
    }

References $DIC.

◆ initLrsType()

ilObjCmiXapi::initLrsType ( )

Definition at line 233 of file class.ilObjCmiXapi.php.

                                 : void
    {
        $this->setLrsType(new ilCmiXapiLrsType($this->getLrsTypeId()));
    }

References getLrsTypeId(), and setLrsType().

Referenced by load().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initType()

ilObjCmiXapi::initType ( )

protected

Reimplemented from ilObject2.

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

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

◆ isActivationLimited()

ilObjCmiXapi::isActivationLimited ( )

Definition at line 1793 of file class.ilObjCmiXapi.php.

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

References $activationLimited.

Referenced by saveRepositoryActivationSettings().

Here is the caller graph for this function:

◆ isAuthFetchUrlEnabled()

ilObjCmiXapi::isAuthFetchUrlEnabled ( )

Definition at line 395 of file class.ilObjCmiXapi.php.

                                           : bool
    {
        return $this->authFetchUrlEnabled;
    }

References $authFetchUrlEnabled.

Referenced by doCloneObject(), getDataSetMapping(), and save().

Here is the caller graph for this function:

◆ isBypassProxyEnabled()

ilObjCmiXapi::isBypassProxyEnabled ( )

Definition at line 670 of file class.ilObjCmiXapi.php.

                                          : bool
    {
        return $this->bypassProxyEnabled;
    }

References $bypassProxyEnabled.

Referenced by doCloneObject(), and save().

Here is the caller graph for this function:

◆ isKeepLpStatusEnabled()

ilObjCmiXapi::isKeepLpStatusEnabled ( )

Definition at line 460 of file class.ilObjCmiXapi.php.

                                           : bool
    {
        return $this->keepLpStatusEnabled;
    }

References $keepLpStatusEnabled.

Referenced by doCloneObject(), getDataSetMapping(), and save().

Here is the caller graph for this function:

◆ isMixedContentType()

ilObjCmiXapi::isMixedContentType ( )

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

                                        : bool
    {
        // after 21-07-24 and before cmi5 refactoring
        // launched before cmi5 refactoring ident in:    statement.actor.mbox
        // launched after  cmi5 refactoring ident in:    statement.actor.account.name
        return (($this->getContentType() == self::CONT_TYPE_CMI5) && empty($this->getPublisherId()));
    }

References getContentType(), and getPublisherId().

Referenced by getLastStatementPipline().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isSourceTypeExternal()

ilObjCmiXapi::isSourceTypeExternal ( )

Definition at line 270 of file class.ilObjCmiXapi.php.

                                          : bool
    {
        return $this->sourceType == self::SRC_TYPE_EXTERNAL;
    }

References SRC_TYPE_EXTERNAL.

◆ isSourceTypeRemote()

ilObjCmiXapi::isSourceTypeRemote ( )

Definition at line 265 of file class.ilObjCmiXapi.php.

                                        : bool
    {
        return $this->sourceType == self::SRC_TYPE_REMOTE;
    }

References SRC_TYPE_REMOTE.

◆ isStatementsReportEnabled()

ilObjCmiXapi::isStatementsReportEnabled ( )

Definition at line 640 of file class.ilObjCmiXapi.php.

                                               : bool
    {
        return $this->statementsReportEnabled;
    }

References $statementsReportEnabled.

Referenced by doCloneObject(), getDataSetMapping(), and save().

Here is the caller graph for this function:

◆ isSwitchToReviewEnabled()

ilObjCmiXapi::isSwitchToReviewEnabled ( )

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

                                             : bool
    {
        return $this->switchToReviewEnabled;
    }

References $switchToReviewEnabled.

Referenced by doCloneObject(), getDataSetMapping(), and save().

Here is the caller graph for this function:

◆ load()

ilObjCmiXapi::load ( )

protected

Definition at line 686 of file class.ilObjCmiXapi.php.

                             : void
    {
        $query = "SELECT * FROM " . self::DB_TABLE_NAME . " WHERE obj_id = %s";
        $res = $this->database->queryF($query, ['integer'], [$this->getId()]);
 
        while ($row = $this->database->fetchAssoc($res)) {
            if ($row['lrs_type_id']) {
                $this->setLrsTypeId((int) $row['lrs_type_id']);
                $this->initLrsType();
            }
 
            $this->setContentType((string) $row['content_type']);
            $this->setSourceType((string) $row['source_type']);
 
            $this->setActivityId((string) $row['activity_id']);
            $this->setPublisherId((string) $row['publisher_id']);
            $this->setInstructions((string) $row['instructions']);
 
            $this->setLaunchUrl((string) $row['launch_url']);
            $this->setLaunchParameters((string) $row['launch_parameters']);
            $this->setMoveOn((string) $row['moveon']);
            $this->setEntitlementKey((string) $row['entitlement_key']);
            $this->setAuthFetchUrlEnabled((bool) $row['auth_fetch_url']);
 
            $this->setLaunchMethod((string) $row['launch_method']);
 
            $this->setLaunchMode((string) $row['launch_mode']);
            $this->setSwitchToReviewEnabled((bool) $row['switch_to_review']);
            $this->setMasteryScore((float) $row['mastery_score']);
            $this->setKeepLpStatusEnabled((bool) $row['keep_lp']);
 
            $this->setPrivacyIdent((int) $row['privacy_ident']);
            $this->setPrivacyName((int) $row['privacy_name']);
 
            $this->setOnlyMoveon((bool) $row['only_moveon']);
            $this->setAchieved((bool) $row['achieved']);
            $this->setAnswered((bool) $row['answered']);
            $this->setCompleted((bool) $row['completed']);
            $this->setFailed((bool) $row['failed']);
            $this->setInitialized((bool) $row['initialized']);
            $this->setPassed((bool) $row['passed']);
            $this->setProgressed((bool) $row['progressed']);
            $this->setSatisfied((bool) $row['satisfied']);
            $this->setTerminated((bool) $row['c_terminated']);
            $this->setHideData((bool) $row['hide_data']);
            $this->setTimestamp((bool) $row['c_timestamp']);
            $this->setDuration((bool) $row['duration']);
            $this->setNoSubstatements((bool) $row['no_substatements']);
 
            $this->setUserPrivacyComment((string) $row['usr_privacy_comment']);
 
            $this->setStatementsReportEnabled((bool) $row['show_statements']);
 
            $this->setXmlManifest((string) $row['xml_manifest']);
            $this->setVersion((int) $row['version']);
 
            $this->setBypassProxyEnabled((bool) $row['bypass_proxy']);
 
            $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->loadRepositoryActivationSettings();
    }

References $query, $res, ilObject\getId(), initLrsType(), loadRepositoryActivationSettings(), setAchieved(), setActivityId(), setAnswered(), setAuthFetchUrlEnabled(), setBypassProxyEnabled(), setCompleted(), setContentType(), setDuration(), setEntitlementKey(), setFailed(), setHideData(), setHighscoreAchievedTS(), setHighscoreEnabled(), setHighscoreOwnTable(), setHighscorePercentage(), setHighscoreTopNum(), setHighscoreTopTable(), setHighscoreWTime(), setInitialized(), setInstructions(), setKeepLpStatusEnabled(), setLaunchMethod(), setLaunchMode(), setLaunchParameters(), setLaunchUrl(), setLrsTypeId(), setMasteryScore(), setMoveOn(), setNoSubstatements(), setOnlyMoveon(), setPassed(), setPrivacyIdent(), setPrivacyName(), setProgressed(), setPublisherId(), setSatisfied(), setSourceType(), setStatementsReportEnabled(), setSwitchToReviewEnabled(), setTerminated(), setTimestamp(), setUserPrivacyComment(), setVersion(), and setXmlManifest().

Referenced by doRead().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadRepositoryActivationSettings()

ilObjCmiXapi::loadRepositoryActivationSettings ( )

protected

Definition at line 818 of file class.ilObjCmiXapi.php.

                                                         : void
    {
        if ($this->ref_id) {
            $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:

◆ log()

static ilObjCmiXapi::log ( )

static

Definition at line 1782 of file class.ilObjCmiXapi.php.

                                : ilLogger
    {
        if (self::PLUGIN) {
            global $log;
            return $log;
        } else {
            return \ilLoggerFactory::getLogger('cmix');
        }
    }

References ilObject\$log.

Referenced by ilCmiXapiAbstractRequest\checkResponse(), ilCmiXapiStatementsReport\fetchObjectInfo(), ilCmiXapiStatementsReport\fetchObjectName(), getLastStatement(), getStatementActor(), and ilCmiXapiAbstractRequest\sendRequest().

Here is the caller graph for this function:

◆ save()

ilObjCmiXapi::save ( )

Definition at line 762 of file class.ilObjCmiXapi.php.

                          : void
    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        // not possible: Move Global Access to Constructor
        $DIC->database()->replace(self::DB_TABLE_NAME, [
            'obj_id' => ['integer', $this->getId()]
        ], [
            'lrs_type_id' => ['integer', $this->getLrsTypeId()],
            'content_type' => ['text', $this->getContentType()],
            'source_type' => ['text', $this->getSourceType()],
            'activity_id' => ['text', $this->getActivityId()],
            'publisher_id' => ['text', $this->getPublisherId()],
            'instructions' => ['text', $this->getInstructions()],
            'launch_url' => ['text', $this->getLaunchUrl()],
            'launch_parameters' => ['text', $this->getLaunchParameters()],
            'moveon' => ['text', $this->getMoveOn()],
            'entitlement_key' => ['text', $this->getEntitlementKey()],
            'auth_fetch_url' => ['integer', (int) $this->isAuthFetchUrlEnabled()],
            'launch_method' => ['text', $this->getLaunchMethod()],
            'launch_mode' => ['text', $this->getLaunchMode()],
            'switch_to_review' => ['integer', (int) $this->isSwitchToReviewEnabled()],
            'mastery_score' => ['float', $this->getMasteryScore()],
            'keep_lp' => ['integer', (int) $this->isKeepLpStatusEnabled()],
            'privacy_ident' => ['integer', $this->getPrivacyIdent()],
            'privacy_name' => ['integer', $this->getPrivacyName()],
            'usr_privacy_comment' => ['text', $this->getUserPrivacyComment()],
            'show_statements' => ['integer', (int) $this->isStatementsReportEnabled()],
            'xml_manifest' => ['text', $this->getXmlManifest()],
            'version' => ['integer', $this->getVersion()],
            'bypass_proxy' => ['integer', (int) $this->isBypassProxyEnabled()],
            '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()],
            'only_moveon' => ['integer', (int) $this->getOnlyMoveon()],
            'achieved' => ['integer', (int) $this->getAchieved()],
            'answered' => ['integer', (int) $this->getAnswered()],
            'completed' => ['integer', (int) $this->getCompleted()],
            'failed' => ['integer', (int) $this->getFailed()],
            'initialized' => ['integer', (int) $this->getInitialized()],
            'passed' => ['integer', (int) $this->getPassed()],
            'progressed' => ['integer', (int) $this->getProgressed()],
            'satisfied' => ['integer', (int) $this->getSatisfied()],
            'c_terminated' => ['integer', (int) $this->getTerminated()],
            'hide_data' => ['integer', (int) $this->getHideData()],
            'c_timestamp' => ['integer', (int) $this->getTimestamp()],
            'duration' => ['integer', (int) $this->getDuration()],
            'no_substatements' => ['integer', (int) $this->getNoSubstatements()]
        ]);
 
        $this->saveRepositoryActivationSettings();
    }

References $DIC, getAchieved(), getActivityId(), getAnswered(), getCompleted(), getContentType(), getDuration(), getEntitlementKey(), getFailed(), getHideData(), getHighscoreAchievedTS(), getHighscoreEnabled(), getHighscoreOwnTable(), getHighscorePercentage(), getHighscoreTopNum(), getHighscoreTopTable(), getHighscoreWTime(), ilObject\getId(), getInitialized(), getInstructions(), getLaunchMethod(), getLaunchMode(), getLaunchParameters(), getLaunchUrl(), getLrsTypeId(), getMasteryScore(), getMoveOn(), getNoSubstatements(), getOnlyMoveon(), getPassed(), getPrivacyIdent(), getPrivacyName(), getProgressed(), getPublisherId(), getSatisfied(), getSourceType(), getTerminated(), getTimestamp(), getUserPrivacyComment(), getVersion(), getXmlManifest(), isAuthFetchUrlEnabled(), isBypassProxyEnabled(), isKeepLpStatusEnabled(), isStatementsReportEnabled(), isSwitchToReviewEnabled(), and saveRepositoryActivationSettings().

Referenced by doUpdate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveRepositoryActivationSettings()

ilObjCmiXapi::saveRepositoryActivationSettings ( )

protected

Definition at line 843 of file class.ilObjCmiXapi.php.

                                                         : void
    {
        if ($this->ref_id) {
            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:

◆ setAchieved()

ilObjCmiXapi::setAchieved ( bool $achieved )

Definition at line 505 of file class.ilObjCmiXapi.php.

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

References $achieved.

Referenced by load().

Here is the caller graph for this function:

◆ setActivationEndingTime()

ilObjCmiXapi::setActivationEndingTime ( ?int $activationEndingTime = null )

Definition at line 1819 of file class.ilObjCmiXapi.php.

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

References $activationEndingTime.

Referenced by loadRepositoryActivationSettings().

Here is the caller graph for this function:

◆ setActivationLimited()

ilObjCmiXapi::setActivationLimited ( bool $activationLimited )

Definition at line 1799 of file class.ilObjCmiXapi.php.

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

References $activationLimited.

Referenced by loadRepositoryActivationSettings().

Here is the caller graph for this function:

◆ setActivationStartingTime()

ilObjCmiXapi::setActivationStartingTime ( ?int $activationStartingTime = null )

Definition at line 1809 of file class.ilObjCmiXapi.php.

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

References $activationStartingTime.

Referenced by loadRepositoryActivationSettings().

Here is the caller graph for this function:

◆ setActivationVisibility()

ilObjCmiXapi::setActivationVisibility ( bool $activationVisibility )

Definition at line 1829 of file class.ilObjCmiXapi.php.

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

References $activationVisibility.

Referenced by loadRepositoryActivationSettings().

Here is the caller graph for this function:

◆ setActivityId()

ilObjCmiXapi::setActivityId ( string $activityId )

Definition at line 285 of file class.ilObjCmiXapi.php.

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

References $activityId.

Referenced by load().

Here is the caller graph for this function:

◆ setAnswered()

ilObjCmiXapi::setAnswered ( bool $answered )

Definition at line 515 of file class.ilObjCmiXapi.php.

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

References $answered.

Referenced by load().

Here is the caller graph for this function:

◆ setAuthFetchUrlEnabled()

ilObjCmiXapi::setAuthFetchUrlEnabled ( bool $authFetchUrlEnabled )

Definition at line 400 of file class.ilObjCmiXapi.php.

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

References $authFetchUrlEnabled.

Referenced by load().

Here is the caller graph for this function:

◆ setBypassProxyEnabled()

ilObjCmiXapi::setBypassProxyEnabled ( bool $bypassProxyEnabled )

Definition at line 675 of file class.ilObjCmiXapi.php.

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

References $bypassProxyEnabled.

Referenced by load().

Here is the caller graph for this function:

◆ setCompleted()

ilObjCmiXapi::setCompleted ( bool $completed )

Definition at line 525 of file class.ilObjCmiXapi.php.

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

References $completed.

Referenced by load().

Here is the caller graph for this function:

◆ setContentType()

ilObjCmiXapi::setContentType ( string $contentType )

Definition at line 243 of file class.ilObjCmiXapi.php.

                                                       : void
    {
        //bug before 21-07-24
        if ($contentType == "learning") {
            $contentType = self::CONT_TYPE_GENERIC;
        }
        $this->contentType = $contentType;
    }

References $contentType, and CONT_TYPE_GENERIC.

Referenced by load().

Here is the caller graph for this function:

◆ setDuration()

ilObjCmiXapi::setDuration ( bool $duration )

Definition at line 615 of file class.ilObjCmiXapi.php.

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

References $duration.

Referenced by load().

Here is the caller graph for this function:

◆ setEntitlementKey()

ilObjCmiXapi::setEntitlementKey ( string $entitlementKey )

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

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

References $entitlementKey.

Referenced by load().

Here is the caller graph for this function:

◆ setFailed()

ilObjCmiXapi::setFailed ( bool $failed )

Definition at line 535 of file class.ilObjCmiXapi.php.

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

References $failed.

Referenced by load().

Here is the caller graph for this function:

◆ setHideData()

ilObjCmiXapi::setHideData ( bool $hide_data )

Definition at line 595 of file class.ilObjCmiXapi.php.

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

References $hide_data.

Referenced by load().

Here is the caller graph for this function:

◆ setHighscoreAchievedTS()

ilObjCmiXapi::setHighscoreAchievedTS ( bool $a_achieved_ts )

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

Definition at line 1018 of file class.ilObjCmiXapi.php.

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

Referenced by load().

Here is the caller graph for this function:

◆ setHighscoreEnabled()

ilObjCmiXapi::setHighscoreEnabled ( bool $a_enabled )

Sets if the highscore feature should be enabled.

Definition at line 1001 of file class.ilObjCmiXapi.php.

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

Referenced by load().

Here is the caller graph for this function:

◆ setHighscoreMode()

ilObjCmiXapi::setHighscoreMode ( int $mode )

Definition at line 1143 of file class.ilObjCmiXapi.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().

Here is the call graph for this function:

◆ setHighscoreOwnTable()

ilObjCmiXapi::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 1070 of file class.ilObjCmiXapi.php.

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

Referenced by load(), and setHighscoreMode().

Here is the caller graph for this function:

◆ setHighscorePercentage()

ilObjCmiXapi::setHighscorePercentage ( bool $a_percentage )

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

Definition at line 1035 of file class.ilObjCmiXapi.php.

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

Referenced by load().

Here is the caller graph for this function:

◆ setHighscoreTopNum()

ilObjCmiXapi::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 1106 of file class.ilObjCmiXapi.php.

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

Referenced by load().

Here is the caller graph for this function:

◆ setHighscoreTopTable()

ilObjCmiXapi::setHighscoreTopTable ( bool $a_top_table )

Sets if the top-rankings table should be shown.

Definition at line 1087 of file class.ilObjCmiXapi.php.

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

Referenced by load(), and setHighscoreMode().

Here is the caller graph for this function:

◆ setHighscoreWTime()

ilObjCmiXapi::setHighscoreWTime ( bool $a_wtime )

Sets if the workingtime of the scores should be shown.

Definition at line 1052 of file class.ilObjCmiXapi.php.

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

Referenced by load().

Here is the caller graph for this function:

◆ setInitialized()

ilObjCmiXapi::setInitialized ( bool $initialized )

Definition at line 545 of file class.ilObjCmiXapi.php.

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

References $initialized.

Referenced by load().

Here is the caller graph for this function:

◆ setInstructions()

ilObjCmiXapi::setInstructions ( string $instructions )

Definition at line 305 of file class.ilObjCmiXapi.php.

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

References $instructions.

Referenced by load().

Here is the caller graph for this function:

◆ setKeepLpStatusEnabled()

ilObjCmiXapi::setKeepLpStatusEnabled ( bool $keepLpStatusEnabled )

Definition at line 465 of file class.ilObjCmiXapi.php.

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

References $keepLpStatusEnabled.

Referenced by load().

Here is the caller graph for this function:

◆ setLaunchMethod()

ilObjCmiXapi::setLaunchMethod ( string $launchMethod )

Definition at line 410 of file class.ilObjCmiXapi.php.

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

References $launchMethod.

Referenced by load().

Here is the caller graph for this function:

◆ setLaunchMode()

ilObjCmiXapi::setLaunchMode ( string $launchMode )

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

                                                     : void
    {
        $this->launchMode = ucfirst($launchMode);
    }

References $launchMode.

Referenced by load().

Here is the caller graph for this function:

◆ setLaunchParameters()

ilObjCmiXapi::setLaunchParameters ( string $launchParameters )

Definition at line 325 of file class.ilObjCmiXapi.php.

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

References $launchParameters.

Referenced by load().

Here is the caller graph for this function:

◆ setLaunchUrl()

ilObjCmiXapi::setLaunchUrl ( string $launchUrl )

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

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

References $launchUrl.

Referenced by load().

Here is the caller graph for this function:

◆ setLrsType()

ilObjCmiXapi::setLrsType ( \ilCmiXapiLrsType $lrsType )

Definition at line 228 of file class.ilObjCmiXapi.php.

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

References $lrsType.

Referenced by initLrsType().

Here is the caller graph for this function:

◆ setLrsTypeId()

ilObjCmiXapi::setLrsTypeId ( int $lrsTypeId )

Definition at line 218 of file class.ilObjCmiXapi.php.

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

References $lrsTypeId.

Referenced by load().

Here is the caller graph for this function:

◆ setMasteryScore()

ilObjCmiXapi::setMasteryScore ( float $masteryScore )

Definition at line 445 of file class.ilObjCmiXapi.php.

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

References $masteryScore.

Referenced by load().

Here is the caller graph for this function:

◆ setMasteryScorePercent()

ilObjCmiXapi::setMasteryScorePercent ( float $masteryScorePercent )

Definition at line 455 of file class.ilObjCmiXapi.php.

                                                                      : void
    {
        $this->masteryScore = $masteryScorePercent / 100;
    }

◆ setMoveOn()

ilObjCmiXapi::setMoveOn ( string $moveOn )

Attention: this is the original moveOn from course import should only be set on import!

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

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

References $moveOn.

Referenced by load().

Here is the caller graph for this function:

◆ setNoSubstatements()

ilObjCmiXapi::setNoSubstatements ( bool $no_substatements )

Definition at line 625 of file class.ilObjCmiXapi.php.

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

References $no_substatements.

Referenced by load().

Here is the caller graph for this function:

◆ setOnlyMoveon()

ilObjCmiXapi::setOnlyMoveon ( bool $only_moveon )

Definition at line 495 of file class.ilObjCmiXapi.php.

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

References $only_moveon.

Referenced by load().

Here is the caller graph for this function:

◆ setPassed()

ilObjCmiXapi::setPassed ( bool $passed )

Definition at line 555 of file class.ilObjCmiXapi.php.

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

References $passed.

Referenced by load().

Here is the caller graph for this function:

◆ setPrivacyIdent()

ilObjCmiXapi::setPrivacyIdent ( int $userIdent )

Definition at line 475 of file class.ilObjCmiXapi.php.

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

References $userIdent.

Referenced by load().

Here is the caller graph for this function:

◆ setPrivacyName()

ilObjCmiXapi::setPrivacyName ( int $userName )

Definition at line 485 of file class.ilObjCmiXapi.php.

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

References $userName.

Referenced by load().

Here is the caller graph for this function:

◆ setProgressed()

ilObjCmiXapi::setProgressed ( bool $progressed )

Definition at line 565 of file class.ilObjCmiXapi.php.

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

References $progressed.

Referenced by load().

Here is the caller graph for this function:

◆ setPublisherId()

ilObjCmiXapi::setPublisherId ( string $publisherId )

Definition at line 295 of file class.ilObjCmiXapi.php.

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

References $publisherId.

Referenced by load().

Here is the caller graph for this function:

◆ setSatisfied()

ilObjCmiXapi::setSatisfied ( bool $satisfied )

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

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

References $satisfied.

Referenced by load().

Here is the caller graph for this function:

◆ setSourceType()

ilObjCmiXapi::setSourceType ( string $sourceType )

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

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

References $sourceType.

Referenced by load().

Here is the caller graph for this function:

◆ setStatementsReportEnabled()

ilObjCmiXapi::setStatementsReportEnabled ( bool $statementsReportEnabled )

Definition at line 645 of file class.ilObjCmiXapi.php.

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

References $statementsReportEnabled.

Referenced by load().

Here is the caller graph for this function:

◆ setSwitchToReviewEnabled()

ilObjCmiXapi::setSwitchToReviewEnabled ( bool $switchToReviewEnabled )

Definition at line 435 of file class.ilObjCmiXapi.php.

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

References $switchToReviewEnabled.

Referenced by load().

Here is the caller graph for this function:

◆ setTerminated()

ilObjCmiXapi::setTerminated ( bool $terminated )

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

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

References $terminated.

Referenced by load().

Here is the caller graph for this function:

◆ setTimestamp()

ilObjCmiXapi::setTimestamp ( bool $timestamp )

Definition at line 605 of file class.ilObjCmiXapi.php.

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

References $timestamp.

Referenced by load().

Here is the caller graph for this function:

◆ setUserPrivacyComment()

ilObjCmiXapi::setUserPrivacyComment ( string $userPrivacyComment )

Definition at line 635 of file class.ilObjCmiXapi.php.

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

References $userPrivacyComment.

Referenced by load().

Here is the caller graph for this function:

◆ setVersion()

ilObjCmiXapi::setVersion ( int $version )

Definition at line 665 of file class.ilObjCmiXapi.php.

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

References $version.

Referenced by load().

Here is the caller graph for this function:

◆ setXmlManifest()

ilObjCmiXapi::setXmlManifest ( string $xmlManifest )

Definition at line 655 of file class.ilObjCmiXapi.php.

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

References $xmlManifest.

Referenced by load().

Here is the caller graph for this function:

◆ updateByPassProxyFromLrsType()

static ilObjCmiXapi::updateByPassProxyFromLrsType ( ilCmiXapiLrsType $lrsType )

static

Definition at line 930 of file class.ilObjCmiXapi.php.

                                                                                  : void
    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        // not possible: Move Global Access to Constructor
        $tableName = self::DB_TABLE_NAME;
 
        $query = "
                        UPDATE {$tableName}
                        SET bypass_proxy = %s
                        WHERE lrs_type_id = %s
                ";
 
        $DIC->database()->manipulateF(
            $query,
            ['integer', 'integer'],
            [$lrsType->isBypassProxyEnabled(), $lrsType->getTypeId()]
        );
    }

References $DIC, $lrsType, $query, DB_TABLE_NAME, ilCmiXapiLrsType\getTypeId(), and ilCmiXapiLrsType\isBypassProxyEnabled().

Referenced by ilObjCmiXapiAdministrationGUI\saveLrsTypeFormCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updatePrivacySettingsFromLrsType()

static ilObjCmiXapi::updatePrivacySettingsFromLrsType ( ilCmiXapiLrsType $lrsType )

static

Definition at line 862 of file class.ilObjCmiXapi.php.

                                                                                      : void
    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        //not possible: Move Global Access to Constructor
        $tableName = self::DB_TABLE_NAME;
 
        $query = "
                        UPDATE {$tableName}
                        SET privacy_ident = %s,
                privacy_name = %s,
                only_moveon = %s,
                achieved = %s,
                answered = %s,
                completed = %s,
                failed = %s,
                initialized = %s,
                passed = %s,
                progressed = %s,
                satisfied = %s,
                c_terminated = %s,
                hide_data = %s,
                c_timestamp = %s,
                duration = %s,
                no_substatements = %s
            WHERE lrs_type_id = %s
                ";
 
        $DIC->database()->manipulateF(
            $query,
            ['integer',
             'integer',
             'integer',
             'integer',
             'integer',
             'integer',
             'integer',
             'integer',
             'integer',
             'integer',
             'integer',
             'integer',
             'integer',
             'integer',
             'integer',
             'integer',
             'integer'
            ],
            [$lrsType->getPrivacyIdent(),
             $lrsType->getPrivacyName(),
             $lrsType->getOnlyMoveon(),
             $lrsType->getAchieved(),
             $lrsType->getAnswered(),
             $lrsType->getCompleted(),
             $lrsType->getFailed(),
             $lrsType->getInitialized(),
             $lrsType->getPassed(),
             $lrsType->getProgressed(),
             $lrsType->getSatisfied(),
             $lrsType->getTerminated(),
             $lrsType->getHideData(),
             $lrsType->getTimestamp(),
             $lrsType->getDuration(),
             $lrsType->getNoSubstatements(),
             $lrsType->getTypeId()
            ]
        );
    }

Referenced by ilObjCmiXapiAdministrationGUI\saveLrsTypeFormCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $_highscore_achieved_ts

bool ilObjCmiXapi::$_highscore_achieved_ts = true

protected

Definition at line 982 of file class.ilObjCmiXapi.php.

Referenced by getHighscoreAchievedTS().

◆ $_highscore_enabled

bool ilObjCmiXapi::$_highscore_enabled = false

protected

HIGHSCORE.

Definition at line 978 of file class.ilObjCmiXapi.php.

Referenced by getHighscoreEnabled().

◆ $_highscore_own_table

bool ilObjCmiXapi::$_highscore_own_table = true

protected

Definition at line 988 of file class.ilObjCmiXapi.php.

Referenced by getHighscoreOwnTable().

◆ $_highscore_percentage

bool ilObjCmiXapi::$_highscore_percentage = true

protected

Definition at line 984 of file class.ilObjCmiXapi.php.

Referenced by getHighscorePercentage().

◆ $_highscore_top_num

int ilObjCmiXapi::$_highscore_top_num = 10

protected

Definition at line 992 of file class.ilObjCmiXapi.php.

Referenced by getHighscoreTopNum().

◆ $_highscore_top_table

bool ilObjCmiXapi::$_highscore_top_table = true

protected

Definition at line 990 of file class.ilObjCmiXapi.php.

Referenced by getHighscoreTopTable().

◆ $_highscore_wtime

bool ilObjCmiXapi::$_highscore_wtime = true

protected

Definition at line 986 of file class.ilObjCmiXapi.php.

Referenced by getHighscoreWTime().

◆ $achieved

bool ilObjCmiXapi::$achieved = true

protected

Definition at line 122 of file class.ilObjCmiXapi.php.

Referenced by getAchieved(), and setAchieved().

◆ $activationEndingTime

int ilObjCmiXapi::$activationEndingTime = null

protected

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

Referenced by getActivationEndingTime(), and setActivationEndingTime().

◆ $activationLimited

bool ilObjCmiXapi::$activationLimited = null

protected

repository object activation settings (handled by ilObject)

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

Referenced by isActivationLimited(), and setActivationLimited().

◆ $activationStartingTime

int ilObjCmiXapi::$activationStartingTime = null

protected

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

Referenced by getActivationStartingTime(), and setActivationStartingTime().

◆ $activationVisibility

bool ilObjCmiXapi::$activationVisibility = null

protected

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

Referenced by getActivationVisibility(), and setActivationVisibility().

◆ $activityId

string ilObjCmiXapi::$activityId

protected

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

Referenced by getActivityId(), getLastStatementPipline(), getStatementContextActivities(), and setActivityId().

◆ $anonymity

int ilObjCmiXapi::$anonymity = 0

protected

Definition at line 980 of file class.ilObjCmiXapi.php.

◆ $anonymousHomePage

bool ilObjCmiXapi::$anonymousHomePage = false

protected

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

◆ $answered

bool ilObjCmiXapi::$answered = true

protected

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

Referenced by getAnswered(), and setAnswered().

◆ $authFetchUrlEnabled

bool ilObjCmiXapi::$authFetchUrlEnabled = false

protected

Definition at line 73 of file class.ilObjCmiXapi.php.

Referenced by isAuthFetchUrlEnabled(), and setAuthFetchUrlEnabled().

◆ $bypassProxyEnabled

bool ilObjCmiXapi::$bypassProxyEnabled = false

protected

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

Referenced by isBypassProxyEnabled(), and setBypassProxyEnabled().

◆ $completed

bool ilObjCmiXapi::$completed = true

protected

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

Referenced by getCompleted(), and setCompleted().

◆ $contentType

string ilObjCmiXapi::$contentType

protected

Definition at line 50 of file class.ilObjCmiXapi.php.

Referenced by getContentType(), and setContentType().

◆ $currentCmixUser

ilCmiXapiUser ilObjCmiXapi::$currentCmixUser = null

protected

Definition at line 148 of file class.ilObjCmiXapi.php.

Referenced by getCurrentCmixUser().

◆ $database

ilDBInterface ilObjCmiXapi::$database

private

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

◆ $duration

bool ilObjCmiXapi::$duration = true

protected

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

Referenced by getAbandonedStatement(), getDuration(), and setDuration().

◆ $entitlementKey

string ilObjCmiXapi::$entitlementKey

protected

Definition at line 71 of file class.ilObjCmiXapi.php.

Referenced by getEntitlementKey(), and setEntitlementKey().

◆ $failed

bool ilObjCmiXapi::$failed = true

protected

Definition at line 128 of file class.ilObjCmiXapi.php.

Referenced by getFailed(), and setFailed().

◆ $hide_data

bool ilObjCmiXapi::$hide_data = false

protected

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

Referenced by getHideData(), and setHideData().

◆ $initialized

bool ilObjCmiXapi::$initialized = true

protected

Definition at line 130 of file class.ilObjCmiXapi.php.

Referenced by getInitialized(), and setInitialized().

◆ $instructions

string ilObjCmiXapi::$instructions

protected

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

Referenced by getInstructions(), and setInstructions().

◆ $keepLpStatusEnabled

bool ilObjCmiXapi::$keepLpStatusEnabled = false

protected

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

Referenced by isKeepLpStatusEnabled(), and setKeepLpStatusEnabled().

◆ $launchMethod

string ilObjCmiXapi::$launchMethod

protected

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

Referenced by getLaunchMethod(), and setLaunchMethod().

◆ $launchMode

string ilObjCmiXapi::$launchMode

protected

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

Referenced by getLaunchData(), getLaunchedContextTemplate(), getLaunchedStatement(), and setLaunchMode().

◆ $launchParameters

string ilObjCmiXapi::$launchParameters

protected

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

Referenced by getLaunchParameters(), and setLaunchParameters().

◆ $launchUrl

string ilObjCmiXapi::$launchUrl

protected

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

Referenced by getLaunchUrl(), and setLaunchUrl().

◆ $lrsType

ilCmiXapiLrsType ilObjCmiXapi::$lrsType

protected

Definition at line 48 of file class.ilObjCmiXapi.php.

Referenced by getLastStatement(), getLrsType(), setLrsType(), updateByPassProxyFromLrsType(), and updatePrivacySettingsFromLrsType().

◆ $lrsTypeId

int ilObjCmiXapi::$lrsTypeId

protected

Definition at line 46 of file class.ilObjCmiXapi.php.

Referenced by getDataSetMapping(), getLrsTypeId(), and setLrsTypeId().

◆ $masteryScore

float ilObjCmiXapi::$masteryScore

protected

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

Referenced by getMasteryScore(), and setMasteryScore().

◆ $moveOn

string ilObjCmiXapi::$moveOn

protected

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

Referenced by getLaunchData(), getLMSMoveOn(), getMoveOn(), and setMoveOn().

◆ $no_substatements

bool ilObjCmiXapi::$no_substatements = false

protected

Definition at line 146 of file class.ilObjCmiXapi.php.

Referenced by getNoSubstatements(), and setNoSubstatements().

◆ $only_moveon

bool ilObjCmiXapi::$only_moveon = false

protected

Definition at line 120 of file class.ilObjCmiXapi.php.

Referenced by getOnlyMoveon(), and setOnlyMoveon().

◆ $passed

bool ilObjCmiXapi::$passed = true

protected

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

Referenced by getPassed(), and setPassed().

◆ $progressed

bool ilObjCmiXapi::$progressed = true

protected

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

Referenced by getProgressed(), and setProgressed().

◆ $publisherId

string ilObjCmiXapi::$publisherId

protected

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

Referenced by getPublisherId(), getStatementContextActivities(), and setPublisherId().

◆ $satisfied

bool ilObjCmiXapi::$satisfied = true

protected

Definition at line 136 of file class.ilObjCmiXapi.php.

Referenced by getSatisfied(), and setSatisfied().

◆ $sourceType

string ilObjCmiXapi::$sourceType

protected

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

Referenced by getSourceType(), and setSourceType().

◆ $statementsReportEnabled

bool ilObjCmiXapi::$statementsReportEnabled = false

protected

Definition at line 112 of file class.ilObjCmiXapi.php.

Referenced by isStatementsReportEnabled(), and setStatementsReportEnabled().

◆ $switchToReviewEnabled

bool ilObjCmiXapi::$switchToReviewEnabled = false

protected

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

Referenced by getSwitchToReviewEnabled(), isSwitchToReviewEnabled(), and setSwitchToReviewEnabled().

◆ $terminated

bool ilObjCmiXapi::$terminated = true

protected

Definition at line 138 of file class.ilObjCmiXapi.php.

Referenced by getTerminated(), and setTerminated().

◆ $timestamp

bool ilObjCmiXapi::$timestamp = false

protected

Definition at line 142 of file class.ilObjCmiXapi.php.

Referenced by getTimestamp(), and setTimestamp().

◆ $userIdent

int ilObjCmiXapi::$userIdent

protected

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

Referenced by getPrivacyIdent(), and setPrivacyIdent().

◆ $userName

int ilObjCmiXapi::$userName

protected

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

Referenced by getPrivacyName(), and setPrivacyName().

◆ $userPrivacyComment

string ilObjCmiXapi::$userPrivacyComment = ""

protected

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

Referenced by getUserPrivacyComment(), and setUserPrivacyComment().

◆ $version

int ilObjCmiXapi::$version

protected

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

Referenced by getVersion(), and setVersion().

◆ $xmlManifest

string ilObjCmiXapi::$xmlManifest = ""

protected

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

Referenced by getXmlManifest(), and setXmlManifest().

◆ ANONYMOUS_HOMEPAGE

const ilObjCmiXapi::ANONYMOUS_HOMEPAGE = 'https://example.org'

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

◆ CONT_TYPE_CMI5

const ilObjCmiXapi::CONT_TYPE_CMI5 = 'cmi5'

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

Referenced by ilCmiXapiStatementsReportLinkBuilder\buildFilterStage(), ilCmiXapiSettingsGUI\buildForm(), ilCmiXapiStatementsReportLinkBuilder\buildOrderingStage(), ilCmiXapiHighscoreReportLinkBuilder\buildPipeline(), ilXapiStatementEvaluation\evaluateStatement(), ilCmiXapiStatementsReport\fetchActor(), ilXapiStatementEvaluation\getCmixUser(), getLastStatementPipline(), ilCmiXapiLaunchGUI\getLaunchParameters(), getStatementActor(), ilCmiXapiStatementsGUI\getVerbsPipline(), XapiProxy\XapiProxyRequest\handleGetStatementsRequest(), ilCmiXapiLaunchGUI\initCmixUser(), ilObjCmiXapiGUI\initCreateForm(), ilCmiXapiHighscoreReport\initTableData(), ilCmiXapiLaunchGUI\launchCmd(), and ilCmiXapiSettingsGUI\saveSettings().

◆ CONT_TYPE_GENERIC

const ilObjCmiXapi::CONT_TYPE_GENERIC = 'generic'

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

Referenced by __construct(), ilCmiXapiStatementsReport\__construct(), ilCmiXapiHighscoreReportLinkBuilder\buildFilterStage(), ilCmiXapiHighscoreReportLinkBuilder\buildPipeline(), ilObjCmiXapiGUI\initCreateForm(), and setContentType().

◆ DB_RESULTS_TABLE_NAME

const ilObjCmiXapi::DB_RESULTS_TABLE_NAME = 'cmix_results'

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

◆ DB_TABLE_NAME

const ilObjCmiXapi::DB_TABLE_NAME = 'cmix_settings'

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

Referenced by updateByPassProxyFromLrsType(), and updatePrivacySettingsFromLrsType().

◆ DB_USERS_TABLE_NAME

const ilObjCmiXapi::DB_USERS_TABLE_NAME = 'cmix_users'

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

◆ HIGHSCORE_SHOW_ALL_TABLES

const ilObjCmiXapi::HIGHSCORE_SHOW_ALL_TABLES = 1

Definition at line 994 of file class.ilObjCmiXapi.php.

Referenced by ilCmiXapiSettingsGUI\buildForm(), getHighscoreMode(), and setHighscoreMode().

◆ HIGHSCORE_SHOW_OWN_TABLE

const ilObjCmiXapi::HIGHSCORE_SHOW_OWN_TABLE = 3

Definition at line 996 of file class.ilObjCmiXapi.php.

Referenced by ilCmiXapiSettingsGUI\buildForm(), getHighscoreMode(), and setHighscoreMode().

◆ HIGHSCORE_SHOW_TOP_TABLE

const ilObjCmiXapi::HIGHSCORE_SHOW_TOP_TABLE = 2

Definition at line 995 of file class.ilObjCmiXapi.php.

Referenced by ilCmiXapiSettingsGUI\buildForm(), getHighscoreMode(), and setHighscoreMode().

◆ LAUNCH_METHOD_IFRAME

const ilObjCmiXapi::LAUNCH_METHOD_IFRAME = 'iframe'

Definition at line 81 of file class.ilObjCmiXapi.php.

◆ LAUNCH_METHOD_NEW_WIN

const ilObjCmiXapi::LAUNCH_METHOD_NEW_WIN = 'newWin'

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

Referenced by __construct(), ilCmiXapiSettingsGUI\buildForm(), ilObjCmiXapiListGUI\getCommandFrame(), and ilObjCmiXapiGUI\initInfoScreenToolbar().

◆ LAUNCH_METHOD_OWN_WIN

const ilObjCmiXapi::LAUNCH_METHOD_OWN_WIN = 'ownWin'

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

Referenced by ilCmiXapiSettingsGUI\buildForm().

◆ LAUNCH_MODE_BROWSE

const ilObjCmiXapi::LAUNCH_MODE_BROWSE = 'Browse'

Definition at line 85 of file class.ilObjCmiXapi.php.

Referenced by ilCmiXapiSettingsGUI\buildForm().

◆ LAUNCH_MODE_NORMAL

const ilObjCmiXapi::LAUNCH_MODE_NORMAL = 'Normal'

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

Referenced by __construct(), ilCmiXapiSettingsGUI\buildForm(), ilObjCmiXapiGUI\fetchXapiStatements(), XapiProxy\XapiProxy\handleStatementEvaluation(), ilObjCmiXapiGUI\isFetchXapiStatementsRequired(), ilXapiResultsCronjob\run(), and ilCmiXapiSettingsGUI\saveSettings().

◆ LAUNCH_MODE_REVIEW

const ilObjCmiXapi::LAUNCH_MODE_REVIEW = 'Review'

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

Referenced by ilCmiXapiSettingsGUI\buildForm(), getLaunchData(), getLaunchedContextTemplate(), and getLaunchedStatement().

◆ LMS_MASTERY_SCORE

const ilObjCmiXapi::LMS_MASTERY_SCORE = 0.7

Definition at line 91 of file class.ilObjCmiXapi.php.

Referenced by __construct(), ilCmiXapiSettingsGUI\buildForm(), and ilCmiXapiContentUploadImporter\initObjectFromCmi5Xml().

◆ PLUGIN

const ilObjCmiXapi::PLUGIN = false

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

◆ PRIVACY_IDENT_IL_UUID_EXT_ACCOUNT

const ilObjCmiXapi::PRIVACY_IDENT_IL_UUID_EXT_ACCOUNT = 1

Definition at line 97 of file class.ilObjCmiXapi.php.

Referenced by ilCmiXapiUser\getIdent(), and ilCmiXapiUser\getIdentAsId().

◆ PRIVACY_IDENT_IL_UUID_LOGIN

const ilObjCmiXapi::PRIVACY_IDENT_IL_UUID_LOGIN = 2

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

Referenced by ilCmiXapiUser\getIdent(), and ilCmiXapiUser\getIdentAsId().

◆ PRIVACY_IDENT_IL_UUID_RANDOM

const ilObjCmiXapi::PRIVACY_IDENT_IL_UUID_RANDOM = 4

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

Referenced by ilObjLTIConsumer\buildLaunchParameters(), ilCmiXapiUser\getIdent(), and ilCmiXapiUser\getIdentAsId().

◆ PRIVACY_IDENT_IL_UUID_SHA256

const ilObjCmiXapi::PRIVACY_IDENT_IL_UUID_SHA256 = 5

Definition at line 101 of file class.ilObjCmiXapi.php.

Referenced by ilCmiXapiUser\getIdent(), and ilCmiXapiUser\getIdentAsId().

◆ PRIVACY_IDENT_IL_UUID_SHA256URL

const ilObjCmiXapi::PRIVACY_IDENT_IL_UUID_SHA256URL = 6

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

Referenced by ilCmiXapiUser\getIdent(), and ilCmiXapiUser\getIdentAsId().

◆ PRIVACY_IDENT_IL_UUID_USER_ID

const ilObjCmiXapi::PRIVACY_IDENT_IL_UUID_USER_ID = 0

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

Referenced by __construct(), ilCmiXapiUser\getIdent(), and ilCmiXapiUser\getIdentAsId().

◆ PRIVACY_IDENT_REAL_EMAIL

const ilObjCmiXapi::PRIVACY_IDENT_REAL_EMAIL = 3

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

Referenced by ilCmiXapiUser\getIdent(), and ilCmiXapiUser\getIdentAsId().

◆ PRIVACY_NAME_FIRSTNAME

const ilObjCmiXapi::PRIVACY_NAME_FIRSTNAME = 1

Definition at line 106 of file class.ilObjCmiXapi.php.

Referenced by ilCmiXapiUser\getName().

◆ PRIVACY_NAME_FULLNAME

const ilObjCmiXapi::PRIVACY_NAME_FULLNAME = 3

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

Referenced by ilCmiXapiUser\getName().

◆ PRIVACY_NAME_LASTNAME

const ilObjCmiXapi::PRIVACY_NAME_LASTNAME = 2

Definition at line 107 of file class.ilObjCmiXapi.php.

Referenced by ilCmiXapiUser\getName().

◆ PRIVACY_NAME_NONE

const ilObjCmiXapi::PRIVACY_NAME_NONE = 0

Definition at line 105 of file class.ilObjCmiXapi.php.

Referenced by __construct(), ilCmiXapiStatementsReportLinkBuilder\buildOrderingStage(), and ilCmiXapiUser\getName().

◆ SRC_TYPE_EXTERNAL

const ilObjCmiXapi::SRC_TYPE_EXTERNAL = 'externalSource'

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

Referenced by ilObjCmiXapiGUI\afterSave(), and isSourceTypeExternal().

◆ SRC_TYPE_LOCAL

const ilObjCmiXapi::SRC_TYPE_LOCAL = 'localSource'

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

Referenced by ilObjCmiXapiGUI\afterSave(), and ilCmiXapiLaunchGUI\buildLaunchLink().

◆ SRC_TYPE_REMOTE

const ilObjCmiXapi::SRC_TYPE_REMOTE = 'remoteSource'

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

Referenced by __construct(), ilObjCmiXapiGUI\afterSave(), ilCmiXapiLaunchGUI\buildLaunchLink(), and isSourceTypeRemote().

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

Modules/CmiXapi/classes/class.ilObjCmiXapi.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ doCloneObject()

◆ doDelete()

◆ doRead()

◆ doUpdate()

◆ getAbandonedStatement()

◆ getAchieved()

◆ getActivationEndingTime()

◆ getActivationStartingTime()

◆ getActivationVisibility()

◆ getActivityId()

◆ getAnswered()

◆ getCompleted()

◆ getContentType()

◆ getCurrentCmixUser()

◆ getDataSetMapping()

◆ getDuration()

◆ getEntitlementKey()

◆ getFailed()

◆ getHideData()

◆ getHighscoreAchievedTS()

◆ getHighscoreEnabled()

◆ getHighscoreMode()

◆ getHighscoreOwnTable()

◆ getHighscorePercentage()

◆ getHighscoreTopNum()

◆ getHighscoreTopTable()

◆ getHighscoreWTime()

◆ getInitialized()

◆ getInstance()

◆ getInstructions()

◆ getLastStatement()

◆ getLastStatementPipline()

◆ getLaunchData()

◆ getLaunchedContextTemplate()

◆ getLaunchedStatement()

◆ getLaunchMethod()

◆ getLaunchMode()

◆ getLaunchParameters()

◆ getLaunchUrl()

◆ getLMSMoveOn()

◆ getLPMode()

◆ getLrsType()

◆ getLrsTypeId()

◆ getMasteryScore()

◆ getMasteryScorePercent()

◆ getMoveOn()

◆ getNoSubstatements()

◆ getObjectsHavingBypassProxyEnabledAndRegisteredUsers()

◆ getOnlyMoveon()

◆ getPassed()

◆ getPrivacyIdent()

◆ getPrivacyName()

◆ getProgressed()

◆ getPublisherId()

◆ getSatisfied()

◆ getSatisfiedStatement()

◆ getSessionId()

◆ getSourceType()

◆ getStatement()

◆ getStatementActor()

◆ getStatementContextActivities()

◆ getStatementExtensions()

◆ getStatementObject()

◆ getSwitchToReviewEnabled()

◆ getTerminated()

◆ getTimestamp()

◆ getUserPrivacyComment()

◆ getVersion()

◆ getXmlManifest()

◆ guidv4()