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 (string $a_title="", string $a_postvar="")

	setWidth (int $a_width)

	getWidth ()

	setHeight (int $a_height)

	getHeight ()

	setOptions (array $a_options)

	getOptions ()

	setValue ($a_array)

	getValue ()

	setValueByArray (array $a_values)

	enableSelectAll (bool $a_value)

	enableSelectedFirst (bool $a_value)

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

	getInput ()

	render ()

	insert (ilTemplate $a_tpl)

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

	getCustomAttributes ()

	setCustomAttributes (array $custom_attributes)

	addCustomAttribute (string $custom_attribute)

	getWidthUnit ()

	setWidthUnit (string $widthUnit)

	getHeightUnit ()

	setHeightUnit (string $heightUnit)

	unserializeData (string $a_data)

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
	getTableFilterHTML ()
	Get input item HTML to be inserted into table filters. More...

	getTableFilterLabelFor ()
	Get label "for" attribute value. More...

Protected Attributes
array	$options = []

array	$value = []

bool	$select_all = false

bool	$selected_first = false

string	$widthUnit = 'px'

string	$heightUnit = 'px'

array	$custom_attributes = []

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 Attributes
int	$width = 160

int	$height = 100

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

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

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Deprecated:: 12 This component will be removed with ILIAS 12

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

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented from ilFormPropertyGUI.

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ addCustomAttribute()

ilMultiSelectInputGUI::addCustomAttribute ( string $custom_attribute )

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

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

◆ checkInput()

ilMultiSelectInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Reimplemented from ilFormPropertyGUI.

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

                                : bool
    {
        $lng = $this->lng;
 
        $val = $this->getInput();
        if ($this->getRequired() && count($val) == 0) {
            $this->setAlert($lng->txt("msg_input_is_required"));
            return false;
        }
        if (count($val) > 0) {
            $options = array_map(function ($k) {
                return (string) $k;
            }, array_keys($this->getOptions()));
            foreach ($val as $key => $val2) {
                if ($key != 0 || $val2 != "") {
                    if (!in_array((string) $val2, $options)) {
                        $this->setAlert($lng->txt("msg_unknown_value"));
                        return false;
                    }
                }
            }
        }
        return true;
    }

References ilFormPropertyGUI\$lng, $options, getInput(), getOptions(), ilFormPropertyGUI\getRequired(), ilFormPropertyGUI\setAlert(), and ilLanguage\txt().

Here is the call graph for this function:

◆ enableSelectAll()

ilMultiSelectInputGUI::enableSelectAll ( bool $a_value )

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

                                                  : void
    {
        $this->select_all = $a_value;
    }

◆ enableSelectedFirst()

ilMultiSelectInputGUI::enableSelectedFirst ( bool $a_value )

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

                                                      : void
    {
        $this->selected_first = $a_value;
    }

◆ getCustomAttributes()

ilMultiSelectInputGUI::getCustomAttributes ( )

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

                                         : array
    {
        return $this->custom_attributes;
    }

References $custom_attributes.

Referenced by render().

Here is the caller graph for this function:

◆ getHeight()

ilMultiSelectInputGUI::getHeight ( )

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

                               : int
    {
        return $this->height;
    }

References $height.

Referenced by render().

Here is the caller graph for this function:

◆ getHeightUnit()

ilMultiSelectInputGUI::getHeightUnit ( )

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

                                   : string
    {
        return $this->heightUnit;
    }

References $heightUnit.

Referenced by render().

Here is the caller graph for this function:

◆ getInput()

ilMultiSelectInputGUI::getInput ( )

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

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

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

Referenced by checkInput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOptions()

ilMultiSelectInputGUI::getOptions ( )

Returns: array<string,string>

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

                                : array
    {
        return $this->options;
    }

References $options.

Referenced by checkInput(), and render().

Here is the caller graph for this function:

◆ getTableFilterHTML()

ilMultiSelectInputGUI::getTableFilterHTML ( )

Get input item HTML to be inserted into table filters.

Implements ilTableFilterItem.

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

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

References render().

Here is the call graph for this function:

◆ getValue()

ilMultiSelectInputGUI::getValue ( )

Returns: string[]

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

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

Referenced by render().

Here is the caller graph for this function:

◆ getWidth()

ilMultiSelectInputGUI::getWidth ( )

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

                              : int
    {
        return $this->width;
    }

References $width.

Referenced by render().

Here is the caller graph for this function:

◆ getWidthUnit()

ilMultiSelectInputGUI::getWidthUnit ( )

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

                                  : string
    {
        return $this->widthUnit;
    }

References $widthUnit.

Referenced by render().

Here is the caller graph for this function:

◆ insert()

ilMultiSelectInputGUI::insert ( ilTemplate $a_tpl )

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

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

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

Here is the call graph for this function:

◆ render()

ilMultiSelectInputGUI::render ( )

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

                            : string
    {
        $lng = $this->lng;
 
        $tpl = new ilTemplate("tpl.prop_multi_select.html", true, true, "components/ILIAS/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", ilLegacyFormElementsUtil::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", ilLegacyFormElementsUtil::prepareFormOutput($option_value));
                $tpl->setVariable("ID_VAL", ilLegacyFormElementsUtil::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() ?: ''));
        }
        if ($this->getHeight()) {
            $tpl->setVariable("HEIGHT", $this->getHeight() . ($this->getHeightUnit() ?: ''));
        }
 
        return $tpl->get();
    }

References ilFormPropertyGUI\$lng, $options, getCustomAttributes(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), getHeight(), getHeightUnit(), getOptions(), ilFormPropertyGUI\getPostVar(), getValue(), getWidth(), getWidthUnit(), ilLegacyFormElementsUtil\prepareFormOutput(), and ilLanguage\txt().

Referenced by getTableFilterHTML(), and insert().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCustomAttributes()

ilMultiSelectInputGUI::setCustomAttributes ( array $custom_attributes )

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

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

References $custom_attributes.

◆ setHeight()

ilMultiSelectInputGUI::setHeight ( int $a_height )

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

                                            : void
    {
        $this->height = $a_height;
    }

◆ setHeightUnit()

ilMultiSelectInputGUI::setHeightUnit ( string $heightUnit )

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

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

References $heightUnit.

◆ setOptions()

ilMultiSelectInputGUI::setOptions ( array $a_options )

Parameters

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

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

                                                : void
    {
        $this->options = $a_options;
    }

◆ setValue()

ilMultiSelectInputGUI::setValue ( $a_array )

Parameters

mixed

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

                                      : void
    {
        $this->value = [];
        if (is_array($a_array)) {
            $this->value = $a_array;
        }
    }

Referenced by __construct(), setValueByArray(), and unserializeData().

Here is the caller graph for this function:

◆ setValueByArray()

ilMultiSelectInputGUI::setValueByArray ( array $a_values )

Parameters

string[]

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

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

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

Here is the call graph for this function:

◆ setWidth()

ilMultiSelectInputGUI::setWidth ( int $a_width )

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

                                          : void
    {
        $this->width = $a_width;
    }

◆ setWidthUnit()

ilMultiSelectInputGUI::setWidthUnit ( string $widthUnit )

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

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

References $widthUnit.

◆ unserializeData()

ilMultiSelectInputGUI::unserializeData ( string $a_data )

Reimplemented from ilFormPropertyGUI.

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

                                                   : void
    {
        $data = unserialize($a_data);
 
        if (is_array($data)) {
            $this->setValue($data);
        } else {
            $this->setValue([]);
        }
    }