Input GUI for the configuration of select input elements. More...

Inheritance diagram for ilSelectBuilderInputGUI:

Collaboration diagram for ilSelectBuilderInputGUI:

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

	getOpenAnswerIndexes ()

	setOpenAnswerIndexes (array $a_indexes)

	addOpenAnswerIndex (string $a_idx)

	isOpenAnswerIndex (string $a_idx)

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

	getInput ()

	setValueByArray (array $a_values)

	insert (ilTemplate $a_tpl)

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

	setValues (array $a_values)

	setValue ($a_value)

	getValues ()

	setAllowMove (bool $a_allow_move)

	getAllowMove ()

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

	getInput ()

	insert (ilTemplate $a_tpl)

	render (string $a_mode="")

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

	setValue ($a_value)

	getValue ()

	setValidationFailureMessage (string $a_msg)

	getValidationFailureMessage ()

	setValidationRegexp (string $a_value)

	getValidationRegexp ()

	setMaxLength (?int $a_maxlength)

	getMaxLength ()

	setSize (int $a_size)

	setInlineStyle (string $a_style)

	getInlineStyle ()

	setCssClass (string $a_class)

	getCssClass ()

	setValueByArray (array $a_values)

	getSize ()

	setSuffix (string $a_value)

	getSuffix ()

	setInputType (string $a_type)
	set input type More...

	getInputType ()

	setSubmitFormOnEnter (bool $a_val)

	getSubmitFormOnEnter ()

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

	getInput ()

	getDataSource ()

	setDataSource (string $href, ?string $a_delimiter=null)

	setDataSourceSubmitOnSelection (bool $a_stat)

	getDataSourceSubmitOnSelection ()

	setDataSourceSubmitUrl (string $a_url)

	getDataSourceSubmitUrl ()

	setMultiValues (array $a_values)

	render (string $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...

	setDisableHtmlAutoComplete (bool $autocomplete)

	isHtmlAutoCompleteDisabled ()

	getPostValueForComparison ()

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

Protected Attributes inherited from ilTextWizardInputGUI
ilGlobalTemplateInterface	$tpl

array	$values = array()

bool	$allowMove = false

Protected Attributes inherited from ilTextInputGUI
	$value = null

int	$maxlength = 200

int	$size = 40

string	$validationRegexp = ""

string	$validationFailureMessage = ''

string	$suffix = ""

string	$style_css = ""

string	$css_class = ""

string	$ajax_datasource = ""

string	$ajax_datasource_delimiter = null

bool	$ajax_datasource_commit = false

string	$ajax_datasource_commit_url = ""

bool	$submit_form_on_enter = false

bool	$autocomplete_disabled = false

string	$input_type = ""

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

Input GUI for the configuration of select input elements.

E.g course custum field, udf field, ...

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

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

Definition at line 28 of file class.ilSelectBuilderInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented from ilTextWizardInputGUI.

Definition at line 32 of file class.ilSelectBuilderInputGUI.php.

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

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

Here is the call graph for this function:

Member Function Documentation

◆ addOpenAnswerIndex()

ilSelectBuilderInputGUI::addOpenAnswerIndex ( string $a_idx )

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

                                                     : void
    {
        $this->open_answer_indexes[] = $a_idx;
    }

Referenced by checkInput(), and setValueByArray().

Here is the caller graph for this function:

◆ checkInput()

ilSelectBuilderInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Reimplemented from ilTextWizardInputGUI.

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

                                : bool
    {
        $lng = $this->lng;
 
        $foundvalues = $this->getInput();
        $this->setOpenAnswerIndexes(array());
        if (is_array($foundvalues)) {
            foreach ($foundvalues as $value) {
                if ($this->getRequired() && trim($value) == "") {
                    $this->setAlert($lng->txt("msg_input_is_required"));
                    return false;
                } elseif (strlen($this->getValidationRegexp())) {
                    if (!preg_match($this->getValidationRegexp(), $value)) {
                        $this->setAlert($lng->txt("msg_wrong_format"));
                        return false;
                    }
                }
            }
        } else {
            $this->setAlert($lng->txt("msg_input_is_required"));
            return false;
        }
 
        foreach ($this->strArray($this->getPostVar() . '_open') as $oindex => $ovalue) {
            $this->addOpenAnswerIndex((string) $oindex);
        }
 
        return $this->checkSubItemsInput();
    }

References ilFormPropertyGUI\$lng, ilTextInputGUI\$value, addOpenAnswerIndex(), ilSubEnabledFormPropertyGUI\checkSubItemsInput(), getInput(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilTextInputGUI\getValidationRegexp(), ilFormPropertyGUI\setAlert(), setOpenAnswerIndexes(), ilFormPropertyGUI\strArray(), and ilLanguage\txt().

Here is the call graph for this function:

◆ getInput()

ilSelectBuilderInputGUI::getInput ( )

Returns: string|string[]

Reimplemented from ilTextWizardInputGUI.

Definition at line 94 of file class.ilSelectBuilderInputGUI.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:

◆ getOpenAnswerIndexes()

ilSelectBuilderInputGUI::getOpenAnswerIndexes ( )

Definition at line 43 of file class.ilSelectBuilderInputGUI.php.

                                          : array
    {
        return $this->open_answer_indexes;
    }

References $open_answer_indexes.

◆ insert()

ilSelectBuilderInputGUI::insert ( ilTemplate $a_tpl )

Reimplemented from ilTextWizardInputGUI.

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

                                             : void
    {
        $lng = $this->lng;
 
        $tpl = new ilTemplate("tpl.prop_selectbuilder.html", true, true, "components/ILIAS/Form");
        $i = 0;
        foreach ($this->values as $value) {
            if (!is_string($value)) {
                continue;
            }
 
            if (strlen($value)) {
                $tpl->setCurrentBlock("prop_text_propval");
                $tpl->setVariable("PROPERTY_VALUE", ilLegacyFormElementsUtil::prepareFormOutput($value));
                $tpl->parseCurrentBlock();
            }
            if ($this->getAllowMove()) {
                $tpl->setCurrentBlock("move");
                $tpl->setVariable("CMD_UP", "cmd[up" . $this->getFieldId() . "][$i]");
                $tpl->setVariable("CMD_DOWN", "cmd[down" . $this->getFieldId() . "][$i]");
                $tpl->setVariable("ID", $this->getFieldId() . "[$i]");
                $tpl->setVariable("UP_BUTTON", $this->symbol()->glyph("up")->render());
                $tpl->setVariable("DOWN_BUTTON", $this->symbol()->glyph("down")->render());
 
                $tpl->parseCurrentBlock();
            }
            $tpl->setCurrentBlock("row");
            $tpl->setVariable("POST_VAR", $this->getPostVar() . "[$i]");
            #$tpl->setVariable('POST_VAR_OPEN',$this->getPostVar().'[open]'.'['.$i.']');
            $tpl->setVariable('POST_VAR_OPEN', $this->getPostVar() . '_open' . '[' . $i . ']');
            $tpl->setVariable('POST_VAR_OPEN_ID', $this->getPostVar() . '_open[' . $i . ']');
            $tpl->setVariable('TXT_OPEN', $lng->txt("form_open_answer"));
 
            if ($this->isOpenAnswerIndex((string) $i)) {
                $tpl->setVariable('PROP_OPEN_CHECKED', 'checked="checked"');
            }
            if ($this->getDisabled()) {
                $tpl->setVariable('PROP_OPEN_DISABLED', 'disabled="disabled"');
            }
 
            $tpl->setVariable("ID", $this->getFieldId() . "[$i]");
            $tpl->setVariable("CMD_ADD", "cmd[add" . $this->getFieldId() . "][$i]");
            $tpl->setVariable("CMD_REMOVE", "cmd[remove" . $this->getFieldId() . "][$i]");
            $tpl->setVariable("SIZE", $this->getSize());
            $tpl->setVariable("MAXLENGTH", $this->getMaxLength());
            if ($this->getDisabled()) {
                $tpl->setVariable(
                    "DISABLED",
                    " disabled=\"disabled\""
                );
            }
            $tpl->setVariable("ADD_BUTTON", $this->symbol()->glyph("add")->render());
            $tpl->setVariable("REMOVE_BUTTON", $this->symbol()->glyph("remove")->render());
            $tpl->parseCurrentBlock();
            $i++;
        }
        $tpl->setVariable("ELEMENT_ID", $this->getFieldId());
 
        $a_tpl->setCurrentBlock("prop_generic");
        $a_tpl->setVariable("PROP_GENERIC", $tpl->get());
        $a_tpl->parseCurrentBlock();
 
        $tpl = $this->tpl;
        $tpl->addJavascript("assets/js/ServiceFormWizardInput.js");
        $tpl->addJavascript("assets/js/textwizard.js");
    }

References ilFormPropertyGUI\$lng, ilTextWizardInputGUI\$tpl, ilTextInputGUI\$value, ILIAS\UICore\GlobalTemplate\get(), ilTextWizardInputGUI\getAllowMove(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), ilTextInputGUI\getMaxLength(), ilFormPropertyGUI\getPostVar(), ilTextInputGUI\getSize(), isOpenAnswerIndex(), ILIAS\UICore\GlobalTemplate\parseCurrentBlock(), ilTemplate\parseCurrentBlock(), ilLegacyFormElementsUtil\prepareFormOutput(), ilTextWizardInputGUI\render(), ilTemplate\setCurrentBlock(), ILIAS\UICore\GlobalTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), ILIAS\UICore\GlobalTemplate\setVariable(), ilFormPropertyGUI\symbol(), and ilLanguage\txt().

Here is the call graph for this function:

◆ isOpenAnswerIndex()

ilSelectBuilderInputGUI::isOpenAnswerIndex ( string $a_idx )

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

                                                    : bool
    {
        return in_array($a_idx, $this->open_answer_indexes);
    }

Referenced by insert().

Here is the caller graph for this function:

◆ setOpenAnswerIndexes()

ilSelectBuilderInputGUI::setOpenAnswerIndexes ( array $a_indexes )

Definition at line 48 of file class.ilSelectBuilderInputGUI.php.

                                                          : void
    {
        $this->open_answer_indexes = $a_indexes;
    }

Referenced by checkInput().

Here is the caller graph for this function:

◆ setValueByArray()

ilSelectBuilderInputGUI::setValueByArray ( array $a_values )

Reimplemented from ilTextInputGUI.

Definition at line 99 of file class.ilSelectBuilderInputGUI.php.

                                                    : void
    {
        parent::setValueByArray($a_values);
 
        foreach ($this->strArray($this->getPostVar() . '_open') as $oindex => $ovalue) {
            $this->addOpenAnswerIndex((string) $oindex);
        }
    }