ilNumericStyleValueInputGUI Class Reference

This class represents a numeric style property in a property form. More...

Inheritance diagram for ilNumericStyleValueInputGUI:

Collaboration diagram for ilNumericStyleValueInputGUI:

Public Member Functions
	__construct (string $a_title="", string $a_postvar="")
	setValue (string $a_value)
	getValue ()
	setAllowPercentage (bool $a_allowpercentage)
	getAllowPercentage ()
	checkInput ()
	getInput ()
	insert (ilTemplate $a_tpl)
	setValueByArray (array $a_values)
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
ilObjUser	$user
string	$value = ""
bool	$allowpercentage = true
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
	symbol ()
	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 numeric style 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.ilNumericStyleValueInputGUI.php.

Constructor & Destructor Documentation

__construct()

ilNumericStyleValueInputGUI::__construct	(	string	$a_title = "",
		string	$a_postvar = ""
	)

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

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

    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->user = $DIC->user();
        parent::__construct($a_title, $a_postvar);
        $this->setType("style_numeric");
    }

Here is the call graph for this function:

Member Function Documentation

checkInput()

ilNumericStyleValueInputGUI::checkInput

(

)

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

References ilFormPropertyGUI\$lng, getInput(), ilFormPropertyGUI\getRequired(), ilFormPropertyGUI\setAlert(), setValue(), and ilLanguage\txt().

                                : bool
    {
        $lng = $this->lng;

        $input = $this->getInput();
        $num_value = $input["num_value"];
        $num_unit = $input["num_unit"];

        if ($this->getRequired() && trim($num_value) == "") {
            $this->setAlert($lng->txt("msg_input_is_required"));

            return false;
        }

        if (!is_numeric($num_value) && $num_value != "") {
            $this->setAlert($lng->txt("sty_msg_input_must_be_numeric"));

            return false;
        }

        if (trim($num_value) != "") {
            $this->setValue($num_value . $num_unit);
        }

        return true;
    }

Here is the call graph for this function:

getAllowPercentage()

ilNumericStyleValueInputGUI::getAllowPercentage

(

)

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

References $allowpercentage.

Referenced by insert().

                                        : bool
    {
        return $this->allowpercentage;
    }

Here is the caller graph for this function:

getInput()

ilNumericStyleValueInputGUI::getInput

(

)

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

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

Referenced by checkInput().

                              : array
    {
        return $this->strArray($this->getPostVar());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getValue()

ilNumericStyleValueInputGUI::getValue

(

)

Definition at line 47 of file class.ilNumericStyleValueInputGUI.php.

References $value.

Referenced by insert().

                              : string
    {
        return $this->value;
    }

Here is the caller graph for this function:

insert()

ilNumericStyleValueInputGUI::insert

(

ilTemplate

$a_tpl

)

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

References ilObjStyleSheet\_getStyleParameterNumericUnits(), getAllowPercentage(), ilFormPropertyGUI\getPostVar(), getValue(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

                                             : void
    {
        $tpl = new ilTemplate("tpl.prop_style_numeric.html", true, true, "components/ILIAS/Style/Content");

        $tpl->setVariable("POSTVAR", $this->getPostVar());

        $unit_options = ilObjStyleSheet::_getStyleParameterNumericUnits(!$this->getAllowPercentage());

        $value = strtolower(trim($this->getValue()));

        $current_unit = "";
        foreach ($unit_options as $u) {
            if (substr($value, strlen($value) - strlen($u)) == $u) {
                $current_unit = $u;
            }
        }
        $tpl->setVariable(
            "VAL_NUM",
            substr($value, 0, strlen($value) - strlen($current_unit))
        );
        if ($current_unit == "") {
            $current_unit = "px";
        }

        foreach ($unit_options as $option) {
            $tpl->setCurrentBlock("unit_option");
            $tpl->setVariable("VAL_UNIT", $option);
            $tpl->setVariable("TXT_UNIT", $option);
            if ($current_unit == $option) {
                $tpl->setVariable("UNIT_SELECTED", 'selected="selected"');
            }
            $tpl->parseCurrentBlock();
        }

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

Here is the call graph for this function:

setAllowPercentage()

ilNumericStyleValueInputGUI::setAllowPercentage

(

bool

$a_allowpercentage

)

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

Referenced by ilStyleCharacteristicGUI\initTagStyleForm(), and ilObjStyleSheetGUI\initTemplateGenerationForm().

                                                               : void
    {
        $this->allowpercentage = $a_allowpercentage;
    }

Here is the caller graph for this function:

setValue()

ilNumericStyleValueInputGUI::setValue

(

string

$a_value

)

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

Referenced by checkInput(), and setValueByArray().

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

Here is the caller graph for this function:

setValueByArray()

ilNumericStyleValueInputGUI::setValueByArray

(

array

$a_values

)

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

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

                                                    : void
    {
        $this->setValue($a_values[$this->getPostVar()]["num_value"] .
            $a_values[$this->getPostVar()]["num_unit"]);
    }

Here is the call graph for this function:

Field Documentation

$allowpercentage

bool ilNumericStyleValueInputGUI::$allowpercentage = true

protected

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

Referenced by getAllowPercentage().

$user

ilObjUser ilNumericStyleValueInputGUI::$user

protected

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

$value

string ilNumericStyleValueInputGUI::$value = ""

protected

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

Referenced by getValue().

---

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

• components/ILIAS/Style/Content/Characteristic/Inputs/class.ilNumericStyleValueInputGUI.php