This class represents a number property in a property form. More...

Inheritance diagram for ilNumberInputGUI:

Collaboration diagram for ilNumberInputGUI:

Public Member Functions
	__construct ($a_title="", $a_postvar="")
	Constructor. More...

	setSuffix ($a_value)
	Set suffix. More...

	getSuffix ()
	Get suffix. More...

	setValue ($a_value)
	Set Value. More...

	getValue ()
	Get Value. More...

	setMaxLength ($a_maxlength)
	Set Max Length. More...

	getMaxLength ()
	Get Max Length. More...

	setMinvalueShouldBeGreater ($a_bool)
	Set minvalueShouldBeGreater. More...

	minvalueShouldBeGreater ()
	Get minvalueShouldBeGreater. More...

	setMaxvalueShouldBeLess ($a_bool)
	Set maxvalueShouldBeLess. More...

	maxvalueShouldBeLess ()
	Get maxvalueShouldBeLess. More...

	setSize ($a_size)
	Set Size. More...

	setValueByArray ($a_values)
	Set value by array. More...

	getSize ()
	Get Size. More...

	setMinValue ($a_minvalue, $a_display_always=false)
	Set Minimum Value. More...

	getMinValue ()
	Get Minimum Value. More...

	setMaxValue ($a_maxvalue, $a_display_always=false)
	Set Maximum Value. More...

	getMaxValue ()
	Get Maximum Value. More...

	setDecimals ($a_decimals)
	Set Decimal Places. More...

	getDecimals ()
	Get Decimal Places. More...

	allowDecimals ($a_value)
	Toggle Decimals. More...

	areDecimalsAllowed ()

	checkInput ()
	Check input, strip slashes etc. More...

	insert (&$a_tpl)
	Insert property html. More...

	render ()
	Insert property html. More...

	getPostValueForComparison ()
	parse post value to make it comparable More...

Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem ($a_item)
	Add Subitem. More...

	getSubItems ()
	Get Subitems. More...

	getSubInputItemsRecursive ()
	returns a flat array of possibly existing subitems recursively More...

	checkSubItemsInput ()
	Check SubItems. More...

	getSubForm ()
	Get sub form html. More...

	getItemByPostVar ($a_post_var)
	Get item by post var. More...

Public Member Functions inherited from ilFormPropertyGUI
	__construct ($a_title="", $a_postvar="")
	Constructor. More...

&	executeCommand ()
	Execute command. More...

	getType ()
	Get Type. More...

	setTitle ($a_title)
	Set Title. More...

	getTitle ()
	Get Title. More...

	setPostVar ($a_postvar)
	Set Post Variable. More...

	getPostVar ()
	Get Post Variable. More...

	getFieldId ()
	Get Post Variable. More...

	setInfo ($a_info)
	Set Information Text. More...

	getInfo ()
	Get Information Text. More...

	setAlert ($a_alert)
	Set Alert Text. More...

	getAlert ()
	Get Alert Text. More...

	setRequired ($a_required)
	Set Required. More...

	getRequired ()
	Get Required. More...

	setDisabled ($a_disabled)
	Set Disabled. More...

	getDisabled ()
	Get Disabled. More...

	checkInput ()
	Check input, strip slashes etc. More...

	setParentForm ($a_parentform)
	Set Parent Form. More...

	getParentForm ()
	Get Parent Form. More...

	setParent ($a_val)
	Set Parent GUI object. More...

	getParent ()
	Get Parent GUI object. More...

	getSubForm ()
	Get sub form html. More...

	hideSubForm ()
	Sub form hidden on init? More...

	setHiddenTitle ($a_val)
	Set hidden title (for screenreaders) More...

	getHiddenTitle ()
	Get hidden title. More...

	getItemByPostVar ($a_post_var)
	Get item by post var. More...

	serializeData ()
	serialize data More...

	unserializeData ($a_data)
	unserialize data More...

	writeToSession ()
	Write to session. More...

	clearFromSession ()
	Clear session value. More...

	readFromSession ()
	Read from session. More...

	getHiddenTag ($a_post_var, $a_value)
	Get hidden tag (used for disabled properties) More...

	setMulti ($a_multi, $a_sortable=false, $a_addremove=true)
	Set Multi. More...

	getMulti ()
	Get Multi. More...

	setMultiValues (array $a_values)
	Set multi values. More...

	getMultiValues ()
	Get multi values. More...

	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g. More...

	removeProhibitedCharacters ($a_text)
	Remove prohibited characters see #19159. More...

	stripSlashesAddSpaceFallback ($a_str)
	Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727. More...

Protected Attributes
	$value

	$maxlength = 200

	$size = 40

	$suffix

	$minvalue = false

	$minvalueShouldBeGreater = false

	$minvalue_visible = false

	$maxvalue = false

	$maxvalueShouldBeLess = false

	$maxvalue_visible = false

	$decimals

	$allow_decimals = false

Protected Attributes inherited from ilSubEnabledFormPropertyGUI
	$sub_items = array()

Protected Attributes inherited from ilFormPropertyGUI
	$type

	$title

	$postvar

	$info

	$alert

	$required = false

	$parentgui

	$parentform

	$hidden_title = ""

	$multi = false

	$multi_sortable = false

	$multi_addremove = true

	$multi_values

Additional Inherited Members
Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type. More...

	getMultiIconsHTML ()
	Get HTML for multiple value icons. More...

Detailed Description

This class represents a number property in a property form.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

Definition at line 14 of file class.ilNumberInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilNumberInputGUI::__construct	(	$a_title = `""`,
		$a_postvar = `""`
	)

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Reimplemented from ilFormPropertyGUI.

Definition at line 35 of file class.ilNumberInputGUI.php.

        {
                parent::__construct($a_title, $a_postvar);
        }

Member Function Documentation

◆ allowDecimals()

ilNumberInputGUI::allowDecimals ( $a_value )

Toggle Decimals.

Parameters

bool $a_value

Definition at line 262 of file class.ilNumberInputGUI.php.

        {               
                $this->allow_decimals = (bool)$a_value;
        }

Referenced by setDecimals().

Here is the caller graph for this function:

◆ areDecimalsAllowed()

ilNumberInputGUI::areDecimalsAllowed ( )

Returns: bool

Definition at line 272 of file class.ilNumberInputGUI.php.

        {
                return $this->allow_decimals;
        }

References $allow_decimals.

Referenced by render(), and setValue().

Here is the caller graph for this function:

◆ checkInput()

ilNumberInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: boolean Input ok, true/false

Reimplemented from ilFormPropertyGUI.

Definition at line 282 of file class.ilNumberInputGUI.php.

        {
                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();
        }

References $_POST, $lng, ilSubEnabledFormPropertyGUI\checkSubItemsInput(), getMaxValue(), getMinValue(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), maxvalueShouldBeLess(), minvalueShouldBeGreater(), ilFormPropertyGUI\setAlert(), and ilUtil\stripSlashes().

Here is the call graph for this function:

◆ getDecimals()

ilNumberInputGUI::getDecimals ( )

Get Decimal Places.

Returns: int Decimal Places

Definition at line 252 of file class.ilNumberInputGUI.php.

        {
                return $this->decimals;
        }

References $decimals.

Referenced by render(), and setValue().

Here is the caller graph for this function:

◆ getMaxLength()

ilNumberInputGUI::getMaxLength ( )

Get Max Length.

Returns: int Max Length

Definition at line 114 of file class.ilNumberInputGUI.php.

        {
                return $this->maxlength;
        }

References $maxlength.

Referenced by render().

Here is the caller graph for this function:

◆ getMaxValue()

ilNumberInputGUI::getMaxValue ( )

Get Maximum Value.

Returns: float Maximum Value

Definition at line 228 of file class.ilNumberInputGUI.php.

        {
                return $this->maxvalue;
        }

References $maxvalue.

Referenced by checkInput(), and render().

Here is the caller graph for this function:

◆ getMinValue()

ilNumberInputGUI::getMinValue ( )

Get Minimum Value.

Returns: float Minimum Value

Definition at line 206 of file class.ilNumberInputGUI.php.

        {
                return $this->minvalue;
        }

References $minvalue.

Referenced by checkInput(), and render().

Here is the caller graph for this function:

◆ getPostValueForComparison()

ilNumberInputGUI::getPostValueForComparison ( )

parse post value to make it comparable

used by combination input gui

Definition at line 428 of file class.ilNumberInputGUI.php.

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

References $_POST, $value, ilFormPropertyGUI\getPostVar(), and ilUtil\stripSlashes().

Here is the call graph for this function:

◆ getSize()

ilNumberInputGUI::getSize ( )

Get Size.

Returns: int Size

Definition at line 184 of file class.ilNumberInputGUI.php.

        {
                return $this->size;
        }

References $size.

Referenced by render().

Here is the caller graph for this function:

◆ getSuffix()

ilNumberInputGUI::getSuffix ( )

Get suffix.

Returns: string suffix

Definition at line 55 of file class.ilNumberInputGUI.php.

        {
                return $this->suffix;
        }

References $suffix.

Referenced by render().

Here is the caller graph for this function:

◆ getValue()

ilNumberInputGUI::getValue ( )

Get Value.

Returns: string Value

Definition at line 94 of file class.ilNumberInputGUI.php.

        {
                return $this->value;
        }

References $value.

Referenced by render().

Here is the caller graph for this function:

◆ insert()

ilNumberInputGUI::insert ( & $a_tpl )

Insert property html.

Returns: int Size

Definition at line 356 of file class.ilNumberInputGUI.php.

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

References $html, and render().

Here is the call graph for this function:

◆ maxvalueShouldBeLess()

ilNumberInputGUI::maxvalueShouldBeLess ( )

Get maxvalueShouldBeLess.

Returns: boolean true if the maximum value should be less than maxvalue

Definition at line 154 of file class.ilNumberInputGUI.php.

        {
                return $this->maxvalueShouldBeLess;
        }

References $maxvalueShouldBeLess.

Referenced by checkInput(), render(), and setMaxvalueShouldBeLess().

Here is the caller graph for this function:

◆ minvalueShouldBeGreater()

ilNumberInputGUI::minvalueShouldBeGreater ( )

Get minvalueShouldBeGreater.

Returns: boolean true if the minimum value should be greater than minvalue

Definition at line 134 of file class.ilNumberInputGUI.php.

        {
                return $this->minvalueShouldBeGreater;
        }

References $minvalueShouldBeGreater.

Referenced by checkInput(), render(), and setMinvalueShouldBeGreater().

Here is the caller graph for this function:

◆ render()

ilNumberInputGUI::render ( )

Insert property html.

Definition at line 368 of file class.ilNumberInputGUI.php.

        {
                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();
        }

References $lng, $maxvalue_visible, $tpl, areDecimalsAllowed(), getDecimals(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), getMaxLength(), getMaxValue(), getMinValue(), ilFormPropertyGUI\getPostVar(), getSize(), getSuffix(), getValue(), maxvalueShouldBeLess(), minvalueShouldBeGreater(), and ilUtil\prepareFormOutput().

Referenced by insert().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDecimals()

ilNumberInputGUI::setDecimals ( $a_decimals )

Set Decimal Places.

Parameters

int $a_decimals Decimal Places

Definition at line 238 of file class.ilNumberInputGUI.php.

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

References allowDecimals().

Here is the call graph for this function:

◆ setMaxLength()

ilNumberInputGUI::setMaxLength ( $a_maxlength )

Set Max Length.

Parameters

int $a_maxlength Max Length

Definition at line 104 of file class.ilNumberInputGUI.php.

        {
                $this->maxlength = $a_maxlength;
        }

◆ setMaxValue()

ilNumberInputGUI::setMaxValue	(	$a_maxvalue,
		$a_display_always = `false`
	)

Set Maximum Value.

Parameters

float	$a_maxvalue	Maximum Value
bool	$a_display_always

Definition at line 217 of file class.ilNumberInputGUI.php.

        {
                $this->maxvalue = $a_maxvalue;
                $this->maxvalue_visible = (bool)$a_display_always;
        }

◆ setMaxvalueShouldBeLess()

ilNumberInputGUI::setMaxvalueShouldBeLess ( $a_bool )

Set maxvalueShouldBeLess.

Parameters

boolean $a_bool true if the maximum value should be less than maxvalue

Definition at line 144 of file class.ilNumberInputGUI.php.

        {
                $this->maxvalueShouldBeLess = $a_bool;
        }

References maxvalueShouldBeLess().

Here is the call graph for this function:

◆ setMinValue()

ilNumberInputGUI::setMinValue	(	$a_minvalue,
		$a_display_always = `false`
	)

Set Minimum Value.

Parameters

float	$a_minvalue	Minimum Value
bool	$a_display_always

Definition at line 195 of file class.ilNumberInputGUI.php.

        {
                $this->minvalue = $a_minvalue;
                $this->minvalue_visible = (bool)$a_display_always;
        }

◆ setMinvalueShouldBeGreater()

ilNumberInputGUI::setMinvalueShouldBeGreater ( $a_bool )

Set minvalueShouldBeGreater.

Parameters

boolean $a_bool true if the minimum value should be greater than minvalue

Definition at line 124 of file class.ilNumberInputGUI.php.

        {
                $this->minvalueShouldBeGreater = $a_bool;
        }

References minvalueShouldBeGreater().

Here is the call graph for this function:

◆ setSize()

ilNumberInputGUI::setSize ( $a_size )

Set Size.

Parameters

int $a_size Size

Definition at line 164 of file class.ilNumberInputGUI.php.

        {
                $this->size = $a_size;
        }

◆ setSuffix()

ilNumberInputGUI::setSuffix ( $a_value )

Set suffix.

Parameters

string $a_value suffix

Definition at line 45 of file class.ilNumberInputGUI.php.

        {
                $this->suffix = $a_value;
        }

◆ setValue()

ilNumberInputGUI::setValue ( $a_value )

Set Value.

Parameters

string $a_value Value

Definition at line 65 of file class.ilNumberInputGUI.php.

        {
                $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(), ".", "");
                        }
                }
        }

References areDecimalsAllowed(), and getDecimals().

Referenced by setValueByArray().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setValueByArray()

ilNumberInputGUI::setValueByArray ( $a_values )

Set value by array.

Parameters

array $a_values value array

Definition at line 174 of file class.ilNumberInputGUI.php.

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

References ilFormPropertyGUI\getPostVar(), and setValue().

Here is the call graph for this function:

Field Documentation

◆ $allow_decimals

ilNumberInputGUI::$allow_decimals = false

protected

Definition at line 27 of file class.ilNumberInputGUI.php.

Referenced by areDecimalsAllowed().

◆ $decimals

ilNumberInputGUI::$decimals

protected

Definition at line 26 of file class.ilNumberInputGUI.php.

Referenced by getDecimals().

◆ $maxlength

ilNumberInputGUI::$maxlength = 200

protected

Definition at line 17 of file class.ilNumberInputGUI.php.

Referenced by getMaxLength().

◆ $maxvalue

ilNumberInputGUI::$maxvalue = false

protected

Definition at line 23 of file class.ilNumberInputGUI.php.

Referenced by getMaxValue().

◆ $maxvalue_visible

ilNumberInputGUI::$maxvalue_visible = false

protected

Definition at line 25 of file class.ilNumberInputGUI.php.

Referenced by render().

◆ $maxvalueShouldBeLess

ilNumberInputGUI::$maxvalueShouldBeLess = false

protected

Definition at line 24 of file class.ilNumberInputGUI.php.

Referenced by maxvalueShouldBeLess().

◆ $minvalue

ilNumberInputGUI::$minvalue = false

protected

Definition at line 20 of file class.ilNumberInputGUI.php.

Referenced by getMinValue().

◆ $minvalue_visible

ilNumberInputGUI::$minvalue_visible = false

protected

Definition at line 22 of file class.ilNumberInputGUI.php.

◆ $minvalueShouldBeGreater

ilNumberInputGUI::$minvalueShouldBeGreater = false

protected

Definition at line 21 of file class.ilNumberInputGUI.php.

Referenced by minvalueShouldBeGreater().

◆ $size

ilNumberInputGUI::$size = 40

protected

Definition at line 18 of file class.ilNumberInputGUI.php.

Referenced by getSize().

◆ $suffix

ilNumberInputGUI::$suffix

protected

Definition at line 19 of file class.ilNumberInputGUI.php.

Referenced by getSuffix().

◆ $value

ilNumberInputGUI::$value

protected

Definition at line 16 of file class.ilNumberInputGUI.php.

Referenced by getPostValueForComparison(), and getValue().

The documentation for this class was generated from the following file:

Services/Form/classes/class.ilNumberInputGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ allowDecimals()

◆ areDecimalsAllowed()

◆ checkInput()

◆ getDecimals()

◆ getMaxLength()

◆ getMaxValue()

◆ getMinValue()

◆ getPostValueForComparison()

◆ getSize()

◆ getSuffix()

◆ getValue()

◆ insert()

◆ maxvalueShouldBeLess()

◆ minvalueShouldBeGreater()

◆ render()

◆ setDecimals()

◆ setMaxLength()

◆ setMaxValue()

◆ setMaxvalueShouldBeLess()

◆ setMinValue()

◆ setMinvalueShouldBeGreater()

◆ setSize()

◆ setSuffix()

◆ setValue()

◆ setValueByArray()

Field Documentation

◆ $allow_decimals

◆ $decimals

◆ $maxlength

◆ $maxvalue

◆ $maxvalue_visible

◆ $maxvalueShouldBeLess

◆ $minvalue

◆ $minvalue_visible

◆ $minvalueShouldBeGreater

◆ $size

◆ $suffix

◆ $value