class.ilTextInputGUI.php

Go to the documentation of this file.

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

include_once("./Services/Table/interfaces/interface.ilTableFilterItem.php");
include_once("./Services/Form/classes/class.ilSubEnabledFormPropertyGUI.php");
include_once 'Services/UIComponent/Toolbar/interfaces/interface.ilToolbarItem.php';

class ilTextInputGUI extends ilSubEnabledFormPropertyGUI implements ilTableFilterItem, ilToolbarItem
{
        protected $value;
        protected $maxlength = 200;
        protected $size = 40;
        protected $validationRegexp;
        protected $validationFailureMessage = '';
        protected $suffix;
        protected $style_css;
        protected $css_class;

        // added for YUI autocomplete feature
        protected $yui_dataSource;
        protected $yui_dataSchema;
        protected $yui_formatCallback;
        protected $yui_delimiterarray = array();
        protected $submit_form_on_enter = false;

        function __construct($a_title = "", $a_postvar = "")
        {
                parent::__construct($a_title, $a_postvar);
                $this->setInputType("text");
                $this->validationRegexp = "";
        }

        function setValue($a_value)
        {
                $this->value = $a_value;
        }

        function getValue()
        {
                return $this->value;
        }

        public function setValidationFailureMessage($a_msg)
        {
                $this->validationFailureMessage = $a_msg;
        }
        
        public function getValidationFailureMessage()
        {
                return $this->validationFailureMessage;
        }

        public function setValidationRegexp($a_value)
        {
                $this->validationRegexp = $a_value;
        }

        function getValidationRegexp()
        {
                return $this->validationRegexp;
        }

        function setMaxLength($a_maxlength)
        {
                $this->maxlength = $a_maxlength;
        }

        function getMaxLength()
        {
                return $this->maxlength;
        }

        function setSize($a_size)
        {
                $this->size = $a_size;
        }

        function setInlineStyle($a_style)
        {
                $this->style_css = $a_style;
        }
        
        function getInlineStyle()
        {
                return $this->style_css;
        }
        
        public function setCssClass($a_class)
        {
                $this->css_class = $a_class;
        }
        
        public function getCssClass()
        {
                return $this->css_class;
        }
        
        
        function setValueByArray($a_values)
        {
                $this->setValue($a_values[$this->getPostVar()]);
        }

        function getSize()
        {
                return $this->size;
        }
        
        function setSuffix($a_value)
        {
                $this->suffix = $a_value;
        }

        function getSuffix()
        {
                return $this->suffix;
        }

        public function setInputType($a_type)
        {
                $this->input_type = $a_type;
        }
        
        public function getInputType()
        {
                return $this->input_type;
        }
        
        function setSubmitFormOnEnter($a_val)
        {
                $this->submit_form_on_enter = $a_val;
        }
        
        function getSubmitFormOnEnter()
        {
                return $this->submit_form_on_enter;
        }

        function checkInput()
        {
                global $lng;
                
                $_POST[$this->getPostVar()] = ilUtil::stripSlashes($_POST[$this->getPostVar()]);
                if ($this->getRequired() && trim($_POST[$this->getPostVar()]) == "")
                {
                        $this->setAlert($lng->txt("msg_input_is_required"));

                        return false;
                }
                else if (strlen($this->getValidationRegexp()))
                {
                        if (!preg_match($this->getValidationRegexp(), $_POST[$this->getPostVar()]))
                        {
                                $this->setAlert(
                                        $this->getValidationFailureMessage() ?
                                        $this->getValidationFailureMessage() :
                                        $lng->txt('msg_wrong_format')
                                );
                                return FALSE;
                        }
                }
                
                return $this->checkSubItemsInput();
        }

         function getDataSource()
         {
                return $this->yui_dataSource;
         }

        function setDataSource($href)
        {
                $this->yui_dataSource = $href;
        }
        
         function getDataSourceSchema()
         {
                return $this->yui_dataSchema;
         }

        function setDataSourceSchema($ds)
        {
                $this->yui_dataSchema = $ds;
        }

         function getDataSourceResultFormat()
         {
                return $this->yui_formatCallback;
         }

        function setDataSourceResultFormat($callback)
        {
                $this->yui_formatCallback = $callback;
        }
        
        public function setDataSourceDelimiter($ar)
        {
                if (!is_array($ar))
                        $ar = array($ar);
                $this->yui_delimiterarray = $ar;
        }
        
        public function getDataSourceDelimiter()
        {
                return $this->yui_delimiterarray;       
        }
        
        protected function render($a_mode = "")
        {
                $tpl = new ilTemplate("tpl.prop_textinput.html", true, true, "Services/Form");
                if (strlen($this->getValue()))
                {
                        $tpl->setCurrentBlock("prop_text_propval");
                        $tpl->setVariable("PROPERTY_VALUE", ilUtil::prepareFormOutput($this->getValue()));
                        $tpl->parseCurrentBlock();
                }
                if (strlen($this->getInlineStyle()))
                {
                        $tpl->setCurrentBlock("stylecss");
                        $tpl->setVariable("CSS_STYLE", ilUtil::prepareFormOutput($this->getInlineStyle()));
                        $tpl->parseCurrentBlock();
                }
                if(strlen($this->getCssClass()))
                {
                        $tpl->setCurrentBlock("classcss");
                        $tpl->setVariable('CLASS_CSS', ilUtil::prepareFormOutput($this->getCssClass()));
                        $tpl->parseCurrentBlock();
                }
                if ($this->getSubmitFormOnEnter())
                {
                        $tpl->touchBlock("submit_form_on_enter");
                }

                switch($this->getInputType())
                {
                        case 'password':
                                $tpl->setVariable('PROP_INPUT_TYPE','password');
                                break;
                        case 'hidden':
                                $tpl->setVariable('PROP_INPUT_TYPE','hidden');
                                break;
                        case 'text':
                        default:
                                $tpl->setVariable('PROP_INPUT_TYPE','text');
                }
                $tpl->setVariable("ID", $this->getFieldId());
                $tpl->setVariable("SIZE", $this->getSize());
                if($this->getMaxLength() != null)
                        $tpl->setVariable("MAXLENGTH", $this->getMaxLength());
                if (strlen($this->getSuffix())) $tpl->setVariable("INPUT_SUFFIX", $this->getSuffix());
                
                if ($this->getDisabled())
                {
                        $tpl->setVariable("DISABLED",
                                " disabled=\"disabled\"");
                        $tpl->setVariable("HIDDEN_INPUT",
                                $this->getHiddenTag($this->getPostVar(), $this->getValue()));
                }
                else
                {
                        $tpl->setVariable("POST_VAR", $this->getPostVar());
                }

                // use autocomplete feature?
                if ($this->getDataSource() && $this->getDataSourceSchema())
                {
                        include_once "./Services/YUI/classes/class.ilYuiUtil.php";
                        include_once "./Services/JSON/classes/class.ilJsonUtil.php";
                        ilYuiUtil::initAutoComplete();
                        $tpl->setVariable('ID_AUTOCOMPLETE', $this->getFieldId() . "_autocomplete");
                        $tpl->setVariable('YUI_DATASOURCE', $this->getDataSource());
                        $tpl->setVariable('YUI_DATASCHEMA', ilJsonUtil::encode($this->getDataSourceSchema()));
                        if ($this->getDataSourceResultFormat())
                        {
                                $tpl->setVariable('YUI_FORMAT_CALLBACK', $this->getDataSourceResultFormat());
                        }

                        if ($this->getDataSourceDelimiter())
                        {
                                $tpl->setVariable('DELIMITER_ARRAY', ilJsonUtil::encode($this->getDataSourceDelimiter()));      
                        }
                }
                
                if ($a_mode == "toolbar")
                {
                        // block-inline hack, see: http://blog.mozilla.com/webdev/2009/02/20/cross-browser-inline-block/
                        // -moz-inline-stack for FF2
                        // zoom 1; *display:inline for IE6 & 7
                        $tpl->setVariable("STYLE_PAR", 'display: -moz-inline-stack; display:inline-block; zoom: 1; *display:inline;');
                        if ($this->getDataSource() && $this->getDataSourceSchema())
                        {
                                $tpl->setVariable("AC_STYLE", 'style="position:absolute; width:400px;"');
                        }
                }
                else
                {
                        $tpl->setVariable("STYLE_PAR", '');
                }
                
                return $tpl->get();
        }
        
        function insert(&$a_tpl)
        {
                $html = $this->render();

                $a_tpl->setCurrentBlock("prop_generic");
                $a_tpl->setVariable("PROP_GENERIC", $html);
                $a_tpl->parseCurrentBlock();
        }
        
        function getTableFilterHTML()
        {
                $html = $this->render();
                return $html;
        }

        function getToolbarHTML()
        {
                $html = $this->render("toolbar");
                return $html;
        }
        
}
?>