This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilCombinationInputGUI:

Collaboration diagram for ilCombinationInputGUI:

Public Member Functions
	__construct (string $a_title="", string $a_postvar="")

	addCombinationItem (string $id, ilFormPropertyGUI $item, $label="")

	getCombinationItem (string $id)

	removeCombinationItem (string $id)

	__call (string $method, array $param)

	serializeData ()

	unserializeData (string $a_data)

	setComparisonMode (int $mode)
	Set mode for comparison (extended validation) More...

	setValue (?array $a_value)

	getValue ()

	setValueByArray (array $a_values)

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

	insert (ilTemplate $a_tpl)

	render ()

	getTableFilterHTML ()
	Get input item HTML to be inserted into table filters. More...

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...

Public Member Functions inherited from ilTableFilterItem
	getTableFilterLabelFor ()
	Get label "for" attribute value. More...

Data Fields
const	COMPARISON_NONE = 0

const	COMPARISON_ASCENDING = 1

const	COMPARISON_DESCENDING = 2

Protected Attributes
array	$items = array()

array	$labels = []

int	$comparison_mode = self::COMPARISON_NONE

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
	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 file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning This class represents a number property in a property form.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 26 of file class.ilCombinationInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilCombinationInputGUI::__construct	(	string	$a_title = `""`,
		string	$a_postvar = `""`
	)

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ __call()

ilCombinationInputGUI::__call	(	string	$method,
		array	$param
	)

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

References $id.

      : array {
         $result = array();
         foreach ($this->items as $id => $obj) {
             if (method_exists($obj, $method)) {
                 $result[$id] = call_user_func_array(array($obj, $method), $param);
             }
         }
         return $result;
     }

◆ addCombinationItem()

ilCombinationInputGUI::addCombinationItem	(	string	$id,
		ilFormPropertyGUI	$item,
			$label = `""`
	)

Definition at line 46 of file class.ilCombinationInputGUI.php.

References $id.

      : void {
         $this->items[$id] = $item;
         if ($label) {
             $this->labels[$id] = $label;
         }
     }

◆ checkInput()

ilCombinationInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Definition at line 202 of file class.ilCombinationInputGUI.php.

References ilSubEnabledFormPropertyGUI\checkSubItemsInput().

                                 : bool
     {
         if (sizeof($this->items)) {
             foreach ($this->items as $obj) {
                 if (!$obj->checkInput()) {
                     return false;
                 }
             }
 
             if ($this->comparison_mode !== self::COMPARISON_NONE) {
                 $prev = null;
                 foreach ($this->items as $obj) {
                     $value = $obj->getPostValueForComparison();
                     if ($value != "") {
                         if ($prev !== null) {
                             if ($this->comparison_mode == self::COMPARISON_ASCENDING) {
                                 if ($value < $prev) {
                                     return false;
                                 }
                             } else {
                                 if ($value > $prev) {
                                     return false;
                                 }
                             }
                         }
                         $prev = $value;
                     }
                 }
             }
         }
 
         return $this->checkSubItemsInput();
     }

Here is the call graph for this function:

◆ getCombinationItem()

ilCombinationInputGUI::getCombinationItem ( string $id )

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

References $id.

                                                   : ?ilFormPropertyGUI
     {
         if (isset($this->items[$id])) {
             return $this->items[$id];
         }
         return null;
     }

◆ getTableFilterHTML()

ilCombinationInputGUI::getTableFilterHTML ( )

Get input item HTML to be inserted into table filters.

Implements ilTableFilterItem.

Definition at line 267 of file class.ilCombinationInputGUI.php.

References render().

                                         : string
     {
         $html = $this->render();
         return $html;
     }

Here is the call graph for this function:

◆ getValue()

ilCombinationInputGUI::getValue ( )

Definition at line 173 of file class.ilCombinationInputGUI.php.

References $id.

                               : ?array
     {
         $result = array();
         foreach ($this->items as $id => $obj) {
             if (method_exists($obj, "getValue")) {
                 $result[$id] = $obj->getValue();
             }
             // datetime
             elseif (method_exists($obj, "setDate")) {
                 $result[$id] = $obj->getDate();
             }
             // duration
             elseif (method_exists($obj, 'getValueAsArray')) {
                 $result[$id] = $obj->getValueAsArray();
             }
         }
         return $result;
     }

◆ insert()

ilCombinationInputGUI::insert ( ilTemplate $a_tpl )

Definition at line 236 of file class.ilCombinationInputGUI.php.

References ilTemplate\parseCurrentBlock(), render(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

                                              : void
     {
         $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:

◆ removeCombinationItem()

ilCombinationInputGUI::removeCombinationItem ( string $id )

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

                                                      : void
     {
         if (isset($this->items[$id])) {
             unset($this->items[$id]);
         }
     }

◆ render()

ilCombinationInputGUI::render ( )

Definition at line 245 of file class.ilCombinationInputGUI.php.

References $id, and $tpl.

Referenced by getTableFilterHTML(), and insert().

                             : string
     {
         $tpl = new ilTemplate("tpl.prop_combination.html", true, true, "Services/Form");
 
         if (sizeof($this->items)) {
             foreach ($this->items as $id => $obj) {
                 // label
                 if (isset($this->labels[$id])) {
                     $tpl->setCurrentBlock("prop_combination_label");
                     $tpl->setVariable("LABEL", $this->labels[$id]);
                     $tpl->parseCurrentBlock();
                 }
 
                 $tpl->setCurrentBlock("prop_combination");
                 $tpl->setVariable("FIELD", $obj->render());
                 $tpl->parseCurrentBlock();
             }
         }
 
         return $tpl->get();
     }

Here is the caller graph for this function:

◆ serializeData()

ilCombinationInputGUI::serializeData ( )

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

References $id.

                                    : string
     {
         $result = array();
         foreach ($this->items as $id => $obj) {
             $result[$id] = $obj->serializeData();
         }
         return serialize($result);
     }

◆ setComparisonMode()

ilCombinationInputGUI::setComparisonMode ( int $mode )

Set mode for comparison (extended validation)

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

                                                 : bool
     {
         if (in_array($mode, array(self::COMPARISON_ASCENDING, self::COMPARISON_DESCENDING))) {
             foreach ($this->items as $obj) {
                 if (!method_exists($obj, "getPostValueForComparison")) {
                     return false;
                 }
             }
             $this->comparison_mode = $mode;
             return true;
         }
         return false;
     }

◆ setValue()

ilCombinationInputGUI::setValue ( ?array $a_value )

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

References $id.

Referenced by unserializeData().

                                              : void
     {
         if (is_array($a_value)) {
             foreach ($a_value as $id => $value) {
                 if (isset($this->items[$id])) {
                     if (method_exists($this->items[$id], "setValue")) {
                         // BT 35708: numeric inputs in table filters do not take floats as values
                         $value = is_float($value) ? (string) $value : $value;
                         $this->items[$id]->setValue($value);
                     }
                     // datetime
                     elseif (method_exists($this->items[$id], "setDate")) {
                         $this->items[$id]->setDate($value);
                     }
                     // duration
                     elseif (method_exists($this->items[$id], "setMonths")) {
                         $this->items[$id]->setMonths((int) ($value['MM'] ?? 0));
                         $this->items[$id]->setDays((int) ($value['dd'] ?? 0));
                         $this->items[$id]->setHours((int) ($value['hh'] ?? 0));
                         $this->items[$id]->setMinutes((int) ($value['mm'] ?? 0));
                         $this->items[$id]->setSeconds((int) ($value['ss'] ?? 0));
                     }
                 }
             }
         } elseif ($a_value === null) {
             foreach ($this->items as $item) {
                 if (method_exists($item, "setValue")) {
                     $item->setValue(null);
                 }
                 // datetime
                 elseif (method_exists($item, "setDate")) {
                     $item->setDate();
                 }
                 // duration
                 elseif (method_exists($item, "setMonths")) {
                     $item->setMonths(0);
                     $item->setDays(0);
                     $item->setHours(0);
                     $item->setMinutes(0);
                     $item->setSeconds(0);
                 }
             }
         }
     }

Here is the caller graph for this function:

◆ setValueByArray()

ilCombinationInputGUI::setValueByArray ( array $a_values )

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

                                                     : void
     {
         foreach ($this->items as $obj) {
             $obj->setValueByArray($a_values);
         }
     }

◆ unserializeData()

ilCombinationInputGUI::unserializeData ( string $a_data )

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

References $data, $id, and setValue().

                                                    : void
     {
         $data = unserialize($a_data);
 
         if ($data) {
             foreach ($this->items as $id => $obj) {
                 $obj->unserializeData($data[$id]);
             }
         } else {
             foreach ($this->items as $id => $obj) {
                 if (method_exists($obj, "setValue")) {
                     $this->setValue(null);
                 }
             }
         }
     }