class.ilNumberInputGUI.php

Go to the documentation of this file.

<?php

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

include_once("./Services/Form/classes/class.ilSubEnabledFormPropertyGUI.php");

class ilNumberInputGUI extends ilSubEnabledFormPropertyGUI
{
        protected $value;
        protected $maxlength = 200;
        protected $size = 40;
        protected $suffix;
        protected $minvalue = false;
        protected $minvalueShouldBeGreater = false;
        protected $minvalue_visible = false;
        protected $maxvalue = false;
        protected $maxvalueShouldBeLess = false;
        protected $maxvalue_visible = false;
        protected $decimals;
        protected $allow_decimals = false;
        
        function __construct($a_title = "", $a_postvar = "")
        {
                parent::__construct($a_title, $a_postvar);
        }

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

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

        function setValue($a_value)
        {
                $this->value = str_replace(',', '.', $a_value);
                
                // empty strings are allowed
                if($this->value != "")
                {
                        // integer
                        if(!$this->areDecimalsAllowed())
                        {
                                $this->value = round($this->value);
                        }
                        // float
                        else if($this->getDecimals() > 0)
                        {
                                // get rid of unwanted decimals
                                $this->value = round($this->value, $this->getDecimals());

                                // pad value to specified format
                                $this->value = number_format($this->value, $this->getDecimals(), ".", "");
                        }
                }
        }

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

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

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

        function setMinvalueShouldBeGreater($a_bool)
        {
                $this->minvalueShouldBeGreater = $a_bool;
        }
        
        function minvalueShouldBeGreater()
        {
                return $this->minvalueShouldBeGreater;
        }

        function setMaxvalueShouldBeLess($a_bool)
        {
                $this->maxvalueShouldBeLess = $a_bool;
        }
        
        function maxvalueShouldBeLess()
        {
                return $this->maxvalueShouldBeLess;
        }
        
        function setSize($a_size)
        {
                $this->size = $a_size;
        }

        function setValueByArray($a_values)
        {
                $this->setValue($a_values[$this->getPostVar()]);
        }

        function getSize()
        {
                return $this->size;
        }
        
        function setMinValue($a_minvalue, $a_display_always = false)
        {
                $this->minvalue = $a_minvalue;
                $this->minvalue_visible = (bool)$a_display_always;
        }

        function getMinValue()
        {
                return $this->minvalue;
        }

        function setMaxValue($a_maxvalue, $a_display_always = false)
        {
                $this->maxvalue = $a_maxvalue;
                $this->maxvalue_visible = (bool)$a_display_always;
        }

        function getMaxValue()
        {
                return $this->maxvalue;
        }

        function setDecimals($a_decimals)
        {               
                $this->decimals = (int)$a_decimals;
                if($this->decimals)
                {
                        $this->allowDecimals(true);
                }
        }

        function getDecimals()
        {
                return $this->decimals;
        }
        
        function allowDecimals($a_value)
        {               
                $this->allow_decimals = (bool)$a_value;
        }
        
        function areDecimalsAllowed()
        {
                return $this->allow_decimals;
        }

        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;
                }

                if (trim($_POST[$this->getPostVar()]) != "" &&
                        ! is_numeric(str_replace(',', '.', $_POST[$this->getPostVar()])))
                {
                        $this->minvalue_visible = true;
                        $this->maxvalue_visible = true;
                        $this->setAlert($lng->txt("form_msg_numeric_value_required"));
                        return false;
                }

                if ($this->minvalueShouldBeGreater())
                {
                        if (trim($_POST[$this->getPostVar()]) != "" &&
                                $this->getMinValue() !== false &&
                                $_POST[$this->getPostVar()] <= $this->getMinValue())
                        {
                                $this->minvalue_visible = true;
                                $this->setAlert($lng->txt("form_msg_value_too_low"));
                                return false;
                        }
                }
                else
                {
                        if (trim($_POST[$this->getPostVar()]) != "" &&
                                $this->getMinValue() !== false &&
                                $_POST[$this->getPostVar()] < $this->getMinValue())
                        {
                                $this->minvalue_visible = true;
                                $this->setAlert($lng->txt("form_msg_value_too_low"));                           
                                return false;
                        }
                }

                if ($this->maxvalueShouldBeLess())
                {
                        if (trim($_POST[$this->getPostVar()]) != "" &&
                                $this->getMaxValue() !== false &&
                                $_POST[$this->getPostVar()] >= $this->getMaxValue())
                        {
                                $this->maxvalue_visible = true;
                                $this->setAlert($lng->txt("form_msg_value_too_high"));
                                return false;
                        }
                }
                else
                {
                        if (trim($_POST[$this->getPostVar()]) != "" &&
                                $this->getMaxValue() !== false &&
                                $_POST[$this->getPostVar()] > $this->getMaxValue())
                        {
                                $this->maxvalue_visible = true;
                                $this->setAlert($lng->txt("form_msg_value_too_high"));
                                return false;
                        }
                }
                
                return $this->checkSubItemsInput();
        }

        function insert(&$a_tpl)
        {
                $html = $this->render();

                $a_tpl->setCurrentBlock("prop_generic");
                $a_tpl->setVariable("PROP_GENERIC", $html);
                $a_tpl->parseCurrentBlock();
        }

        function render()
        {
                global $lng;

                $tpl = new ilTemplate("tpl.prop_number.html", true, true, "Services/Form");

                if (strlen($this->getValue()))
                {
                        $tpl->setCurrentBlock("prop_number_propval");
                        $tpl->setVariable("PROPERTY_VALUE", ilUtil::prepareFormOutput($this->getValue()));
                        $tpl->parseCurrentBlock();
                }
                $tpl->setCurrentBlock("prop_number");
                
                $tpl->setVariable("POST_VAR", $this->getPostVar());
                $tpl->setVariable("ID", $this->getFieldId());
                $tpl->setVariable("SIZE", $this->getSize());
                $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("JS_DECIMALS_ALLOWED", (int)$this->areDecimalsAllowed());
                */ 
                
                // constraints
                if ($this->areDecimalsAllowed() && $this->getDecimals() > 0)
                {
                        $constraints = $lng->txt("form_format").": ###.".str_repeat("#", $this->getDecimals());
                        $delim = ", ";
                }
                if ($this->getMinValue() !== false && $this->minvalue_visible)
                {
                        $constraints.= $delim.$lng->txt("form_min_value").": ".(($this->minvalueShouldBeGreater()) ? "&gt; " : "").$this->getMinValue();
                        $delim = ", ";
                }
                if ($this->getMaxValue() !== false && $this->maxvalue_visible)
                {
                        $constraints.= $delim.$lng->txt("form_max_value").": ".(($this->maxvalueShouldBeLess()) ? "&lt; " : "").$this->getMaxValue();
                        $delim = ", ";
                }
                if ($constraints != "")
                {
                        $tpl->setVariable("TXT_NUMBER_CONSTRAINTS", $constraints);
                }
                
                $tpl->parseCurrentBlock();

                return $tpl->get();
        }

        function getPostValueForComparison()
        {
                $value = ilUtil::stripSlashes($_POST[$this->getPostVar()]);
                if($value != "")
                {
                        return (int)$value;
                }
        }
}
?>