ilObjAICCLearningModule Class Reference

Class ilObjAICCLearningModule. More...

Inheritance diagram for ilObjAICCLearningModule:

Collaboration diagram for ilObjAICCLearningModule:

Public Member Functions
	ilObjAICCLearningModule ($a_id=0, $a_call_by_reference=true)
	Constructor public.
	readObject ()
	public
	delete ()
	delete SCORM learning module and all related data
	getTrackingItems ()
	get all tracking items of scorm object
	_getTrackingItems ($a_obj_id)
	get all tracking items of scorm object
	getTrackedItems ()
	get all tracked items of current user
	getTrackingData ($a_sco_id)
Public Member Functions inherited from ilObjSCORMLearningModule
	ilObjSCORMLearningModule ($a_id=0, $a_call_by_reference=true)
	Constructor public.
	validate ($directory)
	Validate all XML-Files in a SCOM-Directory.
	getValidationSummary ()
	getTrackedUsers ($a_search)
	getAttemptsForUser ($a_user_id)
	get number of atttempts for a certain user and package
	getModuleVersionForUser ($a_user_id)
	get module version that tracking data for a user was recorded on
	getTrackingDataPerUser ($a_sco_id, $a_user_id)
	getTrackingDataAgg ($a_user_id)
	getTrackingDataAggSco ($a_sco_id)
	exportSelectedRaw ($a_exportall=0, $a_user=array())
	exportSelected ($a_exportall=0, $a_user=array())
	importTrackingData ($a_file)
	importSuccess ($a_file)
	get_user_id ($a_login)
	getUserIdEmail ($a_mail)
	assumes that only one account exists for a mailadress
	sendExportFile ($a_header, $a_content)
	send export file to browser
	getAllScoIds ()
	getStatusForUser ($a_user, $a_allScoIds, $a_numerical=false)
	getCourseCompletionForUser ($a_user)
Public Member Functions inherited from ilObjSAHSLearningModule
	ilObjSAHSLearningModule ($a_id=0, $a_call_by_reference=true)
	Constructor public.
	create ($upload=false)
	create file based lm
	read ()
	read object
	_lookupOnline ($a_id)
	check wether scorm module is online
	_lookupSubType ($a_obj_id)
	lookup subtype id (scorm, aicc, hacp)
	setEditable ($a_editable)
	Set Editable.
	getEditable ()
	Get Editable.
	setTries ($a_tries)
	Set default tries for questions.
	getTries ()
	Get Tries.
	getDiskUsage ()
	Gets the disk usage of the object in bytes.
	createDataDirectory ()
	creates data directory for package files ("./data/lm_data/lm_<id>")
	getDataDirectory ($mode="filesystem")
	get data directory of lm
	getAPIAdapterName ()
	get api adapter name
	setAPIAdapterName ($a_api)
	set api adapter name
	getAPIFunctionsPrefix ()
	get api functions prefix
	setAPIFunctionsPrefix ($a_prefix)
	set api functions prefix
	getCreditMode ()
	get credit mode
	setCreditMode ($a_credit_mode)
	set credit mode
	setDefaultLessonMode ($a_lesson_mode)
	set default lesson mode
	getDefaultLessonMode ()
	get default lesson mode
	getStyleSheetId ()
	get ID of assigned style sheet object
	setStyleSheetId ($a_style_id)
	set ID of assigned style sheet object
	setAutoReview ($a_auto_review)
	get auto review
	getAutoReview ()
	set auto review
	getMaxAttempt ()
	get max attempt
	setMaxAttempt ($a_max_attempt)
	set max attempt
	getModuleVersion ()
	get max attempt
	getAssignedGlossary ()
	get assigned glossary
	setAssignedGlossary ($a_assigned_glossary)
	set assigned glossary
	setModuleVersion ($a_module_version)
	set max attempt
	getSession ()
	get session setting
	setSession ($a_session)
	set session setting
	getNoMenu ()
	disable menu
	setNoMenu ($a_no_menu)
	disable menu
	getHideNavig ()
	hide navigation tree
	setHideNavig ($a_hide_navig)
	disable menu
	getDebug ()
	debug
	setDebug ($a_debug)
	debug
	getDebugPw ()
	debug pw
	setDebugPw ($a_debug_pw)
	debug pw
	setAutoContinue ($a_auto_continue)
	get auto continue
	getAutoContinue ()
	set auto continue
	update ()
	update meta data only
	setOnline ($a_online)
	get online
	getOnline ()
	set online
	setSubType ($a_sub_type)
	get sub type
	getSubType ()
	set sub type
	notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0)
	notifys an object about an event occured Based on the event happend, each object may decide how it reacts.
	getPointsInPercent ()
	Returns the points in percent for the learning module This is called by the certificate generator if [SCORM_POINTS] is inserted.
Public Member Functions inherited from ilObject
	ilObject ($a_id=0, $a_reference=true)
	Constructor public.
	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not)
	read ($a_force_db=false)
	read object data from db into object
	getId ()
	get object id public
	setId ($a_id)
	set object id public
	setRefId ($a_id)
	set reference id public
	getRefId ()
	get reference id public
	getType ()
	get object type public
	setType ($a_type)
	set object type public
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions
	getTitle ()
	get object title public
	getUntranslatedTitle ()
	get untranslated object title public
	setTitle ($a_title)
	set object title
	getDescription ()
	get object description
	setDescription ($a_desc)
	set object description
	getLongDescription ()
	get object long description (stored in object_description)
	getImportId ()
	get import id
	setImportId ($a_import_id)
	set import id
	_lookupObjIdByImportId ($a_import_id)
	getOwner ()
	get object owner
	getOwnerName ()
	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id
	setOwner ($a_owner)
	set object owner
	getCreateDate ()
	get create date public
	getLastUpdateDate ()
	get last update date public
	setObjDataRecord ($a_record)
	set object_data record (note: this method should only be called from the ilObjectFactory class)
	create ()
	create
	MDUpdateListener ($a_element)
	Meta data update listener.
	createMetaData ()
	create meta data entry
	updateMetaData ()
	update meta data entry
	deleteMetaData ()
	delete meta data entry
	updateOwner ()
	update owner of object in db
	_getIdForImportId ($a_import_id)
	get current object id for import id (static)
	_lookupOwner ($a_id)
	lookup object owner
	_lookupDescription ($a_id)
	lookup object description
	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update
	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects.
	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree
	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes
	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes
	_writeTitle ($a_obj_id, $a_title)
	write title to db (static)
	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static)
	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static)
	_isInTrash ($a_ref_id)
	checks wether object is in trash
	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash
	_lookupObjectId ($a_ref_id)
	lookup object id
	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type
	putInTree ($a_parent_ref)
	maybe this method should be in tree object!?
	setPermissions ($a_parent_ref)
	set permissions of object
	createReference ()
	creates reference for object
	countReferences ()
	count references of object
	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) public
	createRoleFolder ()
	creates a local role folder
	setRegisterMode ($a_bool)
	isUserRegistered ($a_user_id=0)
	requireRegistration ()
	getXMLZip ()
	getHTMLDirectory ()
	cloneObject ($a_target_id, $a_copy_id=0)
	Clone object permissions, put in tree ...
	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container.
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies.
	cloneMetaData ($target_obj)
	Copy meta data.

Additional Inherited Members
Static Public Member Functions inherited from ilObjSCORMLearningModule
static	_lookupLastAccess ($a_obj_id, $a_usr_id)
	Return the last access timestamp for a given user.
static	_getAllScoIds ($a_id)
	Get an array of id's for all Sco's in the module.
static	_getStatusForUser ($a_id, $a_user, $a_allScoIds, $a_numerical=false)
	Get the status of a SCORM module for a given user.
static	_getCourseCompletionForUser ($a_id, $a_user)
	Get the completion of a SCORM module for a given user.
static	_removeTrackingDataForUser ($user_id)
Data Fields inherited from ilObjSCORMLearningModule
	$validator

Detailed Description

Class ilObjAICCLearningModule.

Author

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

Id:

class.ilObjAICCLearningModule.php 28616 2011-04-20 10:21:37Z mjansen

Definition at line 17 of file class.ilObjAICCLearningModule.php.

Member Function Documentation

ilObjAICCLearningModule::_getTrackingItems

(

$a_obj_id

)

get all tracking items of scorm object

Reimplemented from ilObjSCORMLearningModule.

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

References $ilDB, and $row.

Referenced by ilLPCollections\_getPossibleSAHSItems(), ilLPStatusSCORM\_getStatusInfo(), and getTrackingItems().

        {
                global $ilDB;

                include_once("./Modules/ScormAicc/classes/AICC/class.ilAICCUnit.php");

                $statement = $ilDB->queryF('
                        SELECT obj_id,title FROM aicc_object 
                        WHERE slm_id = %s
                        AND c_type = %s ',
                        array('integer', 'text'),
                        array($a_obj_id,'sau')
                );
                
                while($row = $ilDB->fetchObject($statement))
                {
                        $items[$row->obj_id]['obj_id'] = $row->obj_id;
                        $items[$row->obj_id]['title'] = $row->title;

                }               
                
                return $items ? $items : array();

                /*
                include_once("./Modules/ScormAicc/classes/SCORM/class.ilSCORMTree.php");
                $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"] == "sau")
                        {
                                include_once("./Modules/ScormAicc/classes/AICC/class.ilAICCUnit.php");
                                $ac_item =& new ilAICCUnit($child["obj_id"]);
                                $items[count($items)] =& $ac_item;
                        }
                }

                return $items;
                */
        }

Here is the caller graph for this function:

ilObjAICCLearningModule::delete

(

)

delete SCORM learning module and all related data

this method has been tested on may 9th 2004 meta data, scorm lm data, scorm tree, scorm objects (organization(s), manifest, resources and items), tracking data and data directory have been deleted correctly as desired

public

Returns

boolean true if all object data were removed; false if only a references were removed

Reimplemented from ilObjSAHSLearningModule.

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

References $ilDB, $ilLog, $res, $row, ilLPStatusWrapper\_refreshStatus(), ilUtil\delDir(), ilObject\deleteMetaData(), ilObjSAHSLearningModule\getDataDirectory(), and ilObject\getId().

        {
                global $ilDB, $ilLog;

                // always call parent delete function first!!
                if (!parent::delete())
                {
                        return false;
                }

                // delete meta data of scorm content object
/*
                $nested = new ilNestedSetXML();
                $nested->init($this->getId(), $this->getType());
                $nested->deleteAllDBData();
*/
                $this->deleteMetaData();

                // delete data directory
                ilUtil::delDir($this->getDataDirectory());

                // delete scorm learning module record
                $ilDB->manipulateF('DELETE FROM sahs_lm WHERE id = %s',
                array('integer'), array($this->getId()));

                // delete aicc data
                $res = $ilDB->queryF('
                        SELECT * FROM aicc_object, aicc_units
                        WHERE aicc_object.obj_id = aicc_units.obj_id
                        AND aicc_object.slm_id = %s',
                        array('integer'), array($this->getId()));
                
                        while($row = $ilDB->fetchAssoc($res))
                        {
                                $obj_id = $row['obj_id'];
                                $ilDB->manipulateF('
                                        DELETE FROM aicc_units WHERE obj_id = %s', 
                                        array('integer'), array($obj_id));                              
                        }
                
                $res = $ilDB->queryF('
                        SELECT * FROM aicc_object, aicc_course
                        WHERE aicc_object.obj_id = aicc_course.obj_id
                        AND aicc_object.slm_id = %s',
                        array('integer'), array($this->getId()));
                
                        while($row = $ilDB->fetchAssoc($res))
                        {
                                $obj_id = $row['obj_id'];
                                $ilDB->manipulateF('
                                DELETE FROM aicc_course WHERE obj_id = %s',
                                array('integer'), array($obj_id));              
                        }

                $ilDB->manipulateF('DELETE FROM scorm_tree WHERE slm_id = %s',
                array('integer'), array($this->getId()));

                $ilDB->manipulateF('DELETE FROM aicc_object WHERE slm_id = %s',
                array('integer'), array($this->getId()));

                $q_log = "DELETE FROM scorm_tracking WHERE obj_id = ".$ilDB->quote($this->getId());
                $ilLog->write("SAHS Delete (AICC LM): ".$q_log);
                $ilDB->manipulateF('DELETE FROM scorm_tracking WHERE obj_id = %s',
                array('integer'), array($this->getId()));

                // update learning progress status
                include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
                ilLPStatusWrapper::_refreshStatus($this->getId());

                // always call parent delete function at the end!!
                return true;
        }

Here is the call graph for this function:

ilObjAICCLearningModule::getTrackedItems

(

)

get all tracked items of current user

Reimplemented from ilObjSCORMLearningModule.

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

References $ilDB, and ilObject\getId().

        {
                global $ilUser, $ilDB, $ilUser;
        
                $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))
                {
                        include_once("./Modules/ScormAicc/classes/AICC/class.ilAICCUnit.php");  
                        $ac_item =& new ilAICCUnit($sco_rec["sco_id"]);
                        $items[count($items)] =& $ac_item;

                }               
                
                return $items;
        }

Here is the call graph for this function:

ilObjAICCLearningModule::getTrackingData

(

$a_sco_id

)

Definition at line 226 of file class.ilObjAICCLearningModule.php.

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

        {
                global $ilDB;

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

Here is the call graph for this function:

ilObjAICCLearningModule::getTrackingItems

(

)

get all tracking items of scorm object

Reimplemented from ilObjSCORMLearningModule.

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

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

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

Here is the call graph for this function:

ilObjAICCLearningModule::ilObjAICCLearningModule	(		$a_id = 0,
			$a_call_by_reference = true
	)

Constructor public.

Parameters

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

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

References ilObject\ilObject().

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

Here is the call graph for this function:

ilObjAICCLearningModule::readObject

(

)

public

Reimplemented from ilObjSCORMLearningModule.

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

References $_POST, ilObjSAHSLearningModule\getDataDirectory(), and ilObject\getId().

        {
                require_once("./Modules/ScormAicc/classes/class.ilObjAICCCourseInterchangeFiles.php");
                $cifModule = new ilObjAICCCourseInterchangeFiles();
                $cifModule->findFiles($this->getDataDirectory());

                $cifModule->readFiles();
                if (!empty($cifModule->errorText))
                {
                        $this->ilias->raiseError("<b>Error reading LM-File(s):</b><br>".implode("<br>", $cifModule->errorText), $this->ilias->error_obj->WARNING);
                }

                if ($_POST["validate"] == "y")
                {

                        $cifModule->validate();
                        if (!empty($cifModule->errorText))
                        {
                                $this->ilias->raiseError("<b>Validation Error(s):</b><br>".implode("<br>", $cifModule->errorText), $this->ilias->error_obj->WARNING);
                        }
                }

                $cifModule->writeToDatabase($this->getId());
        }

Here is the call graph for this function:

---

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

• Modules/ScormAicc/classes/class.ilObjAICCLearningModule.php