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

Inheritance diagram for ilNumericStyleValueInputGUI:

Collaboration diagram for ilNumericStyleValueInputGUI:

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

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

	getValue ()
	Get Value. More...

	setAllowPercentage ($a_allowpercentage)
	Set Allow Percentage. More...

	getAllowPercentage ()
	Get Allow Percentage. More...

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

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

	setValueByArray ($a_values)
	Set value by array. 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...

	stripSlashesAddSpaceFallback ($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...

Protected Attributes
	$user

	$value

	$allowpercentage = true

Protected Attributes inherited from ilFormPropertyGUI
	$ctrl

	$lng

	$type

	$title

	$postvar

	$info

	$alert

	$required = false

	$parentgui

	$parentform

	$hidden_title = ""

	$multi = false

	$multi_sortable = false

	$multi_addremove = true

	$multi_values

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

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 numeric style 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.ilNumericStyleValueInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

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

References $DIC, ilFormPropertyGUI\setType(), and 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 ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: boolean Input ok, true/false

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

References $_POST, ilFormPropertyGUI\$lng, ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilFormPropertyGUI\setAlert(), setValue(), and ilUtil\stripSlashes().

     {
         $lng = $this->lng;
         
         $num_value = $_POST[$this->getPostVar()]["num_value"] =
             trim(ilUtil::stripSlashes($_POST[$this->getPostVar()]["num_value"]));
         $num_unit = $_POST[$this->getPostVar()]["num_unit"] =
             trim(ilUtil::stripSlashes($_POST[$this->getPostVar()]["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 ( )

Get Allow Percentage.

Returns: boolean Allow Percentage

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

References $allowpercentage.

Referenced by insert().

     {
         return $this->allowpercentage;
     }

Here is the caller graph for this function:

◆ getValue()

ilNumericStyleValueInputGUI::getValue ( )

Get Value.

Returns: string Value

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

References $value.

Referenced by insert().

     {
         return $this->value;
     }

Here is the caller graph for this function:

◆ insert()

ilNumericStyleValueInputGUI::insert ( & $a_tpl )

Insert property html.

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

References $tpl, $value, ilObjStyleSheet\_getStyleParameterNumericUnits(), getAllowPercentage(), ilFormPropertyGUI\getPostVar(), and getValue().

     {
         $tpl = new ilTemplate("tpl.prop_style_numeric.html", true, true, "Services/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 ( $a_allowpercentage )

Set Allow Percentage.

Parameters

boolean $a_allowpercentage Allow Percentage

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

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

     {
         $this->allowpercentage = $a_allowpercentage;
     }

Here is the caller graph for this function:

◆ setValue()

ilNumericStyleValueInputGUI::setValue ( $a_value )

Set Value.

Parameters

string $a_value Value

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

Referenced by checkInput(), and setValueByArray().

     {
         $this->value = $a_value;
     }

Here is the caller graph for this function:

◆ setValueByArray()

ilNumericStyleValueInputGUI::setValueByArray ( $a_values )

Set value by array.

Parameters

array $a_values value array

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

References $ilUser, $user, ilFormPropertyGUI\getPostVar(), and setValue().

     {
         $ilUser = $this->user;
         
         $this->setValue($a_values[$this->getPostVar()]["num_value"] .
             $a_values[$this->getPostVar()]["num_unit"]);
     }