Inheritance diagram for ilObjSCORMLearningModule:

Collaboration diagram for ilObjSCORMLearningModule:

Public Member Functions
	__construct (int $a_id=0, bool $a_call_by_reference=true)
	Constructor. More...

	getTrackingItems ()

	readObject ()
	read manifest file More...

	setLearningProgressSettingsAtUpload ()
	set settings for learning progress determination per default at upload More...

	getTrackedItems ()
	get all tracked items of current user More...

	getTrackedUsers (string $a_search)
	Return the last access timestamp for a given user. More...

	getAttemptsForUsers ()
	Get attempts for all users. More...

	getAttemptsForUser (int $a_user_id)
	get number of attempts for a certain user and package More...

	getModuleVersionForUsers ()
	Get module version for users. More...

	getModuleVersionForUser (int $a_user_id)
	get module version that tracking data for a user was recorded on More...

	getTrackingDataPerUser (int $a_sco_id, int $a_user_id)
	Get tracking data per user. More...

	getTrackingDataAgg (int $a_user_id)

	getTrackingDataAggSco (int $a_sco_id)

	exportSelected (bool $a_all, array $a_users=array())
	Export selected user tracking data ilObjUser $ilUser. More...

	importTrackingData (string $a_file)

	importSuccess (string $a_file)

	importSuccessForSahsUser (int $user_id, ?DateTimeImmutable $last_access, int $status, ?int $attempts=null, ?int $percentage_completed=null, ?int $sco_total_time_sec=null)

	get_user_id (string $a_login)

	getUserIdEmail (string $a_mail)
	assumes that only one account exists for a mailadress More...

	sendExportFile (string $a_header, string $a_content)
	send export file to browser More...

	getAllScoIds ()

	getStatusForUser (int $a_user, array $a_allScoIds, bool $a_numerical=false)

	getCourseCompletionForUser (int $a_user)

	getLastVisited (int $user_id)

	deleteTrackingDataOfUsers (array $a_users)

Public Member Functions inherited from ilObjSAHSLearningModule
	__construct (int $a_id=0, bool $a_call_by_reference=true)
	Constructor. More...

	create (bool $upload=false)
	create file based lm More...

	read ()
	read object More...

	getEditable ()
	Set Editable. More...

	setTries (int $a_tries)
	Set default tries for questions. More...

	getTries ()

	setLocalization (string $a_val)

	getLocalization ()

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

	createDataDirectory ()
	creates data directory for package files ("./public/data/lm_data/lm_<id>") More...

	getDataDirectory (?string $mode="filesystem")
	get data directory of lm More...

	getAPIAdapterName ()
	get api adapter name More...

	setAPIAdapterName (string $a_api)
	set api adapter name More...

	getAPIFunctionsPrefix ()
	get api functions prefix More...

	setAPIFunctionsPrefix (string $a_prefix)
	set api functions prefix More...

	getCreditMode ()
	get credit mode More...

	setDefaultLessonMode (string $a_lesson_mode)
	set default lesson mode More...

	getDefaultLessonMode ()
	get default lesson mode More...

	getStyleSheetId ()
	get ID of assigned style sheet object More...

	setStyleSheetId (int $a_style_id)
	set ID of assigned style sheet object More...

	setAutoReview (bool $a_auto_review)
	set auto review as true/false for SCORM 1.2 More...

	getAutoReview ()
	get auto review as true/false for SCORM 1.2 More...

	setAutoReviewChar (?string $a_auto_review)
	set auto review as Char for SCORM 2004 More...

	getAutoReviewChar ()
	get auto review as Char for SCORM 2004 More...

	getMaxAttempt ()

	setMaxAttempt (int $a_max_attempt)

	getModuleVersion ()

	getAssignedGlossary ()

	setAssignedGlossary (int $a_assigned_glossary)

	setModuleVersion (int $a_module_version)

	getSession ()

	setSession (bool $a_session)

	getNoMenu ()
	disable menu More...

	setNoMenu (bool $a_no_menu)
	disable menu More...

	getHideNavig ()
	hide navigation tree More...

	setHideNavig (bool $a_hide_navig)
	disable menu More...

	getCacheDeactivated ()
	BrowserCacheDisabled for SCORM 2004 / ENABLE_JS_DEBUG. More...

	getSessionDeactivated ()
	sessionDisabled for SCORM 2004 More...

	getDebugActivated ()
	debugActivated More...

	getIe_force_render ()
	force Internet Explorer to render again after some Milliseconds - useful for learning Modules with a lot of iframes or frames and IE >=10 More...

	setIe_force_render (bool $a_ie_force_render)

	getFourth_Edition ()
	SCORM 2004 4th edition features. More...

	setFourth_edition (bool $a_fourth_edition)

	getSequencing ()

	setSequencing (bool $a_sequencing)

	getInteractions ()

	setInteractions (bool $a_interactions)

	getObjectives ()

	setObjectives (bool $a_objectives)

	getComments ()

	setComments (bool $a_comments)

	getTime_from_lms ()

	setTime_from_lms (bool $a_time_from_lms)

	getCheck_values ()

	setCheck_values (bool $a_check_values)

	getDebug ()
	offlineMode More...

	setDebug (bool $a_debug)

	setAutoContinue (bool $a_auto_continue)
	debug pw More...

	getAutoContinue ()

	getAuto_last_visited ()

	setAuto_last_visited (bool $a_auto_last_visited)

	setAutoSuspend (bool $a_auto_suspend)
	Set sequencing expert mode. More...

	getAutoSuspend ()

	getOpenMode ()
	open_mode 0: in Tab/new Window like in previous versions 1: in iFrame with width=100% and heigth=100% 2: in iFrame with specified width and height 3: 4: 5: in new Window without specified width and height 6: in new Window with specified width and height More...

	setOpenMode (int $a_open_mode)

	getWidth ()

	setWidth (int $a_width)

	getHeight ()

	setHeight (int $a_height)

	getMasteryScore ()

	setMasteryScore (?int $a_mastery_score)

	checkMasteryScoreValues ()
	check mastery_score / min_normalized_measure of SCOs (SCORM 1.2) / objectives (SCORM 2004) More...

	getMasteryScoreValues ()

	getIdSetting ()

	setIdSetting (int $a_id_setting)

	getNameSetting ()

	setNameSetting (int $a_name_setting)

	update ()

	setSubType (string $a_sub_type)

	getSubType ()

	delete ()
	delete SCORM learning module and all related data More...

	getPointsInPercent ()
	Returns the points in percent for the learning module This is called by the certificate generator if [SCORM_POINTS] is inserted. More...

	getMaxPoints ()
	Returns score.max for the learning module, refered to the last sco where score.max is set. More...

	populateByDirectoy (string $a_dir, string $a_filename="")
	Populate by directory. More...

	getApiStudentId ()
	Get cmi.core.student_id / cmi.learner_id for API. More...

	getApiStudentName ()
	Get cmi.core.student_name / cmi.learner_name for API note: 'lastname, firstname' is required for SCORM 1.2; 9 = no name to hide student_name for external content. More...

	getViewButton ()
	get button for view More...

Public Member Functions inherited from ilObject
	getObjectProperties ()

	flushObjectProperties ()

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

	processAutoRating ()

	read ()

	getId ()

	setId (int $id)

	setRefId (int $ref_id)

	getRefId ()

	getType ()

	setType (string $type)

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

	getTitle ()

	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...

	setTitle (string $title)

	getDescription ()

	setDescription (string $description)

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

	getImportId ()

	setImportId (string $import_id)

	setOfflineStatus (bool $status)

	getOfflineStatus ()

	supportsOfflineHandling ()

	getOwner ()

	getOwnerName ()
	get full name of object owner More...

	setOwner (int $usr_id)

	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...

	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...

	create ()
	note: title, description and type should be set when this function is called More...

	update ()

	MDUpdateListener (string $element)
	Metadata update listener. More...

	createMetaData ()

	updateMetaData ()

	deleteMetaData ()

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

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

	setPermissions (int $parent_ref_id)

	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...

	createReference ()
	creates reference for object More...

	countReferences ()

	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...

	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type. More...

	applyDidacticTemplate (int $tpl_id)

	getXMLZip ()

	getHTMLDirectory ()

	appendCopyInfo (int $target_id, int $copy_id, int $new_obj_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...

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

	selfOrParentWithRatingEnabled ()

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

Static Public Member Functions
static	_getTrackingItems (int $a_obj_id)
	get all tracking items of scorm object More...

static	_getAllScoIds (int $a_id)
	Get an array of id's for all Sco's in the module. More...

static	_getStatusForUser (int $a_id, int $a_user, array $a_allScoIds, bool $a_numerical=false)
	Get the status of a SCORM module for a given user. More...

static	_getCourseCompletionForUser (int $a_id, int $a_user)
	Get the completion of a SCORM module for a given user. More...

static	_removeTrackingDataForUser (int $user_id)
	to be called from IlObjUser More...

static	_getScoresForUser (int $a_item_id, int $a_user_id)

Static Public Member Functions inherited from ilObjSAHSLearningModule
static	getAffectiveLocalization (int $a_id)
	Get affective localization. More...

static	_lookupSubType (int $a_obj_id)
	lookup subtype id (scorm, ) More...

static	_getTries (int $a_id)
	obsolet? More...

static	getScormModulesForGlossary (int $a_glo_id)
	Get SCORM modules that assign a certain glossary. More...

static	lookupAssignedGlossary (int $a_slm_id)
	Get SCORM modules that assign a certain glossary. More...

Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId (string $import_id)
	Get (latest) object id for an import id. More...

static	_lookupImportId (int $obj_id)

static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...

static	_getIdForImportId (string $import_id)

static	_getAllReferences (int $id)
	get all reference ids for object ID More...

static	_lookupTitle (int $obj_id)

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

static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...

static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)

static	_lookupDescription (int $obj_id)

static	_lookupLastUpdate (int $obj_id, bool $formatted=false)

static	_getLastUpdateOfObjects (array $obj_ids)

static	_lookupObjId (int $ref_id)

static	_setDeletedDate (int $ref_id, int $deleted_by)

static	setDeletedDates (array $ref_ids, int $user_id)

static	_resetDeletedDate (int $ref_id)

static	_lookupDeletedDate (int $ref_id)

static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...

static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...

static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...

static	_lookupType (int $id, bool $reference=false)

static	_isInTrash (int $ref_id)

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

static	_lookupObjectId (int $ref_id)

static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...

static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...

static	_getObjectsByType (string $obj_type="", ?int $owner=null)

static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...

static	getIconForType (string $type)

static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...

static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $obj_ids)

static	getAllOwnedRepositoryObjects (int $user_id)

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

static	_lookupCreationDate (int $obj_id)

static	_getObjectTypeIdByTitle (string $type, ?\ilDBInterface $ilDB=null)

Protected Member Functions
	kindlyToDateTime (string $format, string $maybe_datetime, ?DateTimeImmutable $default=null)

Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)

	beforeMDUpdateListener (string $a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDeleteMetaData ()

	beforeDeleteMetaData ()

	handleAutoRating ()

	hasAutoRating ()

Private Member Functions
	parseUserId (string $il_id)
	Parse il_usr_123_6 id. More...

	importRaw (string $a_file)
	Import raw data. More...

	lookupSCOId (string $a_referrer)
	resolves manifest SCOID to internal ILIAS SCO ID More...

Additional Inherited Members
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 Attributes inherited from ilObjSAHSLearningModule
bool	$sequencing = false

string	$localization = ""

string	$mastery_score_values = ""

int	$tries = 0

string	$api_adapter = 'API'

ILIAS DI UIServices	$ui

Protected Attributes inherited from ilObject
ilLogger	$obj_log

ILIAS	$ilias

ilObjectDefinition	$obj_definition

ilDBInterface	$db

ilLogger	$log

ilErrorHandling	$error

ilTree	$tree

ilAppEventHandler	$app_event_handler

ilRbacAdmin	$rbac_admin

ilRbacReview	$rbac_review

ilObjUser	$user

ilLanguage	$lng

LOMServices	$lom_services

bool	$call_by_reference

int	$max_title = self::TITLE_LENGTH

int	$max_desc = self::DESC_LENGTH

bool	$add_dots = true

int	$ref_id = null

string	$type = ""

string	$title = ""

string	$desc = ""

string	$long_desc = ""

int	$owner = 0

string	$create_date = ""

string	$last_update = ""

string	$import_id = ""

bool	$register = false

Detailed Description

Class ilObjSCORMLearningModule.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e $Id$

\

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

Constructor & Destructor Documentation

◆ __construct()

ilObjSCORMLearningModule::__construct	(	int	$a_id = `0`,
		bool	$a_call_by_reference = `true`
	)

Constructor.

Parameters

integer	$a_id	reference_id or object_id
boolean	$a_call_by_reference	treat the id as reference_id (true) or object_id (false)

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

References ILIAS\GlobalScreen\Provider\__construct().

     {
         $this->type = "sahs";
         parent::__construct($a_id, $a_call_by_reference);
     }

Here is the call graph for this function:

Member Function Documentation

◆ _getAllScoIds()

static ilObjSCORMLearningModule::_getAllScoIds ( int $a_id )

static

Get an array of id's for all Sco's in the module.

Parameters

int $a_id Object id

Returns: array Sco id's

Definition at line 1056 of file class.ilObjSCORMLearningModule.php.

References $DIC, and $ilDB.

Referenced by _getCourseCompletionForUser().

                                                    : array
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $scos = array();
 
         $val_set = $ilDB->queryF(
             '
                 SELECT scorm_object.obj_id,
                                 scorm_object.title,
                                 scorm_object.c_type,
                                 scorm_object.slm_id,
                                 scorm_object.obj_id scoid 
                 FROM scorm_object,sc_item,sc_resource 
                 WHERE(scorm_object.slm_id = %s
                 AND scorm_object.obj_id = sc_item.obj_id 
                 AND sc_item.identifierref = sc_resource.import_id 
                 AND sc_resource.scormtype = %s)
                 GROUP BY scorm_object.obj_id,
                                 scorm_object.title,
                                 scorm_object.c_type,
                                 scorm_object.slm_id,
                                 scorm_object.obj_id ',
             array('integer', 'text'),
             array($a_id,'sco')
         );
 
         while ($val_rec = $ilDB->fetchAssoc($val_set)) {
             $scos[] = $val_rec['scoid'];
         }
         return $scos;
     }

Here is the caller graph for this function:

◆ _getCourseCompletionForUser()

static ilObjSCORMLearningModule::_getCourseCompletionForUser	(	int	$a_id,
		int	$a_user
	)

static

Get the completion of a SCORM module for a given user.

Parameters

int	$a_id	Object id
int	$a_user	User id

Returns: string Completion status

Definition at line 1140 of file class.ilObjSCORMLearningModule.php.

References _getAllScoIds(), and _getStatusForUser().

                                                                               : bool
     {
         return ilObjSCORMLearningModule::_getStatusForUser($a_id, $a_user, ilObjSCORMLearningModule::_getAllScoIds($a_id), true);
     }

Here is the call graph for this function:

◆ _getScoresForUser()

static ilObjSCORMLearningModule::_getScoresForUser	(	int	$a_item_id,
		int	$a_user_id
	)

static

Definition at line 1240 of file class.ilObjSCORMLearningModule.php.

References $DIC, $ilDB, and null.

Referenced by ilLPCollectionOfSCOs\getScoresForUserAndCP_Node_Id().

                                                                             : array
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $retAr = array("raw" => null, "max" => null, "scaled" => null);
         $val_set = $ilDB->queryF(
             "
                         SELECT lvalue, rvalue FROM scorm_tracking 
                         WHERE sco_id = %s 
                         AND user_id =  %s
                         AND (lvalue = 'cmi.core.score.raw' OR lvalue = 'cmi.core.score.max')",
             array('integer', 'integer'),
             array($a_item_id, $a_user_id)
         );
         while ($val_rec = $ilDB->fetchAssoc($val_set)) {
             if ($val_rec['lvalue'] === "cmi.core.score.raw") {
                 $retAr["raw"] = $val_rec["rvalue"];
             }
             if ($val_rec['lvalue'] === "cmi.core.score.max") {
                 $retAr["max"] = $val_rec["rvalue"];
             }
         }
         if ($retAr["raw"] != null && $retAr["max"] != null) {
             $retAr["scaled"] = ($retAr["raw"] / $retAr["max"]);
         }
 
         return $retAr;
     }

Here is the caller graph for this function:

◆ _getStatusForUser()

static ilObjSCORMLearningModule::_getStatusForUser	(	int	$a_id,
		int	$a_user,
		array	$a_allScoIds,
		bool	$a_numerical = `false`
	)

static

Get the status of a SCORM module for a given user.

Parameters

int	$a_id	Object id
int	$a_user	User id
array	$a_allScoIds	Array of Sco id's in this module
boolean	$a_numerical	Text (false) or boolean result (true)

Returns: bool Status result

Definition at line 1098 of file class.ilObjSCORMLearningModule.php.

References $DIC, $ilDB, ilObject\$lng, and ilLanguage\txt().

Referenced by _getCourseCompletionForUser().

                                                                                                                    : bool
     {
         global $DIC;
         $ilDB = $DIC->database();
         $lng = $DIC->language();
 
         $scos = $a_allScoIds;
         //check if all SCO's are completed
         $scos_c = implode(',', $scos);
 
         $val_set = $ilDB->queryF(
             '
                 SELECT * FROM scorm_tracking 
                 WHERE (user_id = %s
                 AND obj_id = %s
                 AND ' . $ilDB->in('sco_id', $scos, false, 'integer') . '
                 AND ((lvalue = %s AND ' . $ilDB->like('rvalue', 'clob', 'completed') . ') 
                         OR (lvalue = %s AND ' . $ilDB->like('rvalue', 'clob', 'passed') . ')))',
             array('integer','integer','text','text'),
             array($a_user,$a_id,'cmi.core.lesson_status', 'cmi.core.lesson_status')
         );
         while ($val_rec = $ilDB->fetchAssoc($val_set)) {
             $key = array_search($val_rec['sco_id'], $scos);
             unset($scos[$key]);
         }
         $completion = false;
         //check for completion
         if (count($scos) == 0) {
             $completion = ($a_numerical === true) ? true : $lng->txt("cont_complete");
         }
         if (count($scos) > 0) {
             $completion = ($a_numerical === true) ? false : $lng->txt("cont_incomplete");
         }
         return $completion;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getTrackingItems()

static ilObjSCORMLearningModule::_getTrackingItems ( int $a_obj_id )

static

get all tracking items of scorm object

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

References ilObject\$tree, ilTree\getNodeData(), ilTree\getSubTree(), and ilTree\readRootId().

Referenced by ilLPCollectionOfSCOs\getPossibleItems(), and getTrackingItems().

                                                            : array
     {
         $tree = new ilSCORMTree($a_obj_id);
         $root_id = $tree->readRootId();
 
         $items = array();
         $childs = $tree->getSubTree($tree->getNodeData($root_id));
 
         foreach ($childs as $child) {
             if ($child["c_type"] === "sit") {
                 $sc_item = new ilSCORMItem((int) $child["obj_id"]);
                 if ($sc_item->getIdentifierRef() != "") {
                     $items[] = $sc_item;
                 }
             }
         }
 
         return $items;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _removeTrackingDataForUser()

static ilObjSCORMLearningModule::_removeTrackingDataForUser ( int $user_id )

static

to be called from IlObjUser

Definition at line 1223 of file class.ilObjSCORMLearningModule.php.

References $DIC, and $ilDB.

Referenced by ilObjUser\delete().

                                                                    : void
     {
         global $DIC;
         $ilDB = $DIC->database();
         //gobjective
         $ilDB->manipulateF(
             'DELETE FROM scorm_tracking WHERE user_id = %s',
             array('integer'),
             array($user_id)
         );
         $ilDB->manipulateF(
             'DELETE FROM sahs_user WHERE user_id = %s',
             array('integer'),
             array($user_id)
         );
     }

Here is the caller graph for this function:

◆ deleteTrackingDataOfUsers()

ilObjSCORMLearningModule::deleteTrackingDataOfUsers ( array $a_users )

Definition at line 1287 of file class.ilObjSCORMLearningModule.php.

References $DIC, $ilDB, ilObject\$user, ilChangeEvent\_deleteReadEventsForUsers(), ilLPStatusWrapper\_updateStatus(), ilObject\getId(), and ILIAS\Repository\int().

Referenced by importSuccess().

                                                              : void
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         ilChangeEvent::_deleteReadEventsForUsers($this->getId(), $a_users);
 
         foreach ($a_users as $usr) {
             $user = (int) $usr;
             $ilDB->manipulateF(
                 '
                                 DELETE FROM scorm_tracking
                                 WHERE user_id = %s
                                 AND obj_id = %s',
                 array('integer', 'integer'),
                 array($user, $this->getID())
             );
 
             $ilDB->manipulateF(
                 '
                                 DELETE FROM sahs_user
                                 WHERE user_id = %s
                                 AND obj_id = %s',
                 array('integer', 'integer'),
                 array($user, $this->getID())
             );
 
             ilLPStatusWrapper::_updateStatus($this->getId(), $user);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportSelected()

ilObjSCORMLearningModule::exportSelected	(	bool	$a_all,
		array	$a_users = `array()`
	)

Export selected user tracking data ilObjUser $ilUser.

Definition at line 516 of file class.ilObjSCORMLearningModule.php.

References $data, $DIC, $ilDB, $res, ilLearningProgressBaseGUI\__readStatus(), ilObject\getId(), ilPrivacySettings\getInstance(), ilObject\getTitle(), sendExportFile(), ilSCORMTrackingItems\userDataArrayForExport(), and ilSCORMTrackingItems\userDataHeaderForExport().

                                                                          : void
     {
         global $DIC;
         $ilDB = $DIC->database();
         $ilUser = $DIC->user();
         $privacy = ilPrivacySettings::getInstance();
         $allowExportPrivacy = $privacy->enabledExportSCORM();
 
         $csv = "";
         $query = 'SELECT * FROM sahs_user WHERE obj_id = %s';
         if (count($a_users) > 0) {
             $query .= ' AND ' . $ilDB->in('user_id', $a_users, false, 'integer');
         }
         $res = $ilDB->queryF(
             $query,
             array('integer'),
             array($this->getId())
         );
         while ($data = $ilDB->fetchAssoc($res)) {
             $csv = $csv . $data["obj_id"]
                 . ";\"" . $this->getTitle() . "\""
                 . ";" . $data["module_version"]
                 . ";\"" . implode("\";\"", ilSCORMTrackingItems::userDataArrayForExport((int) $data["user_id"], $allowExportPrivacy)) . "\""
                 . ";\"" . $data["last_access"] . "\""
                 . ";\"" . ilLearningProgressBaseGUI::__readStatus((int) $data["obj_id"], (int) $data["user_id"]) . "\"" //not $data["status"] because modifications to learning progress could have made before export
                 . ";" . $data["package_attempts"]
                 . ";" . $data["percentage_completed"]
                 . ";" . $data["sco_total_time_sec"]
 //                              . ";\"" . $certificateDate ."\""
                 . "\n";
         }
         $udh = ilSCORMTrackingItems::userDataHeaderForExport();
         $header = "LearningModuleId;LearningModuleTitle;LearningModuleVersion;" . str_replace(',', ';', $udh["cols"]) . ";"
                 . "LastAccess;Status;Attempts;percentageCompletedSCOs;SumTotal_timeSeconds\n";
 
         $this->sendExportFile($header, $csv);
     }

Here is the call graph for this function:

◆ get_user_id()

ilObjSCORMLearningModule::get_user_id ( string $a_login )

Definition at line 970 of file class.ilObjSCORMLearningModule.php.

References $DIC, $ilDB, and null.

Referenced by importRaw(), ilObjSCORM2004LearningModule\importSuccess(), and importSuccess().

                                                 : ?int
     {
         global $DIC;
         $ilDB = $DIC->database();
         $ilUser = $DIC->user();
 
         $val_set = $ilDB->queryF(
             'SELECT * FROM usr_data WHERE(login=%s)',
             array('text'),
             array($a_login)
         );
         $val_rec = $ilDB->fetchAssoc($val_set);
 
         if (count($val_rec) > 0) {
             return (int) $val_rec['usr_id'];
         }
 
         return null;
     }

Here is the caller graph for this function:

◆ getAllScoIds()

ilObjSCORMLearningModule::getAllScoIds ( )

Returns: array

Definition at line 1148 of file class.ilObjSCORMLearningModule.php.

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

Referenced by getCourseCompletionForUser().

                                   : array
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $scos = array();
         //get all SCO's of this object
         $val_set = $ilDB->queryF(
             '
                 SELECT scorm_object.obj_id,
                                 scorm_object.title,
                                 scorm_object.c_type,
                                 scorm_object.slm_id,
                                 scorm_object.obj_id scoid 
                 FROM scorm_object, sc_item,sc_resource 
                 WHERE(scorm_object.slm_id = %s 
                         AND scorm_object.obj_id = sc_item.obj_id 
                         AND sc_item.identifierref = sc_resource.import_id 
                         AND sc_resource.scormtype = %s )
                 GROUP BY scorm_object.obj_id,
                 scorm_object.title,
                 scorm_object.c_type,
                 scorm_object.slm_id,
                 scorm_object.obj_id',
             array('integer','text'),
             array($this->getId(),'sco')
         );
 
         while ($val_rec = $ilDB->fetchAssoc($val_set)) {
             $scos[] = $val_rec['scoid'];
         }
         return $scos;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAttemptsForUser()

ilObjSCORMLearningModule::getAttemptsForUser ( int $a_user_id )

get number of attempts for a certain user and package

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

References $DIC, $ilDB, ilObject\getId(), and null.

                                                       : int
     {
         global $DIC;
         $ilDB = $DIC->database();
         $val_set = $ilDB->queryF(
             'SELECT package_attempts FROM sahs_user WHERE obj_id = %s AND user_id = %s',
             array('integer','integer'),
             array($this->getId(),$a_user_id)
         );
 
         $val_rec = $ilDB->fetchAssoc($val_set);
 
         if ($val_rec["package_attempts"] == null) {
             $val_rec["package_attempts"] = 0;
         }
         return (int) $val_rec["package_attempts"];
     }

Here is the call graph for this function:

◆ getAttemptsForUsers()

ilObjSCORMLearningModule::getAttemptsForUsers ( )

Get attempts for all users.

Returns: int[]

Definition at line 288 of file class.ilObjSCORMLearningModule.php.

References $DIC, $ilDB, $res, ilDBConstants\FETCHMODE_ASSOC, ilObject\getId(), and ILIAS\Repository\int().

                                          : array
     {
         global $DIC;
         $ilDB = $DIC->database();
         $query = 'SELECT user_id, package_attempts FROM sahs_user WHERE obj_id = ' . $ilDB->quote($this->getId(), 'integer') . ' ';
         $res = $ilDB->query($query);
 
         $attempts = array();
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
             $attempts[$row['user_id']] = (int) $row['package_attempts'];
         }
         return $attempts;
     }

Here is the call graph for this function:

◆ getCourseCompletionForUser()

ilObjSCORMLearningModule::getCourseCompletionForUser ( int $a_user )

Definition at line 1215 of file class.ilObjSCORMLearningModule.php.

References getAllScoIds(), and getStatusForUser().

                                                            : bool
     {
         return $this->getStatusForUser($a_user, $this->getAllScoIds(), true);
     }

Here is the call graph for this function:

◆ getLastVisited()

ilObjSCORMLearningModule::getLastVisited ( int $user_id )

Definition at line 1270 of file class.ilObjSCORMLearningModule.php.

References $DIC, $ilDB, and null.

Referenced by ilObjSCORMInitData\getIliasScormVars().

                                                 : string
     {
         global $DIC;
         $ilDB = $DIC->database();
         $val_set = $ilDB->queryF(
             'SELECT last_visited FROM sahs_user WHERE obj_id = %s AND user_id = %s',
             array('integer','integer'),
             array($this->getID(),$user_id)
         );
         while ($val_rec = $ilDB->fetchAssoc($val_set)) {
             if ($val_rec["last_visited"] != null) {
                 return "" . $val_rec["last_visited"];
             }
         }
         return '0';
     }

Here is the caller graph for this function:

◆ getModuleVersionForUser()

ilObjSCORMLearningModule::getModuleVersionForUser ( int $a_user_id )

get module version that tracking data for a user was recorded on

Definition at line 345 of file class.ilObjSCORMLearningModule.php.

References $DIC, $ilDB, ilObject\getId(), and null.

                                                            : string
     {
         global $DIC;
         $ilDB = $DIC->database();
         $val_set = $ilDB->queryF(
             'SELECT module_version FROM sahs_user WHERE obj_id = %s AND user_id = %s',
             array('integer','integer'),
             array($this->getId(),$a_user_id,0)
         );
 
         $val_rec = $ilDB->fetchAssoc($val_set);
 
         if ($val_rec["module_version"] == null) {
             $val_rec["module_version"] = "";
         }
         return $val_rec["module_version"];
     }

Here is the call graph for this function:

◆ getModuleVersionForUsers()

ilObjSCORMLearningModule::getModuleVersionForUsers ( )

Get module version for users.

Definition at line 328 of file class.ilObjSCORMLearningModule.php.

References $DIC, $ilDB, $res, ilDBConstants\FETCHMODE_ASSOC, ilObject\getId(), and ILIAS\Repository\int().

                                               : array
     {
         global $DIC;
         $ilDB = $DIC->database();
         $query = 'SELECT user_id, module_version FROM sahs_user WHERE obj_id = ' . $ilDB->quote($this->getId(), 'integer') . ' ';
         $res = $ilDB->query($query);
 
         $versions = array();
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
             $versions[$row['user_id']] = (int) $row['module_version'];
         }
         return $versions;
     }

Here is the call graph for this function:

◆ getStatusForUser()

ilObjSCORMLearningModule::getStatusForUser	(	int	$a_user,
		array	$a_allScoIds,
		bool	$a_numerical = `false`
	)

Definition at line 1182 of file class.ilObjSCORMLearningModule.php.

References $DIC, $ilDB, and ILIAS\Repository\lng().

Referenced by getCourseCompletionForUser().

                                                                                                 : bool
     {
         global $DIC;
         $ilDB = $DIC->database();
         $scos = $a_allScoIds;
         //loook up status
         //check if all SCO's are completed
         $scos_c = implode(',', $scos);
 
         $val_set = $ilDB->queryF(
             '
                 SELECT sco_id FROM scorm_tracking 
                 WHERE (user_id = %s
                         AND obj_id = %s
                         AND ' . $ilDB->in('sco_id', $scos, false, 'integer') . '
                  AND ((lvalue = %s AND ' . $ilDB->like('rvalue', 'clob', 'completed') . ') OR (lvalue =  %s AND ' . $ilDB->like('rvalue', 'clob', 'passed') . ') ) )',
             array('integer','integer','text','text',),
             array($a_user,$this->getID(),'cmi.core.lesson_status','cmi.core.lesson_status')
         );
         while ($val_rec = $ilDB->fetchAssoc($val_set)) {
             $key = array_search($val_rec['sco_id'], $scos);
             unset($scos[$key]);
         }
         //check for completion
         if (count($scos) == 0) {
             $completion = ($a_numerical === true) ? true : $this->lng->txt("cont_complete");
         }
         if (count($scos) > 0) {
             $completion = ($a_numerical === true) ? false : $this->lng->txt("cont_incomplete");
         }
         return $completion;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTrackedItems()

ilObjSCORMLearningModule::getTrackedItems ( )

get all tracked items of current user

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

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

                                      : array
     {
         global $DIC;
         $ilDB = $DIC->database();
         $ilUser = $DIC->user();
 
         $sco_set = $ilDB->queryF(
             '
                 SELECT DISTINCT sco_id FROM scorm_tracking WHERE obj_id = %s',
             array('integer'),
             array($this->getId())
         );
 
         $items = array();
         while ($sco_rec = $ilDB->fetchAssoc($sco_set)) {
             $sc_item = new ilSCORMItem((int) $sco_rec["sco_id"]);
             if ($sc_item->getIdentifierRef() != "") {
                 $items[] = $sc_item;
             }
         }
 
         return $items;
     }

Here is the call graph for this function:

◆ getTrackedUsers()

ilObjSCORMLearningModule::getTrackedUsers ( string $a_search )

Return the last access timestamp for a given user.

Parameters

int	$a_obj_id	object id
int	$user_id	user id

Returns: timestamp

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

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

                                                      : array
     {
         global $DIC;
         $ilDB = $DIC->database();
         $ilUser = $DIC->user();
         //TODO: UK last_access is not correct if no Commit or last_visited_sco
         //              $query = 'SELECT user_id,MAX(c_timestamp) last_access, lastname, firstname FROM scorm_tracking st ' .
         $query = 'SELECT user_id, last_access, lastname, firstname FROM sahs_user st ' .
             'JOIN usr_data ud ON st.user_id = ud.usr_id ' .
             'WHERE obj_id = ' . $ilDB->quote($this->getId(), 'integer');
         if ($a_search) {
             //                  $query .= ' AND (' . $ilDB->like('lastname', 'text', '%' . $a_search . '%') . ' OR ' . $ilDB->like('firstname', 'text', '%' . $a_search . '%') .')';
             $query .= ' AND ' . $ilDB->like('lastname', 'text', '%' . $a_search . '%');
         }
         $query .= ' GROUP BY user_id, lastname, firstname, last_access';
         $sco_set = $ilDB->query($query);
 
         $items = array();
         while ($sco_rec = $ilDB->fetchAssoc($sco_set)) {
             $items[] = $sco_rec;
         }
         return $items;
     }

Here is the call graph for this function:

◆ getTrackingDataAgg()

ilObjSCORMLearningModule::getTrackingDataAgg ( int $a_user_id )

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

References $data, $DIC, $ilDB, and ilObject\getId().

                                                       : array
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         // get all users with any tracking data
         $sco_set = $ilDB->queryF(
             '
                 SELECT DISTINCT sco_id FROM scorm_tracking 
                 WHERE obj_id = %s
                 AND user_id = %s
                 AND sco_id <> %s',
             array('integer','integer','integer'),
             array($this->getId(),$a_user_id,0)
         );
 
         $data = array();
         while ($sco_rec = $ilDB->fetchAssoc($sco_set)) {
             $data_set = $ilDB->queryF(
                 '
                         SELECT * FROM scorm_tracking 
                         WHERE  obj_id = %s
                         AND sco_id = %s
                         AND user_id = %s 
                         AND lvalue <> %s
                         AND (lvalue = %s
                                 OR lvalue = %s
                                 OR lvalue = %s)',
                 array('integer','integer','integer','text','text','text','text'),
                 array($this->getId(),
                 $sco_rec["sco_id"],
                 $a_user_id,
                 "package_attempts",
                 "cmi.core.lesson_status",
                 "cmi.core.total_time",
                 "cmi.core.score.raw")
             );
 
             $score = $time = $status = "";
 
             while ($data_rec = $ilDB->fetchAssoc($data_set)) {
                 switch ($data_rec["lvalue"]) {
                     case "cmi.core.lesson_status":
                         $status = $data_rec["rvalue"];
                         break;
 
                     case "cmi.core.total_time":
                         $time = $data_rec["rvalue"];
                         break;
 
                     case "cmi.core.score.raw":
                         $score = $data_rec["rvalue"];
                         break;
                 }
             }
             $sc_item = new ilSCORMItem((int) $sco_rec["sco_id"]);
             $data[] = array("sco_id" => (int) $sco_rec["sco_id"], "title" => $sc_item->getTitle(),
             "score" => $score, "time" => $time, "status" => $status);
         }
         return (array) $data;
     }

Here is the call graph for this function:

◆ getTrackingDataAggSco()

ilObjSCORMLearningModule::getTrackingDataAggSco ( int $a_sco_id )

Definition at line 452 of file class.ilObjSCORMLearningModule.php.

References $data, $DIC, $ilDB, and ilObject\getId().

                                                         : array
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         // get all users with any tracking data
         $user_set = $ilDB->queryF(
             '
                 SELECT DISTINCT user_id FROM scorm_tracking 
                 WHERE obj_id = %s
                 AND sco_id = %s',
             array('integer','integer'),
             array($this->getId(),$a_sco_id)
         );
 
         $data = array();
         while ($user_rec = $ilDB->fetchAssoc($user_set)) {
             $data_set = $ilDB->queryF(
                 '
                     SELECT * FROM scorm_tracking 
                     WHERE obj_id = %s
                     AND sco_id = %s
                     AND user_id = %s
                     AND (lvalue = %s
                     OR lvalue = %s
                     OR lvalue = %s)',
                 array('integer','integer','integer','text','text','text'),
                 array($this->getId(),
                     $a_sco_id,
                     $user_rec["user_id"],
                     "cmi.core.lesson_status",
                     "cmi.core.total_time",
                     "cmi.core.score.raw")
             );
 
             $score = $time = $status = "";
 
             while ($data_rec = $ilDB->fetchAssoc($data_set)) {
                 switch ($data_rec["lvalue"]) {
                     case "cmi.core.lesson_status":
                         $status = $data_rec["rvalue"];
                         break;
 
                     case "cmi.core.total_time":
                         $time = $data_rec["rvalue"];
                         break;
 
                     case "cmi.core.score.raw":
                         $score = $data_rec["rvalue"];
                         break;
                 }
             }
 
             $data[] = array("user_id" => $user_rec["user_id"],
                     "score" => $score, "time" => $time, "status" => $status);
         }
 
         return $data;
     }

Here is the call graph for this function:

◆ getTrackingDataPerUser()

ilObjSCORMLearningModule::getTrackingDataPerUser	(	int	$a_sco_id,
		int	$a_user_id
	)

Get tracking data per user.

Definition at line 366 of file class.ilObjSCORMLearningModule.php.

References $data, $DIC, $ilDB, and ilObject\getId().

                                                                          : array
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $data_set = $ilDB->queryF(
             '
                 SELECT * FROM scorm_tracking 
                 WHERE user_id = %s
                 AND sco_id = %s
                 AND obj_id = %s
                 ORDER BY lvalue',
             array('integer','integer','integer'),
             array($a_user_id,$a_sco_id,$this->getId())
         );
 
         $data = array();
         while ($data_rec = $ilDB->fetchAssoc($data_set)) {
             $data[] = $data_rec;
         }
 
         return $data;
     }

Here is the call graph for this function:

◆ getTrackingItems()

ilObjSCORMLearningModule::getTrackingItems ( )

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

References _getTrackingItems(), and ilObject\getId().

                                       : array
     {
         return ilObjSCORMLearningModule::_getTrackingItems($this->getId());
     }

Here is the call graph for this function:

◆ getUserIdEmail()

ilObjSCORMLearningModule::getUserIdEmail ( string $a_mail )

assumes that only one account exists for a mailadress

Definition at line 1021 of file class.ilObjSCORMLearningModule.php.

References $DIC, and $ilDB.

                                                   : int
     {
         global $DIC;
         $ilDB = $DIC->database();
         $ilUser = $DIC->user();
 
         $val_set = $ilDB->queryF(
             'SELECT usr_id FROM usr_data WHERE(email=%s)',
             array('text'),
             array($a_mail)
         );
         $val_rec = $ilDB->fetchAssoc($val_set);
 
 
         return (int) $val_rec["usr_id"];
     }

◆ importRaw()

ilObjSCORMLearningModule::importRaw ( string $a_file )

private

Import raw data.

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

References $data, $DIC, $ilDB, ilObject\$lng, $user_id, ilLPStatus\_lookupPercentage(), ilLPStatus\_lookupStatus(), ilLPStatusWrapper\_refreshStatus(), get_user_id(), ilObject\getId(), importSuccessForSahsUser(), ILIAS\Repository\int(), kindlyToDateTime(), ilLanguage\loadLanguageModule(), lookupSCOId(), null, parseUserId(), and ilLanguage\txt().

Referenced by importTrackingData().

                                               : bool
     {
         global $DIC;
         $ilDB = $DIC->database();
         $ilUser = $DIC->user();
         $lng = $DIC->language();
         $lng->loadLanguageModule("scormtrac");
 
         $fhandle = fopen($a_file, "r");
 
         $fields = fgetcsv($fhandle, 2 ** 16, ';', '"', '\\');
         $users = array();
         $a_last_access = array();
         $a_time = array();
         $a_package_attempts = array();
         $a_module_version = array();
         while (($csv_rows = fgetcsv($fhandle, 2 ** 16, ";", '"', '\\')) !== false) {
             $data = array_combine($fields, $csv_rows);
             if ($data['Userid']) {
                 $user_id = $this->parseUserId($data['Userid']);
             } elseif ($data[$lng->txt("user")]) {
                 if (is_int($data[$lng->txt("user")])) {
                     $user_id = $data[$lng->txt("user")];
                 }
             }
             if ($data[$lng->txt("login")]) {
                 $user_id = $this->get_user_id($data[$lng->txt("login")]);
             }
             if (!$user_id) {
                 continue;
             }
 
             if ($data['Scoid']) {
                 $il_sco_id = $this->lookupSCOId($data['Scoid']);
             }
             if ($data[$lng->txt("identifierref")]) {
                 $il_sco_id = $this->lookupSCOId($data[$lng->txt("identifierref")]);
             }
             if (!$il_sco_id) {
                 continue;
             }
 
             $c_timestamp = null;
             foreach ([$lng->txt("c_timestamp"), 'Timestamp'] as $key) {
                 if (!empty($data[$key])) {
                     $c_timestamp = $this->kindlyToDateTime('Y-m-d H:i:s', $data[$key]);
                     break;
                 }
             }
 
             $c_timestamp ??= new DateTimeImmutable('now');
             if (!isset($a_last_access[$user_id]) || $a_last_access[$user_id] < $c_timestamp) {
                 $a_last_access[$user_id] = $c_timestamp;
             }
 
             if (!$data['Key']) {
                 continue;
             }
             if (!$data['Value']) {
                 $data['Value'] = "";
             }
 
             if ($data['Key'] === "cmi.core.total_time" && $data['Value'] != "") {
                 $tarr = explode(":", $data['Value']);
                 $sec = (int) $tarr[2] + (int) $tarr[1] * 60 +
                     (int) substr($tarr[0], strlen($tarr[0]) - 3) * 60 * 60;
                 if ($a_time[$user_id]) {
                     $a_time[$user_id] += $sec;
                 } else {
                     $a_time[$user_id] = $sec;
                 }
             }
             //do the actual import
             if ($il_sco_id > 0) {
                 $statement = $ilDB->queryF(
                     '
                                         SELECT * FROM scorm_tracking 
                                         WHERE user_id = %s
                                         AND sco_id = %s 
                                         AND lvalue = %s
                                         AND obj_id = %s',
                     array('integer', 'integer', 'text', 'integer'),
                     array($user_id, $il_sco_id, $data['Key'], $this->getID())
                 );
                 if ($ilDB->numRows($statement) > 0) {
                     $ilDB->update(
                         'scorm_tracking',
                         array(
                             'rvalue' => array('clob', $data['Value']),
                             'c_timestamp' => array('timestamp', $c_timestamp)
                         ),
                         array(
                             'user_id' => array('integer', $user_id),
                             'sco_id' => array('integer', $il_sco_id),
                             'lvalue' => array('text', $data['Key']),
                             'obj_id' => array('integer', $this->getId())
                         )
                     );
                 } else {
                     $ilDB->insert('scorm_tracking', array(
                         'obj_id' => array('integer', $this->getId()),
                         'user_id' => array('integer', $user_id),
                         'sco_id' => array('integer', $il_sco_id),
                         'lvalue' => array('text', $data['Key']),
                         'rvalue' => array('clob', $data['Value']),
                         'c_timestamp' => array('timestamp', $data['Timestamp'])
                     ));
                 }
             }
             // $package_attempts = 1;
             if ($il_sco_id == 0) {
                 if ($data['Key'] === "package_attempts") {
                     $a_package_attempts[$user_id] = $data['Value'];
                 }
                 // if ($data['Key'] == "module_version") $a_module_version[$user_id] = $data['Value'];
             }
             if (!in_array($user_id, $users)) {
                 $users[] = $user_id;
             }
         }
         fclose($fhandle);
         ilLPStatusWrapper::_refreshStatus($this->getId(), $users);
         foreach ($users as $user_id) {
             $attempts = 1;
             if ($a_package_attempts[$user_id]) {
                 $attempts = $a_package_attempts[$user_id];
             }
             // $module_version = 1;
             // if ($a_module_version[$user_id]) $module_version = $a_module_version[$user_id];
             $sco_total_time_sec = null;
             if ($a_time[$user_id]) {
                 $sco_total_time_sec = $a_time[$user_id];
             }
             $last_access = null;
             if (isset($a_last_access[$user_id])) {
                 $last_access = $a_last_access[$user_id];
             }
             // $status = ilLPStatusWrapper::_determineStatus($this->getId(),$user_id);
             $status = (int) ilLPStatus::_lookupStatus($this->getId(), $user_id);
             // $percentage_completed = ilLPStatusSCORM::determinePercentage($this->getId(),$user_id);
             $percentage_completed = ilLPStatus::_lookupPercentage($this->getId(), $user_id);
 
             $this->importSuccessForSahsUser($user_id, $last_access, $status, $attempts, $percentage_completed, $sco_total_time_sec);
         }
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ importSuccess()

ilObjSCORMLearningModule::importSuccess ( string $a_file )

Definition at line 587 of file class.ilObjSCORMLearningModule.php.

References $data, $DIC, $ilDB, $user_id, ilLPStatusWrapper\_refreshStatus(), deleteTrackingDataOfUsers(), get_user_id(), ilObject\getId(), ilObjectLP\getInstance(), importSuccessForSahsUser(), ILIAS\Repository\int(), kindlyToDateTime(), ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED, ilLPStatus\LP_STATUS_FAILED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, ilLPStatus\LP_STATUS_NOT_ATTEMPTED, ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM, and null.

Referenced by importTrackingData().

                                                  : bool
     {
         global $DIC;
         $ilDB = $DIC->database();
         $ilUser = $DIC->user();
         $scos = array();
         $olp = ilObjectLP::getInstance($this->getId());
         $collection = $olp->getCollectionInstance();
         if ($collection) {
             $scos = $collection->getItems();
         }
 
         $fhandle = fopen($a_file, "r");
 
         $obj_id = $this->getID();
         $fields = fgetcsv($fhandle, 2 ** 16, ';', '"', '\\');
         $users = array();
         $usersToDelete = array();
         while (($csv_rows = fgetcsv($fhandle, 2 ** 16, ";", '"', '\\')) !== false) {
             $user_id = 0;
             $data = array_combine($fields, $csv_rows);
             //no check the format - sufficient to import users
             if (isset($data["Login"])) {
                 $user_id = $this->get_user_id($data["Login"]);
             }
             if (isset($data["login"])) {
                 $user_id = $this->get_user_id($data["login"]);
             }
             //add mail in future
             if (isset($data["user"]) && is_numeric($data["user"])) {
                 $user_id = (int) $data["user"];
             }
 
             if ($user_id > 0) {
                 $last_access = new DateTimeImmutable('now');
                 if (isset($data['LastAccess']) && $data['LastAccess']) {
                     $last_access = $this->kindlyToDateTime('Y-m-d H:i:s', $data['LastAccess']);
                 } elseif (isset($data['Date']) && $data['Date']) {
                     $last_access = $this->kindlyToDateTime('d.m.Y', $data['Date']);
                 }
 
                 $status = ilLPStatus::LP_STATUS_COMPLETED_NUM;
 
                 if (isset($data["Status"])) {
                     if (is_int($data["Status"])) {
                         $status = $data["Status"];
                     } elseif ($data["Status"] == "0" || $data["Status"] == "1" || $data["Status"] == "2" || $data["Status"] == "3") {
                         $status = (int) $data["Status"];
                     } elseif ($data["Status"] == ilLPStatus::LP_STATUS_NOT_ATTEMPTED) {
                         $status = ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM;
                     } elseif ($data["Status"] == ilLPStatus::LP_STATUS_IN_PROGRESS) {
                         $status = ilLPStatus::LP_STATUS_IN_PROGRESS_NUM;
                     } elseif ($data["Status"] == ilLPStatus::LP_STATUS_FAILED) {
                         $status = ilLPStatus::LP_STATUS_FAILED_NUM;
                     }
                 }
 
                 $attempts = null;
                 if (isset($data["Attempts"])) {
                     $attempts = (int) $data["Attempts"];
                 }
 
                 $percentage_completed = 0;
                 if ($status == ilLPStatus::LP_STATUS_COMPLETED_NUM) {
                     $percentage_completed = 100;
                 }
                 if (isset($data['percentageCompletedSCOs'])) {
                     $percentage_completed = (int) $data['percentageCompletedSCOs'];
                 }
 
                 $sco_total_time_sec = null;
                 if (isset($data['SumTotal_timeSeconds'])) {
                     $sco_total_time_sec = (int) $data['SumTotal_timeSeconds'];
                 }
 
                 if ($status == ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM) {
                     $usersToDelete[] = $user_id;
                 } else {
                     $this->importSuccessForSahsUser($user_id, $last_access, $status, $attempts, $percentage_completed, $sco_total_time_sec);
                     $users[] = $user_id;
                 }
 
                 if ($status == ilLPStatus::LP_STATUS_COMPLETED_NUM) {
                     foreach ($scos as $sco_id) {
                         $statement = $ilDB->queryF(
                             '
                                                         SELECT * FROM scorm_tracking 
                                                         WHERE user_id = %s
                                                         AND sco_id = %s 
                                                         AND lvalue = %s
                                                         AND obj_id = %s',
                             array('integer','integer','text','integer'),
                             array($user_id, $sco_id, 'cmi.core.lesson_status',$obj_id)
                         );
                         if ($ilDB->numRows($statement) > 0) {
                             $ilDB->update(
                                 'scorm_tracking',
                                 array(
                                     'rvalue' => array('clob', 'completed'),
                                     'c_timestamp' => array('timestamp', $last_access?->format('Y-m-d H:i:s'))
                                 ),
                                 array(
                                     'user_id' => array('integer', $user_id),
                                     'sco_id' => array('integer', $sco_id),
                                     'lvalue' => array('text', 'cmi.core.lesson_status'),
                                     'obj_id' => array('integer', $obj_id)
                                 )
                             );
                         } else {
                             $ilDB->insert('scorm_tracking', array(
                                 'obj_id' => array('integer', $obj_id),
                                 'user_id' => array('integer', $user_id),
                                 'sco_id' => array('integer', $sco_id),
                                 'lvalue' => array('text', 'cmi.core.lesson_status'),
                                 'rvalue' => array('clob', 'completed'),
                                 'c_timestamp' => array('timestamp', $last_access?->format('Y-m-d H:i:s'))
                             ));
                         }
                     }
                 }
             } else {
                 //echo "Warning! User $csv_rows[0] does not exist in ILIAS. Data for this user was skipped.\n";
             }
         }
 
         if (count($usersToDelete) > 0) {
             // include_once("../components/ILIAS/Tracking/classes/class.ilLPMarks.php");
             // ilLPMarks::_deleteForUsers($this->getId(), $usersToDelete);
             $this->deleteTrackingDataOfUsers($usersToDelete);
         }
         ilLPStatusWrapper::_refreshStatus($this->getId(), $users);
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ importSuccessForSahsUser()

ilObjSCORMLearningModule::importSuccessForSahsUser	(	int	$user_id,
		?DateTimeImmutable	$last_access,
		int	$status,
		?int	$attempts = `null`,
		?int	$percentage_completed = `null`,
		?int	$sco_total_time_sec = `null`
	)

Definition at line 744 of file class.ilObjSCORMLearningModule.php.

References $DIC, $ilDB, $user_id, ilChangeEvent\_lookupReadEvents(), and ilChangeEvent\_recordReadEvent().

Referenced by importRaw(), ilObjSCORM2004LearningModule\importSuccess(), and importSuccess().

      : void {
         global $DIC;
         $ilDB = $DIC->database();
         $statement = $ilDB->queryF(
             'SELECT * FROM sahs_user WHERE obj_id = %s AND user_id = %s',
             array('integer','integer'),
             array($this->getID(),$user_id)
         );
         if ($ilDB->numRows($statement) > 0) {
             $ilDB->update(
                 'sahs_user',
                 array(
                     'last_access' => array('timestamp', $last_access?->format('Y-m-d H:i:s')),
                     'status' => array('integer', $status),
                     'package_attempts' => array('integer', $attempts),
                     'percentage_completed' => array('integer', $percentage_completed),
                     'sco_total_time_sec' => array('integer', $sco_total_time_sec)
                 ),
                 array(
                     'obj_id' => array('integer', $this->getID()),
                     'user_id' => array('integer', $user_id)
                 )
             );
         } else {
             $ilDB->insert('sahs_user', array(
                 'obj_id' => array('integer', $this->getID()),
                 'user_id' => array('integer', $user_id),
                 'last_access' => array('timestamp', $last_access?->format('Y-m-d H:i:s')),
                 'status' => array('integer', $status),
                 'package_attempts' => array('integer', $attempts),
                 'percentage_completed' => array('integer', $percentage_completed),
                 'sco_total_time_sec' => array('integer', $sco_total_time_sec)
             ));
         }
         //        since 8 necessary because attempts can be null
         if (ilChangeEvent::_lookupReadEvents($this->getID(), $user_id) == []) {
             ilChangeEvent::_recordReadEvent("sahs", $DIC->http()->wrapper()->query()->retrieve('ref_id', $DIC->refinery()->kindlyTo()->int()), $this->getID(), $user_id, false);
         }
 
         ilChangeEvent::_recordReadEvent("sahs", $DIC->http()->wrapper()->query()->retrieve('ref_id', $DIC->refinery()->kindlyTo()->int()), $this->getID(), $user_id, false, $attempts, $sco_total_time_sec);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ importTrackingData()

ilObjSCORMLearningModule::importTrackingData ( string $a_file )

Definition at line 554 of file class.ilObjSCORMLearningModule.php.

References $DIC, $ilDB, importRaw(), importSuccess(), and null.

                                                       : bool
     {
         global $DIC;
         $ilDB = $DIC->database();
         $ilUser = $DIC->user();
 
         $success = false;
         //echo file_get_contents($a_file);
         $method = null;
 
         //lets import
         $fhandle = fopen($a_file, "r");
 
         //the top line is the field names
         $fields = fgetcsv($fhandle, 2 ** 16, ';', '"', '\\');
         //lets check the import method
         fclose($fhandle);
 
         switch ($fields[0]) {
             case "Scoid":
             case "SCO-Identifier":
                 $success = $this->importRaw($a_file);
                 break;
             case "Department":
             case "LearningModuleId":
                 $success = $this->importSuccess($a_file);
                 break;
             default:
                 return false;
         }
         return $success;
     }

Here is the call graph for this function:

◆ kindlyToDateTime()

ilObjSCORMLearningModule::kindlyToDateTime	(	string	$format,
		string	$maybe_datetime,
		?DateTimeImmutable	$default = `null`
	)

protected

Definition at line 721 of file class.ilObjSCORMLearningModule.php.

References $datetime, and null.

Referenced by importRaw(), ilObjSCORM2004LearningModule\importSuccess(), and importSuccess().

      : ?DateTimeImmutable {
         $datetime = $default;
 
         if ($maybe_datetime === '0000-00-00 00:00:00' || $maybe_datetime === '0000-00-00') {
             return null;
         }
 
         try {
             $parsed_date = DateTimeImmutable::createFromFormat($format, $maybe_datetime);
             if ($parsed_date !== false) {
                 $datetime = $parsed_date;
             }
         } catch (Throwable) {
             // Ignore
         }
 
         return $datetime;
     }

Here is the caller graph for this function:

◆ lookupSCOId()

ilObjSCORMLearningModule::lookupSCOId ( string $a_referrer )

private

resolves manifest SCOID to internal ILIAS SCO ID

Definition at line 993 of file class.ilObjSCORMLearningModule.php.

References $DIC, and $ilDB.

Referenced by importRaw().

                                                     : int
     {
         global $DIC;
         $ilDB = $DIC->database();
         $ilUser = $DIC->user();
 
         //non specific SCO entries
         if ($a_referrer == "0") {
             return 0;
         }
 
         $val_set = $ilDB->queryF(
             '
                 SELECT obj_id FROM sc_item,scorm_tree 
                 WHERE (obj_id = child 
                 AND identifierref = %s 
                 AND slm_id = %s)',
             array('text','integer'),
             array($a_referrer,$this->getID())
         );
         $val_rec = $ilDB->fetchAssoc($val_set);
 
         return (int) $val_rec["obj_id"];
     }

Here is the caller graph for this function:

◆ parseUserId()

ilObjSCORMLearningModule::parseUserId ( string $il_id )

private

Parse il_usr_123_6 id.

Definition at line 796 of file class.ilObjSCORMLearningModule.php.

References $DIC, $ilSetting, and $parts.

Referenced by importRaw().

                                                : int
     {
         global $DIC;
         $ilSetting = $DIC->settings();
 
         $parts = explode('_', $il_id);
 
         if (!count((array) $parts)) {
             return 0;
         }
         if (!isset($parts[2]) or !isset($parts[3])) {
             return 0;
         }
         if ($parts[2] != $ilSetting->get('inst_id', $parts[2])) {
             return 0;
         }
         return (int) $parts[3];
     }

Here is the caller graph for this function:

◆ readObject()

ilObjSCORMLearningModule::readObject ( )

read manifest file

Exceptions

ilSaxParserException

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

References $DIC, $ilErr, ilObjSAHSLearningModule\getDataDirectory(), and ILIAS\Repository\lng().

                                 : string
     {
         global $DIC;
         $ilErr = $DIC['ilErr'];
 
         $needs_convert = false;
 
         // convert imsmanifest.xml file in iso to utf8 if needed
 
         $manifest_file = $this->getDataDirectory() . "/imsmanifest.xml";
 
         // check if manifestfile exists and space left on device...
         $check_for_manifest_file = is_file($manifest_file);
 
         // if no manifestfile
         if (!$check_for_manifest_file) {
             $ilErr->raiseError($this->lng->txt("Manifestfile $manifest_file not found!"), $ilErr->MESSAGE);
             return "";
         }
 
         if ($check_for_manifest_file) {
             $manifest_file_array = file($manifest_file);
             foreach ($manifest_file_array as $mfa) {
                 // if (seems_not_utf8($mfa))
                 if (@iconv('UTF-8', 'UTF-8', $mfa) != $mfa) {
                     $needs_convert = true;
                     break;
                 }
             }
 
             // to copy the file we need some extraspace, counted in bytes *2 ... we need 2 copies....
             $estimated_manifest_filesize = filesize($manifest_file) * 2;
 
             // i deactivated this, because it seems to fail on some windows systems (see bug #1795)
             //$check_disc_free = disk_free_space($this->getDataDirectory()) - $estimated_manifest_filesize;
             $check_disc_free = 2;
         }
 
         // if $manifest_file needs to be converted to UTF8
         if ($needs_convert) {
             // if file exists and enough space left on device
             if ($check_for_manifest_file && ($check_disc_free > 1)) {
                 // create backup from original
                 if (!copy($manifest_file, $manifest_file . ".old")) {
                     echo "Failed to copy $manifest_file...<br>\n";
                 }
 
                 // read backupfile, convert each line to utf8, write line to new file
                 // php < 4.3 style
                 $f_write_handler = fopen($manifest_file . ".new", "w");
                 $f_read_handler = fopen($manifest_file . ".old", "r");
                 while (!feof($f_read_handler)) {
                     $zeile = fgets($f_read_handler);
                     //echo mb_detect_encoding($zeile);
                     fwrite($f_write_handler, utf8_encode($zeile));
                 }
                 fclose($f_read_handler);
                 fclose($f_write_handler);
 
                 // copy new utf8-file to imsmanifest.xml
                 if (!copy($manifest_file . ".new", $manifest_file)) {
                     echo "Failed to copy $manifest_file...<br>\n";
                 }
 
                 if (!@is_file($manifest_file)) {
                     $ilErr->raiseError($this->lng->txt("cont_no_manifest"), $ilErr->WARNING);
                 }
             } else {
                 // gives out the specific error
 
                 if (!($check_disc_free > 1)) {
                     $ilErr->raiseError($this->lng->txt("Not enough space left on device!"), $ilErr->MESSAGE);
                 }
                 return "";
             }
         } else {
             // check whether file starts with BOM (that confuses some sax parsers, see bug #1795)
             $hmani = fopen($manifest_file, "r");
             $start = fread($hmani, 3);
             if (strtolower(bin2hex($start)) === "efbbbf") {
                 $f_write_handler = fopen($manifest_file . ".new", "w");
                 while (!feof($hmani)) {
                     $n = fread($hmani, 900);
                     fwrite($f_write_handler, $n);
                 }
                 fclose($f_write_handler);
                 fclose($hmani);
 
                 // copy new utf8-file to imsmanifest.xml
                 if (!copy($manifest_file . ".new", $manifest_file)) {
                     echo "Failed to copy $manifest_file...<br>\n";
                 }
             } else {
                 fclose($hmani);
             }
         }
 
         // todo determine imsmanifest.xml path here...
         $slmParser = new ilSCORMPackageParser($this, $manifest_file);
         $slmParser->startParsing();
         return (string) $slmParser->getPackageTitle();
     }

Here is the call graph for this function:

◆ sendExportFile()

ilObjSCORMLearningModule::sendExportFile	(	string	$a_header,
		string	$a_content
	)

send export file to browser

Definition at line 1042 of file class.ilObjSCORMLearningModule.php.

References $filename, $timestamp, ilUtil\deliverData(), exit, and ilObject\getRefId().

Referenced by exportSelected().

                                                                        : void
     {
         $timestamp = time();
         $refid = $this->getRefId();
         $filename = "scorm_tracking_" . $refid . "_" . $timestamp . ".csv";
         ilUtil::deliverData($a_header . $a_content, $filename);
         exit;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setLearningProgressSettingsAtUpload()

ilObjSCORMLearningModule::setLearningProgressSettingsAtUpload ( )

set settings for learning progress determination per default at upload

Definition at line 180 of file class.ilObjSCORMLearningModule.php.

References $DIC, $ilSetting, $lm_set, ilObjUserTracking\_enabledLearningProgress(), ilObject\getId(), and ilLPObjSettings\LP_MODE_SCORM.

                                                          : void
     {
         global $DIC;
         $ilSetting = $DIC->settings();
         //condition 1
         $lm_set = new ilSetting("lm");
         if ($lm_set->get('scorm_lp_auto_activate') != 1) {
             return;
         }
         if (ilObjUserTracking::_enabledLearningProgress() == false) {
             return;
         }
         $lm_set = new ilLPObjSettings($this->getId());
         $lm_set->setMode(ilLPObjSettings::LP_MODE_SCORM);
         $lm_set->insert();
         $collection = new ilLPCollectionOfSCOs($this->getId(), ilLPObjSettings::LP_MODE_SCORM);
         $scos = array();
         foreach ($collection->getPossibleItems() as $sco_id => $item) {
             $scos[] = $sco_id;
         }
         $collection->activateEntries($scos);
     }

Here is the call graph for this function:

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

components/ILIAS/ScormAicc/classes/class.ilObjSCORMLearningModule.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getAllScoIds()

◆ _getCourseCompletionForUser()

◆ _getScoresForUser()

◆ _getStatusForUser()

◆ _getTrackingItems()

◆ _removeTrackingDataForUser()

◆ deleteTrackingDataOfUsers()

◆ exportSelected()

◆ get_user_id()

◆ getAllScoIds()

◆ getAttemptsForUser()

◆ getAttemptsForUsers()

◆ getCourseCompletionForUser()

◆ getLastVisited()

◆ getModuleVersionForUser()

◆ getModuleVersionForUsers()

◆ getStatusForUser()

◆ getTrackedItems()

◆ getTrackedUsers()

◆ getTrackingDataAgg()

◆ getTrackingDataAggSco()

◆ getTrackingDataPerUser()

◆ getTrackingItems()

◆ getUserIdEmail()

◆ importRaw()

◆ importSuccess()

◆ importSuccessForSahsUser()

◆ importTrackingData()

◆ kindlyToDateTime()

◆ lookupSCOId()

◆ parseUserId()

◆ readObject()

◆ sendExportFile()

◆ setLearningProgressSettingsAtUpload()