This class represents a property that may include a sub form. More...

Inheritance diagram for ilSubEnabledFormPropertyGUI:

Collaboration diagram for ilSubEnabledFormPropertyGUI:

Public Member Functions
	addSubItem (ilFormPropertyGUI $a_item)

	getSubItems ()

	getSubInputItemsRecursive ()
	returns a flat array of possibly existing subitems recursively More...

	checkSubItemsInput ()
	Check SubItems. More...

	getSubForm ()

	getItemByPostVar (string $a_post_var)

Public Member Functions inherited from ilFormPropertyGUI
	__construct (string $a_title="", string $a_postvar="")

	executeCommand ()

	getType ()

	setTitle (string $a_title)

	getTitle ()

	setPostVar (string $a_postvar)

	getPostVar ()

	getFieldId ()

	setInfo (string $a_info)

	getInfo ()

	setAlert (string $a_alert)

	getAlert ()

	setRequired (bool $a_required)

	getRequired ()

	setDisabled (bool $a_disabled)

	getDisabled ()

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

	setParentForm (ilPropertyFormGUI $a_parentform)

	getParentForm ()

	setParent (ilFormPropertyGUI $a_val)

	getParent ()

	getSubForm ()

	hideSubForm ()

	setHiddenTitle (string $a_val)

	getHiddenTitle ()

	getItemByPostVar (string $a_post_var)
	Get item by post var. More...

	serializeData ()

	unserializeData (string $a_data)

	setParentTable ($a_val)
	Set parent table. More...

	getParentTable ()
	Get parent table. More...

	writeToSession ()

	clearFromSession ()

	readFromSession ()

	getHiddenTag (string $a_post_var, string $a_value)

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

	getMulti ()

	setMultiValues (array $a_values)

	getMultiValues ()

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

	stripSlashesAddSpaceFallback (string $a_str)
	Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727. More...

	getTableFilterLabelFor ()
	Get label "for" attribute value for filter. More...

	getFormLabelFor ()
	Get label "for" attribute value for form. More...

	setRequestParam (string $key, $val)
	This writes the request (aka post) values. More...

Protected Attributes
array	$sub_items = array()

Protected Attributes inherited from ilFormPropertyGUI
array	$set_params = []

ilTable2GUI	$parent_table = null

ilFormPropertyGUI	$parent_gui = null

ilCtrl	$ctrl

ilLanguage	$lng

string	$type = ""

string	$title = ""

string	$postvar = ""

string	$info = ""

string	$alert = ""

bool	$required = false

ilPropertyFormGUI	$parentform = null

string	$hidden_title = ""

bool	$multi = false

bool	$multi_sortable = false

bool	$multi_addremove = true

array	$multi_values = []

RequestInterface	$request

HTTP Services	$http

Refinery Factory	$refinery = null

bool	$disabled = false

ilGlobalTemplateInterface	$global_tpl = null

Additional Inherited Members
Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters (string $a_text)
	Remove prohibited characters see #19159. More...

Protected Member Functions inherited from ilFormPropertyGUI
	symbol ()

	setType (string $a_type)

	checkParentFormTable ()

	getSessionKey ()

	getMultiIconsHTML ()

	int ($key)

	intArray ($key)

	str ($key)

	raw ($key)

	strArray ($key)

	arrayArray ($key)

	isRequestParamArray (string $key)

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

Detailed Description

This class represents a property that may include a sub form.

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

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

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

Member Function Documentation

◆ addSubItem()

ilSubEnabledFormPropertyGUI::addSubItem ( ilFormPropertyGUI $a_item )

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

References ilFormPropertyGUI\setParent().

Referenced by ilDclIliasReferenceFieldRepresentation\buildFieldCreationInput(), ilDclTextFieldRepresentation\buildFieldCreationInput(), ilDclCopyFieldRepresentation\buildFieldCreationInput(), ilDclReferenceFieldRepresentation\buildFieldCreationInput(), ilPCMediaObjectGUI\initAliasForm(), ilExAssignmentEditorGUI\initAssignmentForm(), ilPCDataTableGUI\initCellPropertiesForm(), ilObjSAHSLearningModuleGUI\initCreateForm(), ilLTIConsumeProviderFormGUI\initForm(), ilPCVerificationGUI\initForm(), ilRegistrationSettingsGUI\initForm(), ilObjMediaObjectGUI\initForm(), ilLDAPSettingsGUI\initForm(), ilObjCalendarSettingsGUI\initFormSettings(), ilPCListGUI\initListForm(), ilSurveyRaterGUI\initOptionSelectForm(), ilExAssignmentEditorGUI\initPeerReviewForm(), ilObjSCORMLearningModuleGUI\initPropertiesForm(), ilObjSCORM2004LearningModuleGUI\initPropertiesForm(), ilObjSCORMLearningModuleGUI\newModuleVersion(), assTextQuestionGUI\populateAnswerSpecificFormPart(), and ilAssQuestionSkillAssignmentPropertyFormGUI\populateFullProperties().

                                                          : void
     {
         $a_item->setParent($this);
         $this->sub_items[] = $a_item;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkSubItemsInput()

ilSubEnabledFormPropertyGUI::checkSubItemsInput ( )

final

Check SubItems.

Definition at line 67 of file class.ilSubEnabledFormPropertyGUI.php.

References getSubItems().

                                               : bool
     {
         $ok = true;
         foreach ($this->getSubItems() as $item) {
             $item_ok = $item->checkInput();
             if (!$item_ok) {
                 $ok = false;
             }
         }
         return $ok;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getItemByPostVar()

ilSubEnabledFormPropertyGUI::getItemByPostVar ( string $a_post_var )

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

References ilFormPropertyGUI\getPostVar(), getSubItems(), and null.

                                                         : ?ilFormPropertyGUI
     {
         if ($this->getPostVar() == $a_post_var) {
             return $this;
         }
 
         foreach ($this->getSubItems() as $item) {
             if ($item->getType() != "section_header") {
                 $ret = $item->getItemByPostVar($a_post_var);
                 if (is_object($ret)) {
                     return $ret;
                 }
             }
         }
 
         return null;
     }

Here is the call graph for this function:

◆ getSubForm()

ilSubEnabledFormPropertyGUI::getSubForm ( )

final

Definition at line 79 of file class.ilSubEnabledFormPropertyGUI.php.

References getSubItems(), and null.

                                       : ?ilPropertyFormGUI
     {
         // subitems
         $pf = null;
         if (count($this->getSubItems()) > 0) {
             $pf = new ilPropertyFormGUI();
             $pf->setMode("subform");
             $pf->setItems($this->getSubItems());
         }
 
         return $pf;
     }

Here is the call graph for this function:

◆ getSubInputItemsRecursive()

ilSubEnabledFormPropertyGUI::getSubInputItemsRecursive ( )

returns a flat array of possibly existing subitems recursively

Definition at line 45 of file class.ilSubEnabledFormPropertyGUI.php.

Referenced by ilRadioGroupInputGUI\getTableFilterHTML(), and ilCheckboxGroupInputGUI\render().

                                                : array
     {
         $subInputItems = array();
 
         foreach ($this->sub_items as $subItem) {
             if ($subItem->getType() == 'section_header') {
                 continue;
             }
 
             $subInputItems[] = $subItem;
 
             if ($subItem instanceof ilSubEnabledFormPropertyGUI) {
                 $subInputItems = array_merge($subInputItems, $subItem->getSubInputItemsRecursive());
             }
         }
 
         return $subInputItems;
     }

Here is the caller graph for this function:

◆ getSubItems()

ilSubEnabledFormPropertyGUI::getSubItems ( )

Definition at line 37 of file class.ilSubEnabledFormPropertyGUI.php.

References $sub_items.

Referenced by checkSubItemsInput(), getItemByPostVar(), getSubForm(), ilDclTextInputGUI\setValueByArray(), ilCustomInputGUI\setValueByArray(), ilCheckboxInputGUI\setValueByArray(), ilSelectInputGUI\setValueByArray(), ilChatroomAuthInputGUI\setValueByArray(), ilDateTimeInputGUI\setValueByArray(), ilTagInputGUI\setValueByArray(), ilNonEditableValueGUI\setValueByArray(), ilDateDurationInputGUI\setValueByArray(), and ilTextAreaInputGUI\setValueByArray().

                                  : array
     {
         return $this->sub_items;
     }

Here is the caller graph for this function:

Field Documentation

◆ $sub_items

array ilSubEnabledFormPropertyGUI::$sub_items = array()

protected

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

Referenced by getSubItems().

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addSubItem()

◆ checkSubItemsInput()

◆ getItemByPostVar()

◆ getSubForm()

◆ getSubInputItemsRecursive()

◆ getSubItems()

Field Documentation

◆ $sub_items