This class represents a non editable value in a property form. More...

Inheritance diagram for ilNonEditableValueGUI:

Collaboration diagram for ilNonEditableValueGUI:

Public Member Functions
	__construct (string $a_title="", string $a_id="", bool $a_disable_escaping=false)

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

	getInput ()

	getType ()

	setTitle (string $a_title)

	getTitle ()

	setInfo (string $a_info)

	getInfo ()

	setValue ($a_value)

	getValue ()

	render ()

	insert (ilTemplate $a_tpl)

	setValueByArray (array $a_values)

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

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

Protected Member Functions
	setType (string $a_type)

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)

Protected Attributes
	$value = null

string	$section_icon = ""

bool	$disable_escaping = 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...

Detailed Description

This class represents a non editable value 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.ilNonEditableValueGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilNonEditableValueGUI::__construct	(	string	$a_title = `""`,
		string	$a_id = `""`,
		bool	$a_disable_escaping = `false`
	)

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

      {
        parent::__construct($a_title, $a_id);
        $this->setTitle($a_title);
        $this->setType("non_editable_value");
        $this->disable_escaping = $a_disable_escaping;
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilNonEditableValueGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Reimplemented from ilFormPropertyGUI.

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

                                : bool
    {
        return $this->checkSubItemsInput();
    }

References ilSubEnabledFormPropertyGUI\checkSubItemsInput().

Here is the call graph for this function:

◆ getInfo()

ilNonEditableValueGUI::getInfo ( )

Reimplemented from ilFormPropertyGUI.

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

                             : string
    {
        return $this->info;
    }

References ilFormPropertyGUI\$info.

◆ getInput()

ilNonEditableValueGUI::getInput ( )

Returns: array|string

Definition at line 55 of file class.ilNonEditableValueGUI.php.

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

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

Here is the call graph for this function:

◆ getTableFilterHTML()

ilNonEditableValueGUI::getTableFilterHTML ( )

Get input item HTML to be inserted into table filters.

Implements ilTableFilterItem.

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

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

References render().

Here is the call graph for this function:

◆ getTitle()

ilNonEditableValueGUI::getTitle ( )

Reimplemented from ilFormPropertyGUI.

Definition at line 78 of file class.ilNonEditableValueGUI.php.

                              : string
    {
        return $this->title;
    }

References ilFormPropertyGUI\$title.

◆ getType()

ilNonEditableValueGUI::getType ( )

Reimplemented from ilFormPropertyGUI.

Definition at line 68 of file class.ilNonEditableValueGUI.php.

                             : string
    {
        return $this->type;
    }

References ilFormPropertyGUI\$type.

◆ getValue()

ilNonEditableValueGUI::getValue ( )

Returns: string|array

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

    {
        return $this->value;
    }

References $value.

Referenced by render().

Here is the caller graph for this function:

◆ insert()

ilNonEditableValueGUI::insert ( ilTemplate $a_tpl )

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

ilNonEditableValueGUI::render ( )

Definition at line 113 of file class.ilNonEditableValueGUI.php.

                            : string
    {
        $postvar = "";
 
        $tpl = new ilTemplate("tpl.non_editable_value.html", true, true, "components/ILIAS/Form");
        if ($this->getPostVar() != "") {
            $postvar = $this->getPostVar();
            if ($this->getMulti() && substr($postvar, -2) != "[]") {
                $postvar .= "[]";
            }
 
            $tpl->setCurrentBlock("hidden");
            $tpl->setVariable('NON_EDITABLE_ID', $postvar);
            $tpl->setVariable('MULTI_HIDDEN_ID', $this->getFieldId());
            $tpl->setVariable("HVALUE", ilLegacyFormElementsUtil::prepareFormOutput((string) $this->getValue()));
            $tpl->parseCurrentBlock();
        }
        $value = $this->getValue();
        if (!$this->disable_escaping) {
            $value = ilLegacyFormElementsUtil::prepareFormOutput((string) $value);
        }
        $tpl->setVariable("VALUE", $value);
        if ($this->getFieldId() != "") {
            $tpl->setVariable("ID", ' id="' . $this->getFieldId() . '" ');
        }
        $tpl->parseCurrentBlock();
 
        if ($this->getMulti() && $postvar != "" && !$this->getDisabled()) {
            $tpl->setVariable("MULTI_ICONS", $this->getMultiIconsHTML());
        }
 
 
        return $tpl->get();
    }

References ilFormPropertyGUI\$postvar, $value, ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), ilFormPropertyGUI\getMulti(), ilFormPropertyGUI\getMultiIconsHTML(), ilFormPropertyGUI\getPostVar(), getValue(), and ilLegacyFormElementsUtil\prepareFormOutput().

Referenced by getTableFilterHTML(), and insert().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setInfo()

ilNonEditableValueGUI::setInfo ( string $a_info )

Reimplemented from ilFormPropertyGUI.

Definition at line 83 of file class.ilNonEditableValueGUI.php.

                                           : void
    {
        $this->info = $a_info;
    }

References ILIAS\UI\examples\MessageBox\Info\info().

Here is the call graph for this function:

◆ setTitle()

ilNonEditableValueGUI::setTitle ( string $a_title )

Reimplemented from ilFormPropertyGUI.

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

                                             : void
    {
        $this->title = $a_title;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setType()

ilNonEditableValueGUI::setType ( string $a_type )

protected

Reimplemented from ilFormPropertyGUI.

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

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

Referenced by __construct().

Here is the caller graph for this function:

◆ setValue()

ilNonEditableValueGUI::setValue ( $a_value )

Parameters

string | array $a_value

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

ilNonEditableValueGUI::setValueByArray ( array $a_values )

Definition at line 155 of file class.ilNonEditableValueGUI.php.

                                                    : void
    {
        if ($this->getPostVar() && isset($a_values[$this->getPostVar()])) {
            $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

◆ $disable_escaping

bool ilNonEditableValueGUI::$disable_escaping = false

protected

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

◆ $section_icon

string ilNonEditableValueGUI::$section_icon = ""

protected

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

◆ $value

ilNonEditableValueGUI::$value = null

protected

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

Referenced by getValue(), and render().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ getInfo()

◆ getInput()

◆ getTableFilterHTML()

◆ getTitle()

◆ getType()

◆ getValue()

◆ insert()

◆ render()

◆ setInfo()

◆ setTitle()

◆ setType()

◆ setValue()

◆ setValueByArray()

Field Documentation

◆ $disable_escaping

◆ $section_icon

◆ $value