ILIAS  Release_3_10_x_branch Revision 61812
 All Data Structures Namespaces Files Functions Variables Groups Pages
ilObjSAHSLearningModule Class Reference

Class ilObjSCORMLearningModule. More...

+ Inheritance diagram for ilObjSAHSLearningModule:
+ Collaboration diagram for ilObjSAHSLearningModule:

Public Member Functions

 ilObjSAHSLearningModule ($a_id=0, $a_call_by_reference=true)
 Constructor public.
 create ()
 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)
 createDataDirectory ()
 get title of content object
 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
 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
 setModuleVersion ($a_module_version)
 set max attempt
 update ()
 update meta data only
 setOnline ($a_online)
 get online
 getOnline ()
 set online
 setSubType ($a_sub_type)
 get sub type
 getSubType ()
 set sub type
 delete ()
 delete SCORM learning module and all related data
 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.
- 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)
 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)
 _getAllReferences ($a_id)
 get all reference ids of object
 _lookupTitle ($a_id)
 lookup object title
 _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.
 _lookupObjId ($a_id)
 _setDeletedDate ($a_ref_id)
 only called in ilTree::saveSubTree
 _resetDeletedDate ($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)
 _lookupType ($a_id, $a_reference=false)
 lookup object type
 _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.

Data Fields

 $validator
- Data Fields inherited from ilObject
 $ilias
 $lng
 $id
 $ref_id
 $type
 $title
 $untranslatedTitle
 $desc
 $long_desc
 $owner
 $create_date
 $last_update
 $import_id
 $register = false
 $referenced
 $objectList
 $max_title
 $max_desc
 $add_dots
 $obj_data_record
 object_data record

Additional Inherited Members

- Static Public Member Functions inherited from ilObject
static _getIdsForTitle ($title, $type= '')
 _exists ($a_id, $a_reference=false)
 checks if an object exists in object_data
static _getObjectsByType ($a_obj_type="")
 Get objects by type.
static _prepareCloneSelection ($a_ref_ids, $new_type)
 Prepare copy wizard object selection.
static _getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)

Detailed Description

Class ilObjSCORMLearningModule.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Id:
class.ilObjSAHSLearningModule.php 16525 2008-05-02 21:06:42Z hholtmann

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

Member Function Documentation

ilObjSAHSLearningModule::_lookupOnline (   $a_id)

check wether scorm module is online

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

References DB_FETCHMODE_ASSOC, and ilUtil\yn2tf().

{
global $ilDB;
$q = "SELECT * FROM sahs_lm WHERE id = ".$ilDB->quote($a_id);
$lm_set = $this->ilias->db->query($q);
$lm_rec = $lm_set->fetchRow(DB_FETCHMODE_ASSOC);
return ilUtil::yn2tf($lm_rec["online"]);
}

+ Here is the call graph for this function:

ilObjSAHSLearningModule::_lookupSubType (   $a_obj_id)

lookup subtype id (scorm, aicc, hacp)

Parameters
int$a_idobject id

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

References DB_FETCHMODE_ASSOC.

Referenced by ilLPCollections\_getPossibleSAHSItems(), ilLPStatusSCORM\_getStatusInfo(), ilSAHSEditGUI\executeCommand(), ilSAHSPresentationGUI\executeCommand(), ilObjSCORMLearningModuleGUI\exportOptions(), ilLPObjSettings\getValidModes(), ilObjSCORMLearningModuleGUI\importForm(), and ilObjSCORMLearningModuleGUI\newModuleVersion().

{
global $ilDB;
$q = "SELECT * FROM sahs_lm WHERE id = ".$ilDB->quote($a_obj_id);
$obj_set = $ilDB->query($q);
$obj_rec = $obj_set->fetchRow(DB_FETCHMODE_ASSOC);
return $obj_rec["type"];
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::create ( )

create file based lm

Reimplemented from ilObject.

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

References createDataDirectory(), ilObject\createMetaData(), and getSubType().

{
global $ilDB;
$this->createMetaData();
/*
$this->meta_data->setId($this->getId());
//echo "<br>title:".$this->getId();
$this->meta_data->setType($this->getType());
//echo "<br>title:".$this->getType();
$this->meta_data->setTitle($this->getTitle());
//echo "<br>title:".$this->getTitle();
$this->meta_data->setDescription($this->getDescription());
$this->meta_data->setObject($this);
$this->meta_data->create();
*/
$q = "INSERT INTO sahs_lm (id, online, api_adapter, type) VALUES ".
" (".$ilDB->quote($this->getID()).",".$ilDB->quote("n").",".
$ilDB->quote("API").",".$ilDB->quote($this->getSubType()).")";
$ilDB->query($q);
}

+ Here is the call graph for this function:

ilObjSAHSLearningModule::createDataDirectory ( )

get title of content object

Returns
string title set title of content object
Parameters
string$a_titletitle get description of content object
Returns
string description set description of content object
Parameters
string$a_descriptiondescription assign a meta data object to content object
object$a_meta_datameta data object get meta data object of content object
Returns
object meta data object creates data directory for package files ("./data/lm_data/lm_<id>")

Definition at line 221 of file class.ilObjSAHSLearningModule.php.

References getDataDirectory(), ilUtil\getWebspaceDir(), and ilUtil\makeDir().

Referenced by create().

{
$lm_data_dir = ilUtil::getWebspaceDir()."/lm_data";
ilUtil::makeDir($lm_data_dir);
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::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 ilObject.

Reimplemented in ilObjAICCLearningModule.

Definition at line 449 of file class.ilObjSAHSLearningModule.php.

References $ilLog, ilSCORMObject\_getInstance(), ilUtil\delDir(), ilObject\deleteMetaData(), getDataDirectory(), ilObject\getId(), and getSubType().

{
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
// delete scorm learning module record
$q = "DELETE FROM sahs_lm WHERE id = ".$ilDB->quote($this->getId());
$this->ilias->db->query($q);
$ilLog->write("SAHS Delete(SAHSLM), Subtype: ".$this->getSubType());
if ($this->getSubType() == "scorm")
{
// remove all scorm objects and scorm tree
include_once("./Modules/ScormAicc/classes/SCORM/class.ilSCORMTree.php");
include_once("./Modules/ScormAicc/classes/SCORM/class.ilSCORMObject.php");
$sc_tree = new ilSCORMTree($this->getId());
$r_id = $sc_tree->readRootId();
if ($r_id > 0)
{
$items = $sc_tree->getSubTree($sc_tree->getNodeData($r_id));
foreach($items as $item)
{
$sc_object =& ilSCORMObject::_getInstance($item["obj_id"], $this->getId());
if (is_object($sc_object))
{
$sc_object->delete();
}
}
$sc_tree->removeTree($sc_tree->getTreeId());
}
}
if ($this->getSubType() != "scorm")
{
// delete aicc data
// this is highly dependent on the database
$q = "DELETE FROM aicc_units USING aicc_object, aicc_units WHERE aicc_object.obj_id=aicc_units.obj_id and aicc_object.slm_id=".$ilDB->quote($this->getId());
$this->ilias->db->query($q);
$q = "DELETE FROM aicc_course USING aicc_object, aicc_course WHERE aicc_object.obj_id=aicc_course.obj_id and aicc_object.slm_id=".$ilDB->quote($this->getId());
$this->ilias->db->query($q);
$q = "DELETE FROM aicc_object WHERE slm_id = ".$ilDB->quote($this->getId());
$this->ilias->db->query($q);
}
$q = "DELETE FROM scorm_tracking WHERE obj_id = ".$ilDB->quote($this->getId());
$ilLog->write("SAHS Delete(SAHSLM): ".$q);
$this->ilias->db->query($q);
// always call parent delete function at the end!!
return true;
}

+ Here is the call graph for this function:

ilObjSAHSLearningModule::getAPIAdapterName ( )

get api adapter name

Definition at line 242 of file class.ilObjSAHSLearningModule.php.

Referenced by update().

{
return $this->api_adapter;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getAPIFunctionsPrefix ( )

get api functions prefix

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

Referenced by update().

{
return $this->api_func_prefix;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getAutoReview ( )

set auto review

Definition at line 313 of file class.ilObjSAHSLearningModule.php.

Referenced by update().

{
return $this->auto_review;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getCreditMode ( )

get credit mode

Definition at line 274 of file class.ilObjSAHSLearningModule.php.

Referenced by update().

{
return $this->credit_mode;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getDataDirectory (   $mode = "filesystem")

get data directory of lm

Definition at line 231 of file class.ilObjSAHSLearningModule.php.

References ilObject\getId(), and ilUtil\getWebspaceDir().

Referenced by ilObjSCORM2004LearningModule\convert_1_2_to_2004(), createDataDirectory(), ilObjAICCLearningModule\delete(), delete(), ilObjAICCLearningModule\readObject(), ilObjSCORM2004LearningModule\readObject(), and ilObjSCORMLearningModule\readObject().

{
$lm_data_dir = ilUtil::getWebspaceDir($mode)."/lm_data";
$lm_dir = $lm_data_dir."/lm_".$this->getId();
return $lm_dir;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getDefaultLessonMode ( )

get default lesson mode

Definition at line 298 of file class.ilObjSAHSLearningModule.php.

Referenced by update().

{
return $this->lesson_mode;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getMaxAttempt ( )

get max attempt

Definition at line 322 of file class.ilObjSAHSLearningModule.php.

Referenced by update().

{
return $this->max_attempt;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getModuleVersion ( )

get max attempt

Definition at line 339 of file class.ilObjSAHSLearningModule.php.

Referenced by update().

{
return $this->module_version;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getOnline ( )

set online

Definition at line 417 of file class.ilObjSAHSLearningModule.php.

Referenced by update().

{
return $this->online;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::getSubType ( )

set sub type

Definition at line 433 of file class.ilObjSAHSLearningModule.php.

Referenced by create(), delete(), and update().

{
return $this->sub_type;
}

+ Here is the caller graph for this function:

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

Constructor public.

Parameters
integerreference_id or object_id
booleantreat the id as reference_id (true) or object_id (false)

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

References ilObject\ilObject().

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

+ Here is the call graph for this function:

ilObjSAHSLearningModule::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.

public

Parameters
stringevent
integerreference id of object where the event occured
arraypasses optional paramters if required
Returns
boolean

Reimplemented from ilObject.

Definition at line 529 of file class.ilObjSAHSLearningModule.php.

References $_GET, and ilObject\getType().

{
global $tree;
switch ($a_event)
{
case "link":
//var_dump("<pre>",$a_params,"</pre>");
//echo "SCORMLearningModule ".$this->getRefId()." triggered by link event. Objects linked into target object ref_id: ".$a_ref_id;
//exit;
break;
case "cut":
//echo "SCORMLearningModule ".$this->getRefId()." triggered by cut event. Objects are removed from target object ref_id: ".$a_ref_id;
//exit;
break;
case "copy":
//var_dump("<pre>",$a_params,"</pre>");
//echo "SCORMLearningModule ".$this->getRefId()." triggered by copy event. Objects are copied into target object ref_id: ".$a_ref_id;
//exit;
break;
case "paste":
//echo "SCORMLearningModule ".$this->getRefId()." triggered by paste (cut) event. Objects are pasted into target object ref_id: ".$a_ref_id;
//exit;
break;
case "new":
//echo "SCORMLearningModule ".$this->getRefId()." triggered by paste (new) event. Objects are applied to target object ref_id: ".$a_ref_id;
//exit;
break;
}
// At the beginning of the recursive process it avoids second call of the notify function with the same parameter
if ($a_node_id==$_GET["ref_id"])
{
$parent_obj =& $this->ilias->obj_factory->getInstanceByRefId($a_node_id);
$parent_type = $parent_obj->getType();
if($parent_type == $this->getType())
{
$a_node_id = (int) $tree->getParentId($a_node_id);
}
}
parent::notify($a_event,$a_ref_id,$a_parent_non_rbac_id,$a_node_id,$a_params);
}

+ Here is the call graph for this function:

ilObjSAHSLearningModule::read ( )

read object

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

References DB_FETCHMODE_ASSOC, ilObject\getId(), setAPIAdapterName(), setAPIFunctionsPrefix(), setAutoReview(), setCreditMode(), setDefaultLessonMode(), setMaxAttempt(), setModuleVersion(), setOnline(), setSubType(), and ilUtil\yn2tf().

{
global $ilDB;
$q = "SELECT * FROM sahs_lm WHERE id = ".$ilDB->quote($this->getId());
$lm_set = $this->ilias->db->query($q);
$lm_rec = $lm_set->fetchRow(DB_FETCHMODE_ASSOC);
$this->setOnline(ilUtil::yn2tf($lm_rec["online"]));
$this->setAutoReview(ilUtil::yn2tf($lm_rec["auto_review"]));
$this->setAPIAdapterName($lm_rec["api_adapter"]);
$this->setDefaultLessonMode($lm_rec["default_lesson_mode"]);
$this->setAPIFunctionsPrefix($lm_rec["api_func_prefix"]);
$this->setCreditMode($lm_rec["credit"]);
$this->setSubType($lm_rec["type"]);
$this->setSubType($lm_rec["type"]);
$this->setMaxAttempt($lm_rec["max_attempt"]);
$this->setModuleVersion($lm_rec["module_version"]);
}

+ Here is the call graph for this function:

ilObjSAHSLearningModule::setAPIAdapterName (   $a_api)

set api adapter name

Definition at line 250 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->api_adapter = $a_api;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setAPIFunctionsPrefix (   $a_prefix)

set api functions prefix

Definition at line 266 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->api_func_prefix = $a_prefix;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setAutoReview (   $a_auto_review)

get auto review

Definition at line 306 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->auto_review = $a_auto_review;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setCreditMode (   $a_credit_mode)

set credit mode

Definition at line 282 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->credit_mode = $a_credit_mode;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setDefaultLessonMode (   $a_lesson_mode)

set default lesson mode

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

Referenced by read().

{
$this->lesson_mode = $a_lesson_mode;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setMaxAttempt (   $a_max_attempt)

set max attempt

Definition at line 331 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->max_attempt = $a_max_attempt;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setModuleVersion (   $a_module_version)

set max attempt

Definition at line 347 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->module_version = $a_module_version;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setOnline (   $a_online)

get online

Definition at line 409 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

{
$this->online = $a_online;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::setSubType (   $a_sub_type)

get sub type

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

Referenced by read().

{
$this->sub_type = $a_sub_type;
}

+ Here is the caller graph for this function:

ilObjSAHSLearningModule::update ( )

update meta data only

update object data

public

Returns
boolean

Reimplemented from ilObject.

Definition at line 383 of file class.ilObjSAHSLearningModule.php.

References getAPIAdapterName(), getAPIFunctionsPrefix(), getAutoReview(), getCreditMode(), getDefaultLessonMode(), ilObject\getId(), getMaxAttempt(), getModuleVersion(), getOnline(), getSubType(), ilUtil\tf2yn(), and ilObject\updateMetaData().

{
global $ilDB;
$this->updateMetaData();
$q = "UPDATE sahs_lm SET ".
" online = ".$ilDB->quote(ilUtil::tf2yn($this->getOnline())).",".
" api_adapter = ".$ilDB->quote($this->getAPIAdapterName()).",".
" api_func_prefix = ".$ilDB->quote($this->getAPIFunctionsPrefix()).",".
" auto_review = ".$ilDB->quote(ilUtil::tf2yn($this->getAutoReview())).",".
" default_lesson_mode = ".$ilDB->quote($this->getDefaultLessonMode()).",".
" type = ".$ilDB->quote($this->getSubType()).",".
" max_attempt = ".$ilDB->quote($this->getMaxAttempt()).",".
" module_version = ".$ilDB->quote($this->getModuleVersion()).",".
" credit = ".$ilDB->quote($this->getCreditMode())."".
" WHERE id = ".$ilDB->quote($this->getId());
$this->ilias->db->query($q);
return true;
}

+ Here is the call graph for this function:

Field Documentation

ilObjSAHSLearningModule::$validator

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


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