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

Inheritance diagram for ilNumberInputGUI:

Collaboration diagram for ilNumberInputGUI:

Public Member Functions
	__construct (string $a_title="", string $a_postvar="")

	setSuffix (string $a_value)

	getSuffix ()

	setValue (?string $a_value)

	getValue ()

	unserializeData (string $a_data)

	setMaxLength (int $a_maxlength)

	getMaxLength ()

	setMinvalueShouldBeGreater (bool $a_bool)

	minvalueShouldBeGreater ()

	setMaxvalueShouldBeLess (bool $a_bool)

	maxvalueShouldBeLess ()

	setSize (int $a_size)

	setValueByArray (array $a_values)

	getSize ()

	setMinValue (float $a_minvalue, bool $a_display_always=false)

	getMinValue ()

	setMaxValue (float $a_maxvalue, bool $a_display_always=false)

	getMaxValue ()

	setDecimals (int $a_decimals)

	getDecimals ()

	allowDecimals (bool $a_value)

	areDecimalsAllowed ()

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

	getInput ()

	insert (ilTemplate $a_tpl)

	render ()

	getPostValueForComparison ()

	setClientSideValidation (bool $validate)

Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem (ilFormPropertyGUI $a_item)

	getSubItems ()

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

	checkSubItemsInput ()
	Check SubItems. More...

	getSubForm ()

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

Public Member Functions inherited from ilFormPropertyGUI
	__construct (string $a_title="", string $a_postvar="")

	executeCommand ()

	getType ()

	setTitle (string $a_title)

	getTitle ()

	setPostVar (string $a_postvar)

	getPostVar ()

	getFieldId ()

	setInfo (string $a_info)

	getInfo ()

	setAlert (string $a_alert)

	getAlert ()

	setRequired (bool $a_required)

	getRequired ()

	setDisabled (bool $a_disabled)

	getDisabled ()

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

	setParentForm (ilPropertyFormGUI $a_parentform)

	getParentForm ()

	setParent (ilFormPropertyGUI $a_val)

	getParent ()

	getSubForm ()

	hideSubForm ()

	setHiddenTitle (string $a_val)

	getHiddenTitle ()

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

	serializeData ()

	unserializeData (string $a_data)

	setParentTable ($a_val)
	Set parent table. More...

	getParentTable ()
	Get parent table. More...

	writeToSession ()

	clearFromSession ()

	readFromSession ()

	getHiddenTag (string $a_post_var, string $a_value)

	setMulti (bool $a_multi, bool $a_sortable=false, bool $a_addremove=true)

	getMulti ()

	setMultiValues (array $a_values)

	getMultiValues ()

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

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

	getTableFilterLabelFor ()
	Get label "for" attribute value for filter. More...

	getFormLabelFor ()
	Get label "for" attribute value for form. More...

	setRequestParam (string $key, $val)
	This writes the request (aka post) values. More...

Protected Attributes
float	$value = null

int	$maxlength = 200

int	$size = 40

string	$suffix = ""

float	$minvalue = null

bool	$minvalueShouldBeGreater = false

bool	$minvalue_visible = false

float	$maxvalue = null

bool	$maxvalueShouldBeLess = false

bool	$maxvalue_visible = false

int	$decimals = 0

bool	$allow_decimals = false

bool	$client_side_validation = false

Protected Attributes inherited from ilSubEnabledFormPropertyGUI
array	$sub_items = array()

Protected Attributes inherited from ilFormPropertyGUI
array	$set_params = []

ilTable2GUI	$parent_table = null

ilFormPropertyGUI	$parent_gui = null

ilCtrl	$ctrl

ilLanguage	$lng

string	$type = ""

string	$title = ""

string	$postvar = ""

string	$info = ""

string	$alert = ""

bool	$required = false

ilPropertyFormGUI	$parentform = null

string	$hidden_title = ""

bool	$multi = false

bool	$multi_sortable = false

bool	$multi_addremove = true

array	$multi_values = []

RequestInterface	$request

HTTP Services	$http

Refinery Factory	$refinery = null

bool	$disabled = false

ilGlobalTemplateInterface	$global_tpl = null

Additional Inherited Members
Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters (string $a_text)
	Remove prohibited characters see #19159. More...

Protected Member Functions inherited from ilFormPropertyGUI
	setType (string $a_type)

	checkParentFormTable ()

	getSessionKey ()

	getMultiIconsHTML ()

	int ($key)

	intArray ($key)

	str ($key)

	raw ($key)

	strArray ($key)

	arrayArray ($key)

	isRequestParamArray (string $key)

	getRequestParam (string $key, Refinery\Transformation $t)

Detailed Description

This class represents a number property in a property form.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented from ilFormPropertyGUI.

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

      {
        global $DIC;
 
        $this->lng = $DIC->language();
        parent::__construct($a_title, $a_postvar);
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\lng().

Here is the call graph for this function:

Member Function Documentation

◆ allowDecimals()

ilNumberInputGUI::allowDecimals ( bool $a_value )

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

                                                : void
    {
        $this->allow_decimals = $a_value;
    }

◆ areDecimalsAllowed()

ilNumberInputGUI::areDecimalsAllowed ( )

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

                                        : bool
    {
        return $this->allow_decimals;
    }

Referenced by setValue().

Here is the caller graph for this function:

◆ checkInput()

ilNumberInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Reimplemented from ilFormPropertyGUI.

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

                                : bool
    {
        $lng = $this->lng;
 
        $val = trim($this->str($this->getPostVar()));
        if ($this->getRequired() && $val == "") {
            $this->setAlert($lng->txt("msg_input_is_required"));
            return false;
        }
        $val = str_replace(',', '.', $val);
 
        if ($val != "" && !is_numeric($val)) {
            $this->minvalue_visible = true;
            $this->maxvalue_visible = true;
            $this->setAlert($lng->txt("form_msg_numeric_value_required"));
            return false;
        }
 
        if ($this->minvalueShouldBeGreater()) {
            if ($val != "" && $this->getMinValue() !== null &&
                $val <= $this->getMinValue()) {
                $this->minvalue_visible = true;
                $this->setAlert($lng->txt("form_msg_value_too_low"));
                return false;
            }
        } else {
            if ($val != "" &&
                $this->getMinValue() !== null &&
                $val < $this->getMinValue()) {
                $this->minvalue_visible = true;
                $this->setAlert($lng->txt("form_msg_value_too_low"));
                return false;
            }
        }
 
        if ($this->maxvalueShouldBeLess()) {
            if ($val != "" &&
                $this->getMaxValue() !== null &&
                $val >= $this->getMaxValue()) {
                $this->maxvalue_visible = true;
                $this->setAlert($lng->txt("form_msg_value_too_high"));
                return false;
            }
        } else {
            if ($val != "" &&
                $this->getMaxValue() !== null &&
                $val > $this->getMaxValue()) {
                $this->maxvalue_visible = true;
                $this->setAlert($lng->txt("form_msg_value_too_high"));
                return false;
            }
        }
 
        return $this->checkSubItemsInput();
    }

References $lng, and ILIAS\Repository\str().

Here is the call graph for this function:

◆ getDecimals()

ilNumberInputGUI::getDecimals ( )

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

                                 : int
    {
        return $this->decimals;
    }

Referenced by setValue().

Here is the caller graph for this function:

◆ getInput()

ilNumberInputGUI::getInput ( )

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

                              : ?float
    {
        $value = $this->str($this->getPostVar());
        if (trim($value) == "") {
            return null;
        }
        return (float) str_replace(',', '.', $value);
    }

References ILIAS\Repository\str().

Here is the call graph for this function:

◆ getMaxLength()

ilNumberInputGUI::getMaxLength ( )

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

                                  : int
    {
        return $this->maxlength;
    }

References $maxlength.

◆ getMaxValue()

ilNumberInputGUI::getMaxValue ( )

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

                                 : ?float
    {
        return $this->maxvalue;
    }

◆ getMinValue()

ilNumberInputGUI::getMinValue ( )

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

                                 : ?float
    {
        return $this->minvalue;
    }

◆ getPostValueForComparison()

ilNumberInputGUI::getPostValueForComparison ( )

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

                                               : ?float
    {
        return $this->getInput();
    }

◆ getSize()

ilNumberInputGUI::getSize ( )

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

                             : int
    {
        return $this->size;
    }

References $size.

◆ getSuffix()

ilNumberInputGUI::getSuffix ( )

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

                               : string
    {
        return $this->suffix;
    }

References $suffix.

◆ getValue()

ilNumberInputGUI::getValue ( )

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

                              : ?float
    {
        return $this->value;
    }

References $value.

◆ insert()

ilNumberInputGUI::insert ( ilTemplate $a_tpl )

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

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

References ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Here is the call graph for this function:

◆ maxvalueShouldBeLess()

ilNumberInputGUI::maxvalueShouldBeLess ( )

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

                                          : bool
    {
        return $this->maxvalueShouldBeLess;
    }

References $maxvalueShouldBeLess.

Referenced by setMaxvalueShouldBeLess().

Here is the caller graph for this function:

◆ minvalueShouldBeGreater()

ilNumberInputGUI::minvalueShouldBeGreater ( )

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

                                             : bool
    {
        return $this->minvalueShouldBeGreater;
    }

References $minvalueShouldBeGreater.

Referenced by setMinvalueShouldBeGreater().

Here is the caller graph for this function:

◆ render()

ilNumberInputGUI::render ( )

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

                            : string
    {
        $lng = $this->lng;
 
        $tpl = new ilTemplate("tpl.prop_number.html", true, true, "Services/Form");
 
        if (strlen((string) $this->getValue())) {
            $tpl->setCurrentBlock("prop_number_propval");
            $tpl->setVariable("PROPERTY_VALUE", ilLegacyFormElementsUtil::prepareFormOutput((string) $this->getValue()));
            $tpl->parseCurrentBlock();
        }
 
        if ($this->getInfo() !== '') {
            $tpl->setCurrentBlock('described_by_description');
            $tpl->setVariable('DESCRIBED_BY_DESCRIPTION_FIELD_ID', $this->getFieldId());
            $tpl->parseCurrentBlock();
        }
 
        // constraints
        $constraints = "";
        $delim = "";
        if ($this->areDecimalsAllowed() && $this->getDecimals() > 0) {
            $constraints = $lng->txt("form_format") . ": ###." . str_repeat("#", $this->getDecimals());
            $delim = ", ";
        }
        if ($this->getMinValue() !== null && $this->minvalue_visible) {
            $constraints .= $delim . $lng->txt("form_min_value") . ": " . (($this->minvalueShouldBeGreater()) ? "&gt; " : "") . $this->getMinValue();
            $delim = ", ";
        }
        if ($this->getMaxValue() !== null && $this->maxvalue_visible) {
            $constraints .= $delim . $lng->txt("form_max_value") . ": " . (($this->maxvalueShouldBeLess()) ? "&lt; " : "") . $this->getMaxValue();
            $delim = ", ";
        }
 
        if ($constraints !== "") {
            $tpl->setCurrentBlock('described_by_constraint');
            $tpl->setVariable('DESCRIBED_BY_CONSTRAINT_FIELD_ID', $this->getFieldId());
            $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\""
            );
        }
 
        if ($this->client_side_validation) {
            $tpl->setVariable("JS_DECIMALS_ALLOWED", (int) $this->areDecimalsAllowed());
            $tpl->setVariable("JS_ID", $this->getFieldId());
        }
 
        if ($constraints !== '') {
            $tpl->setVariable("TXT_NUMBER_CONSTRAINTS", $constraints);
            $tpl->setVariable(
                "CONSTRAINT_FOR_ID",
                $this->getFieldId()
            );
        }
 
        if ($this->getRequired()) {
            $tpl->setVariable("REQUIRED", "required=\"required\"");
        }
 
        $tpl->parseCurrentBlock();
 
        return $tpl->get();
    }

References $lng, $tpl, ILIAS\UI\Implementation\Component\Input\getValue(), and ilLegacyFormElementsUtil\prepareFormOutput().

Here is the call graph for this function:

◆ setClientSideValidation()

ilNumberInputGUI::setClientSideValidation ( bool $validate )

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

                                                           : void
    {
        $this->client_side_validation = $validate;
    }

◆ setDecimals()

ilNumberInputGUI::setDecimals ( int $a_decimals )

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

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

◆ setMaxLength()

ilNumberInputGUI::setMaxLength ( int $a_maxlength )

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

                                                  : void
    {
        $this->maxlength = $a_maxlength;
    }

◆ setMaxValue()

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

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

     : void {
        $this->maxvalue = $a_maxvalue;
        $this->maxvalue_visible = $a_display_always;
    }

◆ setMaxvalueShouldBeLess()

ilNumberInputGUI::setMaxvalueShouldBeLess ( bool $a_bool )

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

                                                         : void
    {
        $this->maxvalueShouldBeLess = $a_bool;
    }

References maxvalueShouldBeLess().

Here is the call graph for this function:

◆ setMinValue()

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

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

     : void {
        $this->minvalue = $a_minvalue;
        $this->minvalue_visible = $a_display_always;
    }

◆ setMinvalueShouldBeGreater()

ilNumberInputGUI::setMinvalueShouldBeGreater ( bool $a_bool )

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

                                                            : void
    {
        $this->minvalueShouldBeGreater = $a_bool;
    }

References minvalueShouldBeGreater().

Here is the call graph for this function:

◆ setSize()

ilNumberInputGUI::setSize ( int $a_size )

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

                                        : void
    {
        $this->size = $a_size;
    }

◆ setSuffix()

ilNumberInputGUI::setSuffix ( string $a_value )

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

                                              : void
    {
        $this->suffix = $a_value;
    }

◆ setValue()

ilNumberInputGUI::setValue ( ?string $a_value )

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

                                              : void
    {
        if ($a_value == "" || is_null($a_value)) {
            $this->value = null;
            return;
        }
        $this->value = (float) str_replace(',', '.', $a_value);
 
        // integer
        if (!$this->areDecimalsAllowed()) {
            $this->value = round($this->value);
        }
        // float
        elseif ($this->getDecimals() > 0) {
            // get rid of unwanted decimals
            $this->value = round($this->value, $this->getDecimals());
 
            // pad value to specified format
            $this->value = (float) number_format($this->value, $this->getDecimals(), ".", "");
        }
    }

References areDecimalsAllowed(), and getDecimals().

Referenced by setValueByArray(), and unserializeData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setValueByArray()

ilNumberInputGUI::setValueByArray ( array $a_values )

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

                                                    : void
    {
        $this->setValue((string) ($a_values[$this->getPostVar()] ?? ""));
    }

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

Here is the call graph for this function:

◆ unserializeData()

ilNumberInputGUI::unserializeData ( string $a_data )

Reimplemented from ilFormPropertyGUI.

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

                                                   : void
    {
        $data = unserialize($a_data);
 
        // BT 35716: table filters with numeric input fields should accept 0
        if ($data || $data === 0 || $data === 0. || $data === '0') {
            $this->setValue((string) $data);
        } else {
            $this->setValue(null);
        }
    }

References $data, and setValue().

Here is the call graph for this function:

Field Documentation

◆ $allow_decimals

bool ilNumberInputGUI::$allow_decimals = false

protected

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

◆ $client_side_validation

bool ilNumberInputGUI::$client_side_validation = false

protected

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

◆ $decimals

int ilNumberInputGUI::$decimals = 0

protected

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

◆ $maxlength

int ilNumberInputGUI::$maxlength = 200

protected

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

Referenced by getMaxLength().

◆ $maxvalue

float ilNumberInputGUI::$maxvalue = null

protected

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

◆ $maxvalue_visible

bool ilNumberInputGUI::$maxvalue_visible = false

protected

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

◆ $maxvalueShouldBeLess

bool ilNumberInputGUI::$maxvalueShouldBeLess = false

protected

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

Referenced by maxvalueShouldBeLess().

◆ $minvalue

float ilNumberInputGUI::$minvalue = null

protected

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

◆ $minvalue_visible

bool ilNumberInputGUI::$minvalue_visible = false

protected

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

◆ $minvalueShouldBeGreater

bool ilNumberInputGUI::$minvalueShouldBeGreater = false

protected

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

Referenced by minvalueShouldBeGreater().

◆ $size

int ilNumberInputGUI::$size = 40

protected

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

Referenced by getSize().

◆ $suffix

string ilNumberInputGUI::$suffix = ""

protected

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

Referenced by getSuffix().

◆ $value

float ilNumberInputGUI::$value = null

protected

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

Referenced by 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()

◆ getInput()

◆ getMaxLength()

◆ getMaxValue()

◆ getMinValue()

◆ getPostValueForComparison()

◆ getSize()

◆ getSuffix()

◆ getValue()

◆ insert()

◆ maxvalueShouldBeLess()

◆ minvalueShouldBeGreater()

◆ render()

◆ setClientSideValidation()

◆ setDecimals()

◆ setMaxLength()

◆ setMaxValue()

◆ setMaxvalueShouldBeLess()

◆ setMinValue()

◆ setMinvalueShouldBeGreater()

◆ setSize()

◆ setSuffix()

◆ setValue()

◆ setValueByArray()

◆ unserializeData()

Field Documentation

◆ $allow_decimals

◆ $client_side_validation

◆ $decimals

◆ $maxlength

◆ $maxvalue

◆ $maxvalue_visible

◆ $maxvalueShouldBeLess

◆ $minvalue

◆ $minvalue_visible

◆ $minvalueShouldBeGreater

◆ $size

◆ $suffix

◆ $value