This class represents a text property in a property form. More...

Inheritance diagram for ilTextInputGUI:

Collaboration diagram for ilTextInputGUI:

Public Member Functions
	__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
	$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

This class represents a text 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.ilTextInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented from ilFormPropertyGUI.

Reimplemented in ilColorPickerInputGUI, ilFormulaInputGUI, ilRegExpInputGUI, ilSelectBuilderInputGUI, ilTextWizardInputGUI, ilUriInputGUI, ilTRBLColorPickerInputGUI, ilCategoryWizardInputGUI, and ilMatrixRowWizardInputGUI.

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilTextInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Reimplemented from ilFormPropertyGUI.

Reimplemented in ilDclTextInputGUI, ilColorPickerInputGUI, ilFormulaInputGUI, ilRegExpInputGUI, ilSelectBuilderInputGUI, ilTextWizardInputGUI, ilUriInputGUI, ilLuceneQueryInputGUI, ilTRBLColorPickerInputGUI, ilCategoryWizardInputGUI, ilMatrixRowWizardInputGUI, ilAnswerWizardInputGUI, ilErrorTextWizardInputGUI, ilEssayKeywordWizardInputGUI, ilKprimChoiceWizardInputGUI, ilMatchingPairWizardInputGUI, ilMatchingWizardInputGUI, ilMultipleChoiceWizardInputGUI, ilSingleChoiceWizardInputGUI, ilAssAnswerCorrectionsInputGUI, ilAssClozeTestCombinationVariantsInputGUI, ilAssErrorTextCorrectionsInputGUI, ilAssLongmenuCorrectionsInputGUI, ilAssMatchingPairCorrectionsInputGUI, ilAssMultipleChoiceCorrectionsInputGUI, ilAssSingleChoiceCorrectionsInputGUI, ilIdentifiedMultiValuesInputGUI, and ilKprimChoiceCorrectionsInputGUI.

Definition at line 180 of file class.ilTextInputGUI.php.

                                : bool
    {
        $lng = $this->lng;
 
        if (!$this->getMulti()) {
            if ($this->getRequired() && trim($this->str($this->getPostVar())) == "") {
                $this->setAlert($lng->txt("msg_input_is_required"));
                return false;
            } elseif (strlen($this->getValidationRegexp())) {
                if (!preg_match($this->getValidationRegexp(), $this->str($this->getPostVar()))) {
                    $this->setAlert(
                        $this->getValidationFailureMessage() ?:
                            $lng->txt('msg_wrong_format')
                    );
                    return false;
                }
            }
        } else {
            if ($this->getRequired() &&
                !trim(implode("", $this->strArray($this->getPostVar())))) {
                $this->setAlert($lng->txt("msg_input_is_required"));
                return false;
            } elseif (strlen($this->getValidationRegexp())) {
                $reg_valid = true;
                foreach ($this->strArray($this->getPostVar()) as $value) {
                    if (!preg_match($this->getValidationRegexp(), $value)) {
                        $reg_valid = false;
                        break;
                    }
                }
                if (!$reg_valid) {
                    $this->setAlert(
                        $this->getValidationFailureMessage() ?:
                            $lng->txt('msg_wrong_format')
                    );
                    return false;
                }
            }
        }
 
        return $this->checkSubItemsInput();
    }

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

Here is the call graph for this function:

◆ getCssClass()

ilTextInputGUI::getCssClass ( )

Definition at line 131 of file class.ilTextInputGUI.php.

                                 : string
    {
        return $this->css_class;
    }

References $css_class.

◆ getDataSource()

ilTextInputGUI::getDataSource ( )

Definition at line 234 of file class.ilTextInputGUI.php.

                                   : string
    {
        return $this->ajax_datasource;
    }

References $ajax_datasource.

◆ getDataSourceSubmitOnSelection()

ilTextInputGUI::getDataSourceSubmitOnSelection ( )

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

                                                    : bool
    {
        return $this->ajax_datasource_commit;
    }

◆ getDataSourceSubmitUrl()

ilTextInputGUI::getDataSourceSubmitUrl ( )

Definition at line 262 of file class.ilTextInputGUI.php.

                                            : string
    {
        return $this->ajax_datasource_commit_url;
    }

◆ getInlineStyle()

ilTextInputGUI::getInlineStyle ( )

Definition at line 121 of file class.ilTextInputGUI.php.

                                    : string
    {
        return $this->style_css;
    }

References $style_css.

◆ getInput()

ilTextInputGUI::getInput ( )

Returns: string|string[]

Reimplemented in ilColorPickerInputGUI, ilFormulaInputGUI, ilRegExpInputGUI, ilSelectBuilderInputGUI, ilTextWizardInputGUI, ilTRBLColorPickerInputGUI, ilCategoryWizardInputGUI, ilMatrixRowWizardInputGUI, ilLogicalAnswerComparisonExpressionInputGUI, and ilIdentifiedMultiValuesInputGUI.

Definition at line 226 of file class.ilTextInputGUI.php.

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

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

Referenced by ilUriInputGUI\checkInput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInputType()

ilTextInputGUI::getInputType ( )

Definition at line 165 of file class.ilTextInputGUI.php.

                                  : string
    {
        return $this->input_type;
    }

References $input_type.

◆ getMaxLength()

ilTextInputGUI::getMaxLength ( )

Definition at line 106 of file class.ilTextInputGUI.php.

                                  : ?int
    {
        return $this->maxlength;
    }

References $maxlength.

Referenced by ilSingleChoiceWizardInputGUI\checkAnswersInput(), ilTextWizardInputGUI\checkInput(), ilSelectBuilderInputGUI\insert(), ilMatrixRowWizardInputGUI\insert(), ilAnswerWizardInputGUI\insert(), ilEssayKeywordWizardInputGUI\insert(), ilKprimChoiceWizardInputGUI\insert(), ilMatchingWizardInputGUI\insert(), ilMultipleChoiceWizardInputGUI\insert(), ilSingleChoiceWizardInputGUI\insert(), ilTextWizardInputGUI\render(), and ilMultipleTextsInputGUI\render().

Here is the caller graph for this function:

◆ getPostValueForComparison()

ilTextInputGUI::getPostValueForComparison ( )

Definition at line 447 of file class.ilTextInputGUI.php.

                                               : string
    {
        return $this->getInput();
    }

◆ getSize()

ilTextInputGUI::getSize ( )

Definition at line 141 of file class.ilTextInputGUI.php.

                             : int
    {
        return $this->size;
    }

References $size.

Referenced by ilSelectBuilderInputGUI\insert(), ilMatrixRowWizardInputGUI\insert(), ilAnswerWizardInputGUI\insert(), ilEssayKeywordWizardInputGUI\insert(), ilKprimChoiceWizardInputGUI\insert(), ilMatchingWizardInputGUI\insert(), ilMultipleChoiceWizardInputGUI\insert(), ilSingleChoiceWizardInputGUI\insert(), ilTextWizardInputGUI\render(), and ilMultipleTextsInputGUI\render().

Here is the caller graph for this function:

◆ getSubmitFormOnEnter()

ilTextInputGUI::getSubmitFormOnEnter ( )

Definition at line 175 of file class.ilTextInputGUI.php.

                                          : bool
    {
        return $this->submit_form_on_enter;
    }

References $submit_form_on_enter.

◆ getSuffix()

ilTextInputGUI::getSuffix ( )

Definition at line 151 of file class.ilTextInputGUI.php.

                               : string
    {
        return $this->suffix;
    }

References $suffix.

◆ getTableFilterHTML()

ilTextInputGUI::getTableFilterHTML ( )

Get input item HTML to be inserted into table filters.

Implements ilTableFilterItem.

Definition at line 425 of file class.ilTextInputGUI.php.

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

◆ getToolbarHTML()

ilTextInputGUI::getToolbarHTML ( )

Get input item HTML to be inserted into ilToolbarGUI.

Implements ilToolbarItem.

Definition at line 431 of file class.ilTextInputGUI.php.

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

◆ getValidationFailureMessage()

ilTextInputGUI::getValidationFailureMessage ( )

Definition at line 86 of file class.ilTextInputGUI.php.

                                                 : string
    {
        return $this->validationFailureMessage;
    }

References $validationFailureMessage.

Referenced by checkInput().

Here is the caller graph for this function:

◆ getValidationRegexp()

ilTextInputGUI::getValidationRegexp ( )

Definition at line 96 of file class.ilTextInputGUI.php.

                                         : string
    {
        return $this->validationRegexp;
    }

References $validationRegexp.

Referenced by ilSelectBuilderInputGUI\checkInput(), checkInput(), ilTextWizardInputGUI\checkInput(), and ilMultipleTextsInputGUI\onCheckInput().

Here is the caller graph for this function:

◆ getValue()

ilTextInputGUI::getValue ( )

Returns: array|string

Reimplemented in ilIdentifiedMultiValuesInputGUI.

Definition at line 76 of file class.ilTextInputGUI.php.

    {
        return $this->value;
    }

References $value.

Referenced by ilColorPickerInputGUI\insert(), and ilTRBLColorPickerInputGUI\insert().

Here is the caller graph for this function:

◆ insert()

ilTextInputGUI::insert ( ilTemplate $a_tpl )

Reimplemented in ilColorPickerInputGUI, ilSelectBuilderInputGUI, ilTextWizardInputGUI, ilTRBLColorPickerInputGUI, ilCategoryWizardInputGUI, ilMatrixRowWizardInputGUI, ilAnswerWizardInputGUI, ilErrorTextWizardInputGUI, ilEssayKeywordWizardInputGUI, ilKprimChoiceWizardInputGUI, ilMatchingPairWizardInputGUI, ilMatchingWizardInputGUI, ilMultipleChoiceWizardInputGUI, ilSingleChoiceWizardInputGUI, ilAssAnswerCorrectionsInputGUI, ilAssClozeTestCombinationVariantsInputGUI, ilAssErrorTextCorrectionsInputGUI, ilAssLongmenuCorrectionsInputGUI, ilAssMatchingPairCorrectionsInputGUI, ilAssMultipleChoiceCorrectionsInputGUI, and ilAssSingleChoiceCorrectionsInputGUI.

Definition at line 416 of file class.ilTextInputGUI.php.

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

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

Here is the call graph for this function:

◆ isHtmlAutoCompleteDisabled()

ilTextInputGUI::isHtmlAutoCompleteDisabled ( )

Definition at line 442 of file class.ilTextInputGUI.php.

                                                : bool
    {
        return $this->autocomplete_disabled;
    }

◆ render()

ilTextInputGUI::render ( string $a_mode = "" )

Reimplemented in ilTextWizardInputGUI, ilMultipleImagesInputGUI, ilMultipleTextsInputGUI, and ilAssNestedOrderingElementsInputGUI.

Definition at line 278 of file class.ilTextInputGUI.php.

                                               : string
    {
        $lng = $this->lng;
 
        $tpl = new ilTemplate("tpl.prop_textinput.html", true, true, "components/ILIAS/Form");
        if (strlen((string) $this->getValue())) {
            $tpl->setCurrentBlock("prop_text_propval");
            $tpl->setVariable(
                "PROPERTY_VALUE",
                ilLegacyFormElementsUtil::prepareFormOutput((string) $this->getValue())
            );
            $tpl->parseCurrentBlock();
        }
        if (strlen($this->getInlineStyle())) {
            $tpl->setCurrentBlock("stylecss");
            $tpl->setVariable(
                "CSS_STYLE",
                ilLegacyFormElementsUtil::prepareFormOutput((string) $this->getInlineStyle())
            );
            $tpl->parseCurrentBlock();
        }
        if (strlen($this->getCssClass())) {
            $tpl->setCurrentBlock("classcss");
            $tpl->setVariable('CLASS_CSS', ilLegacyFormElementsUtil::prepareFormOutput((string) $this->getCssClass()));
            $tpl->parseCurrentBlock();
        }
        if ($this->getSubmitFormOnEnter()) {
            $tpl->touchBlock("submit_form_on_enter");
        }
 
        switch ($this->getInputType()) {
            case 'password':
                $tpl->setVariable('PROP_INPUT_TYPE', 'password');
                break;
            case 'hidden':
                $tpl->setVariable('PROP_INPUT_TYPE', 'hidden');
                break;
            case 'text':
            default:
                $tpl->setVariable('PROP_INPUT_TYPE', 'text');
        }
        $tpl->setVariable("ID", $this->getFieldId());
        $tpl->setVariable("SIZE", $this->getSize());
        if ($this->getMaxLength() != null) {
            $tpl->setVariable("MAXLENGTH", $this->getMaxLength());
        }
        if (strlen($this->getSuffix())) {
            $tpl->setVariable("INPUT_SUFFIX", $this->getSuffix());
        }
 
        $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, $this->getValue());
            }
            if ($hidden) {
                $tpl->setVariable("HIDDEN_INPUT", $hidden);
            }
            $tpl->setVariable("DISABLED", " disabled=\"disabled\"");
        }
 
        // use autocomplete feature?
        if ($this->getDataSource()) {
            $tpl->setVariable('AUTOCOMPLETE', 'autocomplete="off"');
            $this->global_tpl->addJavaScript('assets/js/legacyAutocomplete.js', true, 3);
            $config = json_encode([
                'delimiter' => $this->ajax_datasource_delimiter,
                'dataSource' => $this->ajax_datasource,
                'submitOnSelection' => $this->ajax_datasource_commit,
                'submitUrl' => $this->ajax_datasource_commit_url,
                'autocompleteLength' => 3,
                'moreText' => $this->lng->txt('autocomplete_more')
            ]);
 
            if ($this->multi) {
                $sel_auto = '[id^="' . $this->getFieldId() . '"]';
            } else {
                // use id for autocomplete selector
                $sel_auto = "#" . $this->getFieldId();
            }
 
            $this->global_tpl->addOnLoadCode(
                "il.LegacyForm.autocomplete.init(document.querySelector(`{$sel_auto}`), {$config});"
            );
            if ($this->multi) {
                $this->global_tpl->addOnLoadCode(
                    "ilMultiFormValues.addAutocomplete(`" . $this->getFieldId() . "`, " . $config . ");"
                );
            }
        }
 
        if ($a_mode == "toolbar") {
            // block-inline hack, see: http://blog.mozilla.com/webdev/2009/02/20/cross-browser-inline-block/
            // -moz-inline-stack for FF2
            // zoom 1; *display:inline for IE6 & 7
            $tpl->setVariable(
                "STYLE_PAR",
                'display: -moz-inline-stack; display:inline-block; zoom: 1; *display:inline;'
            );
        } else {
            $tpl->setVariable("STYLE_PAR", '');
        }
 
        if ($this->isHtmlAutoCompleteDisabled()) {
            $tpl->setVariable("AUTOCOMPLETE", "autocomplete=\"off\"");
        }
 
        if ($this->getRequired()) {
            $tpl->setVariable("REQUIRED", "required=\"required\"");
        }
 
        // 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()));
        if ($this->getInfo() !== '') {
            $tpl->setVariable('DESCRIBED_BY_FIELD_ID', $this->getFieldId());
        }
 
        return $tpl->get();
    }

References $lng, ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle(), ILIAS\UI\Implementation\Component\Input\getValue(), ILIAS\Repository\lng(), and ilLegacyFormElementsUtil\prepareFormOutput().

Referenced by ilAssLongmenuCorrectionsInputGUI\insert().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCssClass()

ilTextInputGUI::setCssClass ( string $a_class )

Definition at line 126 of file class.ilTextInputGUI.php.

                                                : void
    {
        $this->css_class = $a_class;
    }

◆ setDataSource()

ilTextInputGUI::setDataSource	(	string	$href,
		?string	$a_delimiter = `null`
	)

Definition at line 239 of file class.ilTextInputGUI.php.

     : void {
        $this->ajax_datasource = $href;
        $this->ajax_datasource_delimiter = $a_delimiter;
    }

Referenced by ilRoleAutoCompleteInputGUI\__construct(), and ILIAS\LegalDocuments\Table\HistoryTable\userName().

Here is the caller graph for this function:

◆ setDataSourceSubmitOnSelection()

ilTextInputGUI::setDataSourceSubmitOnSelection ( bool $a_stat )

Definition at line 247 of file class.ilTextInputGUI.php.

                                                                : void
    {
        $this->ajax_datasource_commit = $a_stat;
    }

◆ setDataSourceSubmitUrl()

ilTextInputGUI::setDataSourceSubmitUrl ( string $a_url )

Definition at line 257 of file class.ilTextInputGUI.php.

                                                         : void
    {
        $this->ajax_datasource_commit_url = $a_url;
    }

◆ setDisableHtmlAutoComplete()

ilTextInputGUI::setDisableHtmlAutoComplete ( bool $autocomplete )

Definition at line 437 of file class.ilTextInputGUI.php.

                                                                  : void
    {
        $this->autocomplete_disabled = $autocomplete;
    }

◆ setInlineStyle()

ilTextInputGUI::setInlineStyle ( string $a_style )

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

                                                   : void
    {
        $this->style_css = $a_style;
    }

◆ setInputType()

ilTextInputGUI::setInputType ( string $a_type )

set input type

Parameters

string $a_type input type password | text

Definition at line 160 of file class.ilTextInputGUI.php.

                                                : void
    {
        $this->input_type = $a_type;
    }

Referenced by ilRoleAutoCompleteInputGUI\__construct(), and __construct().

Here is the caller graph for this function:

◆ setMaxLength()

ilTextInputGUI::setMaxLength ( ?int $a_maxlength )

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

                                                   : void
    {
        $this->maxlength = $a_maxlength;
    }

Referenced by ilMatchingWizardInputGUI\__construct(), ilSingleChoiceWizardInputGUI\__construct(), ilRoleAutoCompleteInputGUI\__construct(), ilCategoryWizardInputGUI\__construct(), and ilMatrixRowWizardInputGUI\__construct().

Here is the caller graph for this function:

◆ setMultiValues()

ilTextInputGUI::setMultiValues ( array $a_values )

Reimplemented from ilFormPropertyGUI.

Reimplemented in ilIdentifiedMultiValuesInputGUI.

Definition at line 267 of file class.ilTextInputGUI.php.

                                                   : void
    {
        foreach ($a_values as $idx => $value) {
            $a_values[$idx] = trim($value);
            if ($a_values[$idx] == "") {
                unset($a_values[$idx]);
            }
        }
        parent::setMultiValues($a_values);
    }

Referenced by setValue().

Here is the caller graph for this function:

◆ setSize()

ilTextInputGUI::setSize ( int $a_size )

Definition at line 111 of file class.ilTextInputGUI.php.

                                        : void
    {
        $this->size = $a_size;
    }

Referenced by ilAnswerWizardInputGUI\__construct(), ilMatchingWizardInputGUI\__construct(), ilMultipleImagesInputGUI\__construct(), ilSingleChoiceWizardInputGUI\__construct(), and ilRoleAutoCompleteInputGUI\__construct().

Here is the caller graph for this function:

◆ setSubmitFormOnEnter()

ilTextInputGUI::setSubmitFormOnEnter ( bool $a_val )

Definition at line 170 of file class.ilTextInputGUI.php.

                                                     : void
    {
        $this->submit_form_on_enter = $a_val;
    }

◆ setSuffix()

ilTextInputGUI::setSuffix ( string $a_value )

Definition at line 146 of file class.ilTextInputGUI.php.

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

◆ setValidationFailureMessage()

ilTextInputGUI::setValidationFailureMessage ( string $a_msg )

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

                                                              : void
    {
        $this->validationFailureMessage = $a_msg;
    }

◆ setValidationRegexp()

ilTextInputGUI::setValidationRegexp ( string $a_value )

Definition at line 91 of file class.ilTextInputGUI.php.

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

◆ setValue()

ilTextInputGUI::setValue ( $a_value )

Parameters

string | array $a_value

Reimplemented in ilColorPickerInputGUI, ilFormulaInputGUI, ilTextWizardInputGUI, ilCategoryWizardInputGUI, ilMatrixRowWizardInputGUI, ilAnswerWizardInputGUI, ilErrorTextWizardInputGUI, ilEssayKeywordWizardInputGUI, ilKprimChoiceWizardInputGUI, ilMatchingPairWizardInputGUI, ilMatchingWizardInputGUI, ilMultipleChoiceWizardInputGUI, ilSingleChoiceWizardInputGUI, ilAssAnswerCorrectionsInputGUI, ilAssClozeTestCombinationVariantsInputGUI, ilAssErrorTextCorrectionsInputGUI, ilAssMatchingPairCorrectionsInputGUI, ilAssMultipleChoiceCorrectionsInputGUI, ilAssSingleChoiceCorrectionsInputGUI, ilKprimChoiceCorrectionsInputGUI, and ilIdentifiedMultiValuesInputGUI.

Definition at line 64 of file class.ilTextInputGUI.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 setMultiValues().

Referenced by setValueByArray().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setValueByArray()

ilTextInputGUI::setValueByArray ( array $a_values )

Reimplemented in ilDclTextInputGUI, ilColorPickerInputGUI, ilSelectBuilderInputGUI, ilSingleChoiceWizardInputGUI, and ilIdentifiedMultiValuesInputGUI.

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

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

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

Here is the call graph for this function:

Field Documentation

◆ $ajax_datasource

string ilTextInputGUI::$ajax_datasource = ""

protected

Definition at line 40 of file class.ilTextInputGUI.php.

Referenced by getDataSource().

◆ $ajax_datasource_commit

bool ilTextInputGUI::$ajax_datasource_commit = false

protected

Definition at line 42 of file class.ilTextInputGUI.php.

◆ $ajax_datasource_commit_url

string ilTextInputGUI::$ajax_datasource_commit_url = ""

protected

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

◆ $ajax_datasource_delimiter

string ilTextInputGUI::$ajax_datasource_delimiter = null

protected

Definition at line 41 of file class.ilTextInputGUI.php.

◆ $autocomplete_disabled

bool ilTextInputGUI::$autocomplete_disabled = false

protected

Definition at line 46 of file class.ilTextInputGUI.php.

◆ $css_class

string ilTextInputGUI::$css_class = ""

protected

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

Referenced by getCssClass().

◆ $input_type

string ilTextInputGUI::$input_type = ""

protected

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

Referenced by getInputType().

◆ $maxlength

int ilTextInputGUI::$maxlength = 200

protected

Definition at line 33 of file class.ilTextInputGUI.php.

Referenced by getMaxLength().

◆ $size

int ilTextInputGUI::$size = 40

protected

Definition at line 34 of file class.ilTextInputGUI.php.

Referenced by getSize().

◆ $style_css

string ilTextInputGUI::$style_css = ""

protected

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

Referenced by getInlineStyle().

◆ $submit_form_on_enter

bool ilTextInputGUI::$submit_form_on_enter = false

protected

Definition at line 44 of file class.ilTextInputGUI.php.

Referenced by getSubmitFormOnEnter().

◆ $suffix

string ilTextInputGUI::$suffix = ""

protected

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

Referenced by ilMatchingWizardInputGUI\checkInput(), ilMultipleChoiceWizardInputGUI\checkInput(), ilSingleChoiceWizardInputGUI\checkInput(), ilKprimChoiceWizardInputGUI\checkUploads(), getSuffix(), ilKprimChoiceWizardInputGUI\insert(), ilMatchingWizardInputGUI\insert(), ilMultipleChoiceWizardInputGUI\insert(), ilSingleChoiceWizardInputGUI\insert(), ilMultipleImagesInputGUI\onCheckInput(), and ilMultipleImagesInputGUI\render().

◆ $validationFailureMessage

string ilTextInputGUI::$validationFailureMessage = ''

protected

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

Referenced by getValidationFailureMessage().

◆ $validationRegexp

string ilTextInputGUI::$validationRegexp = ""

protected

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

Referenced by getValidationRegexp().

◆ $value

ilTextInputGUI::$value = null

protected

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

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ getCssClass()

◆ getDataSource()

◆ getDataSourceSubmitOnSelection()

◆ getDataSourceSubmitUrl()

◆ getInlineStyle()

◆ getInput()

◆ getInputType()

◆ getMaxLength()

◆ getPostValueForComparison()

◆ getSize()

◆ getSubmitFormOnEnter()

◆ getSuffix()

◆ getTableFilterHTML()

◆ getToolbarHTML()

◆ getValidationFailureMessage()

◆ getValidationRegexp()

◆ getValue()

◆ insert()

◆ isHtmlAutoCompleteDisabled()

◆ render()

◆ setCssClass()

◆ setDataSource()

◆ setDataSourceSubmitOnSelection()

◆ setDataSourceSubmitUrl()

◆ setDisableHtmlAutoComplete()

◆ setInlineStyle()

◆ setInputType()

◆ setMaxLength()

◆ setMultiValues()

◆ setSize()

◆ setSubmitFormOnEnter()

◆ setSuffix()

◆ setValidationFailureMessage()

◆ setValidationRegexp()

◆ setValue()

◆ setValueByArray()

Field Documentation

◆ $ajax_datasource

◆ $ajax_datasource_commit

◆ $ajax_datasource_commit_url

◆ $ajax_datasource_delimiter

◆ $autocomplete_disabled

◆ $css_class

◆ $input_type

◆ $maxlength

◆ $size

◆ $style_css

◆ $submit_form_on_enter

◆ $suffix

◆ $validationFailureMessage

◆ $validationRegexp

◆ $value