Class ilOrgUnitMultiLineInputGUI. More...

Inheritance diagram for ilOrgUnitMultiLineInputGUI:

Collaboration diagram for ilOrgUnitMultiLineInputGUI:

Public Member Functions
	__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=array())

	getTemplateDir ()

	setTemplateDir (string $template_dir)

	isShowLabel ()

	setShowLabel (bool $show_label)

	getInputs ()

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

	setValue (string $a_value)

	getValue ()

	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)

	initCSSandJS ()

	insert (ilTemplate $a_tpl)

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

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

	isPositionMovable ()

	setPositionMovable (bool $position_movable)

	isShowLabelOnce ()

	setShowLabelOnce (bool $show_label_once)

	isShowInfo ()

	setShowInfo (bool $show_info)

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 Attributes
array	$cust_attr = array()

	$value

array	$inputs = array()

array	$input_options = array()

array	$hooks = array()

array	$line_values = array()

string	$template_dir = ''

array	$post_var_cache = array()

bool	$show_label = false

bool	$show_label_once = false

array	$hidden_inputs = array()

bool	$position_movable = false

int	$counter = 0

bool	$show_info = 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

Private Member Functions
	createInputPostVar (string $iterator_id, \ilFormPropertyGUI $input)

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

Class ilOrgUnitMultiLineInputGUI.

Author: Michael Herren mh@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

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

References ILIAS\MetaData\Repository\Validation\Data\__construct(), initCSSandJS(), setMulti(), and ilFormPropertyGUI\setType().

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

Here is the call graph for this function:

Member Function Documentation

◆ addCustomAttribute()

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

Definition at line 190 of file class.ilOrgUnitMultiLineInputGUI.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()

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

Definition at line 69 of file class.ilOrgUnitMultiLineInputGUI.php.

References ILIAS\LTI\ToolProvider\$key.

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

◆ addInput()

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

Definition at line 81 of file class.ilOrgUnitMultiLineInputGUI.php.

References ilFormPropertyGUI\getPostVar().

                                                                                  : void
     {
         $this->inputs[$input->getPostVar()] = $input;
         $this->input_options[$input->getPostVar()] = $options;
         $this->counter++;
     }

Here is the call graph for this function:

◆ checkInput()

ilOrgUnitMultiLineInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: bool Input ok, true/false

Definition at line 158 of file class.ilOrgUnitMultiLineInputGUI.php.

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

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

ilOrgUnitMultiLineInputGUI::createInputPostVar	(	string	$iterator_id,
		\ilFormPropertyGUI	$input
	)

private

Definition at line 204 of file class.ilOrgUnitMultiLineInputGUI.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()

ilOrgUnitMultiLineInputGUI::getCustomAttributes ( )

Definition at line 199 of file class.ilOrgUnitMultiLineInputGUI.php.

References $cust_attr.

Referenced by render().

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

Here is the caller graph for this function:

◆ getHook()

ilOrgUnitMultiLineInputGUI::getHook ( string $key )

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

References ILIAS\LTI\ToolProvider\$key.

Referenced by render().

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

Here is the caller graph for this function:

◆ getInputs()

ilOrgUnitMultiLineInputGUI::getInputs ( )

Definition at line 108 of file class.ilOrgUnitMultiLineInputGUI.php.

References $inputs.

                                : array
     {
         return $this->inputs;
     }

◆ getTableFilterHTML()

ilOrgUnitMultiLineInputGUI::getTableFilterHTML ( )

Get HTML for table filter.

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

References render().

     {
         return $this->render();
     }

Here is the call graph for this function:

◆ getTemplateDir()

ilOrgUnitMultiLineInputGUI::getTemplateDir ( )

Definition at line 88 of file class.ilOrgUnitMultiLineInputGUI.php.

References $template_dir.

                                     : string
     {
         return $this->template_dir;
     }

◆ getToolbarHTML()

ilOrgUnitMultiLineInputGUI::getToolbarHTML ( )

Get HTML for toolbar.

Definition at line 381 of file class.ilOrgUnitMultiLineInputGUI.php.

References render().

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

Here is the call graph for this function:

◆ getValue()

ilOrgUnitMultiLineInputGUI::getValue ( )

Definition at line 130 of file class.ilOrgUnitMultiLineInputGUI.php.

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

Referenced by render().

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

Here is the caller graph for this function:

◆ initCSSandJS()

ilOrgUnitMultiLineInputGUI::initCSSandJS ( )

Definition at line 339 of file class.ilOrgUnitMultiLineInputGUI.php.

Referenced by __construct().

                                   : void
     {
         global $tpl;
         $tpl->addJavascript('./Modules/OrgUnit/templates/default/multi_line_input.js');
     }

Here is the caller graph for this function:

◆ insert()

ilOrgUnitMultiLineInputGUI::insert ( ilTemplate $a_tpl )

Definition at line 345 of file class.ilOrgUnitMultiLineInputGUI.php.

References $data, ilFormPropertyGUI\getFieldId(), ilFormPropertyGUI\getMulti(), ilTemplate\parseCurrentBlock(), render(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

                                              : int
     {
         $output = "";
 
         $output .= $this->render(0, true);
         if ($this->getMulti() && is_array($this->line_values) && count($this->line_values) > 0) {
             foreach ($this->line_values as $run => $data) {
                 $object = $this;
                 $object->setValue($data);
                 $output .= $object->render($run);
             }
         } else {
             $output .= $this->render(0, true);
         }
         if ($this->getMulti()) {
             $output = '<div id="' . $this->getFieldId() . '" class="multi_line_input">' . $output
                 . '</div>';
             $output .= '<script type="text/javascript">$("#' . $this->getFieldId()
                 . '").multi_line_input(' . json_encode($this->input_options) . ')</script>';
         }
         $a_tpl->setCurrentBlock("prop_generic");
         $a_tpl->setVariable("PROP_GENERIC", $output);
         $a_tpl->parseCurrentBlock();
     }

Here is the call graph for this function:

◆ isPositionMovable()

ilOrgUnitMultiLineInputGUI::isPositionMovable ( )

Definition at line 386 of file class.ilOrgUnitMultiLineInputGUI.php.

References $position_movable.

Referenced by render().

                                        : bool
     {
         return $this->position_movable;
     }

Here is the caller graph for this function:

◆ isShowInfo()

ilOrgUnitMultiLineInputGUI::isShowInfo ( )

Definition at line 407 of file class.ilOrgUnitMultiLineInputGUI.php.

References $show_info.

Referenced by render().

                                 : bool
     {
         return $this->show_info;
     }

Here is the caller graph for this function:

◆ isShowLabel()

ilOrgUnitMultiLineInputGUI::isShowLabel ( )

Definition at line 98 of file class.ilOrgUnitMultiLineInputGUI.php.

References $show_label.

Referenced by render().

                                  : bool
     {
         return $this->show_label;
     }

Here is the caller graph for this function:

◆ isShowLabelOnce()

ilOrgUnitMultiLineInputGUI::isShowLabelOnce ( )

Definition at line 396 of file class.ilOrgUnitMultiLineInputGUI.php.

References $show_label_once.

Referenced by render().

                                      : bool
     {
         return $this->show_label_once;
     }

Here is the caller graph for this function:

◆ removeHook()

ilOrgUnitMultiLineInputGUI::removeHook ( string $key )

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

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

◆ render()

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

Exceptions

ilTemplateException
ilException

Definition at line 217 of file class.ilOrgUnitMultiLineInputGUI.php.

References $inputs, ILIAS\LTI\ToolProvider\$key, $value, addCustomAttribute(), createInputPostVar(), ILIAS\Repository\get(), getCustomAttributes(), ilFormPropertyGUI\getDisabled(), getHook(), ilFormPropertyGUI\getMulti(), getValue(), isPositionMovable(), isShowInfo(), isShowLabel(), isShowLabelOnce(), and ilLegacyFormElementsUtil\prepareFormOutput().

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

                                                                             : string
     {
         $first_label = true;
         $tpl = new \ilTemplate(
             "tpl.multi_line_input.html",
             true,
             true,
             'Customizing/global/plugins/Services/Repository/RepositoryObject/LiveVoting'
         );
         $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;
             $is_hidden = false;
             $is_ta = false;
             if (!method_exists($input, 'render')) {
                 switch (true) {
                     case ($input instanceof \ilHiddenInputGUI):
                         $is_hidden = true;
                         break;
                     case ($input instanceof \ilTextAreaInputGUI):
                         $is_ta = true;
                         break;
                     default:
                         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);
             }
             switch (true) {
                 case $is_hidden:
                     $tpl->setCurrentBlock('hidden');
                     $tpl->setVariable('NAME', $post_var);
                     $tpl->setVariable('VALUE', ilLegacyFormElementsUtil::prepareFormOutput($input->getValue()));
                     break;
                 case $is_ta:
                     if ($this->isShowLabel() || ($this->isShowLabelOnce() && $first_label)) {
                         $tpl->setCurrentBlock('input_label');
                         $tpl->setVariable('LABEL', $input->getTitle());
                         $tpl->setVariable('CONTENT', $input->getHTML());
                         $tpl->parseCurrentBlock();
                         $first_label = false;
                     } else {
                         $tpl->setCurrentBlock('input');
                         $tpl->setVariable('CONTENT', $input->getHTML());
                     }
                     break;
                 default:
                     if ($this->isShowLabel() || ($this->isShowLabelOnce() && $first_label)) {
                         $tpl->setCurrentBlock('input_label');
                         $tpl->setVariable('LABEL', $input->getTitle());
                         $tpl->setVariable('CONTENT', $input->render());
                         $first_label = false;
                     } else {
                         $tpl->setCurrentBlock('input');
                         $tpl->setVariable('CONTENT', $input->render());
                     }
                     break;
             }
             if ($this->isShowInfo()) {
                 if ($this->isShowLabel()) {
                     $tpl->setCurrentBlock('input_info_label');
                     $tpl->setVariable('INFO_LABEL', $input->getInfo());
                     $tpl->parseCurrentBlock();
                 } else {
                     $tpl->setCurrentBlock('input_info');
                     $tpl->setVariable('INFO', $input->getInfo());
                     $tpl->parseCurrentBlock();
                 }
             }
             $tpl->parseCurrentBlock();
         }
         if ($this->getMulti() && !$this->getDisabled()) {
             $image_plus = xlvoGlyphGUI::get('plus');
             $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());
             }
             $show_remove = true;
             $image_minus = ($show_remove) ? xlvoGlyphGUI::get('minus') : '<span class="glyphicon glyphicon-minus hide"></span>';
             $tpl->setCurrentBlock('multi_icons');
             $tpl->setVariable('IMAGE_PLUS', $image_plus);
             $tpl->setVariable('IMAGE_MINUS', $image_minus);
             $tpl->parseCurrentBlock();
             if ($this->isPositionMovable()) {
                 $tpl->setCurrentBlock('multi_icons_move');
                 $tpl->setVariable('IMAGE_UP', xlvoGlyphGUI::get(xlvoGlyphGUI::UP));
                 $tpl->setVariable('IMAGE_DOWN', xlvoGlyphGUI::get(xlvoGlyphGUI::DOWN));
                 $tpl->parseCurrentBlock();
             }
         }
 
         return $tpl->get();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setMulti()

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

Definition at line 113 of file class.ilOrgUnitMultiLineInputGUI.php.

Referenced by __construct().

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

Here is the caller graph for this function:

◆ setPositionMovable()

ilOrgUnitMultiLineInputGUI::setPositionMovable ( bool $position_movable )

Definition at line 391 of file class.ilOrgUnitMultiLineInputGUI.php.

References $position_movable.

     {
         $this->position_movable = $position_movable;
     }

◆ setShowInfo()

ilOrgUnitMultiLineInputGUI::setShowInfo ( bool $show_info )

Definition at line 412 of file class.ilOrgUnitMultiLineInputGUI.php.

References $show_info.

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

◆ setShowLabel()

ilOrgUnitMultiLineInputGUI::setShowLabel ( bool $show_label )

Definition at line 103 of file class.ilOrgUnitMultiLineInputGUI.php.

References $show_label.

Referenced by setShowLabelOnce().

     {
         $this->show_label = $show_label;
     }

Here is the caller graph for this function:

◆ setShowLabelOnce()

ilOrgUnitMultiLineInputGUI::setShowLabelOnce ( bool $show_label_once )

Definition at line 401 of file class.ilOrgUnitMultiLineInputGUI.php.

References $show_label_once, and setShowLabel().

                                                            : void
     {
         $this->setShowLabel(false);
         $this->show_label_once = $show_label_once;
     }

Here is the call graph for this function:

◆ setTemplateDir()

ilOrgUnitMultiLineInputGUI::setTemplateDir ( string $template_dir )

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

References $template_dir.

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

◆ setValue()

ilOrgUnitMultiLineInputGUI::setValue ( string $a_value )

Definition at line 118 of file class.ilOrgUnitMultiLineInputGUI.php.

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

Referenced by setValueByArray().

                                              : void
     {
         foreach ($this->inputs as $key => $item) {
             if (method_exists($item, 'setValue')) {
                 $item->setValue($a_value[$key]);
             } elseif ($item instanceof \ilDateTimeInputGUI) {
                 $item->setDate(new \ilDate($a_value[$key]['date'], IL_CAL_DATE));
             }
         }
         $this->value = $a_value;
     }

Here is the caller graph for this function:

◆ setValueByArray()

ilOrgUnitMultiLineInputGUI::setValueByArray ( array $a_values )

Set value by array.

Parameters

array $a_values value array

Definition at line 144 of file class.ilOrgUnitMultiLineInputGUI.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);
         }
     }