content/classes/class.ilObjSAHSLearningModule.php

Go to the documentation of this file.

<?php
/*
        +-----------------------------------------------------------------------------+
        | ILIAS open source                                                           |
        +-----------------------------------------------------------------------------+
        | Copyright (c) 1998-2001 ILIAS open source, University of Cologne            |
        |                                                                             |
        | This program is free software; you can redistribute it and/or               |
        | modify it under the terms of the GNU General Public License                 |
        | as published by the Free Software Foundation; either version 2              |
        | of the License, or (at your option) any later version.                      |
        |                                                                             |
        | This program is distributed in the hope that it will be useful,             |
        | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
        | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
        | GNU General Public License for more details.                                |
        |                                                                             |
        | You should have received a copy of the GNU General Public License           |
        | along with this program; if not, write to the Free Software                 |
        | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
        +-----------------------------------------------------------------------------+
*/


require_once "classes/class.ilObject.php";
require_once "content/classes/class.ilObjSCORMValidator.php";
require_once "classes/class.ilMetaData.php";

class ilObjSAHSLearningModule extends ilObject
{
        var $validator;
        var $meta_data;

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

        }

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

        function read()
        {
                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"]);
        }

        function _lookupOnline($a_id)
        {
                $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"]);
        }

        function _lookupSubType($a_obj_id)
        {
                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"];
        }

        function getTitle()
        {
                return parent::getTitle();
        }

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

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

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

        function assignMetaData(&$a_meta_data)
        {
                $this->meta_data =& $a_meta_data;
        }

        function &getMetaData()
        {
                return $this->meta_data;
        }


        function createDataDirectory()
        {
                $lm_data_dir = ilUtil::getWebspaceDir()."/lm_data";
                ilUtil::makeDir($lm_data_dir);
                ilUtil::makeDir($this->getDataDirectory());
        }

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

                return $lm_dir;
        }

        function getAPIAdapterName()
        {
                return $this->api_adapter;
        }

        function setAPIAdapterName($a_api)
        {
                $this->api_adapter = $a_api;
        }

        function getAPIFunctionsPrefix()
        {
                return $this->api_func_prefix;
        }

        function setAPIFunctionsPrefix($a_prefix)
        {
                $this->api_func_prefix = $a_prefix;
        }

        function getCreditMode()
        {
                return $this->credit_mode;
        }

        function setCreditMode($a_credit_mode)
        {
                $this->credit_mode = $a_credit_mode;
        }

        function setDefaultLessonMode($a_lesson_mode)
        {
                $this->lesson_mode = $a_lesson_mode;
        }

        function getDefaultLessonMode()
        {
                return $this->lesson_mode;
        }

        function setAutoReview($a_auto_review)
        {
                $this->auto_review = $a_auto_review;
        }

        function getAutoReview()
        {
                return $this->auto_review;
        }

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

        }


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

        function setOnline($a_online)
        {
                $this->online = $a_online;
        }

        function getOnline()
        {
                return $this->online;
        }

        function setSubType($a_sub_type)
        {
                $this->sub_type = $a_sub_type;
        }

        function getSubType()
        {
                return $this->sub_type;
        }

        function ilClone($a_parent_ref)
        {
                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;
        }

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

        function notify($a_event,$a_ref_id,$a_parent_non_rbac_id,$a_node_id,$a_params = 0)
        {
                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);
        }

} // END class.ilObjSCORMLearningModule
?>