class.ilObjFileBasedLM.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2010 ILIAS open source, Extended GPL, see docs/LICENSE */

require_once "./Services/Object/classes/class.ilObject.php";
//require_once "Services/MetaData/classes/class.ilMDLanguageItem.php";

class ilObjFileBasedLM extends ilObject
{
        var $tree;
        
        protected $online; // [bool]

        function __construct($a_id = 0,$a_call_by_reference = true)
        {
                // this also calls read() method! (if $a_id is set)
                $this->type = "htlm";
                parent::__construct($a_id,$a_call_by_reference);
                
        }


        function update($a_skip_meta = false)
        {
                global $ilDB;

                if (!$a_skip_meta)
                {
                        $this->updateMetaData();
                }
                parent::update();

                $ilDB->manipulate($q = "UPDATE file_based_lm SET ".
                        " is_online = ".$ilDB->quote(ilUtil::tf2yn($this->getOnline()), "text").
                        ", startfile = ".$ilDB->quote($this->getStartFile(), "text")." ".
                        " WHERE id = ".$ilDB->quote($this->getId(), "integer"));
                return true;
        }

        function read()
        {
                global $ilDB;
                
                parent::read();

                $q = "SELECT * FROM file_based_lm WHERE id = ".$ilDB->quote($this->getId(), "integer");
                $lm_set = $ilDB->query($q);
                $lm_rec = $ilDB->fetchAssoc($lm_set);
                $this->setOnline(ilUtil::yn2tf($lm_rec["is_online"]));
                $this->setStartFile((string) $lm_rec["startfile"]);
        }



        function create($a_skip_meta = false)
        {
                global $ilDB;

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

                $ilDB->manipulate("INSERT INTO file_based_lm (id, is_online, startfile) VALUES ".
                        " (".$ilDB->quote($this->getID(), "integer").",".
                        $ilDB->quote("n", "text").",".
                        $ilDB->quote($this->getStartfile(), "text").")");
                if (!$a_skip_meta)
                {
                        $this->createMetaData();
                }
        }

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

                return $lm_dir;
        }

        function createDataDirectory()
        {
                ilUtil::makeDir($this->getDataDirectory());
        }

        function getStartFile()
        {               
                return $this->start_file;               
        }

        function setStartFile($a_file, $a_omit_file_check = false)
        {
                if($a_file &&
                        (file_exists($this->getDataDirectory()."/".$a_file) || $a_omit_file_check))
                {                               
                        $this->start_file = $a_file;
                }
        }

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

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

        static function _lookupOnline($a_id)
        {
                global $ilDB;
                
                $q = "SELECT * FROM file_based_lm WHERE id = ".$ilDB->quote($a_id, "integer");
                $lm_set = $ilDB->query($q);
                $lm_rec = $ilDB->fetchAssoc($lm_set);

                return ilUtil::yn2tf($lm_rec["is_online"]);
        }

        function getDiskUsage()
        {
            require_once("./Modules/HTMLLearningModule/classes/class.ilObjFileBasedLMAccess.php");
                return ilObjFileBasedLMAccess::_lookupDiskUsage($this->id);
        }



        function delete()
        {
                global $ilDB;

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

                // Delete meta data
                $this->deleteMetaData();

                // delete file_based_lm record
                $ilDB->manipulate("DELETE FROM file_based_lm WHERE id = ".
                        $ilDB->quote($this->getID(), "integer"));

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

                return true;
        }

        function populateByDirectoy($a_dir, $a_filename = "")
        {
                preg_match("/.*htlm_([0-9]*)\.zip/", $a_filename, $match);
                if (is_dir($a_dir."/htlm_".$match[1]))
                {
                        $a_dir = $a_dir."/htlm_".$match[1];
                }
                ilUtil::rCopy($a_dir, $this->getDataDirectory());
                ilUtil::renameExecutables($this->getDataDirectory());
        }
        
        public function cloneObject($a_target_id,$a_copy_id = 0, $a_omit_tree = false)
        {
                global $ilDB, $ilUser, $ilias;

                $new_obj = parent::cloneObject($a_target_id,$a_copy_id, $a_omit_tree);
                $this->cloneMetaData($new_obj);

                //copy online status if object is not the root copy object
                $cp_options = ilCopyWizardOptions::_getInstance($a_copy_id);

                if(!$cp_options->isRootNode($this->getRefId()))
                {
                        $new_obj->setOnline($this->getOnline());
                }
                
                $new_obj->setTitle($this->getTitle());
                $new_obj->setDescription($this->getDescription());

                // copy content
                $new_obj->populateByDirectoy($this->getDataDirectory());

                $new_obj->setStartFile($this->getStartFile());
                $new_obj->update();

                return $new_obj;
        }

}
?>