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

Inheritance diagram for ilCSSRectInputGUI:

Collaboration diagram for ilCSSRectInputGUI:

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

	setValue (array $valueArray)

	setUseUnits (bool $a_value)

	useUnits ()

	setTop (string $a_value)

	getTop ()

	setBottom (string $a_value)

	getBottom ()

	setLeft (string $a_value)

	getLeft ()

	setRight (string $a_value)

	getRight ()

	setSize (int $a_size)

	setValueByArray (array $a_values)

	getSize ()

	checkInput ()

	getInput ()

	insert (ilTemplate $a_tpl)

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)

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
string	$top = ""

string	$left = ""

string	$right = ""

string	$bottom = ""

int	$size = 0

bool	$useUnits = 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
	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 text property in a property form.

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

Deprecated:: 12 This component will be removed with ILIAS 12

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilCSSRectInputGUI::checkInput ( )

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

References ilFormPropertyGUI\$lng, ilSubEnabledFormPropertyGUI\checkSubItemsInput(), getInput(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilFormPropertyGUI\setAlert(), ilLanguage\txt(), and useUnits().

                                 : bool
     {
         $lng = $this->lng;
 
         $val = $this->getInput();
         if (
             $this->getRequired() &&
             (
                 ($val[$this->getPostVar() . '_top'] == "")
                 || ($val[$this->getPostVar() . '_bottom'] == "")
                 || ($val[$this->getPostVar() . '_left'] == "")
                 || ($val[$this->getPostVar() . '_right'] == "")
             )
         ) {
             $this->setAlert($lng->txt("msg_input_is_required"));
             return false;
         }
 
         foreach (['top', 'right', 'bottom', 'left'] as $side) {
             $value = $val[$this->getPostVar() . '_' . $side];
 
             if (($this->getRequired() || $value !== "") && !preg_match('/^(([1-9]+|([1-9]+[0]*[\.,]{0,1}[\d]+))|(0[\.,](0*[1-9]+[\d]*))|0).*?$/si', $value)) {
                 $this->setAlert($lng->txt('msg_invalid_value_css_rect_input'));
                 return false;
             }
         }
 
         if ($this->useUnits()) {
             if ((!preg_match('/^(([1-9]+|([1-9]+[0]*[\.,]{0,1}[\d]+))|(0[\.,](0*[1-9]+[\d]*))|0)(cm|mm|in|pt|pc|px|em)$/is', $val[$this->getPostVar() . '_top'])) ||
                 (!preg_match('/^(([1-9]+|([1-9]+[0]*[\.,]{0,1}[\d]+))|(0[\.,](0*[1-9]+[\d]*))|0)(cm|mm|in|pt|pc|px|em)$/is', $val[$this->getPostVar() . '_right'])) ||
                 (!preg_match('/^(([1-9]+|([1-9]+[0]*[\.,]{0,1}[\d]+))|(0[\.,](0*[1-9]+[\d]*))|0)(cm|mm|in|pt|pc|px|em)$/is', $val[$this->getPostVar() . '_bottom'])) ||
                 (!preg_match('/^(([1-9]+|([1-9]+[0]*[\.,]{0,1}[\d]+))|(0[\.,](0*[1-9]+[\d]*))|0)(cm|mm|in|pt|pc|px|em)$/is', $val[$this->getPostVar() . '_left']))) {
                 $this->setAlert($lng->txt("msg_unit_is_required"));
                 return false;
             }
         }
         return $this->checkSubItemsInput();
     }

Here is the call graph for this function:

◆ getBottom()

ilCSSRectInputGUI::getBottom ( )

Definition at line 85 of file class.ilCSSRectInputGUI.php.

References $bottom.

Referenced by insert().

                                : string
     {
         return $this->bottom;
     }

Here is the caller graph for this function:

◆ getInput()

ilCSSRectInputGUI::getInput ( )

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

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

Referenced by checkInput().

                               : array
     {
         $val = $this->strArray($this->getPostVar());
         $ret[$this->getPostVar() . '_top'] = trim($val['top']);
         $ret[$this->getPostVar() . '_right'] = trim($val['right']);
         $ret[$this->getPostVar() . '_bottom'] = trim($val['bottom']);
         $ret[$this->getPostVar() . '_left'] = trim($val['left']);
         return $ret;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLeft()

ilCSSRectInputGUI::getLeft ( )

Definition at line 95 of file class.ilCSSRectInputGUI.php.

References $left.

Referenced by insert().

                              : string
     {
         return $this->left;
     }

Here is the caller graph for this function:

◆ getRight()

ilCSSRectInputGUI::getRight ( )

Definition at line 105 of file class.ilCSSRectInputGUI.php.

References $right.

Referenced by insert().

                               : string
     {
         return $this->right;
     }

Here is the caller graph for this function:

◆ getSize()

ilCSSRectInputGUI::getSize ( )

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

References $size.

Referenced by insert().

                              : int
     {
         return $this->size;
     }

Here is the caller graph for this function:

◆ getTop()

ilCSSRectInputGUI::getTop ( )

Definition at line 75 of file class.ilCSSRectInputGUI.php.

References $top.

Referenced by insert().

                             : string
     {
         return $this->top;
     }

Here is the caller graph for this function:

◆ insert()

ilCSSRectInputGUI::insert ( ilTemplate $a_tpl )

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

References ilFormPropertyGUI\$lng, getBottom(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), getLeft(), ilFormPropertyGUI\getPostVar(), getRight(), getSize(), getTop(), ilTemplate\parseCurrentBlock(), ilLegacyFormElementsUtil\prepareFormOutput(), ilTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), and ilLanguage\txt().

                                              : void
     {
         $lng = $this->lng;
 
         if (strlen($this->getTop())) {
             $a_tpl->setCurrentBlock("cssrect_value_top");
             $a_tpl->setVariable("CSSRECT_VALUE", ilLegacyFormElementsUtil::prepareFormOutput($this->getTop()));
             $a_tpl->parseCurrentBlock();
         }
         if (strlen($this->getBottom())) {
             $a_tpl->setCurrentBlock("cssrect_value_bottom");
             $a_tpl->setVariable("CSSRECT_VALUE", ilLegacyFormElementsUtil::prepareFormOutput($this->getBottom()));
             $a_tpl->parseCurrentBlock();
         }
         if (strlen($this->getLeft())) {
             $a_tpl->setCurrentBlock("cssrect_value_left");
             $a_tpl->setVariable("CSSRECT_VALUE", ilLegacyFormElementsUtil::prepareFormOutput($this->getLeft()));
             $a_tpl->parseCurrentBlock();
         }
         if (strlen($this->getRight())) {
             $a_tpl->setCurrentBlock("cssrect_value_right");
             $a_tpl->setVariable("CSSRECT_VALUE", ilLegacyFormElementsUtil::prepareFormOutput($this->getRight()));
             $a_tpl->parseCurrentBlock();
         }
         $a_tpl->setCurrentBlock("cssrect");
         $a_tpl->setVariable("ID", $this->getFieldId());
         $a_tpl->setVariable("SIZE", $this->getSize());
         $a_tpl->setVariable("POST_VAR", $this->getPostVar());
         $a_tpl->setVariable("TEXT_TOP", $lng->txt("pos_top"));
         $a_tpl->setVariable("TEXT_RIGHT", $lng->txt("pos_right"));
         $a_tpl->setVariable("TEXT_BOTTOM", $lng->txt("pos_bottom"));
         $a_tpl->setVariable("TEXT_LEFT", $lng->txt("pos_left"));
         if ($this->getDisabled()) {
             $a_tpl->setVariable(
                 "DISABLED",
                 " disabled=\"disabled\""
             );
         }
         $a_tpl->parseCurrentBlock();
     }

Here is the call graph for this function:

◆ setBottom()

ilCSSRectInputGUI::setBottom ( string $a_value )

Definition at line 80 of file class.ilCSSRectInputGUI.php.

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

◆ setLeft()

ilCSSRectInputGUI::setLeft ( string $a_value )

Definition at line 90 of file class.ilCSSRectInputGUI.php.

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

◆ setRight()

ilCSSRectInputGUI::setRight ( string $a_value )

Definition at line 100 of file class.ilCSSRectInputGUI.php.

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

◆ setSize()

ilCSSRectInputGUI::setSize ( int $a_size )

Definition at line 110 of file class.ilCSSRectInputGUI.php.

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

◆ setTop()

ilCSSRectInputGUI::setTop ( string $a_value )

Definition at line 70 of file class.ilCSSRectInputGUI.php.

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

◆ setUseUnits()

ilCSSRectInputGUI::setUseUnits ( bool $a_value )

Definition at line 60 of file class.ilCSSRectInputGUI.php.

References useUnits().

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

Here is the call graph for this function:

◆ setValue()

ilCSSRectInputGUI::setValue ( array $valueArray )

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

Referenced by setValueByArray().

                                                : void
     {
         $this->top = $valueArray['top'];
         $this->left = $valueArray['left'];
         $this->right = $valueArray['right'];
         $this->bottom = $valueArray['bottom'];
     }

Here is the caller graph for this function:

◆ setValueByArray()

ilCSSRectInputGUI::setValueByArray ( array $a_values )

Definition at line 115 of file class.ilCSSRectInputGUI.php.

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

                                                     : void
     {
         $postVar = $this->getPostVar();
 
         $positions = ['top', 'left', 'right', 'bottom'];
         $values = [
             'top' => '',
             'bottom' => '',
             'right' => '',
             'left' => '',
         ];
 
         foreach ($positions as $position) {
             if (isset($a_values[$postVar . '_' . $position])) {
                 $values[$position] = $a_values[$postVar . '_' . $position];
             } elseif (isset($a_values[$postVar][$position])) {
                 $values[$position] = $a_values[$postVar][$position];
             }
         }
 
         $this->setValue($values);
     }

Here is the call graph for this function:

◆ useUnits()

ilCSSRectInputGUI::useUnits ( )

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

References $useUnits.

Referenced by __construct(), checkInput(), and setUseUnits().

                               : bool
     {
         return $this->useUnits;
     }

Here is the caller graph for this function:

Field Documentation

◆ $bottom

string ilCSSRectInputGUI::$bottom = ""

protected

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

Referenced by getBottom().

◆ $left

string ilCSSRectInputGUI::$left = ""

protected

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

Referenced by getLeft().

◆ $right

string ilCSSRectInputGUI::$right = ""

protected

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

Referenced by getRight().

◆ $size

int ilCSSRectInputGUI::$size = 0

protected

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

Referenced by getSize().

◆ $top

string ilCSSRectInputGUI::$top = ""

protected

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

Referenced by getTop().

◆ $useUnits

bool ilCSSRectInputGUI::$useUnits = false

protected

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

Referenced by useUnits().

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

components/ILIAS/Form/classes/class.ilCSSRectInputGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ getBottom()

◆ getInput()

◆ getLeft()

◆ getRight()

◆ getSize()

◆ getTop()

◆ insert()

◆ setBottom()

◆ setLeft()

◆ setRight()

◆ setSize()

◆ setTop()

◆ setUseUnits()

◆ setValue()

◆ setValueByArray()

◆ useUnits()

Field Documentation

◆ $bottom

◆ $left

◆ $right

◆ $size

◆ $top

◆ $useUnits