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 = `""`
	)

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

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

       {
         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'];
         }
     }

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.

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

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

                                        : 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) ?? []);
     }

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

                                 : bool
     {
         return false;           // please overwrite
     }

◆ checkParentFormTable()

ilFormPropertyGUI::checkParentFormTable ( )

protected

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

References getParentForm(), and getParentTable().

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

                                              : 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.");
         }
     }

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.

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

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

Here is the call graph for this function:

◆ executeCommand()

ilFormPropertyGUI::executeCommand ( )

Returns: mixed

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

References ILIAS\Repository\ctrl().

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

Here is the call graph for this function:

◆ getAlert()

ilFormPropertyGUI::getAlert ( )

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

References $alert.

                               : string
     {
         return $this->alert;
     }

◆ getContentOutsideFormTag()

ilFormPropertyGUI::getContentOutsideFormTag ( )

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

panels/layers

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

                                               : string
     {
         return "";
     }

◆ getDisabled()

ilFormPropertyGUI::getDisabled ( )

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

References $disabled.

                                  : bool
     {
         return $this->disabled;
     }

Here is the caller graph for this function:

◆ getFieldId()

ilFormPropertyGUI::getFieldId ( )

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

References $id, and getPostVar().

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

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.

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

References getFieldId().

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

Here is the call graph for this function:

◆ getHiddenTag()

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

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

References ilLegacyFormElementsUtil\prepareFormOutput().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHiddenTitle()

ilFormPropertyGUI::getHiddenTitle ( )

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

References $hidden_title.

                                     : string
     {
         return $this->hidden_title;
     }

◆ getInfo()

ilFormPropertyGUI::getInfo ( )

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

References $info.

Referenced by ilTextAreaInputGUI\insert(), ilCheckboxInputGUI\render(), ilNumberInputGUI\render(), ilTextInputGUI\render(), and ilDclBaseFieldRepresentation\setupInputField().

                              : string
     {
         return $this->info;
     }

Here is the caller graph for this function:

◆ getItemByPostVar()

ilFormPropertyGUI::getItemByPostVar ( string $a_post_var )

Get item by post var.

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

References getPostVar().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMulti()

ilFormPropertyGUI::getMulti ( )

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

References $multi.

                               : bool
     {
         return $this->multi;
     }

Here is the caller graph for this function:

◆ getMultiIconsHTML()

ilFormPropertyGUI::getMultiIconsHTML ( )

protected

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

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

Referenced by ilOrgUnitAuthorityInputGUI\getValue(), ilNonEditableValueGUI\render(), ilSelectInputGUI\render(), and ilTextInputGUI\render().

                                           : 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();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMultiValues()

ilFormPropertyGUI::getMultiValues ( )

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

References $multi_values.

Referenced by ilOrgUnitAuthorityInputGUI\getValue(), ilMailQuickFilterInputGUI\render(), ilSelectInputGUI\render(), and ilTextInputGUI\render().

                                     : array
     {
         return $this->multi_values;
     }

Here is the caller graph for this function:

◆ getParent()

ilFormPropertyGUI::getParent ( )

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

References $parent_gui.

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

◆ getParentForm()

ilFormPropertyGUI::getParentForm ( )

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

References $parentform.

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

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

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.

References $parent_table.

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

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

Here is the caller graph for this function:

◆ getPostVar()

ilFormPropertyGUI::getPostVar ( )

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

References $postvar.

                                 : string
     {
         return $this->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.

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

Referenced by arrayArray(), ilFormulaInputGUI\getInput(), int(), intArray(), raw(), ilEMailInputGUI\sanitize(), str(), and strArray().

     {
         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;
     }

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.

References $required.

                                  : bool
     {
         return $this->required;
     }

Here is the caller graph for this function:

◆ getSessionKey()

ilFormPropertyGUI::getSessionKey ( )

protected

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSubForm()

ilFormPropertyGUI::getSubForm ( )

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

                                 : ?ilPropertyFormGUI
     {
         return null;
     }

◆ getTableFilterLabelFor()

ilFormPropertyGUI::getTableFilterLabelFor ( )

Get label "for" attribute value for filter.

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

References getFieldId().

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

Here is the call graph for this function:

◆ getTitle()

ilFormPropertyGUI::getTitle ( )

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

References $title.

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

                               : string
     {
         return $this->title;
     }

Here is the caller graph for this function:

◆ getType()

ilFormPropertyGUI::getType ( )

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

References $type.

                              : string
     {
         return $this->type;
     }

◆ hideSubForm()

ilFormPropertyGUI::hideSubForm ( )

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.

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

Referenced by ilDateTimeInputGUI\getDatePickerTimeFormat(), ilDateDurationInputGUI\getDatePickerTimeFormat(), ilLocationInputGUI\getInput(), ilDurationInputGUI\getPostValueForComparison(), ilWidthHeightInputGUI\insert(), intArray(), ilScheduleInputGUI\parseTime(), ilMultipleNestedOrderingElementsInputGUI\renderEndSubList(), ilTaxAssignInputGUI\saveInput(), ilRepositorySelectorInputGUI\setValue(), and ilDurationInputGUI\setValueByArray().

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

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.

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

                                      : 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) ?? []);
     }

Here is the call graph for this function:

◆ isRequestParamArray()

ilFormPropertyGUI::isRequestParamArray ( string $key )

protected

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

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by arrayArray(), ilNonEditableValueGUI\getInput(), intArray(), and strArray().

                                                        : 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;
     }

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.

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

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

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

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.

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

Referenced by ilMMSubItemTableGUI\addAndReadFilterItem().

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

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.

Referenced by ilLMObject\saveTitles().

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

Here is the caller graph for this function:

◆ serializeData()

ilFormPropertyGUI::serializeData ( )

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

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

Referenced by writeToSession().

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

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.

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

Referenced by __construct(), ilADTFormBridge\addBasicFieldProperties(), ilAdvancedMDFieldDefinitionSelect\addEditOptionsFieldsToDefinitionForm(), ilObjTestSettingsGeneralGUI\addGeneralProperties(), ilIncomingMailInputGUI\addSubOptions(), ilECSMappingSettingsGUI\dInitFormTreeSettings(), ilMarkSchemaGUI\getEctsForm(), ilWorkflowEngineSettingsForm\getForm(), ilObjMailGUI\getGeneralSettingsForm(), ilMailTemplateGUI\getTemplateForm(), ilCalendarCategoryGUI\initFormCategory(), ilObjRoleGUI\initFormRoleProperties(), ilSettingsTemplateGUI\initSettingsTemplateForm(), ilLTIConsumeProviderFormGUI\initToolConfigForm(), and ilDclFileuploadFieldRepresentation\requiredWorkaroundForInputField().

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

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.

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

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

Here is the caller graph for this function:

◆ setInfo()

ilFormPropertyGUI::setInfo ( string $a_info )

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

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

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

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

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

Referenced by ilTaxAssignInputGUI\__construct().

      : 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;
     }

Here is the caller graph for this function:

◆ setMultiValues()

ilFormPropertyGUI::setMultiValues ( array $a_values )

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

Referenced by ilObjBlogGUI\initEditCustomForm(), ilSelectInputGUI\setValue(), ilNonEditableValueGUI\setValue(), ilManualPlaceholderInputGUI\setValue(), and ilPersonalProfileGUI\showPublicProfileFields().

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

Here is the caller graph for this function:

◆ setParent()

ilFormPropertyGUI::setParent ( ilFormPropertyGUI $a_val )

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

Referenced by ilSubEnabledFormPropertyGUI\addSubItem().

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

Here is the caller graph for this function:

◆ setParentForm()

ilFormPropertyGUI::setParentForm ( ilPropertyFormGUI $a_parentform )

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

Referenced by ilPCSectionGUI\initForm().

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

Here is the caller graph for this function:

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

Referenced by __construct(), ilIdentifiedMultiValuesInputGUI\getFieldIdFromPostVar(), ilObjMediaCastGUI\initAddCastItemForm(), ilLDAPSettingsGUI\initRoleMappingForm(), and ilLDAPSettingsGUI\roleMapping().

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

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.

References ILIAS\LTI\ToolProvider\$key.

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

◆ setRequired()

ilFormPropertyGUI::setRequired ( bool $a_required )

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

Referenced by FormMailCodesGUI\__construct(), ilRandomTestROInputGUI\__construct(), ilObjTestSettingsGeneralGUI\addAvailabilityProperties(), ilADTFormBridge\addBasicFieldProperties(), ilMemberAgreementGUI\addCustomFields(), ilAdvancedMDFieldDefinitionFloat\addCustomFieldToDefinitionForm(), ilCronOerHarvester\addCustomSettingsToForm(), ilExAssTypePortfolioGUI\addEditFormCustomProperties(), ilExAssTypeWikiTeamGUI\addEditFormCustomProperties(), SurveyMatrixQuestionGUI\addFieldsToEditForm(), SurveyMultipleChoiceQuestionGUI\addFieldsToEditForm(), SurveyMetricQuestionGUI\addFieldsToEditForm(), SurveyTextQuestionGUI\addFieldsToEditForm(), SurveySingleChoiceQuestionGUI\addFieldsToEditForm(), ilDclGenericMultiInputGUI\addInput(), ilTestExpressPageObjectGUI\addQuestion(), ilObjTestSettingsGeneralGUI\addQuestionBehaviourProperties(), ilObjTestGUI\addQuestionObject(), ilSystemStyleIconsGUI\addSelectIconToolbar(), ilECSObjectSettings\addSettingsToForm(), ilObjTestSettingsGeneralGUI\addTestAccessProperties(), ilObjTestSettingsGeneralGUI\addTestFinishProperties(), ilObjTestSettingsGeneralGUI\addTestIntroProperties(), ilMembershipNotifications\addToSettingsForm(), ilTestRandomQuestionSetGeneralConfigFormGUI\build(), ilTestRandomQuestionSetPoolDefinitionFormGUI\build(), ilDclSelectionFieldRepresentation\buildFieldCreationInput(), ilCmiXapiSettingsGUI\buildForm(), ilAssQuestionHintGUI\buildForm(), ilTestPasswordProtectionGUI\buildPasswordForm(), ilAssQuestionSkillAssignmentPropertyFormGUI\buildResultSkillPointsInputField(), ilAssClozeTestFeedback\completeSpecificFormProperties(), ilCertificateSettingsFormRepository\createForm(), ilSurveyEditorGUI\createQuestionObject(), ilObjTestGUI\createQuestionObject(), ilDidacticTemplateSettingsGUI\editImportForm(), ilObjMailGUI\getExternalSettingsForm(), ilObjStyleSheetGUI\getImportForm(), ilObjQuestionPoolGUI\getImportQuestionsForm(), ilUserStartingPointGUI\getRoleStartingPointForm(), ilChatroomFormFactory\getSettingsForm(), ilMailAttachmentGUI\getToolbarForm(), ilSystemStyleOverviewGUI\importSystemStyleForm(), ilObjUserFolderGUI\initAccessRestrictionForm(), ilPageObjectGUI\initActivationForm(), ilObjMediaCastGUI\initAddCastItemForm(), ilAccountCodesGUI\initAddCodesForm(), ilRegistrationSettingsGUI\initAddCodesForm(), ilPCFileItemGUI\initAddFileForm(), ilPortfolioRoleAssignmentGUI\initAssignmentForm(), ilExAssignmentEditorGUI\initAssignmentForm(), ilExSubmissionTextGUI\initAssignmentTextForm(), ilBadgeManagementGUI\initBadgeForm(), ilBookingProcessGUI\initBookingNumbersForm(), ilECSSettingsGUI\initCategoryMappingForm(), ilObjStyleSheetGUI\initColorForm(), ilObjPortfolioGUI\initCopyPageFormOptions(), ilObjCmiXapiGUI\initCreateForm(), ilObjEmployeeTalkSeriesGUI\initCreateForm(), ilObjPortfolioGUI\initCreatePortfolioFromTemplateForm(), ilBlogPostingGUI\initDateForm(), ilObjPollGUI\initEditCustomForm(), ilObjBlogGUI\initEditCustomForm(), ilObjBookingPoolGUI\initEditCustomForm(), SurveyQuestionGUI\initEditForm(), ilPCFileListGUI\initEditForm(), ilObjectCustomUserFieldsGUI\initFieldForm(), ilLTIConsumerSettingsFormGUI\initForm(), ilLTIConsumeProviderFormGUI\initForm(), ilContainerNewsSettingsGUI\initForm(), ilLOTestAssignmentForm\initForm(), ilPCContentTemplateGUI\initForm(), ilOrgUnitSimpleUserImportGUI\initForm(), ilPCMapGUI\initForm(), ilPCConsultationHoursGUI\initForm(), ilAccountRegistrationGUI\initForm(), ilOrgUnitSimpleImportGUI\initForm(), ilBookingScheduleGUI\initForm(), ilCalendarAppointmentGUI\initForm(), ilContainerReferenceGUI\initForm(), ilCustomUserFieldsGUI\initForm(), ilBookingObjectGUI\initForm(), ilObjUserGUI\initForm(), ilObjSessionGUI\initForm(), ilECSMappingSettingsGUI\initFormCSettings(), ilContainerGUI\initFormPasswordInstruction(), ilAuthShibbolethSettingsGUI\initFormRoleAssignment(), ilLDAPSettingsGUI\initFormRoleAssignments(), ilLPListOfSettingsGUI\initFormSettings(), ilCASSettingsGUI\initFormSettings(), ilObjBlogAdministrationGUI\initFormSettings(), ilObjPortfolioAdministrationGUI\initFormSettings(), ilObjLinkResourceGUI\initFormSettings(), ilObjSystemCheckGUI\initFormTrash(), ilRepositoryTrashGUI\initFormTrashTargetLocation(), ilPersonalSettingsGUI\initGeneralSettingsForm(), ilObjBadgeAdministrationGUI\initImageTemplateForm(), ilDclRecordListGUI\initImportForm(), ilPermissionGUI\initImportForm(), ilObjSCORMLearningModuleGUI\initImportForm(), ilSurveyRaterGUI\initMailRatersForm(), ilSurveyParticipantsGUI\initMailRatersForm(), ilObjLanguageExtGUI\initNewImportForm(), ilObjPortfolioBaseGUI\initPageForm(), ilWorkspaceAccessGUI\initPasswordForm(), ilExAssignmentEditorGUI\initPeerReviewForm(), ilPersonalProfileGUI\initPersonalDataImportForm(), SurveyQuestionGUI\initPhrasesForm(), ilMediaCreationGUI\initPoolSelection(), ilExSubmissionObjectGUI\initPortfolioTemplateForm(), ilPCBlogGUI\initPostingForm(), ilPDNewsBlockGUI\initPrivateSettingsForm(), ilObjPollGUI\initQuestionForm(), ilObjForumGUI\initReplyEditForm(), ilEmployeeTalkAppointmentGUI\initSeriesEditForm(), ilObjSurveyAdministrationGUI\initSettingsForm(), ilOpenIdConnectSettingsGUI\initSettingsForm(), ilECSSettingsGUI\initSettingsForm(), ilLOEditorGUI\initSettingsForm(), ilNewsForContextBlockGUI\initSettingsForm(), ilChatroomAdminSmileyGUI\initSmiliesForm(), ilEmployeeTalkAppointmentGUI\initTalkEditForm(), ilObjWikiGUI\initTemplateSelectionForm(), ilLTIConsumeProviderFormGUI\initToolConfigForm(), ilUnitConfigurationGUI\initUnitForm(), ilObjSAHSLearningModuleGUI\initUploadForm(), assFormulaQuestionGUI\isSaveCommand(), SurveyQuestionGUI\material(), ilObjSCORMLearningModuleGUI\newModuleVersion(), ilSurveyPhrasesGUI\phraseEditor(), assMatchingQuestionGUI\populateAnswerSpecificFormPart(), assTextSubsetGUI\populateAnswerSpecificFormPart(), assTextQuestionGUI\populateAnswerSpecificFormPart(), assSingleChoiceGUI\populateAnswerSpecificFormPart(), assMultipleChoiceGUI\populateAnswerSpecificFormPart(), assTextSubsetGUI\populateCorrectionsFormProperties(), assLongMenuGUI\populateCorrectionsFormProperties(), assSingleChoiceGUI\populateCorrectionsFormProperties(), assKprimChoiceGUI\populateCorrectionsFormProperties(), assMultipleChoiceGUI\populateCorrectionsFormProperties(), assMatchingQuestionGUI\populateCorrectionsFormProperties(), ilAssQuestionSkillAssignmentPropertyFormGUI\populateFullProperties(), assKprimChoiceGUI\populateQuestionSpecificFormPart(), assImagemapQuestionGUI\populateQuestionSpecificFormPart(), assLongMenuGUI\populateQuestionSpecificFormPart(), assMatchingQuestionGUI\populateQuestionSpecificFormPart(), assClozeTestGUI\populateQuestionSpecificFormPart(), assClozeTestGUI\populateSelectGapFormPart(), assClozeTestGUI\populateTextGapFormPart(), ilSystemStyleIconsGUI\preview(), ilDclFileuploadFieldRepresentation\requiredWorkaroundForInputField(), ilAccessibilityCriterionFormGUI\setCheckInputCalled(), ilTermsOfServiceCriterionFormGUI\setCheckInputCalled(), ilObjCertificateSettingsGUI\settings(), ilObjAssessmentFolderGUI\settingsObject(), ilMailAttachmentGUI\showAttachments(), and assQuestionGUI\suggestedsolution().

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

Here is the caller graph for this function:

◆ setTitle()

ilFormPropertyGUI::setTitle ( string $a_title )

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

Referenced by ilMailFormAttachmentPropertyGUI\__construct(), __construct(), ilCertificateSettingsCourseFormRepository\createForm(), ilObjLTIAdministrationGUI\getConsumerForm(), ilObjTestGUI\getTargetQuestionpoolForm(), assOrderingQuestion\initOrderingElementFormFieldLabels(), and assQuestionGUI\populateTaxonomyFormSection().

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

Here is the caller graph for this function:

◆ setType()

ilFormPropertyGUI::setType ( string $a_type )

protected

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.

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

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

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.

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

                                      : 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) ?? []);
     }

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.

References ilUtil\stripSlashes().

Referenced by ilSamlIdpMetadataInputGUI\checkInput(), ilChatroomAuthInputGUI\getInput(), str(), and strArray().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unserializeData()

ilFormPropertyGUI::unserializeData ( string $a_data )

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

References $data.

Referenced by readFromSession().

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

Here is the caller graph for this function:

◆ writeToSession()

ilFormPropertyGUI::writeToSession ( )

Exceptions

Exception

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

References checkParentFormTable(), getSessionKey(), serializeData(), and ilSession\set().

Referenced by ilRepositorySelectorInputGUI\reset(), and ilRepositorySelectorInputGUI\selectRepositoryItem().

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