This class represents a multi selection list property in a property form. More...

Inheritance diagram for ilMultiSelectInputGUI:

Collaboration diagram for ilMultiSelectInputGUI:

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

	setWidth ($a_width)
	Sets the width of this field. More...

	getWidth ()
	Returns the width currently set for this field. More...

	setHeight ($a_height)
	Sets the height of this field. More...

	getHeight ()
	Returns the height currently set for this field. More...

	setOptions ($a_options)
	Set Options. More...

	getOptions ()
	Get Options. More...

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

	getValue ()
	Get Value. More...

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

	enableSelectAll ($a_value)

	enableSelectedFirst ($a_value)

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

	render ()
	Render item. More...

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

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

	getCustomAttributes ()

	setCustomAttributes ($custom_attributes)

	addCustomAttribute ($custom_attribute)

	getWidthUnit ()

	setWidthUnit ($widthUnit)

	getHeightUnit ()

	setHeightUnit ($heightUnit)

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

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

Protected Attributes
	$options

	$value

	$select_all

	$selected_first

	$widthUnit = 'px'

	$heightUnit = 'px'

	$custom_attributes = 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

Private Attributes
	$width = 160

	$height = 100

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 multi selection list 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 34 of file class.ilMultiSelectInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Definition at line 78 of file class.ilMultiSelectInputGUI.php.

References $DIC, ilFormPropertyGUI\setType(), and setValue().

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

Here is the call graph for this function:

Member Function Documentation

◆ addCustomAttribute()

ilMultiSelectInputGUI::addCustomAttribute ( $custom_attribute )

Parameters

array $custom_attribute

Definition at line 355 of file class.ilMultiSelectInputGUI.php.

     {
         $this->custom_attributes[] = $custom_attribute;
     }

◆ checkInput()

ilMultiSelectInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: boolean Input ok, true/false

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

References $_POST, $key, ilFormPropertyGUI\$lng, $options, getOptions(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilFormPropertyGUI\setAlert(), and ilUtil\stripSlashes().

     {
         $lng = $this->lng;
         
         if (is_array($_POST[$this->getPostVar()])) {
             foreach ($_POST[$this->getPostVar()] as $k => $v) {
                 $_POST[$this->getPostVar()][$k] =
                     ilUtil::stripSlashes($v);
             }
         } else {
             $_POST[$this->getPostVar()] = array();
         }
         if ($this->getRequired() && count($_POST[$this->getPostVar()]) == 0) {
             $this->setAlert($lng->txt("msg_input_is_required"));
 
             return false;
         }
         if (count($_POST[$this->getPostVar()]) > 0) {
             $options = array_map(function ($k) {
                 return (string) $k;
             }, array_keys($this->getOptions()));
             foreach ($_POST[$this->getPostVar()] as $key => $val) {
                 if ($key != 0 || $val != "") {
                     if (!in_array((string) $val, $options)) {
                         $this->setAlert($lng->txt("msg_unknown_value"));
                         return false;
                     }
                 }
             }
         }
 
         return true;
     }

Here is the call graph for this function:

◆ enableSelectAll()

ilMultiSelectInputGUI::enableSelectAll ( $a_value )

Definition at line 183 of file class.ilMultiSelectInputGUI.php.

     {
         $this->select_all = (bool) $a_value;
     }

◆ enableSelectedFirst()

ilMultiSelectInputGUI::enableSelectedFirst ( $a_value )

Definition at line 188 of file class.ilMultiSelectInputGUI.php.

     {
         $this->selected_first = (bool) $a_value;
     }

◆ getCustomAttributes()

ilMultiSelectInputGUI::getCustomAttributes ( )

Returns: array

Definition at line 337 of file class.ilMultiSelectInputGUI.php.

References $custom_attributes.

Referenced by render().

     {
         return $this->custom_attributes;
     }

Here is the caller graph for this function:

◆ getHeight()

ilMultiSelectInputGUI::getHeight ( )

Returns the height currently set for this field.

public

Returns: integer height

Definition at line 127 of file class.ilMultiSelectInputGUI.php.

References $height.

Referenced by render().

     {
         return $this->height;
     }

Here is the caller graph for this function:

◆ getHeightUnit()

ilMultiSelectInputGUI::getHeightUnit ( )

Returns: string

Definition at line 379 of file class.ilMultiSelectInputGUI.php.

References $heightUnit.

Referenced by render().

     {
         return $this->heightUnit;
     }

Here is the caller graph for this function:

◆ getOptions()

ilMultiSelectInputGUI::getOptions ( )

Get Options.

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

Definition at line 147 of file class.ilMultiSelectInputGUI.php.

References $options.

Referenced by checkInput(), and render().

     {
         return $this->options;
     }

Here is the caller graph for this function:

◆ getTableFilterHTML()

ilMultiSelectInputGUI::getTableFilterHTML ( )

Get HTML for table filter.

Implements ilTableFilterItem.

Definition at line 327 of file class.ilMultiSelectInputGUI.php.

References $html, and render().

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

Here is the call graph for this function:

◆ getValue()

ilMultiSelectInputGUI::getValue ( )

Get Value.

Returns: array array with all activated selections

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

Referenced by render().

     {
         return is_array($this->value) ? $this->value : array();
     }

Here is the caller graph for this function:

◆ getWidth()

ilMultiSelectInputGUI::getWidth ( )

Returns the width currently set for this field.

public

Returns: integer width

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

References $width.

Referenced by render().

     {
         return $this->width;
     }

Here is the caller graph for this function:

◆ getWidthUnit()

ilMultiSelectInputGUI::getWidthUnit ( )

Returns: string

Definition at line 363 of file class.ilMultiSelectInputGUI.php.

References $widthUnit.

Referenced by render().

     {
         return $this->widthUnit;
     }

Here is the caller graph for this function:

◆ insert()

ilMultiSelectInputGUI::insert ( $a_tpl )

Insert property html.

Returns: int Size

Definition at line 317 of file class.ilMultiSelectInputGUI.php.

References render().

     {
         $a_tpl->setCurrentBlock("prop_generic");
         $a_tpl->setVariable("PROP_GENERIC", $this->render());
         $a_tpl->parseCurrentBlock();
     }

Here is the call graph for this function:

◆ render()

ilMultiSelectInputGUI::render ( )

Render item.

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

References ilFormPropertyGUI\$lng, $options, $tpl, $values, getCustomAttributes(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), getHeight(), getHeightUnit(), getOptions(), ilFormPropertyGUI\getPostVar(), getValue(), getWidth(), getWidthUnit(), and ilUtil\prepareFormOutput().

Referenced by getTableFilterHTML(), and insert().

     {
         $lng = $this->lng;
         
         $tpl = new ilTemplate("tpl.prop_multi_select.html", true, true, "Services/Form");
         $values = $this->getValue();
 
         $options = $this->getOptions();
         if ($options) {
             if ($this->select_all) {
                 // enable select all toggle
                 $tpl->setCurrentBlock("item");
                 $tpl->setVariable("VAL", "");
                 $tpl->setVariable("ID_VAL", ilUtil::prepareFormOutput("all__toggle"));
                 $tpl->setVariable("IID", $this->getFieldId());
                 $tpl->setVariable("TXT_OPTION", "<em>" . $lng->txt("select_all") . "</em>");
                 $tpl->setVariable("POST_VAR", $this->getPostVar());
                 $tpl->parseCurrentBlock();
                 
                 $tpl->setVariable("TOGGLE_FIELD_ID", $this->getFieldId());
                 $tpl->setVariable("TOGGLE_ALL_ID", $this->getFieldId() . "_all__toggle");
                 $tpl->setVariable("TOGGLE_ALL_CBOX_ID", $this->getFieldId() . "_");
             }
             
             if ($this->selected_first) {
                 // move selected values to top
                 $tmp_checked = $tmp_unchecked = array();
                 foreach ($options as $option_value => $option_text) {
                     if (in_array($option_value, $values)) {
                         $tmp_checked[$option_value] = $option_text;
                     } else {
                         $tmp_unchecked[$option_value] = $option_text;
                     }
                 }
                 $options = $tmp_checked + $tmp_unchecked;
                 unset($tmp_checked);
                 unset($tmp_unchecked);
             }
             
             foreach ($options as $option_value => $option_text) {
                 $tpl->setCurrentBlock("item");
                 if ($this->getDisabled()) {
                     $tpl->setVariable(
                         "DISABLED",
                         " disabled=\"disabled\""
                     );
                 }
                 if (in_array($option_value, $values)) {
                     $tpl->setVariable(
                         "CHECKED",
                         " checked=\"checked\""
                     );
                 }
 
                 $tpl->setVariable("VAL", ilUtil::prepareFormOutput($option_value));
                 $tpl->setVariable("ID_VAL", ilUtil::prepareFormOutput($option_value));
                 $tpl->setVariable("IID", $this->getFieldId());
                 $tpl->setVariable("TXT_OPTION", $option_text);
                 $tpl->setVariable("POST_VAR", $this->getPostVar());
                 $tpl->parseCurrentBlock();
             }
         }
         
         $tpl->setVariable("ID", $this->getFieldId());
         $tpl->setVariable("CUSTOM_ATTRIBUTES", implode(' ', $this->getCustomAttributes()));
 
         if ($this->getWidth()) {
             $tpl->setVariable("WIDTH", $this->getWidth() . ($this->getWidthUnit()?$this->getWidthUnit():''));
         }
         if ($this->getHeight()) {
             $tpl->setVariable("HEIGHT", $this->getHeight() . ($this->getHeightUnit()?$this->getHeightUnit():''));
         }
         
         return $tpl->get();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCustomAttributes()

ilMultiSelectInputGUI::setCustomAttributes ( $custom_attributes )

Parameters

array $custom_attributes

Definition at line 346 of file class.ilMultiSelectInputGUI.php.

References $custom_attributes.

     {
         $this->custom_attributes = $custom_attributes;
     }

◆ setHeight()

ilMultiSelectInputGUI::setHeight ( $a_height )

Sets the height of this field.

public

Parameters

integer $a_height

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

     {
         $this->height = (int) $a_height;
     }

◆ setHeightUnit()

ilMultiSelectInputGUI::setHeightUnit ( $heightUnit )

Parameters

string $heightUnit

Definition at line 387 of file class.ilMultiSelectInputGUI.php.

References $heightUnit.

     {
         $this->heightUnit = $heightUnit;
     }

◆ setOptions()

ilMultiSelectInputGUI::setOptions ( $a_options )

Set Options.

Parameters

array $a_options Options. Array ("value" => "option_text")

Definition at line 137 of file class.ilMultiSelectInputGUI.php.

Referenced by assFormulaQuestionGUI\isSaveCommand(), ilOrgUnitTypeAdvancedMetaDataFormGUI\saveObject(), and ilStudyProgrammeTypeAdvancedMetaDataFormGUI\saveObject().

     {
         $this->options = $a_options;
     }

Here is the caller graph for this function:

◆ setValue()

ilMultiSelectInputGUI::setValue ( $a_array )

Set Value.

Parameters

array array with all activated selections

Definition at line 157 of file class.ilMultiSelectInputGUI.php.

Referenced by __construct(), and setValueByArray().

     {
         $this->value = $a_array;
     }

Here is the caller graph for this function:

◆ setValueByArray()

ilMultiSelectInputGUI::setValueByArray ( $a_values )

Set value by array.

Parameters

array $a_values value array

Definition at line 177 of file class.ilMultiSelectInputGUI.php.

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

     {
         $this->setValue($a_values[$this->getPostVar()]);
     }

Here is the call graph for this function:

◆ setWidth()

ilMultiSelectInputGUI::setWidth ( $a_width )

Sets the width of this field.

public

Parameters

integer $a_width

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

     {
         $this->width = (int) $a_width;
     }

◆ setWidthUnit()

ilMultiSelectInputGUI::setWidthUnit ( $widthUnit )

Parameters

string $widthUnit

Definition at line 371 of file class.ilMultiSelectInputGUI.php.

References $widthUnit.

     {
         $this->widthUnit = $widthUnit;
     }

Field Documentation

◆ $custom_attributes

ilMultiSelectInputGUI::$custom_attributes = array()

protected

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

Referenced by getCustomAttributes(), and setCustomAttributes().

◆ $height

ilMultiSelectInputGUI::$height = 100

private

Definition at line 55 of file class.ilMultiSelectInputGUI.php.

Referenced by getHeight().

◆ $heightUnit

ilMultiSelectInputGUI::$heightUnit = 'px'

protected

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

Referenced by getHeightUnit(), and setHeightUnit().

◆ $options

ilMultiSelectInputGUI::$options

protected

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

Referenced by checkInput(), getOptions(), and render().

◆ $select_all

ilMultiSelectInputGUI::$select_all

protected

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

◆ $selected_first

ilMultiSelectInputGUI::$selected_first

protected

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

◆ $value

ilMultiSelectInputGUI::$value

protected

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

◆ $width

ilMultiSelectInputGUI::$width = 160

private

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

Referenced by getWidth().

◆ $widthUnit

ilMultiSelectInputGUI::$widthUnit = 'px'

protected

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

Referenced by getWidthUnit(), and setWidthUnit().

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

Services/Form/classes/class.ilMultiSelectInputGUI.php

Public Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCustomAttribute()

◆ checkInput()

◆ enableSelectAll()

◆ enableSelectedFirst()

◆ getCustomAttributes()

◆ getHeight()

◆ getHeightUnit()

◆ getOptions()

◆ getTableFilterHTML()

◆ getValue()

◆ getWidth()

◆ getWidthUnit()

◆ insert()

◆ render()

◆ setCustomAttributes()

◆ setHeight()

◆ setHeightUnit()

◆ setOptions()

◆ setValue()

◆ setValueByArray()

◆ setWidth()

◆ setWidthUnit()

Field Documentation

◆ $custom_attributes

◆ $height

◆ $heightUnit

◆ $options

◆ $select_all

◆ $selected_first

◆ $value

◆ $width

◆ $widthUnit