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

Inheritance diagram for ilFormPropertyGUI:

Collaboration diagram for ilFormPropertyGUI:

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

Static Public Member Functions
static	removeProhibitedCharacters (string $a_text)
	Remove prohibited characters see #19159. More...

Protected Member Functions
	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
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

Detailed Description

This class represents a property in a property form.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented in ilRecurrenceInputGUI, ilGloAdvColSortInputGUI, ilScheduleInputGUI, ilDclGenericMultiInputGUI, ilOrgUnitGenericMultiInputGUI, ilOrgUnitMultiLineInputGUI, ilCategoryWizardInputGUI, ilMatrixRowWizardInputGUI, ilClozeGapInputBuilderGUI, ilAdvSelectInputGUI, ilAlphabetInputGUI, ilCheckboxGroupInputGUI, ilCheckboxInputGUI, ilColorPickerInputGUI, ilCombinationInputGUI, ilCountrySelectInputGUI, ilCustomInputGUI, ilDateDurationInputGUI, ilDateTimeInputGUI, ilDurationInputGUI, ilEMailInputGUI, ilFileInputGUI, ilFileWizardInputGUI, ilFormulaInputGUI, ilImageFileInputGUI, ilLinkInputGUI, ilLocationInputGUI, ilMultiSelectInputGUI, ilNestedListInputGUI, ilNumberInputGUI, ilPasswordInputGUI, ilRadioGroupInputGUI, ilRegExpInputGUI, ilRepositorySelectorInputGUI, ilSelectBuilderInputGUI, ilSelectInputGUI, ilTextAreaInputGUI, ilTextInputGUI, ilTextWizardInputGUI, ilUriInputGUI, ilUserLoginInputGUI, ilWidthHeightInputGUI, ilTypicalLearningTimeInputGUI, ilBackgroundImageInputGUI, ilBackgroundPositionInputGUI, ilFontSizeInputGUI, ilNumericStyleValueInputGUI, ilTRBLBorderStyleInputGUI, ilTRBLBorderWidthInputGUI, ilTRBLColorPickerInputGUI, ilTRBLNumericStyleValueInputGUI, ilCharSelectorRadioGroupInputGUI, and ilManualPlaceholderInputGUI.

Definition at line 56 of file class.ilFormPropertyGUI.php.

      {
        global $DIC;
 
        if (isset($DIC["http"])) {
            $this->http = $DIC->http();
        }
 
        if (isset($DIC["refinery"])) {
            $this->refinery = $DIC->refinery();
        }
 
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->setTitle($a_title);
        $this->setPostVar($a_postvar);
        $this->setDisabled(false);
        if (isset($DIC["http"])) {      // some unit tests will fail otherwise
            $this->request = $DIC->http()->request();
        }
        if (isset($DIC["tpl"])) {      // some unit tests will fail otherwise
            $this->global_tpl = $DIC['tpl'];
        }
    }

References $DIC, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), setDisabled(), setPostVar(), and setTitle().

Here is the call graph for this function:

Member Function Documentation

◆ arrayArray()

ilFormPropertyGUI::arrayArray ( $key )

protected

Definition at line 518 of file class.ilFormPropertyGUI.php.

                                       : array
    {
        if (!$this->isRequestParamArray($key)) {
            return [];
        }
        $t = $this->refinery->custom()->transformation(
            function ($arr) {
                // keep keys(!), transform all values to string
                return array_column(
                    array_map(
                        function ($k, $v) {
                            return [$k, (array) $v];
                        },
                        array_keys($arr),
                        $arr
                    ),
                    1,
                    0
                );
            }
        );
        return (array) ($this->getRequestParam($key, $t) ?? []);
    }

References ILIAS\LTI\ToolProvider\$key, and ILIAS\Repository\refinery().

Referenced by ilGloAdvColSortInputGUI\getInput(), ilCategoryWizardInputGUI\getInput(), ilMatrixRowWizardInputGUI\getInput(), ilIdentifiedMultiValuesInputGUI\getInput(), ilBackgroundPositionInputGUI\getInput(), ilTRBLBorderStyleInputGUI\getInput(), ilTRBLBorderWidthInputGUI\getInput(), ilTRBLColorPickerInputGUI\getInput(), ilTRBLNumericStyleValueInputGUI\getInput(), and ilImagemapFileInputGUI\getPostBody().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkInput()

ilFormPropertyGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Reimplemented in ilScheduleInputGUI, ilChatroomAuthInputGUI, ilChatroomSmiliesCurrentSmileyFormElement, ilDclCheckboxInputGUI, ilDclGenericMultiInputGUI, ilDclTextInputGUI, ilGloAdvColSortInputGUI, ilOrgUnitGenericMultiInputGUI, ilOrgUnitMultiLineInputGUI, ilCategoryWizardInputGUI, ilMatrixRowWizardInputGUI, ilRandomTestROInputGUI, ilAnswerWizardInputGUI, ilErrorTextWizardInputGUI, ilEssayKeywordWizardInputGUI, ilImageWizardInputGUI, ilKprimChoiceWizardInputGUI, ilKVPWizardInputGUI, ilMatchingPairWizardInputGUI, ilMatchingWizardInputGUI, ilMultipleChoiceWizardInputGUI, ilSingleChoiceWizardInputGUI, ilSolutionTitleInputGUI, ilSuggestedSolutionSelectorGUI, ilClozeGapInputBuilderGUI, ilAssAnswerCorrectionsInputGUI, ilAssClozeTestCombinationVariantsInputGUI, ilAssErrorTextCorrectionsInputGUI, ilAssLongmenuCorrectionsInputGUI, ilAssMatchingPairCorrectionsInputGUI, ilAssMultipleChoiceCorrectionsInputGUI, ilAssSingleChoiceCorrectionsInputGUI, ilIdentifiedMultiValuesInputGUI, ilImagemapCorrectionsInputGUI, ilImagemapFileInputGUI, ilKprimChoiceCorrectionsInputGUI, ilTagInputGUI, ilRecurrenceInputGUI, ilAdvSelectInputGUI, ilAlphabetInputGUI, ilCheckboxGroupInputGUI, ilCheckboxInputGUI, ilColorPickerInputGUI, ilCombinationInputGUI, ilCSSRectInputGUI, ilCustomInputGUI, ilDateDurationInputGUI, ilDateTimeInputGUI, ilDurationInputGUI, ilEMailInputGUI, ilFileInputGUI, ilFileWizardInputGUI, ilFormulaInputGUI, ilHiddenInputGUI, ilLinkInputGUI, ilLocationInputGUI, ilMultiSelectInputGUI, ilNestedListInputGUI, ilNonEditableValueGUI, ilNumberInputGUI, ilPasswordInputGUI, ilRadioGroupInputGUI, ilRegExpInputGUI, ilRepositorySelectorInputGUI, ilSelectBuilderInputGUI, ilSelectInputGUI, ilTextAreaInputGUI, ilTextInputGUI, ilTextWizardInputGUI, ilUriInputGUI, ilUserLoginInputGUI, ilIncomingMailInputGUI, ilMailQuickFilterInputGUI, ilManualPlaceholderInputGUI, ilWidthHeightInputGUI, ilTypicalLearningTimeInputGUI, ilSamlIdpMetadataInputGUI, ilLuceneQueryInputGUI, ilBackgroundImageInputGUI, ilBackgroundPositionInputGUI, ilFontSizeInputGUI, ilNumericStyleValueInputGUI, ilTRBLBorderStyleInputGUI, ilTRBLBorderWidthInputGUI, ilTRBLColorPickerInputGUI, ilTRBLNumericStyleValueInputGUI, ilCharSelectorRadioGroupInputGUI, and ilExplorerSelectInputGUI.

Definition at line 172 of file class.ilFormPropertyGUI.php.

                                : bool
    {
        return false;           // please overwrite
    }

◆ checkParentFormTable()

ilFormPropertyGUI::checkParentFormTable ( )

protected

Definition at line 264 of file class.ilFormPropertyGUI.php.

                                             : void
    {
        $parent = $this->getParentForm();
        $parent_table = $this->getParentTable();
        if (!is_object($parent) && !isset($parent_table)) {
            throw new Exception("Parent form/table not set for " . get_class($this) . " to use serialize feature.");
        }
    }

References $parent_table, getParentForm(), and getParentTable().

Referenced by clearFromSession(), readFromSession(), and writeToSession().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearFromSession()

ilFormPropertyGUI::clearFromSession ( )

Exceptions

Exception

Definition at line 294 of file class.ilFormPropertyGUI.php.

                                      : void
    {
        $this->checkParentFormTable();
        ilSession::clear($this->getSessionKey());
    }

References checkParentFormTable(), ilSession\clear(), and getSessionKey().

Here is the call graph for this function:

◆ executeCommand()

ilFormPropertyGUI::executeCommand ( )

Returns: mixed

Reimplemented in ilLinkInputGUI.

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

    {
        $cmd = $this->ctrl->getCmd();
        return $this->$cmd();
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ getAlert()

ilFormPropertyGUI::getAlert ( )

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

                              : string
    {
        return $this->alert;
    }

References $alert.

◆ getContentOutsideFormTag()

ilFormPropertyGUI::getContentOutsideFormTag ( )

Get content that has to reside outside of the parent form tag, e.g.

panels/layers

Reimplemented in ilLinkInputGUI.

Definition at line 391 of file class.ilFormPropertyGUI.php.

                                              : string
    {
        return "";
    }

◆ getDisabled()

ilFormPropertyGUI::getDisabled ( )

Definition at line 164 of file class.ilFormPropertyGUI.php.

                                 : bool
    {
        return $this->disabled;
    }

References $disabled.

Here is the caller graph for this function:

◆ getFieldId()

ilFormPropertyGUI::getFieldId ( )

Definition at line 122 of file class.ilFormPropertyGUI.php.

                                : string
    {
        $id = str_replace("[", "__", $this->getPostVar());
        $id = str_replace("]", "__", $id);
        return $id;
    }

References $id, and getPostVar().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFormLabelFor()

ilFormPropertyGUI::getFormLabelFor ( )

Get label "for" attribute value for form.

Reimplemented in ilDateDurationInputGUI, and ilRadioGroupInputGUI.

Definition at line 428 of file class.ilFormPropertyGUI.php.

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

◆ getHiddenTag()

ilFormPropertyGUI::getHiddenTag	(	string	$a_post_var,
		string	$a_value
	)

Definition at line 313 of file class.ilFormPropertyGUI.php.

     : string {
        return '<input type="hidden" name="' . $a_post_var . '" value="' . ilLegacyFormElementsUtil::prepareFormOutput(
            $a_value
        ) . '" />';
    }

Referenced by ilEMailInputGUI\insert(), ilSelectInputGUI\render(), ilRadioGroupInputGUI\render(), and ilMailQuickFilterInputGUI\render().

Here is the caller graph for this function:

◆ getHiddenTitle()

ilFormPropertyGUI::getHiddenTitle ( )

Definition at line 214 of file class.ilFormPropertyGUI.php.

                                    : string
    {
        return $this->hidden_title;
    }

References $hidden_title.

◆ getInfo()

ilFormPropertyGUI::getInfo ( )

Reimplemented in ilNonEditableValueGUI.

Definition at line 134 of file class.ilFormPropertyGUI.php.

                             : string
    {
        return $this->info;
    }

References $info.

Referenced by ilCheckboxInputGUI\render(), and ilDclBaseFieldRepresentation\setupInputField().

Here is the caller graph for this function:

◆ getItemByPostVar()

ilFormPropertyGUI::getItemByPostVar ( string $a_post_var )

Get item by post var.

Reimplemented in ilCheckboxGroupInputGUI, ilRadioGroupInputGUI, ilSubEnabledFormPropertyGUI, and ilIncomingMailInputGUI.

Definition at line 222 of file class.ilFormPropertyGUI.php.

                                                        : ?ilFormPropertyGUI
    {
        if ($this->getPostVar() == $a_post_var) {
            return $this;
        }
        return null;
    }

References getPostVar().

Referenced by ilCheckboxGroupInputGUI\getItemByPostVar(), ilPropertyFormGUI\getItemByPostVar(), ilRadioGroupInputGUI\getItemByPostVar(), and ilSubEnabledFormPropertyGUI\getItemByPostVar().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMulti()

ilFormPropertyGUI::getMulti ( )

Reimplemented in ilOrgUnitAuthorityInputGUI.

Definition at line 340 of file class.ilFormPropertyGUI.php.

                              : bool
    {
        return $this->multi;
    }

Referenced by ilSelectInputGUI\checkInput(), ilTextInputGUI\checkInput(), ilOrgUnitGenericMultiInputGUI\createInputPostVar(), ilOrgUnitMultiLineInputGUI\createInputPostVar(), ilSelectInputGUI\getInput(), ilTextInputGUI\getInput(), ilOrgUnitGenericMultiInputGUI\insert(), ilOrgUnitMultiLineInputGUI\insert(), ilSelectInputGUI\render(), ilNonEditableValueGUI\render(), ilOrgUnitGenericMultiInputGUI\render(), ilOrgUnitMultiLineInputGUI\render(), ilMailQuickFilterInputGUI\render(), ilNonEditableValueGUI\setValue(), ilSelectInputGUI\setValue(), ilTextInputGUI\setValue(), ilManualPlaceholderInputGUI\setValue(), ilOrgUnitGenericMultiInputGUI\setValueByArray(), and ilOrgUnitMultiLineInputGUI\setValueByArray().

Here is the caller graph for this function:

◆ getMultiIconsHTML()

ilFormPropertyGUI::getMultiIconsHTML ( )

protected

Definition at line 356 of file class.ilFormPropertyGUI.php.

                                          : string
    {
        $lng = $this->lng;
 
        $id = $this->getFieldId();
 
        $tpl = new ilTemplate("tpl.multi_icons.html", true, true, "Services/Form");
 
        $html = "";
        if ($this->multi_addremove) {
            $tpl->setCurrentBlock("addremove");
            $tpl->setVariable("ID", $id);
            $tpl->setVariable("TXT_ADD", $lng->txt("add"));
            $tpl->setVariable("TXT_REMOVE", $lng->txt("remove"));
            $tpl->setVariable("SRC_ADD", ilGlyphGUI::get(ilGlyphGUI::ADD));
            $tpl->setVariable("SRC_REMOVE", ilGlyphGUI::get(ilGlyphGUI::REMOVE));
            $tpl->parseCurrentBlock();
        }
 
        if ($this->multi_sortable) {
            $tpl->setCurrentBlock("sortable");
            $tpl->setVariable("ID", $id);
            $tpl->setVariable("TXT_DOWN", $lng->txt("down"));
            $tpl->setVariable("TXT_UP", $lng->txt("up"));
            $tpl->setVariable("SRC_UP", ilGlyphGUI::get(ilGlyphGUI::UP));
            $tpl->setVariable("SRC_DOWN", ilGlyphGUI::get(ilGlyphGUI::DOWN));
            $tpl->parseCurrentBlock();
        }
 
        return $tpl->get();
    }

References $id, $lng, $tpl, ilGlyphGUI\ADD, ilGlyphGUI\DOWN, ilGlyphGUI\get(), ilGlyphGUI\REMOVE, and ilGlyphGUI\UP.

Referenced by ilSelectInputGUI\render(), and ilNonEditableValueGUI\render().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMultiValues()

ilFormPropertyGUI::getMultiValues ( )

Reimplemented in ilDclMultiTextInputGUI, and ilIdentifiedMultiValuesInputGUI.

Definition at line 350 of file class.ilFormPropertyGUI.php.

                                    : array
    {
        return $this->multi_values;
    }

Referenced by ilSelectInputGUI\render(), and ilMailQuickFilterInputGUI\render().

Here is the caller graph for this function:

◆ getParent()

ilFormPropertyGUI::getParent ( )

Definition at line 193 of file class.ilFormPropertyGUI.php.

                               : ?ilFormPropertyGUI
    {
        return $this->parent_gui;
    }

References $parent_gui.

◆ getParentForm()

ilFormPropertyGUI::getParentForm ( )

Definition at line 182 of file class.ilFormPropertyGUI.php.

                                   : ?ilPropertyFormGUI
    {
        return $this->parentform;
    }

References $parentform.

Referenced by checkParentFormTable(), getSessionKey(), ilCheckboxGroupInputGUI\render(), and ilRadioGroupInputGUI\render().

Here is the caller graph for this function:

◆ getParentTable()

ilFormPropertyGUI::getParentTable ( )

Get parent table.

Returns: ilTable2GUI table object

Definition at line 259 of file class.ilFormPropertyGUI.php.

                                    : ?ilTable2GUI
    {
        return $this->parent_table;
    }

References $parent_table.

Referenced by checkParentFormTable(), getSessionKey(), and ilRepositorySelectorInputGUI\render().

Here is the caller graph for this function:

◆ getPostVar()

ilFormPropertyGUI::getPostVar ( )

Definition at line 117 of file class.ilFormPropertyGUI.php.

                                : string
    {
        return $this->postvar;
    }

References $postvar.

Here is the caller graph for this function:

◆ getRequestParam()

ilFormPropertyGUI::getRequestParam	(	string	$key,
		Refinery\Transformation	$t
	)

protected

Returns: mixed|null

Definition at line 568 of file class.ilFormPropertyGUI.php.

    {
        if (isset($this->set_params[$key])) {
            return $this->set_params[$key];
        }
        $w = $this->http->wrapper();
        if ($w->post()->has($key)) {
            return $w->post()->retrieve($key, $t);
        }
        if ($w->query()->has($key)) {
            return $w->query()->retrieve($key, $t);
        }
        return null;
    }

References ILIAS\LTI\ToolProvider\$key, and ILIAS\FileDelivery\http().

Referenced by ilFormulaInputGUI\getInput(), and ilEMailInputGUI\sanitize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRequired()

ilFormPropertyGUI::getRequired ( )

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

                                 : bool
    {
        return $this->required;
    }

References $required.

Here is the caller graph for this function:

◆ getSessionKey()

ilFormPropertyGUI::getSessionKey ( )

protected

Definition at line 282 of file class.ilFormPropertyGUI.php.

                                      : string
    {
        $parent = $this->getParentForm();
        if (!is_object($parent)) {
            $parent = $this->getParentTable();
        }
        return "form_" . $parent->getId() . "_" . $this->getFieldId();
    }

References getFieldId(), getParentForm(), and getParentTable().

Referenced by clearFromSession(), readFromSession(), and writeToSession().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSubForm()

ilFormPropertyGUI::getSubForm ( )

Reimplemented in ilSubEnabledFormPropertyGUI.

Definition at line 198 of file class.ilFormPropertyGUI.php.

                                : ?ilPropertyFormGUI
    {
        return null;
    }

◆ getTableFilterLabelFor()

ilFormPropertyGUI::getTableFilterLabelFor ( )

Get label "for" attribute value for filter.

Reimplemented in ilDateDurationInputGUI.

Definition at line 420 of file class.ilFormPropertyGUI.php.

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

◆ getTitle()

ilFormPropertyGUI::getTitle ( )

Reimplemented in ilNonEditableValueGUI.

Definition at line 107 of file class.ilFormPropertyGUI.php.

                              : string
    {
        return $this->title;
    }

References $title.

Referenced by ilSelectInputGUI\render(), ilCheckboxInputGUI\render(), and ilMailQuickFilterInputGUI\render().

Here is the caller graph for this function:

◆ getType()

ilFormPropertyGUI::getType ( )

Reimplemented in ilNonEditableValueGUI.

Definition at line 97 of file class.ilFormPropertyGUI.php.

                             : string
    {
        return $this->type;
    }

References $type.

◆ hideSubForm()

ilFormPropertyGUI::hideSubForm ( )

Reimplemented in ilCheckboxInputGUI, ilDateDurationInputGUI, ilDateTimeInputGUI, and ilSelectInputGUI.

Definition at line 203 of file class.ilFormPropertyGUI.php.

                                 : bool
    {
        return false;
    }

◆ int()

ilFormPropertyGUI::int ( $key )

protected

Definition at line 434 of file class.ilFormPropertyGUI.php.

                                : int
    {
        if (is_null($this->refinery)) {
            return 0;
        }
        $t = $this->refinery->kindlyTo()->int();
        return (int) ($this->getRequestParam($key, $t) ?? 0);
    }

References ILIAS\LTI\ToolProvider\$key, and ILIAS\Repository\refinery().

Referenced by ilDateTimeInputGUI\getDatePickerTimeFormat(), ilLocationInputGUI\getInput(), ilDurationInputGUI\getPostValueForComparison(), ilWidthHeightInputGUI\insert(), ilRepositorySelectorInputGUI\setValue(), and ilDurationInputGUI\setValueByArray().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ intArray()

ilFormPropertyGUI::intArray ( $key )

protected

Definition at line 444 of file class.ilFormPropertyGUI.php.

                                     : array
    {
        if (!$this->isRequestParamArray($key)) {
            return [];
        }
        $t = $this->refinery->custom()->transformation(
            function ($arr) {
                // keep keys(!), transform all values to int
                return array_column(
                    array_map(
                        function ($k, $v) {
                            return [$k, (int) $v];
                        },
                        array_keys($arr),
                        $arr
                    ),
                    1,
                    0
                );
            }
        );
        return (array) ($this->getRequestParam($key, $t) ?? []);
    }

References ILIAS\LTI\ToolProvider\$key, ILIAS\Repository\int(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

◆ isRequestParamArray()

ilFormPropertyGUI::isRequestParamArray ( string $key )

protected

Definition at line 542 of file class.ilFormPropertyGUI.php.

                                                       : bool
    {
        $no_transform = $this->refinery->identity();
        $w = $this->http->wrapper();
        if ($w->post()->has($key)) {
            return is_array($w->post()->retrieve($key, $no_transform));
        }
        if ($w->query()->has($key)) {
            return is_array($w->query()->retrieve($key, $no_transform));
        }
        return false;
    }

References ILIAS\LTI\ToolProvider\$key, ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by ilNonEditableValueGUI\getInput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ raw()

ilFormPropertyGUI::raw ( $key )

protected

Definition at line 481 of file class.ilFormPropertyGUI.php.

    {
        $t = $this->refinery->custom()->transformation(function ($v) {
            return $v;
        });
        return $this->getRequestParam($key, $t);
    }

References ILIAS\LTI\ToolProvider\$key, and ILIAS\Repository\refinery().

Referenced by ilOrgUnitGenericMultiInputGUI\checkInput(), ilClozeGapInputBuilderGUI\checkInput(), and ilSamlIdpMetadataInputGUI\checkInput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readFromSession()

ilFormPropertyGUI::readFromSession ( )

Exceptions

Exception

Definition at line 303 of file class.ilFormPropertyGUI.php.

                                     : void
    {
        $this->checkParentFormTable();
        if (ilSession::has($this->getSessionKey())) {
            $this->unserializeData(ilSession::get($this->getSessionKey()));
        } else {
            $this->unserializeData("");
        }
    }

References checkParentFormTable(), ilSession\get(), getSessionKey(), ilSession\has(), and unserializeData().

Referenced by ilMMSubItemTableGUI\addAndReadFilterItem().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeProhibitedCharacters()

static ilFormPropertyGUI::removeProhibitedCharacters ( string $a_text )

static

Remove prohibited characters see #19159.

Definition at line 400 of file class.ilFormPropertyGUI.php.

                                                                     : string
    {
        return str_replace("\x0B", "", $a_text);
    }

◆ serializeData()

ilFormPropertyGUI::serializeData ( )

Reimplemented in ilCheckboxInputGUI, ilCombinationInputGUI, ilDateTimeInputGUI, and ilDurationInputGUI.

Definition at line 230 of file class.ilFormPropertyGUI.php.

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

References ILIAS\UI\Implementation\Component\Input\getValue().

Referenced by writeToSession().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAlert()

ilFormPropertyGUI::setAlert ( string $a_alert )

Definition at line 139 of file class.ilFormPropertyGUI.php.

                                             : void
    {
        $this->alert = $a_alert;
    }

Here is the caller graph for this function:

◆ setDisabled()

ilFormPropertyGUI::setDisabled ( bool $a_disabled )

Definition at line 159 of file class.ilFormPropertyGUI.php.

                                                 : void
    {
        $this->disabled = $a_disabled;
    }

References ILIAS\UI\examples\Input\Field\Checkbox\disabled().

Referenced by __construct(), ilADTFormBridge\addBasicFieldProperties(), ilIncomingMailInputGUI\addSubOptions(), and ilDclFileuploadFieldRepresentation\requiredWorkaroundForInputField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setHiddenTitle()

ilFormPropertyGUI::setHiddenTitle ( string $a_val )

Definition at line 209 of file class.ilFormPropertyGUI.php.

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

Referenced by ilFileInputGUI\__construct(), and ilImageFileInputGUI\__construct().

Here is the caller graph for this function:

◆ setInfo()

ilFormPropertyGUI::setInfo ( string $a_info )

Reimplemented in ilNonEditableValueGUI.

Definition at line 129 of file class.ilFormPropertyGUI.php.

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

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

Referenced by ilADTFormBridge\addBasicFieldProperties(), assOrderingQuestion\initOrderingElementFormFieldLabels(), and ilDclBaseFieldRepresentation\setupInputField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setMulti()

ilFormPropertyGUI::setMulti	(	bool	$a_multi,
		bool	$a_sortable = `false`,
		bool	$a_addremove = `true`
	)

Reimplemented in ilDclGenericMultiInputGUI, ilOrgUnitGenericMultiInputGUI, and ilOrgUnitMultiLineInputGUI.

Definition at line 322 of file class.ilFormPropertyGUI.php.

     : void {
        if (!$this instanceof ilMultiValuesItem) {
            throw new ilFormException(sprintf(
                "%s not supported for form property type %s",
                __FUNCTION__,
                get_class($this)
            ));
        }
 
        $this->multi = $a_multi;
        $this->multi_sortable = $a_sortable;
        $this->multi_addremove = $a_addremove;
    }

Referenced by ilTaxAssignInputGUI\__construct().

Here is the caller graph for this function:

◆ setMultiValues()

ilFormPropertyGUI::setMultiValues ( array $a_values )

Reimplemented in ilTextInputGUI, ilDclMultiTextInputGUI, and ilIdentifiedMultiValuesInputGUI.

Definition at line 345 of file class.ilFormPropertyGUI.php.

                                                   : void
    {
        $this->multi_values = array_unique($a_values);
    }

Referenced by ilNonEditableValueGUI\setValue(), ilSelectInputGUI\setValue(), and ilManualPlaceholderInputGUI\setValue().

Here is the caller graph for this function:

◆ setParent()

ilFormPropertyGUI::setParent ( ilFormPropertyGUI $a_val )

Definition at line 188 of file class.ilFormPropertyGUI.php.

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

Referenced by ilSubEnabledFormPropertyGUI\addSubItem().

Here is the caller graph for this function:

◆ setParentForm()

ilFormPropertyGUI::setParentForm ( ilPropertyFormGUI $a_parentform )

Definition at line 177 of file class.ilFormPropertyGUI.php.

                                                                  : void
    {
        $this->parentform = $a_parentform;
    }

◆ setParentTable()

ilFormPropertyGUI::setParentTable ( $a_val )

Set parent table.

Parameters

ilTable2GUI $a_val table object

Definition at line 250 of file class.ilFormPropertyGUI.php.

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

◆ setPostVar()

ilFormPropertyGUI::setPostVar ( string $a_postvar )

Definition at line 112 of file class.ilFormPropertyGUI.php.

                                                 : void
    {
        $this->postvar = $a_postvar;
    }

Referenced by __construct(), and ilIdentifiedMultiValuesInputGUI\getFieldIdFromPostVar().

Here is the caller graph for this function:

◆ setRequestParam()

ilFormPropertyGUI::setRequestParam	(	string	$key,
			$val
	)

This writes the request (aka post) values.

Code that relies on this should be refactored as soon as possible.

Deprecated:

Definition at line 560 of file class.ilFormPropertyGUI.php.

                                                      : void
    {
        $this->set_params[$key] = $val;
    }

References ILIAS\LTI\ToolProvider\$key.

◆ setRequired()

ilFormPropertyGUI::setRequired ( bool $a_required )

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

                                                 : void
    {
        $this->required = $a_required;
    }

Referenced by ilRandomTestROInputGUI\__construct(), ilADTFormBridge\addBasicFieldProperties(), ilDclGenericMultiInputGUI\addInput(), and ilDclFileuploadFieldRepresentation\requiredWorkaroundForInputField().

Here is the caller graph for this function:

◆ setTitle()

ilFormPropertyGUI::setTitle ( string $a_title )

Reimplemented in ilNonEditableValueGUI.

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

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

Referenced by __construct(), ilMailFormAttachmentPropertyGUI\__construct(), and assOrderingQuestion\initOrderingElementFormFieldLabels().

Here is the caller graph for this function:

◆ setType()

ilFormPropertyGUI::setType ( string $a_type )

protected

Reimplemented in ilNonEditableValueGUI.

Definition at line 92 of file class.ilFormPropertyGUI.php.

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

Here is the caller graph for this function:

◆ str()

ilFormPropertyGUI::str ( $key )

protected

Definition at line 469 of file class.ilFormPropertyGUI.php.

                                : string
    {
        if (is_null($this->refinery)) {
            return "";
        }
        $t = $this->refinery->kindlyTo()->string();
        return $this->stripSlashesAddSpaceFallback(
            (string) ($this->getRequestParam($key, $t) ?? "")
        );
    }

References ILIAS\LTI\ToolProvider\$key, and ILIAS\Repository\refinery().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ strArray()

ilFormPropertyGUI::strArray ( $key )

protected

Definition at line 490 of file class.ilFormPropertyGUI.php.

                                     : array
    {
        if (!$this->isRequestParamArray($key)) {
            return [];
        }
        $t = $this->refinery->custom()->transformation(
            function ($arr) {
                // keep keys(!), transform all values to string
                return array_column(
                    array_map(
                        function ($k, $v) {
                            if (is_array($v)) {
                                $v = "";
                            }
                            return [$k, $this->stripSlashesAddSpaceFallback((string) $v)];
                        },
                        array_keys($arr),
                        $arr
                    ),
                    1,
                    0
                );
            }
        );
        return (array) ($this->getRequestParam($key, $t) ?? []);
    }

References ILIAS\LTI\ToolProvider\$key, and ILIAS\Repository\refinery().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ stripSlashesAddSpaceFallback()

ilFormPropertyGUI::stripSlashesAddSpaceFallback ( string $a_str )

Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727.

Definition at line 408 of file class.ilFormPropertyGUI.php.

                                                               : string
    {
        $str = ilUtil::stripSlashes($a_str);
        if ($str != $a_str) {
            $str = ilUtil::stripSlashes(str_replace("<", "< ", $a_str));
        }
        return $str;
    }

References ilUtil\stripSlashes().

Referenced by ilSamlIdpMetadataInputGUI\checkInput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unserializeData()

ilFormPropertyGUI::unserializeData ( string $a_data )

Reimplemented in ilCheckboxInputGUI, ilCombinationInputGUI, ilDateTimeInputGUI, ilDurationInputGUI, ilMultiSelectInputGUI, and ilNumberInputGUI.

Definition at line 235 of file class.ilFormPropertyGUI.php.

                                                   : void
    {
        $data = unserialize($a_data);
 
        if ($data) {
            $this->setValue($data);
        } else {
            $this->setValue("");
        }
    }

References $data.

Referenced by readFromSession().

Here is the caller graph for this function:

◆ writeToSession()

ilFormPropertyGUI::writeToSession ( )

Exceptions

Exception

Definition at line 276 of file class.ilFormPropertyGUI.php.

                                    : void
    {
        $this->checkParentFormTable();
        ilSession::set($this->getSessionKey(), $this->serializeData());
    }