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

Inheritance diagram for ilHiddenInputGUI:

Collaboration diagram for ilHiddenInputGUI:

Public Member Functions
	__construct (string $a_postvar)

	setValue (string $a_value)

	getValue ()

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

	getInput ()

	setValueByArray (array $a_values)

	insert (ilTemplate $a_tpl)

	getToolbarHTML ()
	Get input item HTML to be inserted into ilToolbarGUI. 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...

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

Protected Attributes
string	$value = ""

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 hidden form property in a property form.

Author: Roland Küstermann (rkues.nosp@m.term.nosp@m.ann@m.nosp@m.ps.d.nosp@m.e)

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

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

Constructor & Destructor Documentation

◆ __construct()

ilHiddenInputGUI::__construct ( string $a_postvar )

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

      {
        parent::__construct("", $a_postvar);
        $this->setType("hidden");
    }

References ILIAS\GlobalScreen\Provider\__construct(), and ilFormPropertyGUI\setType().

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilHiddenInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Reimplemented from ilFormPropertyGUI.

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

                                : bool
    {
        return true;            // please overwrite
    }

◆ getInput()

ilHiddenInputGUI::getInput ( )

Definition at line 53 of file class.ilHiddenInputGUI.php.

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

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

Here is the call graph for this function:

◆ getToolbarHTML()

ilHiddenInputGUI::getToolbarHTML ( )

Get input item HTML to be inserted into ilToolbarGUI.

Implements ilToolbarItem.

Definition at line 73 of file class.ilHiddenInputGUI.php.

                                    : string
    {
        return "<input type=\"hidden\"" .
            " name=\"" . $this->getPostVar() . "\"" .
            " value=\"" . ilLegacyFormElementsUtil::prepareFormOutput($this->getValue()) . "\"" .
            " id=\"" . $this->getFieldId() . "\" />";
    }

References ilFormPropertyGUI\getFieldId(), ilFormPropertyGUI\getPostVar(), getValue(), and ilLegacyFormElementsUtil\prepareFormOutput().

Here is the call graph for this function:

◆ getValue()

ilHiddenInputGUI::getValue ( )

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

                              : string
    {
        return $this->value;
    }

References $value.

Referenced by getToolbarHTML(), and insert().

Here is the caller graph for this function:

◆ insert()

ilHiddenInputGUI::insert ( ilTemplate $a_tpl )

Definition at line 63 of file class.ilHiddenInputGUI.php.

                                             : void
    {
        $a_tpl->setCurrentBlock("hidden");
        $a_tpl->setVariable('PROP_INPUT_TYPE', 'hidden');
        $a_tpl->setVariable("POST_VAR", $this->getPostVar());
        $a_tpl->setVariable("ID", $this->getFieldId());
        $a_tpl->setVariable("PROPERTY_VALUE", ilLegacyFormElementsUtil::prepareFormOutput($this->getValue()));
        $a_tpl->parseCurrentBlock();
    }

References ilFormPropertyGUI\getFieldId(), ilFormPropertyGUI\getPostVar(), getValue(), ilTemplate\parseCurrentBlock(), ilLegacyFormElementsUtil\prepareFormOutput(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Here is the call graph for this function:

◆ setValue()

ilHiddenInputGUI::setValue ( string $a_value )

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

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

Referenced by setValueByArray().

Here is the caller graph for this function:

◆ setValueByArray()

ilHiddenInputGUI::setValueByArray ( array $a_values )

Definition at line 58 of file class.ilHiddenInputGUI.php.

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

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

Here is the call graph for this function:

Field Documentation

◆ $value

string ilHiddenInputGUI::$value = ""

protected

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

Referenced by getValue().

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ getInput()

◆ getToolbarHTML()

◆ getValue()

◆ insert()

◆ setValue()

◆ setValueByArray()

Field Documentation

◆ $value