class.ilSettingsTemplate.php

Go to the documentation of this file.

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

class ilSettingsTemplate
{
        private $id;
        private $type;
        private $title;
        private $description;
        private $setting = array();
        private $hidden_tab = array();
        
        // begin-patch loc
        private $auto_generated = false;
        // end-patch loc
        
        private $config;

        function __construct($a_id = 0, $config = null)
        {
                if ($a_id > 0)
                {
                        if ($config)
                            $this->setConfig($config);
                        $this->setId($a_id);
                        $this->read();
                }
        }

        function setId($a_val)
        {
                $this->id = $a_val;
        }

        function getId()
        {
                return $this->id;
        }
        
        // begin-patch lok
        public function setAutoGenerated($a_status)
        {
                $this->auto_generated = $a_status;
        }
        
        public function getAutoGenerated()
        {
                return $this->auto_generated;
        }
        // end-patch lok

        function setTitle($a_val)
        {
                $this->title = $a_val;
        }

        function getTitle()
        {
                return $this->title;
        }

        public function setType($a_val)
        {
                $this->type = $a_val;
        }

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

        public function setDescription($a_val)
        {
                $this->description = $a_val;
        }

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

        function setSetting($a_setting, $a_value, $a_hide = false)
        {
                if ($this->getConfig()) {
                    $settings = $this->getConfig()->getSettings();

                    if ($settings[$a_setting]['type'] == ilSettingsTemplateConfig::CHECKBOX) {
                        if (is_array($a_value))
                            $a_value = serialize($a_value);
                        else
                            $a_value = unserialize($a_value);
                    }
                }

                $this->setting[$a_setting] = array(
                        "value" => $a_value,
                        "hide" => $a_hide
                );
        }

        function removeSetting($a_setting)
        {
                unset($this->setting[$a_setting]);
        }

        function removeAllSettings()
        {
                $this->setting = array();
        }

        function getSettings()
        {
                return $this->setting;
        }

        function addHiddenTab($a_tab_id)
        {
                $this->hidden_tab[$a_tab_id] = $a_tab_id;
        }

        function removeAllHiddenTabs()
        {
                $this->hidden_tab = array();
        }

        function getHiddenTabs()
        {
                return $this->hidden_tab;
        }
        
        public function getConfig() {
            return $this->config;
        }

        public function setConfig(ilSettingsTemplateConfig $config) {
            $this->config = $config;
        }


        function read()
        {
                global $ilDB;

                // read template
                $set = $ilDB->query("SELECT * FROM adm_settings_template WHERE ".
                        " id = ".$ilDB->quote($this->getId(), "integer")
                        );
                $rec = $ilDB->fetchAssoc($set);
                $this->setTitle($rec["title"]);
                $this->setType($rec["type"]);
                $this->setDescription($rec["description"]);
                // begin-patch lok
                $this->setAutoGenerated($rec['auto_generated']);
                // end-patch lok

                // read template setttings
                $set = $ilDB->query("SELECT * FROM adm_set_templ_value WHERE ".
                        " template_id = ".$ilDB->quote($this->getId(), "integer")
                        );
                while ($rec = $ilDB->fetchAssoc($set))
                {
                        $this->setSetting($rec["setting"],
                                $rec["value"], $rec["hide"]);
                }

                // read hidden tabs
                $set = $ilDB->query("SELECT * FROM adm_set_templ_hide_tab WHERE ".
                        " template_id = ".$ilDB->quote($this->getId(), "integer")
                        );
                while ($rec = $ilDB->fetchAssoc($set))
                {
                        $this->addHiddenTab($rec["tab_id"]);
                }
        }

        function create()
        {
                global $ilDB;

                $this->setId($ilDB->nextId("adm_settings_template"));

                // write template
                $ilDB->insert("adm_settings_template", array(
                        "id" => array("integer", $this->getId()),
                        "title" => array("text", $this->getTitle()),
                        "type" => array("text", $this->getType()),
                        // begin-patch lok
                        "description" => array("clob", $this->getDescription()),
                        'auto_generated' => array('integer',$this->getAutoGenerated())
                        // end-patch lok
                        ));

                // write settings
                $this->insertSettings();

                // write hidden tabs
                $this->insertHiddenTabs();
        }

        public function update()
        {
                global $ilDB;

                // update template
                $ilDB->update("adm_settings_template", array(
                        "title" => array("text", $this->getTitle()),
                        "type" => array("text", $this->getType()),
                        // begin-patch lok
                        "description" => array("clob", $this->getDescription()),
                        'auto_generated' => array('integer',$this->getAutoGenerated())
                        ), array(
                        "id" => array("integer", $this->getId()),
                        ));

                // delete settings and hidden tabs
                $ilDB->manipulate("DELETE FROM adm_set_templ_value WHERE "
                        ." template_id = ".$ilDB->quote($this->getId(), "integer")
                        );
                $ilDB->manipulate("DELETE FROM adm_set_templ_hide_tab WHERE "
                        ." template_id = ".$ilDB->quote($this->getId(), "integer")
                        );

                // insert settings and hidden tabs
                $this->insertSettings();
                $this->insertHiddenTabs();

        }

        private function insertSettings()
        {
                global $ilDB;

                foreach ($this->getSettings() as $s => $set)
                {
                        $ilDB->manipulate("INSERT INTO adm_set_templ_value ".
                                "(template_id, setting, value, hide) VALUES (".
                                $ilDB->quote($this->getId(), "integer").",".
                                $ilDB->quote($s, "text").",".
                                $ilDB->quote($set["value"], "text").",".
                                $ilDB->quote($set["hide"], "integer").
                                ")");
                }
        }

        function insertHiddenTabs()
        {
                global $ilDB;

                foreach ($this->getHiddenTabs() as $tab_id)
                {
                        $ilDB->manipulate("INSERT INTO adm_set_templ_hide_tab ".
                                "(template_id, tab_id) VALUES (".
                                $ilDB->quote($this->getId(), "integer").",".
                                $ilDB->quote($tab_id, "text").
                                ")");
                }
        }

        function delete()
        {
                global $ilDB;

                $ilDB->manipulate("DELETE FROM adm_settings_template WHERE "
                        ." id = ".$ilDB->quote($this->getId(), "integer")
                        );
                $ilDB->manipulate("DELETE FROM adm_set_templ_value WHERE "
                        ." template_id = ".$ilDB->quote($this->getId(), "integer")
                        );
                $ilDB->manipulate("DELETE FROM adm_set_templ_hide_tab WHERE "
                        ." template_id = ".$ilDB->quote($this->getId(), "integer")
                        );
        }

        static function getAllSettingsTemplates($a_type, $a_include_auto_generated = false)
        {
                global $ilDB;

                // begin-patch lok
                if($a_include_auto_generated)
                {
                        $set = $ilDB->query("SELECT * FROM adm_settings_template ".
                                " WHERE type = ".$ilDB->quote($a_type, "text").
                                " ORDER BY title");
                }
                else
                {
                        $set = $ilDB->query("SELECT * FROM adm_settings_template ".
                                " WHERE type = ".$ilDB->quote($a_type, "text").
                                'AND auto_generated = '.$ilDB->quote(0,'integer').' '.
                                " ORDER BY title");
                }
                // end-patch lok
                

                $settings_template = array();
                while ($rec = $ilDB->fetchAssoc($set))
                {
                        $settings_template[] = $rec;
                }
                return $settings_template;
        }

        protected static function lookupProperty($a_id, $a_prop)
        {
                global $ilDB;

                $set = $ilDB->query("SELECT $a_prop FROM adm_settings_template WHERE ".
                        " id = ".$ilDB->quote($a_id, "integer")
                        );
                $rec = $ilDB->fetchAssoc($set);
                return $rec[$a_prop];
        }

        // begin-patch lok
        static function lookupTitle($a_id)
        {
                return self::lookupProperty($a_id, 'title');
        }
        static function lookupDescription($a_id)
        {
                return self::lookupProperty($a_id, 'description');
        }
        
        // begin-patch lok
        public static function translate($a_title_desc)
        {
                if(substr($a_title_desc, 0, 3) == 'il_')
                {
                        return $GLOBALS['lng']->txt($a_title_desc);
                }
                return $a_title_desc;
        }
        // end-patch lok
}
?>