Class ilDclGenericMultiInputGUI. More...

Inheritance diagram for ilDclGenericMultiInputGUI:

Collaboration diagram for ilDclGenericMultiInputGUI:

Public Member Functions
	getLimit ()

	setLimit ($limit)
	set a limit of possible lines, 0 = no limit More...

	isAllowEmptyFields ()

	setAllowEmptyFields ($allow_empty_fields)

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

	getHook ($key)

	addHook ($key, $options)

	removeHook ($key)

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

	isShowLabel ()

	setShowLabel ($show_label)

	getInputs ()
	Get Options. More...

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

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

	getValue ()
	Get Value. More...

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

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

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

	getCustomAttributes ()

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

	insert (&$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 ($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...

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 ($iterator_id, ilFormPropertyGUI $input)

Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type. More...

	getMultiIconsHTML ()
	Get HTML for multiple value icons. More...

Protected Attributes
	$cust_attr = array()

	$value

	$inputs = array()

	$input_options = array()

	$hooks = array()

	$line_values = array()

	$template_dir = ''

	$post_var_cache = array()

	$show_label = false

	$limit = 0

	$allow_empty_fields = false

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

Detailed Description

Class ilDclGenericMultiInputGUI.

Author: Michael Herren mh@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Theodor Truffer tt@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

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

References 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	(	$key,
		$value,
		$override = `false`
	)

Parameters

	$key
	$value
bool \| false	$override

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

References $key, and $value.

Referenced by render().

     {
         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	(	$key,
		$options
	)

Parameters

array $options

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

References $key, and PHPMailer\PHPMailer\$options.

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

◆ addInput()

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

Parameters

	$input
array	$options

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

References $input, PHPMailer\PHPMailer\$options, 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 264 of file class.ilDclGenericMultiInputGUI.php.

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

     {
         global $lng;
 
         $valid = true;
 
         // escape data
         $out_array = array();
         foreach ($_POST[$this->getPostVar()] as $item_num => $item) {
             foreach ($this->inputs as $input_key => $input) {
                 if (isset($item[$input_key])) {
                     $out_array[$item_num][$input_key] = (is_string($item[$input_key])) ? ilUtil::stripSlashes($item[$input_key]) : $item[$input_key];
                 }
             }
         }
         $_POST[$this->getPostVar()] = $out_array;
 
         if ($this->getRequired() && !trim(implode("", $_POST[$this->getPostVar()]))) {
             $valid = false;
         }
 
         // validate
         foreach ($this->inputs as $input_key => $inputs) {
             foreach ($out_array as $subitem) {
                 $_POST[$inputs->getPostVar()] = $subitem[$inputs->getPostVar()];
                 if (!$inputs->checkInput()) {
                     $valid = false;
                 }
             }
         }
 
         if (!$valid) {
             $this->setAlert($lng->txt("msg_input_is_required"));
 
             return false;
         }
 
         return $valid;
     }

Here is the call graph for this function:

◆ createInputPostVar()

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

protected

Parameters

	$iterator_id
ilFormPropertyGUI	$input

Returns: string

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

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

Referenced by render().

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

Returns: array

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

References $cust_attr.

Referenced by render().

     {
         return (array) $this->cust_attr;
     }

Here is the caller graph for this function:

◆ getHook()

ilDclGenericMultiInputGUI::getHook ( $key )

Returns: string

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

References $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 187 of file class.ilDclGenericMultiInputGUI.php.

References $inputs.

     {
         return $this->inputs;
     }

◆ getLimit()

ilDclGenericMultiInputGUI::getLimit ( )

Returns: mixed

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

References $limit.

     {
         return $this->limit;
     }

◆ getSubItems()

ilDclGenericMultiInputGUI::getSubItems ( )

Parameters

bool | false $a_sortable

Returns: string

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

     {
         return array();
     }

◆ getTableFilterHTML()

ilDclGenericMultiInputGUI::getTableFilterHTML ( )

Get HTML for table filter.

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

References $html, and render().

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

Here is the call graph for this function:

◆ getToolbarHTML()

ilDclGenericMultiInputGUI::getToolbarHTML ( )

Get HTML for toolbar.

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

References $html, and render().

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

Here is the call graph for this function:

◆ getValue()

ilDclGenericMultiInputGUI::getValue ( )

Get Value.

Returns: string Value

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

References $key, and $out.

Referenced by render().

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

Here is the caller graph for this function:

◆ insert()

ilDclGenericMultiInputGUI::insert ( & $a_tpl )

Insert property html.

Returns: int Size

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

References $data, $DIC, $i, Sabre\VObject\$output, $tpl, ilFormPropertyGUI\getFieldId(), ilFormPropertyGUI\getMulti(), and render().

     {
         global $DIC;
         $tpl = $DIC['tpl'];
 
         $output = "";
         //              $tpl->addCss($this->getTemplateDir() . '/templates/css/multi_line_input.css');
 
         $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>';
             $tpl->addJavascript('Modules/DataCollection/js/generic_multi_line_input.js');
             $output .= '<script type="text/javascript">$("#' . $this->getFieldId() . '").multi_line_input('
                 . json_encode($this->input_options) . ', '
                 . json_encode(array('limit' => $this->limit, 'sortable' => $this->multi_sortable, 'locale' => $DIC->language()->getLangKey()))
                 . ')</script>';
         }
 
         $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 ( )

Returns: boolean

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

References $allow_empty_fields.

     {
         return $this->allow_empty_fields;
     }

◆ isShowLabel()

ilDclGenericMultiInputGUI::isShowLabel ( )

Returns: boolean

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

References $show_label.

Referenced by render().

     {
         return $this->show_label;
     }

Here is the caller graph for this function:

◆ removeHook()

ilDclGenericMultiInputGUI::removeHook ( $key )

Parameters

$key

Returns: bool

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

References $key.

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

◆ render()

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

Render item.

Parameters

int $iterator_id

Returns: string

Exceptions

ilException

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

References $input, $inputs, $key, $tpl, $value, 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().

     {
         $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());
                 $tpl->setVariable('CONTENT', $input->render());
                 $tpl->parseCurrentBlock();
             } 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 ( $allow_empty_fields )

Parameters

boolean $allow_empty_fields

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

References $allow_empty_fields.

     {
         $this->allow_empty_fields = $allow_empty_fields;
     }

◆ setLimit()

ilDclGenericMultiInputGUI::setLimit ( $limit )

set a limit of possible lines, 0 = no limit

Parameters

mixed $limit

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

References $limit.

     {
         $this->limit = $limit;
     }

◆ setMulti()

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

Parameters

bool $a_multi

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

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

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

Here is the caller graph for this function:

◆ setShowLabel()

ilDclGenericMultiInputGUI::setShowLabel ( $show_label )

Parameters

boolean $show_label

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

References $show_label.

     {
         $this->show_label = $show_label;
     }

◆ setValue()

ilDclGenericMultiInputGUI::setValue ( $a_value )

Set Value.

Parameters

string $a_value Value

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

References $key, and IL_CAL_DATE.

Referenced by setValueByArray().

     {
         foreach ($this->inputs as $key => $item) {
             if ($item instanceof ilCheckboxInputGUI) {
                 $item->setChecked((bool) $a_value[$key]);
             } else {
                 if ($item instanceof ilDateTimeInputGUI) {
                     $item->setDate(new ilDate($a_value[$key], IL_CAL_DATE));
                 } else {
                     if (method_exists($item, 'setValue')) {
                         $item->setValue($a_value[$key]);
                     }
                 }
             }
         }
         $this->value = $a_value;
     }

Here is the caller graph for this function:

◆ setValueByArray()

ilDclGenericMultiInputGUI::setValueByArray ( $a_values )

Set value by array.

Parameters

array $a_values value array

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

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

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