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

Inheritance diagram for ilDclGenericMultiInputGUI:

Collaboration diagram for ilDclGenericMultiInputGUI:

Public Member Functions
	getLimit ()

	setLimit (int $limit)

	isAllowEmptyFields ()

	setAllowEmptyFields (bool $allow_empty_fields)

	__construct (string $a_title="", string $a_postvar="")
	Constructor. More...

	getHook (string $key)

	addHook (string $key, array $options)

	removeHook (string $key)

	addInput (ilFormPropertyGUI $input, array $options=[])

	isShowLabel ()

	setShowLabel (bool $show_label)

	getInputs ()
	Get Options. More...

	setMulti (bool $a_multi, bool $a_sortable=false, bool $a_addremove=true)

	setValue (array $value)
	Set Value. More...

	getValue ()
	Get Value. More...

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

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

	addCustomAttribute (string $key, string $value, bool $override=false)

	getCustomAttributes ()

	render (int $iterator_id=0, bool $clean_render=false)
	Render item. More...

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

	getTableFilterHTML ()
	Get HTML for table filter. More...

	getToolbarHTML ()
	Get HTML for toolbar. More...

	getSubItems ()

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

Data Fields
const	HOOK_IS_LINE_REMOVABLE = "hook_is_line_removable"

const	HOOK_IS_INPUT_DISABLED = "hook_is_disabled"

const	HOOK_BEFORE_INPUT_RENDER = "hook_before_render"

Protected Member Functions
	createInputPostVar (int $iterator_id, ilFormPropertyGUI $input)

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)

Protected Attributes
array	$cust_attr = []

array	$value = []

array	$inputs = []

array	$input_options = []

array	$hooks = []

array	$line_values = []

string	$template_dir = ''

array	$post_var_cache = []

bool	$show_label = false

int	$limit = 999999

bool	$allow_empty_fields = false

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

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

Definition at line 19 of file class.ilDclGenericMultiInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

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

References ILIAS\GlobalScreen\Provider\__construct(), setMulti(), and ilFormPropertyGUI\setType().

     {
         parent::__construct($a_title, $a_postvar);
         $this->setType("line_select");
         $this->setMulti(true);
     }

Here is the call graph for this function:

Member Function Documentation

◆ addCustomAttribute()

ilDclGenericMultiInputGUI::addCustomAttribute	(	string	$key,
		string	$value,
		bool	$override = `false`
	)

Definition at line 222 of file class.ilDclGenericMultiInputGUI.php.

References ILIAS\LTI\ToolProvider\$key, and $value.

Referenced by render().

                                                                                           : void
     {
         if (isset($this->cust_attr[$key]) && !$override) {
             $this->cust_attr[$key] .= ' ' . $value;
         } else {
             $this->cust_attr[$key] = $value;
         }
     }

Here is the caller graph for this function:

◆ addHook()

ilDclGenericMultiInputGUI::addHook	(	string	$key,
		array	$options
	)

Definition at line 79 of file class.ilDclGenericMultiInputGUI.php.

References ILIAS\LTI\ToolProvider\$key.

     {
         $this->hooks[$key] = $options;
     }

◆ addInput()

ilDclGenericMultiInputGUI::addInput	(	ilFormPropertyGUI	$input,
		array	$options = `[]`
	)

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

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

     {
         $input->setRequired(!$this->allow_empty_fields);
         $this->inputs[$input->getPostVar()] = $input;
         $this->input_options[$input->getPostVar()] = $options;
     }

Here is the call graph for this function:

◆ checkInput()

ilDclGenericMultiInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: boolean Input ok, true/false

Definition at line 186 of file class.ilDclGenericMultiInputGUI.php.

References ilFormPropertyGUI\$lng, $out, $valid, ilFormPropertyGUI\arrayArray(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), getValue(), ILIAS\Repository\lng(), ilCalendarUtil\parseIncomingDate(), ilFormPropertyGUI\setAlert(), setValue(), and ilUtil\stripSlashes().

                                 : bool
     {
         global $lng;
 
         $valid = true;
 
         $value = $this->arrayArray($this->getPostVar());
         // escape data
         $out_array = [];
         foreach ($value as $item_num => $item) {
             foreach ($this->inputs as $input_key => $input) {
                 if (isset($item[$input_key])) {
                     if ($input instanceof ilDateTimeInputGUI) {
                         $out = (is_string($item[$input_key])) ? ilUtil::stripSlashes($item[$input_key]) : $item[$input_key];
                         if (ilCalendarUtil::parseIncomingDate($out)) {
                             $out_array[$item_num][$input_key] = $out;
                         } else {
                             $valid = false;
                             $this->setAlert($this->lng->txt("form_msg_wrong_date"));
                             $out_array[$item_num][$input_key] = null;
                         }
                     }
                 }
             }
         }
 
         $this->setValue($out_array);
 
         if ($this->getRequired() && !trim(implode("", $this->getValue()))) {
             $this->setAlert($lng->txt("msg_input_is_required"));
             $valid = false;
         }
 
         return $valid;
     }

Here is the call graph for this function:

◆ createInputPostVar()

ilDclGenericMultiInputGUI::createInputPostVar	(	int	$iterator_id,
		ilFormPropertyGUI	$input
	)

protected

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

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

Referenced by render().

                                                                                      : string
     {
         if ($this->getMulti()) {
             return $this->getPostVar() . '[' . $iterator_id . '][' . $input->getPostVar() . ']';
         } else {
             return $this->getPostVar() . '[' . $input->getPostVar() . ']';
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCustomAttributes()

ilDclGenericMultiInputGUI::getCustomAttributes ( )

Definition at line 231 of file class.ilDclGenericMultiInputGUI.php.

References $cust_attr.

Referenced by render().

                                          : array
     {
         return $this->cust_attr;
     }

Here is the caller graph for this function:

◆ getHook()

ilDclGenericMultiInputGUI::getHook ( string $key )

Returns: string|bool

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

References ILIAS\LTI\ToolProvider\$key.

Referenced by render().

     {
         if (isset($this->hooks[$key])) {
             return $this->hooks[$key];
         }
 
         return false;
     }

Here is the caller graph for this function:

◆ getInputs()

ilDclGenericMultiInputGUI::getInputs ( )

Get Options.

Returns: array Options. Array ("value" => "option_text")

Definition at line 116 of file class.ilDclGenericMultiInputGUI.php.

References $inputs.

                                : array
     {
         return $this->inputs;
     }

◆ getLimit()

ilDclGenericMultiInputGUI::getLimit ( )

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

References $limit.

                               : int
     {
         return $this->limit;
     }

◆ getSubItems()

ilDclGenericMultiInputGUI::getSubItems ( )

Definition at line 390 of file class.ilDclGenericMultiInputGUI.php.

                                  : array
     {
         return [];
     }

◆ getTableFilterHTML()

ilDclGenericMultiInputGUI::getTableFilterHTML ( )

Get HTML for table filter.

Definition at line 373 of file class.ilDclGenericMultiInputGUI.php.

References render().

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

Here is the call graph for this function:

◆ getToolbarHTML()

ilDclGenericMultiInputGUI::getToolbarHTML ( )

Get HTML for toolbar.

Definition at line 383 of file class.ilDclGenericMultiInputGUI.php.

References render().

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

Here is the call graph for this function:

◆ getValue()

ilDclGenericMultiInputGUI::getValue ( )

Get Value.

Definition at line 159 of file class.ilDclGenericMultiInputGUI.php.

References ILIAS\LTI\ToolProvider\$key, and $out.

Referenced by checkInput(), and render().

                               : array
     {
         $out = [];
         foreach ($this->inputs as $key => $item) {
             $out[$key] = $item->getValue();
         }
 
         return $out;
     }

Here is the caller graph for this function:

◆ insert()

ilDclGenericMultiInputGUI::insert ( ilTemplate $a_tpl )

Insert property html.

Definition at line 336 of file class.ilDclGenericMultiInputGUI.php.

References $data, $i, $id, ilFormPropertyGUI\getFieldId(), ilFormPropertyGUI\getMulti(), ILIAS\Repository\lng(), ilTemplate\parseCurrentBlock(), render(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

                                              : void
     {
         $output = "";
 
         $output .= $this->render(0, true);
 
         if ($this->getMulti() && is_array($this->line_values) && count($this->line_values) > 0) {
             $counter = 0;
             foreach ($this->line_values as $i => $data) {
                 $object = $this;
                 $object->setValue($data);
                 $output .= $object->render($i);
                 $counter++;
             }
         } else {
             $output .= $this->render(1, true);
         }
 
         if ($this->getMulti()) {
             $output = '<div id="' . $this->getFieldId() . '" class="multi_line_input">' . $output . '</div>';
             $this->global_tpl->addJavaScript('Modules/DataCollection/js/generic_multi_line_input.js');
             $id = $this->getFieldId();
             $element_config = json_encode($this->input_options);
             $options = json_encode(['limit' => $this->limit,
                                         'sortable' => $this->multi_sortable,
                                         'locale' => $this->lng->getLangKey()]);
             $this->global_tpl->addOnLoadCode("il.DataCollection.genericMultiLineInit('$id',$element_config,$options);");
         }
 
         $a_tpl->setCurrentBlock("prop_generic");
         $a_tpl->setVariable("PROP_GENERIC", $output);
         $a_tpl->parseCurrentBlock();
     }

Here is the call graph for this function:

◆ isAllowEmptyFields()

ilDclGenericMultiInputGUI::isAllowEmptyFields ( )

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

References $allow_empty_fields.

                                         : bool
     {
         return $this->allow_empty_fields;
     }

◆ isShowLabel()

ilDclGenericMultiInputGUI::isShowLabel ( )

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

References $show_label.

Referenced by render().

                                  : bool
     {
         return $this->show_label;
     }

Here is the caller graph for this function:

◆ removeHook()

ilDclGenericMultiInputGUI::removeHook ( string $key )

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

                                            : bool
     {
         if (isset($this->hooks[$key])) {
             unset($this->hooks[$key]);
 
             return true;
         }
 
         return false;
     }

◆ render()

ilDclGenericMultiInputGUI::render	(	int	$iterator_id = `0`,
		bool	$clean_render = `false`
	)

Render item.

Exceptions

ilTemplateException

Definition at line 249 of file class.ilDclGenericMultiInputGUI.php.

References $inputs, ILIAS\LTI\ToolProvider\$key, $tpl, ilGlyphGUI\ADD, addCustomAttribute(), createInputPostVar(), ilGlyphGUI\DOWN, ilGlyphGUI\get(), getCustomAttributes(), ilFormPropertyGUI\getDisabled(), getHook(), ilFormPropertyGUI\getMulti(), getValue(), isShowLabel(), ilGlyphGUI\REMOVE, and ilGlyphGUI\UP.

Referenced by getTableFilterHTML(), getToolbarHTML(), and insert().

                                                                             : string
     {
         $tpl = new ilTemplate("tpl.prop_generic_multi_line.html", true, true, 'Modules/DataCollection');
 
         $class = 'multi_input_line';
 
         $this->addCustomAttribute('class', $class, true);
         foreach ($this->getCustomAttributes() as $key => $value) {
             $tpl->setCurrentBlock('cust_attr');
             $tpl->setVariable('CUSTOM_ATTR_KEY', $key);
             $tpl->setVariable('CUSTOM_ATTR_VALUE', $value);
             $tpl->parseCurrentBlock();
         }
 
         $inputs = $this->inputs;
 
         foreach ($inputs as $key => $input) {
             $input = clone $input;
             if (!method_exists($input, 'render')) {
                 throw new ilException(
                     "Method " . get_class($input)
                     . "::render() does not exists! You cannot use this input-type in ilMultiLineInputGUI"
                 );
             }
 
             $is_disabled_hook = $this->getHook(self::HOOK_IS_INPUT_DISABLED);
             if ($is_disabled_hook !== false && !$clean_render) {
                 $input->setDisabled($is_disabled_hook($this->getValue()));
             }
 
             if ($this->getDisabled()) {
                 $input->setDisabled(true);
             }
 
             if ($iterator_id == 0 && !isset($this->post_var_cache[$key])) {
                 $this->post_var_cache[$key] = $input->getPostVar();
             } else {
                 // Reset post var
                 $input->setPostVar($this->post_var_cache[$key]);
             }
 
             $post_var = $this->createInputPostVar($iterator_id, $input);
             $input->setPostVar($post_var);
 
             $before_render_hook = $this->getHook(self::HOOK_BEFORE_INPUT_RENDER);
             if ($before_render_hook !== false && !$clean_render) {
                 $input = $before_render_hook($this->getValue(), $key, $input);
             }
 
             //var_dump($input);
 
             if ($this->isShowLabel()) {
                 $tpl->setCurrentBlock('input_label');
                 $tpl->setVariable('LABEL', $input->getTitle());
             } else {
                 $tpl->setCurrentBlock('input');
             }
             $tpl->setVariable('CONTENT', $input->render());
             $tpl->parseCurrentBlock();
         }
 
         if ($this->getMulti() && !$this->getDisabled()) {
             $tpl->setVariable('IMAGE_MINUS', ilGlyphGUI::get(ilGlyphGUI::REMOVE));
 
             $show_remove = true;
             $is_removeable_hook = $this->getHook(self::HOOK_IS_LINE_REMOVABLE);
             if ($is_removeable_hook !== false && !$clean_render) {
                 $show_remove = $is_removeable_hook($this->getValue());
             }
 
             $image_minus = ($show_remove) ? ilGlyphGUI::get(ilGlyphGUI::REMOVE) : '<span class="glyphicon glyphicon-minus hide"></span>';
             $tpl->setCurrentBlock('multi_icons');
             $tpl->setVariable('IMAGE_PLUS', ilGlyphGUI::get(ilGlyphGUI::ADD));
             $tpl->setVariable('IMAGE_MINUS', $image_minus);
             if ($this->multi_sortable) {
                 $tpl->setVariable('IMAGE_UP', ilGlyphGUI::get(ilGlyphGUI::UP));
                 $tpl->setVariable('IMAGE_DOWN', ilGlyphGUI::get(ilGlyphGUI::DOWN));
             }
             $tpl->parseCurrentBlock();
         }
 
         return $tpl->get();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAllowEmptyFields()

ilDclGenericMultiInputGUI::setAllowEmptyFields ( bool $allow_empty_fields )

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

References $allow_empty_fields.

                                                                  : void
     {
         $this->allow_empty_fields = $allow_empty_fields;
     }

◆ setLimit()

ilDclGenericMultiInputGUI::setLimit ( int $limit )

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

References $limit.

                                         : void
     {
         $this->limit = $limit;
     }

◆ setMulti()

ilDclGenericMultiInputGUI::setMulti	(	bool	$a_multi,
		bool	$a_sortable = `false`,
		bool	$a_addremove = `true`
	)

Definition at line 121 of file class.ilDclGenericMultiInputGUI.php.

Referenced by __construct(), ilDclDateSelectionFieldRepresentation\buildOptionsInput(), and ilDclTextSelectionFieldRepresentation\buildOptionsInput().

      : void {
         $this->multi = $a_multi;
         $this->multi_sortable = $a_sortable;
     }

Here is the caller graph for this function:

◆ setShowLabel()

ilDclGenericMultiInputGUI::setShowLabel ( bool $show_label )

Definition at line 107 of file class.ilDclGenericMultiInputGUI.php.

References $show_label.

                                                   : void
     {
         $this->show_label = $show_label;
     }

◆ setValue()

ilDclGenericMultiInputGUI::setValue ( array $value )

Set Value.

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

References ILIAS\LTI\ToolProvider\$key, $value, IL_CAL_DATE, and ilCalendarUtil\parseIncomingDate().

Referenced by checkInput(), and setValueByArray().

                                           : void
     {
         $this->value = $value;
 
         foreach ($this->inputs as $key => $item) {
             if (array_key_exists($key, $value)) {
                 if ($item instanceof ilCheckboxInputGUI) {
                     $item->setChecked((bool) $value[$key]);
                 } else {
                     if ($item instanceof ilDateTimeInputGUI) {
                         if (ilCalendarUtil::parseIncomingDate($value[$key])) {
                             $item->setDate(new ilDate($value[$key], IL_CAL_DATE));
                         } else {
                             $item->setDate();
                         }
                     } else {
                         $item->setValue($value[$key]);
                     }
                 }
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setValueByArray()

ilDclGenericMultiInputGUI::setValueByArray ( array $a_values )

Set value by array.

Definition at line 172 of file class.ilDclGenericMultiInputGUI.php.

References $data, ilFormPropertyGUI\getMulti(), ilFormPropertyGUI\getPostVar(), and setValue().

                                                     : void
     {
         $data = $a_values[$this->getPostVar()] ?? [];
         if ($this->getMulti()) {
             $this->line_values = $data;
         } else {
             $this->setValue($data);
         }
     }