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.
	setSuffix ($a_value)
	Set suffix.
	getSuffix ()
	Get suffix.
	setValue ($a_value)
	Set Value.
	getValue ()
	Get Value.
	setMaxLength ($a_maxlength)
	Set Max Length.
	getMaxLength ()
	Get Max Length.
	setMinvalueShouldBeGreater ($a_bool)
	Set minvalueShouldBeGreater.
	minvalueShouldBeGreater ()
	Get minvalueShouldBeGreater.
	setMaxvalueShouldBeLess ($a_bool)
	Set maxvalueShouldBeLess.
	maxvalueShouldBeLess ()
	Get maxvalueShouldBeLess.
	setSize ($a_size)
	Set Size.
	setValueByArray ($a_values)
	Set value by array.
	getSize ()
	Get Size.
	setMinValue ($a_minvalue)
	Set Minimum Value.
	getMinValue ()
	Get Minimum Value.
	setMaxValue ($a_maxvalue)
	Set Maximum Value.
	getMaxValue ()
	Get Maximum Value.
	setDecimals ($a_decimals)
	Set Decimal Places.
	getDecimals ()
	Get Decimal Places.
	checkInput ()
	Check input, strip slashes etc.
	insert (&$a_tpl)
	Insert property html.
	render ()
	Insert property html.
	getPostValueForComparison ()
	parse post value to make it comparable
Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem ($a_item)
	Add Subitem.
	getSubItems ()
	Get Subitems.
	checkSubItemsInput ()
	Check SubItems.
	getSubForm ()
	Get sub form html.
	getItemByPostVar ($a_post_var)
	Get item by post var.
Public Member Functions inherited from ilFormPropertyGUI
&	executeCommand ()
	Execute command.
	getType ()
	Get Type.
	setTitle ($a_title)
	Set Title.
	getTitle ()
	Get Title.
	setPostVar ($a_postvar)
	Set Post Variable.
	getPostVar ()
	Get Post Variable.
	getFieldId ()
	Get Post Variable.
	setInfo ($a_info)
	Set Information Text.
	getInfo ()
	Get Information Text.
	setAlert ($a_alert)
	Set Alert Text.
	getAlert ()
	Get Alert Text.
	setRequired ($a_required)
	Set Required.
	getRequired ()
	Get Required.
	setDisabled ($a_disabled)
	Set Disabled.
	getDisabled ()
	Get Disabled.
	setParentForm ($a_parentform)
	Set Parent Form.
	getParentForm ()
	Get Parent Form.
	setParent ($a_val)
	Set Parent GUI object.
	getParent ()
	Get Parent GUI object.
	hideSubForm ()
	Sub form hidden on init?
	setHiddenTitle ($a_val)
	Set hidden title (for screenreaders)
	getHiddenTitle ()
	Get hidden title.
	serializeData ()
	serialize data
	unserializeData ($a_data)
	unserialize data
	writeToSession ()
	Write to session.
	clearFromSession ()
	Clear session value.
	readFromSession ()
	Read from session.
	getHiddenTag ($a_post_var, $a_value)
	Get hidden tag (used for disabled properties)

Protected Attributes
	$value
	$maxlength = 200
	$size = 40
	$suffix
	$minvalue = false
	$minvalueShouldBeGreater = false
	$maxvalue = false
	$maxvalueShouldBeLess = 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 = ""

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

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 31 of file class.ilNumberInputGUI.php.

Constructor & Destructor Documentation

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Reimplemented from ilFormPropertyGUI.

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

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

Member Function Documentation

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 248 of file class.ilNumberInputGUI.php.

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

        {
                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->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->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->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->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->setAlert($lng->txt("form_msg_value_too_high"));
                                return false;
                        }
                }
                
                return $this->checkSubItemsInput();
        }

Here is the call graph for this function:

ilNumberInputGUI::getDecimals ( )

Get Decimal Places.

Returns: int Decimal Places

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

Referenced by render().

        {
                return $this->decimals;
        }

Here is the caller graph for this function:

ilNumberInputGUI::getMaxLength ( )

Get Max Length.

Returns: int Max Length

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

References $maxlength.

Referenced by render().

        {
                return $this->maxlength;
        }

Here is the caller graph for this function:

ilNumberInputGUI::getMaxValue ( )

Get Maximum Value.

Returns: float Maximum Value

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

References $maxvalue.

Referenced by checkInput(), and render().

        {
                return $this->maxvalue;
        }

Here is the caller graph for this function:

ilNumberInputGUI::getMinValue ( )

Get Minimum Value.

Returns: float Minimum Value

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

References $minvalue.

Referenced by checkInput(), and render().

        {
                return $this->minvalue;
        }

Here is the caller graph for this function:

ilNumberInputGUI::getPostValueForComparison ( )

parse post value to make it comparable

used by combination input gui

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

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

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

Here is the call graph for this function:

ilNumberInputGUI::getSize ( )

Get Size.

Returns: int Size

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

References $size.

Referenced by render().

        {
                return $this->size;
        }

Here is the caller graph for this function:

ilNumberInputGUI::getSuffix ( )

Get suffix.

Returns: string suffix

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

References $suffix.

Referenced by render().

        {
                return $this->suffix;
        }

Here is the caller graph for this function:

ilNumberInputGUI::getValue ( )

Get Value.

Returns: string Value

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

References $value.

Referenced by render().

        {
                return $this->value;
        }

Here is the caller graph for this function:

ilNumberInputGUI::insert ( & $a_tpl )

Insert property html.

Returns: int Size

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

References render().

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

Here is the call graph for this function:

ilNumberInputGUI::maxvalueShouldBeLess ( )

Get maxvalueShouldBeLess.

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

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

References $maxvalueShouldBeLess.

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

        {
                return $this->maxvalueShouldBeLess;
        }

Here is the caller graph for this function:

ilNumberInputGUI::minvalueShouldBeGreater ( )

Get minvalueShouldBeGreater.

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

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

References $minvalueShouldBeGreater.

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

        {
                return $this->minvalueShouldBeGreater;
        }

Here is the caller graph for this function:

ilNumberInputGUI::render ( )

Insert property html.

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

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

Referenced by insert().

        {
                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\"");
                }
                
                // constraints
                if ($this->getDecimals() > 0)
                {
                        $constraints = $lng->txt("form_format").": ###.".str_repeat("#", $this->getDecimals());
                        $delim = ", ";
                }
                if ($this->getMinValue() !== false)
                {
                        $constraints.= $delim.$lng->txt("form_min_value").": ".(($this->minvalueShouldBeGreater()) ? "&gt; " : "").$this->getMinValue();
                        $delim = ", ";
                }
                if ($this->getMaxValue() !== false)
                {
                        $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();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilNumberInputGUI::setDecimals ( $a_decimals )

Set Decimal Places.

Parameters

int $a_decimals Decimal Places

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

Referenced by SurveyMetricQuestionGUI\editQuestion(), and assJavaAppletGUI\editQuestion().

        {
                $this->decimals = $a_decimals;
        }

Here is the caller graph for this function:

ilNumberInputGUI::setMaxLength ( $a_maxlength )

Set Max Length.

Parameters

int $a_maxlength Max Length

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

Referenced by ilPCTabsGUI\initForm(), ilObjSystemFolderGUI\initJavaServerForm(), ilPCListGUI\initListForm(), and ilObjSCORM2004LearningModuleGUI\initPropertiesEditableForm().

        {
                $this->maxlength = $a_maxlength;
        }

Here is the caller graph for this function:

ilNumberInputGUI::setMaxValue ( $a_maxvalue )

Set Maximum Value.

Parameters

float $a_maxvalue Maximum Value

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

Referenced by ilObjStyleSheetGUI\initTemplateGenerationForm().

        {
                $this->maxvalue = $a_maxvalue;
        }

Here is the caller graph for this function:

ilNumberInputGUI::setMaxvalueShouldBeLess ( $a_bool )

Set maxvalueShouldBeLess.

Parameters

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

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

References maxvalueShouldBeLess().

        {
                $this->maxvalueShouldBeLess = $a_bool;
        }

Here is the call graph for this function:

ilNumberInputGUI::setMinValue ( $a_minvalue )

Set Minimum Value.

Parameters

float $a_minvalue Minimum Value

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

Referenced by assTextSubsetGUI\editQuestion(), assMultipleChoiceGUI\editQuestion(), assSingleChoiceGUI\editQuestion(), ilObjMediaPoolGUI\initEditForm(), ilObjCourseGUI\initForm(), ilObjRoleGUI\initFormRoleProperties(), and ilObjStyleSheetGUI\initTagStyleForm().

        {
                $this->minvalue = $a_minvalue;
        }

Here is the caller graph for this function:

ilNumberInputGUI::setMinvalueShouldBeGreater ( $a_bool )

Set minvalueShouldBeGreater.

Parameters

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

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

References minvalueShouldBeGreater().

        {
                $this->minvalueShouldBeGreater = $a_bool;
        }

Here is the call graph for this function:

ilNumberInputGUI::setSize ( $a_size )

Set Size.

Parameters

int $a_size Size

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

Referenced by ilPaymentCouponGUI\addCoupon(), assTextQuestionGUI\editQuestion(), assNumericGUI\editQuestion(), SurveyMultipleChoiceQuestionGUI\editQuestion(), assClozeTestGUI\editQuestion(), ilPaymentCouponGUI\generateCodes(), ilRegistrationSettingsGUI\initAddCodesForm(), ilRegistrationSettingsGUI\initForm(), ilPCMapGUI\initForm(), ilConsultationHoursGUI\initFormSequence(), ilObjSystemFolderGUI\initJavaServerIniForm(), and ilObjExerciseGUI\initPropertiesForm().

        {
                $this->size = $a_size;
        }

Here is the caller graph for this function:

ilNumberInputGUI::setSuffix ( $a_value )

Set suffix.

Parameters

string $a_value suffix

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

        {
                $this->suffix = $a_value;
        }

ilNumberInputGUI::setValue ( $a_value )

Set Value.

Parameters

string $a_value Value

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

Referenced by assQuestionGUI\addBasicQuestionFormProperties(), SurveyMetricQuestionGUI\editQuestion(), assTextQuestionGUI\editQuestion(), assOrderingHorizontalGUI\editQuestion(), assFileUploadGUI\editQuestion(), assNumericGUI\editQuestion(), assErrorTextGUI\editQuestion(), assJavaAppletGUI\editQuestion(), assFlashQuestionGUI\editQuestion(), assClozeTestGUI\editQuestion(), assOrderingQuestionGUI\editQuestion(), assMatchingQuestionGUI\editQuestion(), ilObjSystemFolderGUI\initJavaServerIniForm(), ilObjTestGUI\randomQuestionsObject(), and setValueByArray().

        {
                $this->value = str_replace(',', '.', $a_value);
        }

Here is the caller graph for this function:

ilNumberInputGUI::setValueByArray ( $a_values )

Set value by array.

Parameters

array $a_values value array

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

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

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

Here is the call graph for this function:

Field Documentation

ilNumberInputGUI::$maxlength = 200

protected

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

Referenced by getMaxLength().

ilNumberInputGUI::$maxvalue = false

protected

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

Referenced by getMaxValue().

ilNumberInputGUI::$maxvalueShouldBeLess = false

protected

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

Referenced by maxvalueShouldBeLess().

ilNumberInputGUI::$minvalue = false

protected

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

Referenced by getMinValue().

ilNumberInputGUI::$minvalueShouldBeGreater = false

protected

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

Referenced by minvalueShouldBeGreater().

ilNumberInputGUI::$size = 40

protected

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

Referenced by getSize().

ilNumberInputGUI::$suffix

protected

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

Referenced by getSuffix().

ilNumberInputGUI::$value

protected

Definition at line 33 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

Member Function Documentation

Field Documentation