ilSubEnabledFormPropertyGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. 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)
	Get item by post var. More...
Public Member Functions inherited from ilFormPropertyGUI
	__construct (string $a_title="", string $a_postvar="")
	executeCommand ()
	getType ()
	setTitle (string $a_title)
	getTitle ()
	setPostVar (string $a_postvar)
	getPostVar ()
	getFieldId ()
	setInfo (string $a_info)
	getInfo ()
	setAlert (string $a_alert)
	getAlert ()
	setRequired (bool $a_required)
	getRequired ()
	setDisabled (bool $a_disabled)
	getDisabled ()
	checkInput ()
	Check input, strip slashes etc. More...
	setParentForm (ilPropertyFormGUI $a_parentform)
	getParentForm ()
	setParent (ilFormPropertyGUI $a_val)
	getParent ()
	getSubForm ()
	hideSubForm ()
	setHiddenTitle (string $a_val)
	getHiddenTitle ()
	getItemByPostVar (string $a_post_var)
	Get item by post var. More...
	serializeData ()
	unserializeData (string $a_data)
	setParentTable ($a_val)
	Set parent table. More...
	getParentTable ()
	Get parent table. More...
	writeToSession ()
	clearFromSession ()
	readFromSession ()
	getHiddenTag (string $a_post_var, string $a_value)
	setMulti (bool $a_multi, bool $a_sortable=false, bool $a_addremove=true)
	getMulti ()
	setMultiValues (array $a_values)
	getMultiValues ()
	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g. More...
	stripSlashesAddSpaceFallback (string $a_str)
	Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727. More...
	getTableFilterLabelFor ()
	Get label "for" attribute value for filter. More...
	getFormLabelFor ()
	Get label "for" attribute value for form. More...
	setRequestParam (string $key, $val)
	This writes the request (aka post) values. More...

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
	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 file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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

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

Member Function Documentation

addSubItem()

ilSubEnabledFormPropertyGUI::addSubItem

(

ilFormPropertyGUI

$a_item

)

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

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

References ilFormPropertyGUI\setParent().

Here is the call graph for this function:

checkSubItemsInput()

ilSubEnabledFormPropertyGUI::checkSubItemsInput ( )

final

Check SubItems.

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

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

References getSubItems().

Referenced by ilCategoryWizardInputGUI\checkInput(), ilMatrixRowWizardInputGUI\checkInput(), ilRandomTestROInputGUI\checkInput(), ilAnswerWizardInputGUI\checkInput(), ilErrorTextWizardInputGUI\checkInput(), ilEssayKeywordWizardInputGUI\checkInput(), ilImageWizardInputGUI\checkInput(), ilKprimChoiceWizardInputGUI\checkInput(), ilKVPWizardInputGUI\checkInput(), ilMatchingPairWizardInputGUI\checkInput(), ilMatchingWizardInputGUI\checkInput(), ilMultipleChoiceWizardInputGUI\checkInput(), ilSingleChoiceWizardInputGUI\checkInput(), ilSuggestedSolutionSelectorGUI\checkInput(), ilAssAnswerCorrectionsInputGUI\checkInput(), ilAssErrorTextCorrectionsInputGUI\checkInput(), ilAssMatchingPairCorrectionsInputGUI\checkInput(), ilAssMultipleChoiceCorrectionsInputGUI\checkInput(), ilAssSingleChoiceCorrectionsInputGUI\checkInput(), ilKprimChoiceCorrectionsInputGUI\checkInput(), ilTagInputGUI\checkInput(), ilCheckboxInputGUI\checkInput(), ilCSSRectInputGUI\checkInput(), ilCustomInputGUI\checkInput(), ilDateTimeInputGUI\checkInput(), ilFileWizardInputGUI\checkInput(), ilFormulaInputGUI\checkInput(), ilNonEditableValueGUI\checkInput(), ilSelectBuilderInputGUI\checkInput(), ilSelectInputGUI\checkInput(), ilTextInputGUI\checkInput(), ilTextWizardInputGUI\checkInput(), ilMultipleImagesInputGUI\onCheckInput(), and ilMultipleTextsInputGUI\onCheckInput().

Here is the call graph for this function:

Here is the caller graph for this function:

getItemByPostVar()

ilSubEnabledFormPropertyGUI::getItemByPostVar

(

string

$a_post_var

)

Get item by post var.

Reimplemented from ilFormPropertyGUI.

Reimplemented in ilCheckboxGroupInputGUI, ilRadioGroupInputGUI, and ilIncomingMailInputGUI.

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

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

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

Here is the call graph for this function:

getSubForm()

ilSubEnabledFormPropertyGUI::getSubForm ( )

final

Reimplemented from ilFormPropertyGUI.

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

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

References getSubItems().

Here is the call graph for this function:

getSubInputItemsRecursive()

ilSubEnabledFormPropertyGUI::getSubInputItemsRecursive

(

)

returns a flat array of possibly existing subitems recursively

Reimplemented in ilIncomingMailInputGUI.

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

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

getSubItems()

ilSubEnabledFormPropertyGUI::getSubItems

(

)

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

                                 : array
    {
        return $this->sub_items;
    }

References $sub_items.

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

Here is the caller graph for this function:

Field Documentation

$sub_items

array ilSubEnabledFormPropertyGUI::$sub_items = array()

protected

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

Referenced by getSubItems().

---

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

• Services/Form/classes/class.ilSubEnabledFormPropertyGUI.php