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

Inheritance diagram for ilSelectInputGUI:

Collaboration diagram for ilSelectInputGUI:

Public Member Functions
	__construct (string $a_title="", string $a_postvar="")

	setOptions (array $a_options)

	getOptions ()

	setOptionsLangAttribute (\Closure $langresolve)

	getOptionsLangAttribute ($key)

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

	getValue ()
	Get Value. More...

	setValueByArray (array $a_values)

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

	getInput ()

	addCustomAttribute (string $a_attr)

	getCustomAttributes ()

	render ($a_mode="")

	insert (ilTemplate $a_tpl)

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

	getToolbarHTML ()
	Get input item HTML to be inserted into ilToolbarGUI. More...

	setHideSubForm (bool $a_value, ?string $a_condition=null)
	Set initial sub form visibility, optionally add dynamic value-based condition. More...

	hideSubForm ()

Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem (ilFormPropertyGUI $a_item)

	getSubItems ()

	getSubInputItemsRecursive ()
	returns a flat array of possibly existing subitems recursively More...

	checkSubItemsInput ()
	Check SubItems. More...

	getSubForm ()

	getItemByPostVar (string $a_post_var)
	Get item by post var. More...

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

	getToolbarHTML ()
	Get input item HTML to be inserted into ilToolbarGUI. More...

Protected Attributes
array	$cust_attr = array()

array	$options = array()

Closure	$langresolve = null

	$value

bool	$hide_sub = false

Protected Attributes inherited from ilSubEnabledFormPropertyGUI
array	$sub_items = array()

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

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

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented from ilFormPropertyGUI.

Reimplemented in ilCountrySelectInputGUI.

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ addCustomAttribute()

ilSelectInputGUI::addCustomAttribute ( string $a_attr )

Definition at line 144 of file class.ilSelectInputGUI.php.

                                                      : void
    {
        $this->cust_attr[] = $a_attr;
    }

Referenced by setHideSubForm().

Here is the caller graph for this function:

◆ checkInput()

ilSelectInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Reimplemented from ilFormPropertyGUI.

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

                                : bool
    {
        $lng = $this->lng;
 
        $valid = true;
        if (!$this->getMulti()) {
            if ($this->getRequired() && trim($this->str($this->getPostVar())) == "") {
                $valid = false;
            } elseif (!array_key_exists($this->str($this->getPostVar()), $this->getOptions())) {
                $this->setAlert($lng->txt('msg_invalid_post_input'));
                return false;
            }
        } else {
            $values = $this->strArray($this->getPostVar());
            foreach ($values as $value) {
                if (!array_key_exists($value, $this->getOptions())) {
                    $this->setAlert($lng->txt('msg_invalid_post_input'));
                    return false;
                }
            }
            if ($this->getRequired() && !trim(implode("", $values))) {
                $valid = false;
            }
        }
        if (!$valid) {
            $this->setAlert($lng->txt("msg_input_is_required"));
            return false;
        }
        return $this->checkSubItemsInput();
    }

References ilFormPropertyGUI\$lng, $valid, $value, ilSubEnabledFormPropertyGUI\checkSubItemsInput(), ilFormPropertyGUI\getMulti(), getOptions(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilFormPropertyGUI\setAlert(), ilFormPropertyGUI\str(), ilFormPropertyGUI\strArray(), and ilLanguage\txt().

Here is the call graph for this function:

◆ getCustomAttributes()

ilSelectInputGUI::getCustomAttributes ( )

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

                                         : array
    {
        return $this->cust_attr;
    }

References $cust_attr.

Referenced by render().

Here is the caller graph for this function:

◆ getInput()

ilSelectInputGUI::getInput ( )

Returns: string|string[]

Definition at line 136 of file class.ilSelectInputGUI.php.

    {
        if (!$this->getMulti()) {
            return $this->str($this->getPostVar());
        }
        return $this->strArray($this->getPostVar());
    }

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

Here is the call graph for this function:

◆ getOptions()

ilSelectInputGUI::getOptions ( )

Reimplemented in ilCountrySelectInputGUI, and ilTaxAssignInputGUI.

Definition at line 54 of file class.ilSelectInputGUI.php.

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

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

Here is the caller graph for this function:

◆ getOptionsLangAttribute()

ilSelectInputGUI::getOptionsLangAttribute ( $key )

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

                                                 : string
    {
        return $this->langresolve($this->getOptions(), $key);
    }

References getOptions().

Here is the call graph for this function:

◆ getTableFilterHTML()

ilSelectInputGUI::getTableFilterHTML ( )

Get input item HTML to be inserted into table filters.

Implements ilTableFilterItem.

Definition at line 246 of file class.ilSelectInputGUI.php.

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

References render().

Here is the call graph for this function:

◆ getToolbarHTML()

ilSelectInputGUI::getToolbarHTML ( )

Get input item HTML to be inserted into ilToolbarGUI.

Implements ilToolbarItem.

Definition at line 252 of file class.ilSelectInputGUI.php.

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

References render().

Here is the call graph for this function:

◆ getValue()

ilSelectInputGUI::getValue ( )

Get Value.

Returns: string|array Value

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

    {
        return $this->value;
    }

References $value.

Referenced by render().

Here is the caller graph for this function:

◆ hideSubForm()

ilSelectInputGUI::hideSubForm ( )

Reimplemented from ilFormPropertyGUI.

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

                                 : bool
    {
        return $this->hide_sub;
    }

◆ insert()

ilSelectInputGUI::insert ( ilTemplate $a_tpl )

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

ilSelectInputGUI::render ( $a_mode = "" )

Reimplemented in ilMailTemplateSelectInputGUI.

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

                                        : string
    {
        $sel_value = "";
        $tpl = new ilTemplate("tpl.prop_select.html", true, true, "components/ILIAS/Form");
 
        foreach ($this->getCustomAttributes() as $attr) {
            $tpl->setCurrentBlock('cust_attr');
            $tpl->setVariable('CUSTOM_ATTR', $attr);
            $tpl->parseCurrentBlock();
        }
 
        if ($this->getRequired()) {
            $tpl->setCurrentBlock('required_attribute');
            $tpl->setVariable('REQUIRED', 'required');
            $tpl->parseCurrentBlock();
        }
 
        // determine value to select. Due to accessibility reasons we
        // should always select a value (per default the first one)
        $first = true;
        foreach ($this->getOptions() as $option_value => $option_text) {
            if ($first) {
                $sel_value = $option_value;
            }
            $first = false;
            if ((string) $option_value == (string) $this->getValue()) {
                $sel_value = $option_value;
            }
        }
        foreach ($this->getOptions() as $option_value => $option_text) {
            $tpl->setCurrentBlock("prop_select_option");
            $tpl->setVariable("VAL_SELECT_OPTION", ilLegacyFormElementsUtil::prepareFormOutput((string) $option_value));
            if ((string) $sel_value == (string) $option_value) {
                $tpl->setVariable(
                    "CHK_SEL_OPTION",
                    ' selected="selected"'
                );
            }
            $tpl->setVariable("TXT_SELECT_OPTION", $option_text);
 
            if ($this->langresolve) {
                $f = $this->langresolve;
                $lang = $f($this->getOptions(), $option_value);
                $tpl->setVariable("OPTION_LANG", ' lang="' . $lang . '"');
            }
 
            $tpl->parseCurrentBlock();
        }
        $tpl->setVariable("ID", $this->getFieldId());
 
        $postvar = $this->getPostVar();
        if ($this->getMulti() && substr($postvar, -2) != "[]") {
            $postvar .= "[]";
        }
 
        $tpl->setVariable("POST_VAR", $postvar);
        if ($this->getDisabled()) {
            if ($this->getMulti()) {
                $value = $this->getMultiValues();
                $hidden = "";
                if (is_array($value)) {
                    foreach ($value as $item) {
                        $hidden .= $this->getHiddenTag($postvar, $item);
                    }
                }
            } else {
                $hidden = $this->getHiddenTag($postvar, (string) $this->getValue());
            }
            if ($hidden) {
                $tpl->setVariable("DISABLED", " disabled=\"disabled\"");
                $tpl->setVariable("HIDDEN_INPUT", $hidden);
            }
        }
 
        // multi icons
        if ($this->getMulti() && !$a_mode && !$this->getDisabled()) {
            $tpl->touchBlock("inline_in_bl");
            $tpl->setVariable("MULTI_ICONS", $this->getMultiIconsHTML());
        }
 
        $tpl->setVariable("ARIA_LABEL", ilLegacyFormElementsUtil::prepareFormOutput($this->getTitle()));
 
        return $tpl->get();
    }

References Vendor\Package\$f, $lang, $langresolve, ilFormPropertyGUI\$postvar, $value, getCustomAttributes(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), ilFormPropertyGUI\getHiddenTag(), ilFormPropertyGUI\getMulti(), ilFormPropertyGUI\getMultiIconsHTML(), ilFormPropertyGUI\getMultiValues(), getOptions(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilFormPropertyGUI\getTitle(), getValue(), and ilLegacyFormElementsUtil\prepareFormOutput().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setHideSubForm()

ilSelectInputGUI::setHideSubForm	(	bool	$a_value,
		?string	$a_condition = `null`
	)

Set initial sub form visibility, optionally add dynamic value-based condition.

Definition at line 261 of file class.ilSelectInputGUI.php.

     : void {
        $this->hide_sub = $a_value;
 
        if ($a_condition) {
            $this->addCustomAttribute('onchange="if(this.value ' . $a_condition . ')' .
                ' { il.Form.showSubForm(\'subform_' . $this->getFieldId() . '\', \'il_prop_cont_' . $this->getFieldId() . '\'); }' .
                ' else { il.Form.hideSubForm(\'subform_' . $this->getFieldId() . '\'); };"');
        }
    }

References addCustomAttribute(), and ilFormPropertyGUI\getFieldId().

Here is the call graph for this function:

◆ setOptions()

ilSelectInputGUI::setOptions ( array $a_options )

Definition at line 49 of file class.ilSelectInputGUI.php.

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

◆ setOptionsLangAttribute()

ilSelectInputGUI::setOptionsLangAttribute ( \Closure $langresolve )

Definition at line 59 of file class.ilSelectInputGUI.php.

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

References $langresolve.

◆ setValue()

ilSelectInputGUI::setValue ( $a_value )

Set Value.

Parameters

string | array $a_value Value

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

                                      : void
    {
        if ($this->getMulti() && is_array($a_value)) {
            $this->setMultiValues($a_value);
            $a_value = array_shift($a_value);
        }
        $this->value = $a_value;
    }

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

Referenced by setValueByArray().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setValueByArray()

ilSelectInputGUI::setValueByArray ( array $a_values )

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

                                                    : void
    {
        $this->setValue($a_values[$this->getPostVar()] ?? "");
        foreach ($this->getSubItems() as $item) {
            $item->setValueByArray($a_values);
        }
    }

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

Here is the call graph for this function:

Field Documentation

◆ $cust_attr

array ilSelectInputGUI::$cust_attr = array()

protected

Definition at line 29 of file class.ilSelectInputGUI.php.

Referenced by getCustomAttributes().

◆ $hide_sub

bool ilSelectInputGUI::$hide_sub = false

protected

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

◆ $langresolve

Closure ilSelectInputGUI::$langresolve = null

protected

Definition at line 31 of file class.ilSelectInputGUI.php.

Referenced by render(), and setOptionsLangAttribute().

◆ $options

array ilSelectInputGUI::$options = array()

protected

Definition at line 30 of file class.ilSelectInputGUI.php.

Referenced by ilCountrySelectInputGUI\getOptions(), and ilTaxAssignInputGUI\getOptions().

◆ $value

ilSelectInputGUI::$value

protected

Definition at line 35 of file class.ilSelectInputGUI.php.

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

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

components/ILIAS/Form/classes/class.ilSelectInputGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCustomAttribute()

◆ checkInput()

◆ getCustomAttributes()

◆ getInput()

◆ getOptions()

◆ getOptionsLangAttribute()

◆ getTableFilterHTML()

◆ getToolbarHTML()

◆ getValue()

◆ hideSubForm()

◆ insert()

◆ render()

◆ setHideSubForm()

◆ setOptions()

◆ setOptionsLangAttribute()

◆ setValue()

◆ setValueByArray()

Field Documentation

◆ $cust_attr

◆ $hide_sub

◆ $langresolve

◆ $options

◆ $value