class.ilPageContent.php

Go to the documentation of this file.

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


abstract class ilPageContent
{
        //var $type;            // type
        var $hier_id;           // hierarchical editing id
        var $node;                      // node in page xml
        var $dom;                       // dom object
        var $page_lang;

        protected $file_download_link;

        protected $fullscreen_link;

        protected $sourcecode_download_script;

        protected $log;

        final function __construct($a_pg_obj)
        {
                $this->log = ilLoggerFactory::getLogger('copg');
                $this->setPage($a_pg_obj);
                $this->dom = $a_pg_obj->getDom();
                $this->init();
                if ($this->getType() == "")
                {
                        die ("Error: ilPageContent::init() did not set type");
                }
        }
        
        function setPage($a_val)
        {
                $this->pg_obj = $a_val;
        }
        
        function getPage()
        {
                return $this->pg_obj;
        }
        
        abstract function init();

        final protected function setType($a_type)
        {
                $this->type = $a_type;
        }

        function getType()
        {
                return $this->type;
        }

        function setNode($a_node)
        {
                $this->node = $a_node;
        }
        

        function &getNode()
        {
                return $this->node;
        }

        function getJavascriptFiles($a_mode)
        {
                return array();
        }

        function getCssFiles($a_mode)
        {
                return array();
        }

        function getOnloadCode($a_mode)
        {
                return array();
        }

        function setHierId($a_hier_id)
        {
                $this->hier_id = $a_hier_id;
        }

        function getHierId()
        {
                return $this->hier_id;
        }
        
        
        function lookupHierId()
        {
                return $this->node->get_attribute("HierId");
        }

        function readHierId()
        {
                if (is_object($this->node))
                {
                        return $this->node->get_attribute("HierId");
                }
        }

        function setPcId($a_pcid)
        {
                $this->pcid = $a_pcid;
        }

        function getPCId()
        {
                return $this->pcid;
        }

        function setFileDownloadLink($a_download_link)
        {
                $this->file_download_link = $a_download_link;
        }

        function getFileDownloadLink()
        {
                return $this->file_download_link;
        }

        function setFullscreenLink($a_fullscreen_link)
        {
                $this->fullscreen_link = $a_fullscreen_link;
        }

        function getFullscreenLink()
        {
                return $this->fullscreen_link;
        }

        function setSourcecodeDownloadScript ($script_name)
        {
                $this->sourcecode_download_script = $script_name;
        }

        function getSourcecodeDownloadScript ()
        {
                return $this->sourcecode_download_script;
        }


        function readPCId()
        {
                if (is_object($this->node))
                {
                        return $this->node->get_attribute("PCID");
                }
        }

        function writePCId($a_pc_id)
        {
                if (is_object($this->node))
                {
                        $this->node->set_attribute("PCID", $a_pc_id);
                }
        }

        final static function incEdId($ed_id)
        {
                $id = explode("_", $ed_id);
                $id[count($id) - 1]++;
                
                return implode($id, "_");
        }

        final static function decEdId($ed_id)
        {
                $id = explode("_", $ed_id);
                $id[count($id) - 1]--;

                return implode($id, "_");
        }

        final static function haveSameContainer($ed_id1, $ed_id2)
        {
                $id1 = explode("_", $ed_id1);
                $id2 = explode("_", $ed_id1);
                if(count($id1) == count($id2))
                {
                        array_pop($id1);
                        array_pop($id2);
                        foreach ($id1 as $key => $id)
                        {
                                if($id != $id2[$key])
                                {
                                        return false;
                                }
                        }
                        return true;
                }
                return false;
        }

        static function sortHierIds($a_array)
        {
                uasort($a_array, array("ilPageContent", "isGreaterHierId"));
                
                return $a_array;
        }
        
        static function isGreaterHierId($a, $b)
        {
                $a_arr = explode("_", $a);
                $b_arr = explode("_", $b);
                for ($i = 0; $i < count($a_arr); $i++)
                {
                        if ((int) $a_arr[$i] > (int) $b_arr[$i])
                        {
                                return true;
                        }
                        else if ((int) $a_arr[$i] < (int) $b_arr[$i])
                        {
                                return false;
                        }
                }
                return false;
        }
        
        function setEnabled($value) 
        {
                if (is_object($this->node))
                {
                        $this->node->set_attribute("Enabled", $value);
                }
        }
         
        function enable() 
        {
                $this->setEnabled("True");
        }
          
        function disable()      
        {
                $this->setEnabled("False");
        }

        final function isEnabled()
        {
                if (is_object($this->node) && $this->node->has_attribute("Enabled"))
                {
                        $compare = $this->node->get_attribute("Enabled");                                               
                } 
                else
                {
                        $compare = "True";
                }
                
                return strcasecmp($compare,"true") == 0;
        }
        
        function createPageContentNode($a_set_this_node = true)
        {
                $node = $this->dom->create_element("PageContent");
                if ($a_set_this_node)
                {
                        $this->node = $node;
                }
                return $node;
        }
        
        static function getLangVars()
        {
                return array();
        }

        static function handleCopiedContent(DOMDocument $a_domdoc, $a_self_ass = true, $a_clone_mobs = false)
        {
        }
        
        function modifyPageContentPostXsl($a_output, $a_mode)
        {
                return $a_output;
        }

        static function afterPageUpdate($a_page, DOMDocument $a_domdoc, $a_xml, $a_creation)
        {
        }
        
        static function beforePageDelete($a_page)
        {
        }

        static function afterPageHistoryEntry($a_page, DOMDocument $a_old_domdoc, $a_old_xml, $a_old_nr)
        {
        }

}
?>