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 ($valueArray)

	setUseUnits ($a_value)
	Set use units. More...

	useUnits ()
	Get use units. More...

	setTop ($a_value)
	Set Top. More...

	getTop ()
	Get Top. More...

	setBottom ($a_value)
	Set Bottom. More...

	getBottom ()
	Get Bottom. More...

	setLeft ($a_value)
	Set Left. More...

	getLeft ()
	Get Left. More...

	setRight ($a_value)
	Set Right. More...

	getRight ()
	Get Right. More...

	setSize ($a_size)
	Set Size. More...

	setValueByArray ($a_values)
	Set value by array. More...

	getSize ()
	Get Size. More...

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

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

Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem ($a_item)
	Add Subitem. More...

	getSubItems ()
	Get Subitems. More...

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

	checkSubItemsInput ()
	Check SubItems. More...

	getSubForm ()
	Get sub form html. More...

	getItemByPostVar ($a_post_var)
	Get item by post var. 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
	$lng

	$top

	$left

	$right

	$bottom

	$size

	$useUnits

Protected Attributes inherited from ilSubEnabledFormPropertyGUI
	$sub_items = array()

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 text 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.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 51 of file class.ilCSSRectInputGUI.php.

References $DIC, size, 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 ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: boolean Input ok, true/false

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

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

     {
         $lng = $this->lng;
         
         $_POST[$this->getPostVar() . '_top'] = ilUtil::stripSlashes($_POST[$this->getPostVar()]['top']);
         $_POST[$this->getPostVar() . '_right'] = ilUtil::stripSlashes($_POST[$this->getPostVar()]['right']);
         $_POST[$this->getPostVar() . '_bottom'] = ilUtil::stripSlashes($_POST[$this->getPostVar()]['bottom']);
         $_POST[$this->getPostVar() . '_left'] = ilUtil::stripSlashes($_POST[$this->getPostVar()]['left']);
 
         if (
             $this->getRequired() &&
             (
                 (trim($_POST[$this->getPostVar() . '_top'] == ""))
                 || (trim($_POST[$this->getPostVar() . '_bottom']) == "")
                 || (trim($_POST[$this->getPostVar() . '_left']) == "")
                 || (trim($_POST[$this->getPostVar() . '_right']) == "")
             )
         ) {
             $this->setAlert($lng->txt("msg_input_is_required"));
             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', $_POST[$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', $_POST[$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', $_POST[$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', $_POST[$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 ( )

Get Bottom.

Returns: string Bottom

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

References $bottom.

Referenced by insert().

     {
         return $this->bottom;
     }

Here is the caller graph for this function:

◆ getLeft()

ilCSSRectInputGUI::getLeft ( )

Get Left.

Returns: string Left

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

References $left.

Referenced by insert().

     {
         return $this->left;
     }

Here is the caller graph for this function:

◆ getRight()

ilCSSRectInputGUI::getRight ( )

Get Right.

Returns: string Right

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

References $right.

Referenced by insert().

     {
         return $this->right;
     }

Here is the caller graph for this function:

◆ getSize()

ilCSSRectInputGUI::getSize ( )

Get Size.

Returns: int Size

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

References $size.

Referenced by insert().

     {
         return $this->size;
     }

Here is the caller graph for this function:

◆ getTop()

ilCSSRectInputGUI::getTop ( )

Get Top.

Returns: string Top

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

References $top.

Referenced by insert().

     {
         return $this->top;
     }

Here is the caller graph for this function:

◆ insert()

ilCSSRectInputGUI::insert ( $a_tpl )

Insert property html.

Returns: int Size

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

References $lng, getBottom(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), getLeft(), ilFormPropertyGUI\getPostVar(), getRight(), getSize(), getTop(), and ilUtil\prepareFormOutput().

     {
         $lng = $this->lng;
         
         if (strlen($this->getTop())) {
             $a_tpl->setCurrentBlock("cssrect_value_top");
             $a_tpl->setVariable("CSSRECT_VALUE", ilUtil::prepareFormOutput($this->getTop()));
             $a_tpl->parseCurrentBlock();
         }
         if (strlen($this->getBottom())) {
             $a_tpl->setCurrentBlock("cssrect_value_bottom");
             $a_tpl->setVariable("CSSRECT_VALUE", ilUtil::prepareFormOutput($this->getBottom()));
             $a_tpl->parseCurrentBlock();
         }
         if (strlen($this->getLeft())) {
             $a_tpl->setCurrentBlock("cssrect_value_left");
             $a_tpl->setVariable("CSSRECT_VALUE", ilUtil::prepareFormOutput($this->getLeft()));
             $a_tpl->parseCurrentBlock();
         }
         if (strlen($this->getRight())) {
             $a_tpl->setCurrentBlock("cssrect_value_right");
             $a_tpl->setVariable("CSSRECT_VALUE", ilUtil::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 ( $a_value )

Set Bottom.

Parameters

string $a_value Bottom

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

     {
         $this->bottom = $a_value;
     }

◆ setLeft()

ilCSSRectInputGUI::setLeft ( $a_value )

Set Left.

Parameters

string $a_value Left

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

References left.

     {
         $this->left = $a_value;
     }

◆ setRight()

ilCSSRectInputGUI::setRight ( $a_value )

Set Right.

Parameters

string $a_value Right

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

     {
         $this->right = $a_value;
     }

◆ setSize()

ilCSSRectInputGUI::setSize ( $a_size )

Set Size.

Parameters

int $a_size Size

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

References size.

     {
         $this->size = $a_size;
     }

◆ setTop()

ilCSSRectInputGUI::setTop ( $a_value )

Set Top.

Parameters

string $a_value Top

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

     {
         $this->top = $a_value;
     }

◆ setUseUnits()

ilCSSRectInputGUI::setUseUnits ( $a_value )

Set use units.

Parameters

boolean $a_value Use units

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

References useUnits().

     {
         $this->useUnits = $a_value;
     }

Here is the call graph for this function:

◆ setValue()

ilCSSRectInputGUI::setValue ( $valueArray )

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

References left.

Referenced by setValueByArray().

     {
         $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 ( $a_values )

Set value by array.

Parameters

array $a_values value array

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

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

     {
         $postVar = $this->getPostVar();
 
         $values = array(
             'top' => $a_values[$postVar . '_top'],
             'bottom' => $a_values[$postVar . '_bottom'],
             'right' => $a_values[$postVar . '_right'],
             'left' => $a_values[$postVar . '_left'],
         );
 
         $this->setValue($values);
     }

Here is the call graph for this function:

◆ useUnits()

ilCSSRectInputGUI::useUnits ( )

Get use units.

Returns: boolean use units

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

References $useUnits.

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

     {
         return $this->useUnits;
     }

Here is the caller graph for this function:

Field Documentation

◆ $bottom

ilCSSRectInputGUI::$bottom

protected

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

Referenced by getBottom().

◆ $left

ilCSSRectInputGUI::$left

protected

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

Referenced by getLeft().

◆ $lng

ilCSSRectInputGUI::$lng

protected

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

Referenced by checkInput(), and insert().

◆ $right

ilCSSRectInputGUI::$right

protected

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

Referenced by getRight().

◆ $size

ilCSSRectInputGUI::$size

protected

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

Referenced by getSize().

◆ $top

ilCSSRectInputGUI::$top

protected

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

Referenced by getTop().

◆ $useUnits

ilCSSRectInputGUI::$useUnits

protected

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

Referenced by useUnits().

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

Services/Form/classes/class.ilCSSRectInputGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ getBottom()

◆ getLeft()

◆ getRight()

◆ getSize()

◆ getTop()

◆ insert()

◆ setBottom()

◆ setLeft()

◆ setRight()

◆ setSize()

◆ setTop()

◆ setUseUnits()

◆ setValue()

◆ setValueByArray()

◆ useUnits()

Field Documentation

◆ $bottom

◆ $left

◆ $lng

◆ $right

◆ $size

◆ $top

◆ $useUnits