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)
	getTitle ()
	get title of content object
	setTitle ($a_title)
	set title of content object
	getDescription ()
	get description of content object
	setDescription ($a_description)
	set description of content object
	assignMetaData (&$a_meta_data)
	assign a meta data object to content object
&	getMetaData ()
	get meta data object of content object
	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
	setAutoReview ($a_auto_review)
	get auto review
	getAutoReview ()
	set auto review
	updateMetaData ()
	update meta data only
	update ()
	update object data
	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
	$meta_data

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

References $q, and ilUtil::yn2tf().

Referenced by ilObjUser::getDesktopItems().

        {
                $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:

Here is the caller graph for this function:

ilObjSAHSLearningModule::_lookupSubType ( $ a_obj_id )

lookup subtype id (scorm, aicc, hacp)

Parameters:

int

$a_id object id

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

References $q.

        {
                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"];
        }

ilObjSAHSLearningModule::assignMetaData ( &$ a_meta_data )

assign a meta data object to content object

Parameters:

object

$a_meta_data meta data object

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

Referenced by ilObjAICCLearningModule::ilObjAICCLearningModule(), ilObjHACPLearningModule::ilObjHACPLearningModule(), ilObjSAHSLearningModule(), and ilObjSCORMLearningModule::ilObjSCORMLearningModule().

        {
                $this->meta_data =& $a_meta_data;
        }

Here is the caller graph for this function:

ilObjSAHSLearningModule::create ( )

create file based lm

Reimplemented from ilObject.

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

References $q, createDataDirectory(), getDescription(), ilObject::getId(), getSubType(), getTitle(), and ilObject::getType().

        {
                global $ilDB;

                parent::create();
                $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 ( )

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

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

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

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

                // 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);

                // 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());
                $items = $sc_tree->getSubTree($sc_tree->getNodeData($sc_tree->readRootId()));
                foreach($items as $item)
                {
                        $sc_object =& ilSCORMObject::_getInstance($item["obj_id"]);
                        $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 221 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 237 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 293 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 253 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 210 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 277 of file class.ilObjSAHSLearningModule.php.

Referenced by update().

        {
                return $this->lesson_mode;
        }

Here is the caller graph for this function:

ilObjSAHSLearningModule::getDescription ( )

get description of content object

Returns:: string description

Reimplemented from ilObject.

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

Referenced by create().

        {
                return $this->meta_data->getDescription();
        }

Here is the caller graph for this function:

& ilObjSAHSLearningModule::getMetaData ( )

get meta data object of content object

Returns:: object meta data object

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

        {
                return $this->meta_data;
        }

ilObjSAHSLearningModule::getOnline ( )

set online

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

Referenced by create(), and update().

        {
                return $this->sub_type;
        }

Here is the caller graph for this function:

ilObjSAHSLearningModule::getTitle ( )

get title of content object

Returns:: string title

Reimplemented from ilObject.

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

Referenced by create().

        {
                return parent::getTitle();
        }

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 385 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 assignMetaData(), and 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 458 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 89 of file class.ilObjSAHSLearningModule.php.

References $q, ilObject::getId(), ilObject::getType(), 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 229 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 245 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 285 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 261 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 269 of file class.ilObjSAHSLearningModule.php.

Referenced by read().

        {
                $this->lesson_mode = $a_lesson_mode;
        }

Here is the caller graph for this function:

ilObjSAHSLearningModule::setDescription ( $ a_description )

set description of content object

Parameters:

string

$a_description description

Reimplemented from ilObject.

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

Referenced by updateMetaData().

        {
                $this->meta_data->setDescription($a_description);
        }

Here is the caller graph for this function:

ilObjSAHSLearningModule::setOnline ( $ a_online )

get online

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

Referenced by read().

        {
                $this->sub_type = $a_sub_type;
        }

Here is the caller graph for this function:

ilObjSAHSLearningModule::setTitle ( $ a_title )

set title of content object

Parameters:

string

$a_title title

Reimplemented from ilObject.

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

Referenced by updateMetaData().

        {
                parent::setTitle($a_title);
                $this->meta_data->setTitle($a_title);
        }

Here is the caller graph for this function:

ilObjSAHSLearningModule::update ( )

update object data

public

Returns:: boolean

Reimplemented from ilObject.

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

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

Referenced by 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()).",".
                        " 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:

Here is the caller graph for this function:

ilObjSAHSLearningModule::updateMetaData ( )

update meta data only

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

References setDescription(), setTitle(), and update().

Referenced by update().

        {
                $this->meta_data->update();
                if ($this->meta_data->section != "General")
                {
                        $meta = $this->meta_data->getElement("Title", "General");
                        $this->meta_data->setTitle($meta[0]["value"]);
                        $meta = $this->meta_data->getElement("Description", "General");
                        $this->meta_data->setDescription($meta[0]["value"]);
                }
                else
                {
                        $this->setTitle($this->meta_data->getTitle());
                        $this->setDescription($this->meta_data->getDescription());
                }
                parent::update();

        }