class.ilFormPropertyGUI.php

Go to the documentation of this file.

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

class ilFormPropertyGUI
{
        protected $type;
        protected $title;
        protected $postvar;
        protected $info;
        protected $alert;
        protected $required = false;
        protected $parentgui;
        protected $parentform;
        protected $hidden_title = "";
        protected $multi = false;
        protected $multi_sortable = false;
        protected $multi_addremove = true;
        protected $multi_values; 
        
        function __construct($a_title = "", $a_postvar = "")
        {
                $this->setTitle($a_title);
                $this->setPostVar($a_postvar);
                $this->setDisabled(false);
        }

        function executeCommand()
        {
                global $ilCtrl;
                
                $next_class = $ilCtrl->getNextClass($this);
                $cmd = $ilCtrl->getCmd();
                
                return $this->$cmd();
        }

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

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

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

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

        function setPostVar($a_postvar)
        {
                $this->postvar = $a_postvar;
        }

        function getPostVar()
        {
                return $this->postvar;
        }

        function getFieldId()
        {
                $id = str_replace("[", "__", $this->getPostVar());
                $id = str_replace("]", "__", $id);
                
                return $id;
        }

        function setInfo($a_info)
        {
                $this->info = $a_info;
        }

        function getInfo()
        {
                return $this->info;
        }

        function setAlert($a_alert)
        {
                $this->alert = $a_alert;
        }

        function getAlert()
        {
                return $this->alert;
        }

        function setRequired($a_required)
        {
                $this->required = $a_required;
        }

        function getRequired()
        {
                return $this->required;
        }
        
        function setDisabled($a_disabled)
        {
                $this->disabled = $a_disabled;
        }

        function getDisabled()
        {
                return $this->disabled;
        }
        
        function checkInput()
        {
                return false;           // please overwrite
        }

        function setParentForm($a_parentform)
        {
                $this->setParent($a_parentform);
        }

        function getParentForm()
        {
                return $this->getParent();
        }

        function setParent($a_val)
        {
                $this->parent_gui = $a_val;
        }
        
        function getParent()
        {
                return $this->parent_gui;
        }

        public function getSubForm()
        {
                return "";
        }

        public function hideSubForm()
        {
                return false;
        }

        function setHiddenTitle($a_val)
        {
                $this->hidden_title = $a_val;
        }
        
        function getHiddenTitle()
        {
                return $this->hidden_title;
        }
        
        function getItemByPostVar($a_post_var)
        {
                if ($this->getPostVar() == $a_post_var)
                {
                        return $this;
                }
                
                return false;
        }
        
        function serializeData()
        {
                return serialize($this->getValue());
        }
        
        function unserializeData($a_data)
        {
                $data = unserialize($a_data);

                if ($data)
                {
                        $this->setValue($data);
                }
                else
                {
                        $this->setValue(false);
                }
        }
        
        function writeToSession()
        {
                $parent = $this->getParent();
                if (!is_object($parent))
                {
                        die("You must set parent for ".get_class($this)." to use serialize feature.");
                }
                $_SESSION["form_".$parent->getId()][$this->getFieldId()] =
                        $this->serializeData();
        }

        function clearFromSession()
        {
                $parent = $this->getParent();
                if (!is_object($parent))
                {
                        die("You must set parent for ".get_class($this)." to use serialize feature.");
                }
                $_SESSION["form_".$parent->getId()][$this->getFieldId()] = false;
        }

        function readFromSession()
        {
                $parent = $this->getParent();
                if (!is_object($parent))
                {
                        die("You must set parent for ".get_class($this)." to use serialize feature.");
                }
                $this->unserializeData($_SESSION["form_".$parent->getId()][$this->getFieldId()]);
        }
        
        function getHiddenTag($a_post_var, $a_value)
        {
                return '<input type="hidden" name="'.$a_post_var.'" value="'.ilUtil::prepareFormOutput($a_value).'" />';
        }
        
        public function setMulti($a_multi, $a_sortable = false, $a_addremove = true)
        {
                if(!$this instanceof ilMultiValuesItem)
                {
                        require_once 'Services/Form/exceptions/class.ilFormException.php';
                        throw new ilFormException(sprintf(
                                "%s not supported for form property type %s",
                                __FUNCTION__, get_class($this)
                        ));
                }
                
                $this->multi = (bool)$a_multi;
                $this->multi_sortable = (bool)$a_sortable;
                $this->multi_addremove = (bool)$a_addremove;
        }

        public function getMulti()
        {
                return $this->multi;
        }
        
        public function setMultiValues(array $a_values)
        {
                $this->multi_values = array_unique($a_values);
        }
        
        public function getMultiValues()
        {
                return $this->multi_values;
        }
        
        protected function getMultiIconsHTML()
        {
                global $lng;
                
                $id = $this->getFieldId();
                
                $tpl = new ilTemplate("tpl.multi_icons.html", true, true, "Services/Form");
                
                $html = "";
                if ($this->multi_addremove)
                {
                        $tpl->setCurrentBlock("addremove");
                        $tpl->setVariable("ID", $id);
                        $tpl->setVariable("TXT_ADD", $lng->txt("add"));
                        $tpl->setVariable("TXT_REMOVE", $lng->txt("remove"));
                        include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
                        $tpl->setVariable("SRC_ADD", ilGlyphGUI::get(ilGlyphGUI::ADD));
                        $tpl->setVariable("SRC_REMOVE", ilGlyphGUI::get(ilGlyphGUI::REMOVE));
                        $tpl->parseCurrentBlock();
                }
                
                if ($this->multi_sortable)
                {
                        
                        $tpl->setCurrentBlock("sortable");
                        $tpl->setVariable("ID", $id);                   
                        $tpl->setVariable("TXT_DOWN", $lng->txt("down"));               
                        $tpl->setVariable("TXT_UP", $lng->txt("up"));                   
                        include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
                        $tpl->setVariable("SRC_UP", ilGlyphGUI::get(ilGlyphGUI::UP));
                        $tpl->setVariable("SRC_DOWN", ilGlyphGUI::get(ilGlyphGUI::DOWN));                       
                        $tpl->parseCurrentBlock();
                }
                
                return $tpl->get();
        }
        
        public function getContentOutsideFormTag()
        {
                
        }

        static function removeProhibitedCharacters($a_text)
        {
                return str_replace("\x0B", "", $a_text);
        }

        function stripSlashesAddSpaceFallback($a_str)
        {
                $str = ilUtil::stripSlashes($a_str);
                if ($str != $a_str)
                {
                        $str = ilUtil::stripSlashes(str_replace("<", "< ", $a_str));
                }
                return $str;
        }


}

?>