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

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

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

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented in ilRecurrenceInputGUI, ilScheduleInputGUI, ilDclGenericMultiInputGUI, 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, ilOrgUnitGenericMultiInputGUI, ilBackgroundImageInputGUI, ilBackgroundPositionInputGUI, ilFontSizeInputGUI, ilNumericStyleValueInputGUI, ilTRBLBorderStyleInputGUI, ilTRBLBorderWidthInputGUI, ilTRBLColorPickerInputGUI, ilTRBLNumericStyleValueInputGUI, ilCategoryWizardInputGUI, ilMatrixRowWizardInputGUI, ilClozeGapInputBuilderGUI, and ilTagInputGUI.

Definition at line 57 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 525 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\Repository\refinery().

Referenced by ilBackgroundPositionInputGUI\getInput(), ilTRBLBorderStyleInputGUI\getInput(), ilTRBLBorderWidthInputGUI\getInput(), ilTRBLColorPickerInputGUI\getInput(), ilTRBLNumericStyleValueInputGUI\getInput(), ilCategoryWizardInputGUI\getInput(), ilMatrixRowWizardInputGUI\getInput(), ilIdentifiedMultiValuesInputGUI\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.

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

                                : bool
    {
        return false;           // please overwrite
    }

◆ checkParentFormTable()

ilFormPropertyGUI::checkParentFormTable ( )

protected

Definition at line 271 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 301 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 87 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 151 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 398 of file class.ilFormPropertyGUI.php.

                                              : string
    {
        return "";
    }

◆ getDisabled()

ilFormPropertyGUI::getDisabled ( )

Definition at line 171 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 129 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 435 of file class.ilFormPropertyGUI.php.

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

◆ getHiddenTag()

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

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

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

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

Here is the caller graph for this function:

◆ getHiddenTitle()

ilFormPropertyGUI::getHiddenTitle ( )

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

                                    : string
    {
        return $this->hidden_title;
    }

References $hidden_title.

◆ getInfo()

ilFormPropertyGUI::getInfo ( )

Reimplemented in ilNonEditableValueGUI.

Definition at line 141 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 229 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 347 of file class.ilFormPropertyGUI.php.

                              : bool
    {
        return $this->multi;
    }

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

Here is the caller graph for this function:

◆ getMultiIconsHTML()

ilFormPropertyGUI::getMultiIconsHTML ( )

protected

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

                                          : string
    {
        $lng = $this->lng;
 
        $id = $this->getFieldId();
 
        $tpl = new ilTemplate("tpl.multi_icons.html", true, true, "components/ILIAS/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", $this->symbol()->glyph("add")->render());
            $tpl->setVariable("SRC_REMOVE", $this->symbol()->glyph("remove")->render());
            $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", $this->symbol()->glyph("up")->render());
            $tpl->setVariable("SRC_DOWN", $this->symbol()->glyph("down")->render());
            $tpl->parseCurrentBlock();
        }
 
        return $tpl->get();
    }

References $id, $lng, and ILIAS\Repository\symbol().

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

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

                                    : array
    {
        return $this->multi_values;
    }

Referenced by ilSelectInputGUI\render().

Here is the caller graph for this function:

◆ getParent()

ilFormPropertyGUI::getParent ( )

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

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

References $parent_gui.

◆ getParentForm()

ilFormPropertyGUI::getParentForm ( )

Definition at line 189 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 266 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 124 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 575 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\FileDelivery\http().

Referenced by ilFormulaInputGUI\getInput(), ilLogicalAnswerComparisonExpressionInputGUI\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 161 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 289 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 205 of file class.ilFormPropertyGUI.php.

                                : ?ilPropertyFormGUI
    {
        return null;
    }

◆ getTableFilterLabelFor()

ilFormPropertyGUI::getTableFilterLabelFor ( )

Get label "for" attribute value for filter.

Reimplemented in ilDateDurationInputGUI.

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

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

◆ getTitle()

ilFormPropertyGUI::getTitle ( )

Reimplemented in ilNonEditableValueGUI.

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

                              : string
    {
        return $this->title;
    }

References $title.

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

Here is the caller graph for this function:

◆ getType()

ilFormPropertyGUI::getType ( )

Reimplemented in ilNonEditableValueGUI.

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

                             : string
    {
        return $this->type;
    }

References $type.

◆ hideSubForm()

ilFormPropertyGUI::hideSubForm ( )

Reimplemented in ilCheckboxInputGUI, ilDateDurationInputGUI, ilDateTimeInputGUI, and ilSelectInputGUI.

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

                                 : bool
    {
        return false;
    }

◆ int()

ilFormPropertyGUI::int ( $key )

protected

Definition at line 441 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\Repository\refinery().

Referenced by 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 451 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\Repository\int(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

◆ isRequestParamArray()

ilFormPropertyGUI::isRequestParamArray ( string $key )

protected

Definition at line 549 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\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by ilNonEditableValueGUI\getInput(), and ilLogicalAnswerComparisonExpressionInputGUI\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 488 of file class.ilFormPropertyGUI.php.

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

References ILIAS\Repository\refinery().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readFromSession()

ilFormPropertyGUI::readFromSession ( )

Exceptions

Exception

Definition at line 310 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 ILIAS\LegalDocuments\Legacy\Table\setupFilter().

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 407 of file class.ilFormPropertyGUI.php.

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

Referenced by ilLMObject\saveTitle().

Here is the caller graph for this function:

◆ serializeData()

ilFormPropertyGUI::serializeData ( )

Reimplemented in ilCheckboxInputGUI, ilCombinationInputGUI, ilDateTimeInputGUI, and ilDurationInputGUI.

Definition at line 237 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 146 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 166 of file class.ilFormPropertyGUI.php.

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

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

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

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 216 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 136 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 ilOrgUnitGenericMultiInputGUI.

Definition at line 329 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, and ilIdentifiedMultiValuesInputGUI.

Definition at line 352 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 195 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 184 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 257 of file class.ilFormPropertyGUI.php.

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

◆ setPostVar()

ilFormPropertyGUI::setPostVar ( string $a_postvar )

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

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

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

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 567 of file class.ilFormPropertyGUI.php.

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

◆ setRequired()

ilFormPropertyGUI::setRequired ( bool $a_required )

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

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

Referenced by ilRandomTestROInputGUI\__construct(), and ilADTFormBridge\addBasicFieldProperties().

Here is the caller graph for this function:

◆ setTitle()

ilFormPropertyGUI::setTitle ( string $a_title )

Reimplemented in ilNonEditableValueGUI.

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

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

Referenced by ilMailFormAttachmentPropertyGUI\__construct(), __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 99 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 476 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\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 497 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\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 415 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().

Here is the call graph for this function:

◆ symbol()

ilFormPropertyGUI::symbol ( )

protected

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

                               : \ILIAS\Repository\Symbol\SymbolAdapterGUI
    {
        global $DIC;
        return $DIC->repository()->internal()->gui()->symbol();
    }

References $DIC.

Referenced by ilSelectBuilderInputGUI\insert(), and ilTextWizardInputGUI\render().

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 242 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 283 of file class.ilFormPropertyGUI.php.

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