Public Member Functions | Data Fields

ilObjSAHSLearningModule Class Reference

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
 update ()
 update meta data only
 setOnline ($a_online)
 get online
 getOnline ()
 set online
 setSubType ($a_sub_type)
 get sub type
 getSubType ()
 set sub type
 ilClone ($a_parent_ref)
 copy all properties and subobjects of a SCROM LearningModule.
 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.

Data Fields

 $validator

Detailed Description

Definition at line 38 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 $q, and ilUtil::yn2tf().

        {
                $q = "SELECT * FROM sahs_lm WHERE id = '".$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_id object id

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

References $q.

Referenced by ilLPCollections::_getPossibleSAHSItems(), ilLPStatusSCORM::_getStatusInfo(), and ilSAHSPresentationGUI::executeCommand().

        {
                global $ilDB;

                $q = "SELECT * FROM sahs_lm WHERE id = '".$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 66 of file class.ilObjSAHSLearningModule.php.

References $q, createDataDirectory(), ilObject::createMetaData(), and getSubType().

        {
                global $ilDB;

                parent::create();
                $this->createMetaData();

                $this->createDataDirectory();

/*
                $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_title title get description of content object
Returns:
string description set description of content object
Parameters:
string $a_description description assign a meta data object to content object
object $a_meta_data meta 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 219 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);
                ilUtil::makeDir($this->getDataDirectory());
        }

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 431 of file class.ilObjSAHSLearningModule.php.

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

        {
                global $ilDB;

                // 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
                $q = "DELETE FROM sahs_lm WHERE id = ".$ilDB->quote($this->getId());
                $this->ilias->db->query($q);

                if ($this->getSubType() == "scorm")
                {
                        // remove all scorm objects and scorm tree
                        include_once("content/classes/SCORM/class.ilSCORMTree.php");
                        include_once("content/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());
                        }
                }


                // 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 240 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 256 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 312 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 272 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 229 of file class.ilObjSAHSLearningModule.php.

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

Referenced by createDataDirectory(), delete(), ilObjAICCLearningModule::delete(), ilObjSCORMLearningModule::readObject(), and ilObjAICCLearningModule::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 296 of file class.ilObjSAHSLearningModule.php.

Referenced by update().

        {
                return $this->lesson_mode;
        }

Here is the caller graph for this function:

ilObjSAHSLearningModule::getOnline (  ) 

set online

Definition at line 380 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 396 of file class.ilObjSAHSLearningModule.php.

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

        {
                return $this->sub_type;
        }

Here is the caller graph for this function:

ilObjSAHSLearningModule::ilClone ( $  a_parent_ref  ) 

copy all properties and subobjects of a SCROM LearningModule.

public

Returns:
integer new ref id

Reimplemented from ilObject.

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

References $rbacadmin.

        {
                global $rbacadmin;

                // always call parent ilClone function first!!
                $new_ref_id = parent::ilClone($a_parent_ref);

                // put here slm specific stuff

                // ... and finally always return new reference ID!!
                return $new_ref_id;
        }

ilObjSAHSLearningModule::ilObjSAHSLearningModule ( $  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 49 of file class.ilObjSAHSLearningModule.php.

References ilObject::ilObject().

        {
                $this->type = "sahs";
                parent::ilObject($a_id,$a_call_by_reference);
                if ($a_id == 0)
                {
/*
                        $new_meta =& new ilMetaData();
                        $this->assignMetaData($new_meta);
*/
                }

        }

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:
string event
integer reference id of object where the event occured
array passes optional paramters if required
Returns:
boolean

Reimplemented from ilObject.

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

References $_GET, $tree, 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 96 of file class.ilObjSAHSLearningModule.php.

References $q, setAPIAdapterName(), setAPIFunctionsPrefix(), setAutoReview(), setCreditMode(), setDefaultLessonMode(), setOnline(), setSubType(), and ilUtil::yn2tf().

        {
                parent::read();
//              $this->meta_data =& new ilMetaData($this->getType(), $this->getId());

                $q = "SELECT * FROM sahs_lm WHERE id = '".$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"]);
        }

Here is the call graph for this function:

ilObjSAHSLearningModule::setAPIAdapterName ( $  a_api  ) 

set api adapter name

Definition at line 248 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 264 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 304 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 280 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 288 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

        {
                $this->lesson_mode = $a_lesson_mode;
        }

Here is the caller graph for this function:

ilObjSAHSLearningModule::setOnline ( $  a_online  ) 

get online

Definition at line 372 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 388 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 348 of file class.ilObjSAHSLearningModule.php.

References $q, getAPIAdapterName(), getAPIFunctionsPrefix(), getAutoReview(), getCreditMode(), getDefaultLessonMode(), ilObject::getId(), getOnline(), getSubType(), ilUtil::tf2yn(), and ilObject::updateMetaData().

        {
                global $ilDB;

                $this->updateMetaData();
                parent::update();

                $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()).",".
                        " 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

Reimplemented in ilObjSCORMLearningModule.

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

The documentation for this class was generated from the following file:
Generated on Fri Dec 13 2013 13:52:36 for ILIAS Release_3_7_x_branch .rev 46817 by  doxygen 1.7.1