Class ilObjSCORM2004LearningModule. More...

Inheritance diagram for ilObjSCORM2004LearningModule:

Collaboration diagram for ilObjSCORM2004LearningModule:

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

	setImportSequencing (bool $a_val)
	Set import sequencing. More...

	getImportSequencing ()
	Get import sequencing. More...

	readObject ()
	read manifest file More...

	fixReload ()

	convert_1_2_to_2004 (string $manifest)

	deleteTrackingDataOfUsers (array $a_users)

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

	getTrackingDataAgg (int $a_user_id, ?bool $raw=false)

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

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

	importSuccess (string $a_file)

Public Member Functions inherited from ilObjSCORMLearningModule
	__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)

	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 @global 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 ()

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

	setDebug (bool $a_debug)

	setAutoContinue (bool $a_auto_continue)

	getAutoContinue ()

	getAuto_last_visited ()

	setAuto_last_visited (bool $a_auto_last_visited)

	setAutoSuspend (bool $a_auto_suspend)

	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	_lookupLastAccess (int $a_obj_id, int $a_usr_id)
	Return the last access timestamp for a given user. More...

static	_ISODurationToCentisec (string $str)
	convert ISO 8601 Timeperiods to centiseconds More...

static	getQuantityOfSCOs (int $a_slm_id)

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

static	_getUniqueScaledScoreForUser (int $a_id, int $a_user)
	Get the Unique Scaled Score of a course Conditions: Only one SCO may set cmi.score.scaled. More...

static	_getTrackingItems (int $a_obj_id)
	get all tracking items of scorm object currently a for learning progress only More...

static	_getStatus (int $a_obj_id, int $a_user_id)

static	_getSatisfied (int $a_obj_id, int $a_user_id)

static	_getMeasure (int $a_obj_id, int $a_user_id)

static	_lookupItemTitle (int $a_node_id)

static	_getMaxScoreForUser (int $a_id, int $a_user)
	Returns score.max for the learning module, refered to the last sco where score.max is set. More...

static	_getScores2004ForUser (int $a_cp_node_id, int $a_user)

Static Public Member Functions inherited from ilObjSCORMLearningModule
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)

Data Fields
const	CONVERT_XSL = '../components/ILIAS/Scorm2004/templates/xsl/op/scorm12To2004.xsl'

const	WRAPPER_HTML = '../components/ILIAS/Scorm2004/scripts/converter/GenericRunTimeWrapper1.0_aadlc/GenericRunTimeWrapper.htm'

const	WRAPPER_JS = '../components/ILIAS/Scorm2004/scripts/converter/GenericRunTimeWrapper1.0_aadlc/SCOPlayerWrapper.js'

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
ilObjUser	$user

ilTabsGUI	$tabs

bool	$import_sequencing = false

string	$imsmanifestFile

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

Private Attributes
string	$packageFolder

string	$backupManifest

DomDocument	$totransform

Additional Inherited Members
Protected Member Functions inherited from ilObjSCORMLearningModule
	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 ()

Detailed Description

Class ilObjSCORM2004LearningModule.

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

Definition at line 27 of file class.ilObjSCORM2004LearningModule.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjSCORM2004LearningModule::__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)

Reimplemented from ilObjSCORMLearningModule.

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

    {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->error = $DIC["ilErr"];
        $this->db = $DIC->database();
        $this->log = ilLoggerFactory::getLogger('sc13');
        $this->user = $DIC->user();
        $this->tabs = $DIC->tabs();
        $this->type = "sahs";
        parent::__construct($a_id, $a_call_by_reference);
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), error(), ilLoggerFactory\getLogger(), ILIAS\Repository\lng(), ILIAS\Repository\tabs(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ _getCourseCompletionForUser()

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

static

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

Returns: boolean Completion status

Reimplemented from ilObjSCORMLearningModule.

Definition at line 688 of file class.ilObjSCORM2004LearningModule.php.

                                                                              : bool
    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $ilUser = $DIC->user();
        $scos = array();
        //get all SCO's of the object
 
        $val_set = $ilDB->queryF(
            '
                SELECT cp_node.cp_node_id FROM cp_node,cp_resource,cp_item 
                WHERE cp_item.cp_node_id = cp_node.cp_node_id 
                AND cp_item.resourceid = cp_resource.id 
                AND scormtype = %s
                AND nodename =  %s 
                AND cp_node.slm_id =  %s',
            array('text','text','integer'),
            array('sco' ,'item',$a_id)
        );
        while ($val_rec = $ilDB->fetchAssoc($val_set)) {
            $scos[] = $val_rec['cp_node_id'];
        }
 
        $scos_c = $scos;
        //copy SCO_array
        //check if all SCO's are completed
        foreach ($scos as $i => $value) {
            $val_set = $ilDB->queryF(
                '
                                SELECT * FROM cmi_node 
                                WHERE (user_id= %s
                                AND cp_node_id= %s
                                AND (completion_status = %s OR success_status = %s))',
                array('integer','integer','text','text'),
                array($a_user, $value,'completed','passed')
            );
 
            if ($ilDB->numRows($val_set) > 0) {
                //delete from array
                $key = array_search($value, $scos_c);
                unset($scos_c[$key]);
            }
        }
        //check for completion
        if (count($scos_c) == 0) {
            $completion = true;
        } else {
            $completion = false;
        }
        return $completion;
    }

References $DIC, and $ilDB.

◆ _getMaxScoreForUser()

static ilObjSCORM2004LearningModule::_getMaxScoreForUser	(	int	$a_id,
		int	$a_user
	)

static

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

Definition at line 920 of file class.ilObjSCORM2004LearningModule.php.

                                                                      : ?float
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $scos = array();
 
        $result = $ilDB->query(
            'SELECT cp_node.cp_node_id '
           . 'FROM cp_node, cp_resource, cp_item '
           . 'WHERE cp_item.cp_node_id = cp_node.cp_node_id '
           . 'AND cp_item.resourceId = cp_resource.id '
           . 'AND scormType = ' . $ilDB->quote('sco', 'text') . ' '
           . 'AND nodeName = ' . $ilDB->quote('item', 'text') . ' '
           . 'AND cp_node.slm_id = ' . $ilDB->quote($a_id, 'integer') . ' '
           . 'GROUP BY cp_node.cp_node_id'
        );
 
        while ($row = $ilDB->fetchAssoc($result)) {
            $scos[] = $row['cp_node_id'];
        }
 
        $set = 0; //numbers of SCO that set cmi.score.scaled
        $max = null;
        foreach ($scos as $i => $value) {
            $res = $ilDB->queryF(
                'SELECT c_max FROM cmi_node WHERE (user_id = %s AND cp_node_id = %s)',
                array('integer', 'integer'),
                array($a_user, $value)
            );
 
            if ($ilDB->numRows($res) > 0) {
                $row = $ilDB->fetchAssoc($res);
                if ($row['c_max'] != null) {
                    $set++;
                    $max = floatval($row['c_max']);
                }
            }
        }
        return ($set == 1) ? $max : null;
    }

References $DIC, $ilDB, and $res.

Referenced by ilObjSAHSLearningModule\getMaxPoints().

Here is the caller graph for this function:

◆ _getMeasure()

static ilObjSCORM2004LearningModule::_getMeasure	(	int	$a_obj_id,
		int	$a_user_id
	)

static

Definition at line 874 of file class.ilObjSCORM2004LearningModule.php.

                                                                     : float|bool
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $status_set = $ilDB->queryF(
            '
                        SELECT * FROM cmi_gobjective 
                        WHERE scope_id = %s
                        AND objective_id = %s
                        AND user_id = %s',
            array('integer','text','integer'),
            array($a_obj_id,'-course_overall_status-',$a_user_id)
        );
 
        if ($status_rec = $ilDB->fetchAssoc($status_set)) {
            return (float) $status_rec["measure"];
        }
 
        return false;
    }

References $DIC, and $ilDB.

◆ _getSatisfied()

static ilObjSCORM2004LearningModule::_getSatisfied	(	int	$a_obj_id,
		int	$a_user_id
	)

static

Definition at line 850 of file class.ilObjSCORM2004LearningModule.php.

                                                                       : bool|string
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
 
        $status_set = $ilDB->queryF(
            '
                        SELECT * FROM cmi_gobjective 
                        WHERE scope_id = %s
                        AND objective_id = %s
                        AND user_id = %s',
            array('integer','text','integer'),
            array($a_obj_id,'-course_overall_status-',$a_user_id)
        );
 
        if ($status_rec = $ilDB->fetchAssoc($status_set)) {
            return $status_rec["satisfied"];
        }
 
        return false;
    }

References $DIC, and $ilDB.

◆ _getScores2004ForUser()

static ilObjSCORM2004LearningModule::_getScores2004ForUser	(	int	$a_cp_node_id,
		int	$a_user
	)

static

Returns: array<string, mixed>

Definition at line 966 of file class.ilObjSCORM2004LearningModule.php.

                                                                                : array
    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $retAr = array("raw" => null, "max" => null, "scaled" => null);
        $val_set = $ilDB->queryF(
            "SELECT c_raw, c_max, scaled FROM cmi_node WHERE (user_id = %s AND cp_node_id = %s)",
            array('integer', 'integer'),
            array($a_user, $a_cp_node_id)
        );
        if ($val_set->numRows() > 0) {
            $val_rec = $ilDB->fetchAssoc($val_set);
            $retAr["raw"] = $val_rec['c_raw'];
            $retAr["max"] = $val_rec['c_max'];
            $retAr["scaled"] = $val_rec['scaled'];
            if ($val_rec['scaled'] == null && $val_rec['c_raw'] != null && $val_rec['c_max'] != null) {
                $retAr["scaled"] = ($val_rec['c_raw'] / $val_rec['c_max']);
            }
        }
        return $retAr;
    }

References $DIC, and $ilDB.

Referenced by ilLPCollectionOfSCOs\getScoresForUserAndCP_Node_Id().

Here is the caller graph for this function:

◆ _getStatus()

static ilObjSCORM2004LearningModule::_getStatus	(	int	$a_obj_id,
		int	$a_user_id
	)

static

Definition at line 827 of file class.ilObjSCORM2004LearningModule.php.

                                                                    : bool|string
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $status_set = $ilDB->queryF(
            '
                        SELECT * FROM cmi_gobjective 
                        WHERE scope_id = %s
                        AND objective_id = %s
                        AND user_id = %s',
            array('integer','text','integer'),
            array($a_obj_id,'-course_overall_status-',$a_user_id)
        );
 
        if ($status_rec = $ilDB->fetchAssoc($status_set)) {
            return $status_rec["status"];
        }
 
        return false;
    }

References $DIC, and $ilDB.

◆ _getTrackingItems()

static ilObjSCORM2004LearningModule::_getTrackingItems ( int $a_obj_id )

static

get all tracking items of scorm object currently a for learning progress only

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

Reimplemented from ilObjSCORMLearningModule.

Definition at line 787 of file class.ilObjSCORM2004LearningModule.php.

                                                           : array
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
 
        $item_set = $ilDB->queryF(
            '
                        SELECT cp_item.*  FROM cp_node, cp_item WHERE slm_id = %s
                        AND cp_node.cp_node_id = cp_item.cp_node_id 
                        ORDER BY cp_node.cp_node_id ',
            array('integer'),
            array($a_obj_id)
        );
 
        $items = array();
        while ($item_rec = $ilDB->fetchAssoc($item_set)) {
            $s2 = $ilDB->queryF(
                '
                                SELECT cp_resource.* FROM cp_node, cp_resource 
                                WHERE slm_id = %s
                                AND cp_node.cp_node_id = cp_resource.cp_node_id 
                                AND cp_resource.id = %s ',
                array('integer','text'),
                array($a_obj_id,$item_rec["resourceid"])
            );
 
 
            if ($res = $ilDB->fetchAssoc($s2)) {
                if ($res["scormtype"] === "sco") {
                    $items[] = array("id" => $item_rec["cp_node_id"],
                        "title" => $item_rec["title"]);
                }
            }
        }
 
        return $items;
    }

References $DIC, $ilDB, and $res.

Referenced by ilLPCollectionOfSCOs\getPossibleItems().

Here is the caller graph for this function:

◆ _getUniqueScaledScoreForUser()

static ilObjSCORM2004LearningModule::_getUniqueScaledScoreForUser	(	int	$a_id,
		int	$a_user
	)

static

Get the Unique Scaled Score of a course Conditions: Only one SCO may set cmi.score.scaled.

Returns: float scaled score, -1 if not unique

Definition at line 746 of file class.ilObjSCORM2004LearningModule.php.

                                                                               : float
    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $ilUser = $DIC->user();
        $scos = array();
 
        $val_set = $ilDB->queryF(
            "SELECT cp_node.cp_node_id FROM cp_node,cp_resource,cp_item WHERE" .
            " cp_item.cp_node_id=cp_node.cp_node_id AND cp_item.resourceId = cp_resource.id AND scormType='sco' AND nodeName='item' AND cp_node.slm_id = %s GROUP BY cp_node.cp_node_id",
            array('integer'),
            array($a_id)
        );
        while ($val_rec = $ilDB->fetchAssoc($val_set)) {
            $scos[] = $val_rec['cp_node_id'];
        }
        $set = 0;   //numbers of SCO that set cmi.score.scaled
        $scaled = null;
        foreach ($scos as $i => $iValue) {
            $val_set = $ilDB->queryF(
                "SELECT scaled FROM cmi_node WHERE (user_id = %s AND cp_node_id = %s)",
                array('integer', 'integer'),
                array($a_user, $scos[$i])
            );
            if ($val_set->numRows() > 0) {
                $val_rec = $ilDB->fetchAssoc($val_set);
                if ($val_rec['scaled'] != null) {
                    $set++;
                    $scaled = $val_rec['scaled'];
                }
            }
        }
        return ($set == 1) ? $scaled : -1;
    }

References $DIC, and $ilDB.

Referenced by ilObjSAHSLearningModule\getPointsInPercent().

Here is the caller graph for this function:

◆ _ISODurationToCentisec()

static ilObjSCORM2004LearningModule::_ISODurationToCentisec ( string $str )

static

convert ISO 8601 Timeperiods to centiseconds

Definition at line 614 of file class.ilObjSCORM2004LearningModule.php.

                                                              : float
    {
        $aV = array(0, 0, 0, 0, 0, 0);
        $bErr = false;
        $bTFound = false;
        if (strpos($str, "P") != 0) {
            $bErr = true;
        }
        if (!$bErr) {
            $aT = array("Y", "M", "D", "H", "M", "S");
            $p = 0;
            $i = 0;
            $str = substr($str, 1);
            for ($i = 0, $max = count($aT); $i < $max; $i++) {
                if (strpos($str, "T") === 0) {
                    $str = substr($str, 1);
                    $i = max($i, 3);
                    $bTFound = true;
                }
                $p = strpos($str, $aT[$i]);
 
                if ($p > -1) {
                    if ($i == 1 && strpos($str, "T") > -1 && strpos($str, "T") < $p) {
                        continue;
                    }
                    if ($aT[$i] === "S") {
                        $aV[$i] = substr($str, 0, $p);
                    } else {
                        $aV[$i] = intval(substr($str, 0, $p));
                    }
                    if (!is_numeric($aV[$i])) {
                        $bErr = true;
                        break;
                    }
 
                    if ($i > 2 && !$bTFound) {
                        $bErr = true;
                        break;
                    }
                    $str = substr($str, $p + 1);
                }
            }
            if (!$bErr && strlen($str) != 0) {
                $bErr = true;
            }
        }
 
        if ($bErr) {
            return 0;
        }
        return $aV[0] * 3_155_760_000 + $aV[1] * 262_980_000 + $aV[2] * 8_640_000 + $aV[3] * 360000 + $aV[4] * 6000 + round($aV[5] * 100);
    }

Referenced by ilCmiXapiHighscoreReport\fetchTotalDuration(), ilSCORM2004Tracking\getSumTotalTimeSecondsFromScos(), and getTrackingDataAgg().

Here is the caller graph for this function:

◆ _lookupItemTitle()

static ilObjSCORM2004LearningModule::_lookupItemTitle ( int $a_node_id )

static

Definition at line 897 of file class.ilObjSCORM2004LearningModule.php.

                                                           : string
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $r = $ilDB->queryF(
            '
                        SELECT * FROM cp_item
                        WHERE cp_node_id = %s',
            array('integer'),
            array($a_node_id)
        );
 
        if ($i = $ilDB->fetchAssoc($r)) {
            return $i["title"];
        }
        return "";
    }

References $DIC, and $ilDB.

Referenced by ilLPStatusSCORM\_getStatusInfo(), getTrackedItems(), and getTrackingDataAgg().

Here is the caller graph for this function:

◆ _lookupLastAccess()

static ilObjSCORM2004LearningModule::_lookupLastAccess	(	int	$a_obj_id,
		int	$a_usr_id
	)

static

Return the last access timestamp for a given user.

Definition at line 293 of file class.ilObjSCORM2004LearningModule.php.

                                                                          : ?string
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $result = $ilDB->queryF(
            '
                        SELECT MAX(c_timestamp) last_access 
                        FROM cmi_node, cp_node 
                        WHERE cmi_node.cp_node_id = cp_node.cp_node_id 
                        AND cp_node.slm_id = %s
                        AND user_id = %s
                        GROUP BY c_timestamp',
            array('integer', 'integer'),
            array($a_obj_id, $a_usr_id)
        );
        if ($ilDB->numRows($result)) {
            $row = $ilDB->fetchAssoc($result);
            return (string) $row["last_access"];
        }
 
        return null;
    }

References $DIC, and $ilDB.

◆ convert_1_2_to_2004()

ilObjSCORM2004LearningModule::convert_1_2_to_2004 ( string $manifest )

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

                                                         : void
    {
        $ilDB = $this->db;
        $ilLog = $this->log;
 
        ##check manifest-file for version. Check for schemaversion as this is a required element for SCORM 2004
        ##accept 2004 3rd Edition an CAM 1.3 as valid schemas
 
        //set variables
        $this->packageFolder = $this->getDataDirectory();
        $this->imsmanifestFile = $manifest;
        $doc = new DomDocument();
 
        //fix reload errors before loading
        $this->fixReload();
        $doc->load($this->imsmanifestFile);
        $elements = $doc->getElementsByTagName("schemaversion");
        $schema = "";
        if (isset($elements->item(0)->nodeValue)) {
            $schema = $elements->item(0)->nodeValue;
        }
        if (strtolower(trim($schema)) === "cam 1.3" || strtolower(trim($schema)) === "2004 3rd edition" || strtolower(trim($schema)) === "2004 4th edition") {
            //no conversion
            //            $this->converted = false;
            return;
        }
 
        //        $this->converted = true;
        //convert to SCORM 2004
 
        //check for broken SCORM 1.2 manifest file (missing organization default-common error in a lot of manifest files)
        $organizations = $doc->getElementsByTagName("organizations");
        //first check if organizations is in manifest
        if ($organizations->item(0) == null) {
            die("organizations missing in manifest");
        }
        $default = $organizations->item(0)->getAttribute("default");
        if ($default == "" || $default == null) {
            //lookup identifier
            $organization = $doc->getElementsByTagName("organization");
            $item = $organization->item(0);
            if ($item !== null) {
                $ident = $item->getAttribute("identifier");
                $organizations->item(0)->setAttribute("default", $ident);
            }
        }
 
        //validate the fixed mainfest. If it's still not valid, don't transform an throw error
 
 
        //first copy wrappers
        $wrapperdir = $this->packageFolder . "/GenericRunTimeWrapper1.0_aadlc";
        if (!mkdir($wrapperdir) && !is_dir($wrapperdir)) {
            throw new \RuntimeException(sprintf('Directory "%s" was not created', $wrapperdir));
        }
        copy(self::WRAPPER_HTML, $wrapperdir . "/GenericRunTimeWrapper.htm");
        copy(self::WRAPPER_JS, $wrapperdir . "/SCOPlayerWrapper.js");
 
        //backup manifestfile
        $this->backupManifest = $this->packageFolder . "/imsmanifest.xml.back";
        $ret = copy($this->imsmanifestFile, $this->backupManifest);
 
        //transform manifest file
        $this->totransform = $doc;
        $ilLog->write("SCORM: about to transform to SCORM 2004");
 
        $xsl = new DOMDocument();
        //        $xsl->async = false;
        $xsl->load(self::CONVERT_XSL);
        $prc = new XSLTProcessor();
        $r = @$prc->importStyleSheet($xsl);
 
        file_put_contents($this->imsmanifestFile, $prc->transformToXML($this->totransform));
 
        $ilLog->write("SCORM: Transformation completed");
    }

References ilObject\$db, $ilDB, ilObject\$log, fixReload(), and ilObjSAHSLearningModule\getDataDirectory().

Referenced by readObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteTrackingDataOfUsers()

ilObjSCORM2004LearningModule::deleteTrackingDataOfUsers ( array $a_users )

Reimplemented from ilObjSCORMLearningModule.

Definition at line 318 of file class.ilObjSCORM2004LearningModule.php.

                                                             : void
    {
        $ilDB = $this->db;
        ilChangeEvent::_deleteReadEventsForUsers($this->getId(), $a_users);
 
        foreach ($a_users as $user) {
            ilSCORM2004DeleteData::removeCMIDataForUserAndPackage($user, $this->getId());
            ilLPStatusWrapper::_updateStatus($this->getId(), $user);
        }
    }

References ilObject\$db, $ilDB, $user, ilChangeEvent\_deleteReadEventsForUsers(), ilLPStatusWrapper\_updateStatus(), ilObject\getId(), and ilSCORM2004DeleteData\removeCMIDataForUserAndPackage().

Referenced by importSuccess().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fixReload()

ilObjSCORM2004LearningModule::fixReload ( )

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

                               : void
    {
        $out = file_get_contents($this->imsmanifestFile);
        $check = '/xmlns="http:\/\/www.imsglobal.org\/xsd\/imscp_v1p1"/';
        $replace = "xmlns=\"http://www.imsproject.org/xsd/imscp_rootv1p1p2\"";
        $out = preg_replace($check, $replace, $out);
        file_put_contents($this->imsmanifestFile, $out);
    }

References $check, and $out.

Referenced by convert_1_2_to_2004().

Here is the caller graph for this function:

◆ getAttemptsForUser()

ilObjSCORM2004LearningModule::getAttemptsForUser ( int $a_user_id )

get number of atttempts for a certain user and package

Reimplemented from ilObjSCORMLearningModule.

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

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

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

Here is the call graph for this function:

◆ getImportSequencing()

ilObjSCORM2004LearningModule::getImportSequencing ( )

Get import sequencing.

Returns: boolean import sequencing information

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

                                         : bool
    {
        return $this->import_sequencing;
    }

References $import_sequencing.

◆ getModuleVersionForUser()

ilObjSCORM2004LearningModule::getModuleVersionForUser ( int $a_user_id )

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

Reimplemented from ilObjSCORMLearningModule.

Definition at line 456 of file class.ilObjSCORM2004LearningModule.php.

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

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

Here is the call graph for this function:

◆ getQuantityOfSCOs()

static ilObjSCORM2004LearningModule::getQuantityOfSCOs ( int $a_slm_id )

static

Definition at line 667 of file class.ilObjSCORM2004LearningModule.php.

                                                           : int
    {
        global $DIC;
        $val_set = $DIC->database()->queryF(
            '
                SELECT  distinct(cp_node.cp_node_id) FROM cp_node,cp_resource,cp_item 
                WHERE   cp_item.cp_node_id = cp_node.cp_node_id 
                AND     cp_item.resourceid = cp_resource.id 
                AND scormtype = %s
                AND nodename = %s
                AND cp_node.slm_id = %s ',
            array('text','text','integer'),
            array('sco','item',$a_slm_id)
        );
        return $DIC->database()->numRows($val_set);
    }

References $DIC.

◆ getTrackedItems()

ilObjSCORM2004LearningModule::getTrackedItems ( )

get all tracked items of current user

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

Reimplemented from ilObjSCORMLearningModule.

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

                                     : array
    {
        $ilUser = $this->user;
        $ilDB = $this->db;
        $ilUser = $this->user;
 
        $sco_set = $ilDB->queryF(
            '
                SELECT DISTINCT cmi_node.cp_node_id id
                FROM cp_node, cmi_node 
                WHERE slm_id = %s
                AND cp_node.cp_node_id = cmi_node.cp_node_id 
                ORDER BY cmi_node.cp_node_id ',
            array('integer'),
            array($this->getId())
        );
 
        $items = array();
 
        while ($sco_rec = $ilDB->fetchAssoc($sco_set)) {
            $item['id'] = $sco_rec["id"];
            $item['title'] = self::_lookupItemTitle((int) $sco_rec["id"]);
            $items[] = $item;
        }
        return $items;
    }

References ilObject\$db, $ilDB, $user, _lookupItemTitle(), and ilObject\getId().

Here is the call graph for this function:

◆ getTrackingDataAgg()

ilObjSCORM2004LearningModule::getTrackingDataAgg	(	int	$a_user_id,
		?bool	$raw = `false`
	)

Exceptions

ilDateTimeException

Returns: array<int|string, mixed[]>

Definition at line 365 of file class.ilObjSCORM2004LearningModule.php.

                                                                          : array
    {
        $ilDB = $this->db;
 
        $scos = array();
        $data = array();
        //get all SCO's of this object
 
        $val_set = $ilDB->queryF(
            'SELECT cp_node_id FROM cp_node 
                        WHERE nodename = %s
                        AND cp_node.slm_id = %s',
            array('text', 'integer'),
            array('item',$this->getId())
        );
        while ($val_rec = $ilDB->fetchAssoc($val_set)) {
            $scos[] = $val_rec['cp_node_id'];
        }
 
        foreach ($scos as $sco) {
            $data_set = $ilDB->queryF(
                '
                                SELECT c_timestamp last_access, total_time, success_status, completion_status,
                                           c_raw, scaled, cp_node_id
                                FROM cmi_node 
                                WHERE cp_node_id = %s
                                AND user_id = %s',
                array('integer','integer'),
                array($sco,$a_user_id)
            );
 
            while ($data_rec = $ilDB->fetchAssoc($data_set)) {
                if ($data_rec["success_status"] != "" && $data_rec["success_status"] !== "unknown") {
                    $status = $data_rec["success_status"];
                } else {
                    if ($data_rec["completion_status"] == "") {
                        $status = "unknown";
                    } else {
                        $status = $data_rec["completion_status"];
                    }
                }
                if (!$raw) {
                    $time = ilDatePresentation::secondsToString((int) round(self::_ISODurationToCentisec($data_rec["total_time"]) / 100));
                    $score = "";
                    if ($data_rec["c_raw"] != null) {
                        $score = $data_rec["c_raw"];
                        if ($data_rec["scaled"] != null) {
                            $score .= " = ";
                        }
                    }
                    if ($data_rec["scaled"] != null) {
                        $score .= ($data_rec["scaled"] * 100) . "%";
                    }
                    $title = self::_lookupItemTitle((int) $data_rec["cp_node_id"]);
                    $last_access = ilDatePresentation::formatDate(new ilDateTime($data_rec['last_access'], IL_CAL_DATETIME));
                    $data[] = array("sco_id" => $data_rec["cp_node_id"],
                        "score" => $score, "time" => $time, "status" => $status,"last_access" => $last_access,"title" => $title);
                } else {
                    $data_rec["total_time"] = self::_ISODurationToCentisec($data_rec["total_time"]) / 100;
                    $data[$data_rec["cp_node_id"]] = $data_rec;
                }
            }
        }
 
        return $data;
    }

References $data, ilObject\$db, $ilDB, ilObject\$title, _ISODurationToCentisec(), _lookupItemTitle(), ilDatePresentation\formatDate(), ilObject\getId(), IL_CAL_DATETIME, and ilDatePresentation\secondsToString().

Here is the call graph for this function:

◆ importSuccess()

ilObjSCORM2004LearningModule::importSuccess ( string $a_file )

Reimplemented from ilObjSCORMLearningModule.

Definition at line 473 of file class.ilObjSCORM2004LearningModule.php.

                                                 : bool
    {
        $ilDB = $this->db;
        $ilUser = $this->user;
        $scos = array();
        $olp = ilObjectLP::getInstance($this->getId());
        $collection = $olp->getCollectionInstance();
        if ($collection) {
            $scos = $collection->getItems();
        }
 
        $fhandle = fopen($a_file, "rb");//changed from r to rb
 
        $obj_id = $this->getID();
        $users = array();
        $usersToDelete = array();
        $fields = fgetcsv($fhandle, 4096, ';', '"', '\\');
        while (($csv_rows = fgetcsv($fhandle, 4096, ";", '"', '\\')) !== 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_numeric($data["Status"])) {
                        $status = $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;
                } elseif (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) {
                        $res = $ilDB->queryF(
                            '
                                                        SELECT completion_status, success_status, user_id FROM cmi_node WHERE cp_node_id = %s AND user_id  = %s',
                            array('integer','integer'),
                            array($sco_id,$user_id)
                        );
 
                        if (!$ilDB->numRows($res)) {
                            $nextId = $ilDB->nextId('cmi_node');
                            $val_set = $ilDB->manipulateF(
                                'INSERT INTO cmi_node 
                                                        (cp_node_id,user_id,completion_status,c_timestamp,cmi_node_id) 
                                                        VALUES(%s,%s,%s,%s,%s)',
                                array('integer','integer','text','timestamp','integer'),
                                [$sco_id, $user_id, 'completed', $last_access?->format('Y-m-d H:i:s'), $nextId]
                            );
                        } else {
                            $doUpdate = false;
                            while ($row = $ilDB->fetchAssoc($res)) {
                                if (($row["completion_status"] === "completed" && $row["success_status"] !== "failed") || $row["success_status"] === "passed") {
                                    if ($doUpdate != true) {
                                        $doUpdate = false;
                                    } //note for issue if there are 2 entries for same sco_id
                                } else {
                                    $doUpdate = true;
                                }
                            }
                            if ($doUpdate == true) {
                                $ilDB->update(
                                    'cmi_node',
                                    array(
                                        'completion_status' => array('text', 'completed'),
                                        'success_status' => array('text', ''),
                                        'suspend_data' => array('text', ''),
                                        'c_timestamp' => array('timestamp', $last_access?->format('Y-m-d H:i:s')),
                                    ),
                                    array(
                                        'user_id' => array('integer', $user_id),
                                        'cp_node_id' => array('integer', $sco_id)
                                    )
                                );
                            }
                        }
                    }
                }
            } 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;
    }

References $data, ilObject\$db, $ilDB, $res, $user, $user_id, ilLPStatusWrapper\_refreshStatus(), deleteTrackingDataOfUsers(), ilObjSCORMLearningModule\get_user_id(), ilObject\getId(), ilObjectLP\getInstance(), ilObjSCORMLearningModule\importSuccessForSahsUser(), ILIAS\Repository\int(), ilObjSCORMLearningModule\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, and ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM.

Here is the call graph for this function:

◆ readObject()

ilObjSCORM2004LearningModule::readObject ( )

read manifest file

Reimplemented from ilObjSCORMLearningModule.

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

                                : string
    {
        global $DIC;
        $lng = $this->lng;
        $ilErr = $this->error;
 
        //check for json_encode,json_decode
        if (!function_exists('json_encode') || !function_exists('json_decode')) {
            $ilErr->raiseError($lng->txt('scplayer_phpmysqlcheck'), $ilErr->WARNING);
        }
 
        $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);
            }
        }
 
        //check for SCORM 1.2
        $this->convert_1_2_to_2004($manifest_file);
 
        return (new ilSCORM13Package())->il_import($this->getDataDirectory(), $this->getId());
    }

References $DIC, ilObject\$error, $ilErr, ilObject\$lng, convert_1_2_to_2004(), ilObjSAHSLearningModule\getDataDirectory(), ilObject\getId(), ILIAS\Repository\lng(), and ilLanguage\txt().

Here is the call graph for this function:

◆ setImportSequencing()

ilObjSCORM2004LearningModule::setImportSequencing ( bool $a_val )

Set import sequencing.

Parameters

boolean $a_val import sequencing information

Definition at line 68 of file class.ilObjSCORM2004LearningModule.php.

                                                    : void
    {
        $this->import_sequencing = $a_val;
    }

Field Documentation

◆ $backupManifest

string ilObjSCORM2004LearningModule::$backupManifest

private

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

◆ $import_sequencing

bool ilObjSCORM2004LearningModule::$import_sequencing = false

protected

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

Referenced by getImportSequencing().

◆ $imsmanifestFile

string ilObjSCORM2004LearningModule::$imsmanifestFile

protected

Definition at line 38 of file class.ilObjSCORM2004LearningModule.php.

◆ $packageFolder

string ilObjSCORM2004LearningModule::$packageFolder

private

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

◆ $tabs

ilTabsGUI ilObjSCORM2004LearningModule::$tabs

protected

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

◆ $totransform

DomDocument ilObjSCORM2004LearningModule::$totransform

private

Definition at line 31 of file class.ilObjSCORM2004LearningModule.php.

◆ $user

ilObjUser ilObjSCORM2004LearningModule::$user

protected

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

Referenced by deleteTrackingDataOfUsers(), getTrackedItems(), and importSuccess().

◆ CONVERT_XSL

const ilObjSCORM2004LearningModule::CONVERT_XSL = '../components/ILIAS/Scorm2004/templates/xsl/op/scorm12To2004.xsl'

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

◆ WRAPPER_HTML

const ilObjSCORM2004LearningModule::WRAPPER_HTML = '../components/ILIAS/Scorm2004/scripts/converter/GenericRunTimeWrapper1.0_aadlc/GenericRunTimeWrapper.htm'

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

◆ WRAPPER_JS

const ilObjSCORM2004LearningModule::WRAPPER_JS = '../components/ILIAS/Scorm2004/scripts/converter/GenericRunTimeWrapper1.0_aadlc/SCOPlayerWrapper.js'

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

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

components/ILIAS/Scorm2004/classes/class.ilObjSCORM2004LearningModule.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getCourseCompletionForUser()

◆ _getMaxScoreForUser()

◆ _getMeasure()

◆ _getSatisfied()

◆ _getScores2004ForUser()

◆ _getStatus()

◆ _getTrackingItems()

◆ _getUniqueScaledScoreForUser()

◆ _ISODurationToCentisec()

◆ _lookupItemTitle()

◆ _lookupLastAccess()

◆ convert_1_2_to_2004()

◆ deleteTrackingDataOfUsers()

◆ fixReload()

◆ getAttemptsForUser()

◆ getImportSequencing()

◆ getModuleVersionForUser()

◆ getQuantityOfSCOs()

◆ getTrackedItems()

◆ getTrackingDataAgg()

◆ importSuccess()

◆ readObject()

◆ setImportSequencing()

Field Documentation

◆ $backupManifest

◆ $import_sequencing

◆ $imsmanifestFile

◆ $packageFolder

◆ $tabs

◆ $totransform

◆ $user

◆ CONVERT_XSL

◆ WRAPPER_HTML

◆ WRAPPER_JS