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

Inheritance diagram for ilSubEnabledFormPropertyGUI:

Collaboration diagram for ilSubEnabledFormPropertyGUI:

Public Member Functions
	addSubItem ($a_item)
	Add Subitem. More...

	getSubItems ()
	Get Subitems. More...

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

	checkSubItemsInput ()
	Check SubItems. More...

	getSubForm ()
	Get sub form html. More...

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

Public Member Functions inherited from ilFormPropertyGUI
	__construct ($a_title="", $a_postvar="")
	Constructor. More...

	executeCommand ()
	Execute command. More...

	getType ()
	Get Type. More...

	setTitle ($a_title)
	Set Title. More...

	getTitle ()
	Get Title. More...

	setPostVar ($a_postvar)
	Set Post Variable. More...

	getPostVar ()
	Get Post Variable. More...

	getFieldId ()
	Get Post Variable. More...

	setInfo ($a_info)
	Set Information Text. More...

	getInfo ()
	Get Information Text. More...

	setAlert ($a_alert)
	Set Alert Text. More...

	getAlert ()
	Get Alert Text. More...

	setRequired ($a_required)
	Set Required. More...

	getRequired ()
	Get Required. More...

	setDisabled ($a_disabled)
	Set Disabled. More...

	getDisabled ()
	Get Disabled. More...

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

	setParentForm ($a_parentform)
	Set Parent Form. More...

	getParentForm ()
	Get Parent Form. More...

	setParent ($a_val)
	Set Parent GUI object. More...

	getParent ()
	Get Parent GUI object. More...

	getSubForm ()
	Get sub form html. More...

	hideSubForm ()
	Sub form hidden on init? More...

	setHiddenTitle ($a_val)
	Set hidden title (for screenreaders) More...

	getHiddenTitle ()
	Get hidden title. More...

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

	serializeData ()
	serialize data More...

	unserializeData ($a_data)
	unserialize data More...

	writeToSession ()
	Write to session. More...

	clearFromSession ()
	Clear session value. More...

	readFromSession ()
	Read from session. More...

	getHiddenTag ($a_post_var, $a_value)
	Get hidden tag (used for disabled properties) More...

	setMulti ($a_multi, $a_sortable=false, $a_addremove=true)
	Set Multi. More...

	getMulti ()
	Get Multi. More...

	setMultiValues (array $a_values)
	Set multi values. More...

	getMultiValues ()
	Get multi values. More...

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

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

Protected Attributes
	$sub_items = array()

Protected Attributes inherited from ilFormPropertyGUI
	$ctrl

	$lng

	$type

	$title

	$postvar

	$info

	$alert

	$required = false

	$parentgui

	$parentform

	$hidden_title = ""

	$multi = false

	$multi_sortable = false

	$multi_addremove = true

	$multi_values

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

Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type. More...

	getMultiIconsHTML ()
	Get HTML for multiple value icons. More...

Detailed Description

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

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

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

Member Function Documentation

◆ addSubItem()

ilSubEnabledFormPropertyGUI::addSubItem ( $a_item )

Add Subitem.

Parameters

object $a_item Item

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

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

◆ checkSubItemsInput()

ilSubEnabledFormPropertyGUI::checkSubItemsInput ( )

final

Check SubItems.

Returns: boolean Input ok, true/false

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

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

References $ok, and getSubItems().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getItemByPostVar()

ilSubEnabledFormPropertyGUI::getItemByPostVar ( $a_post_var )

Get item by post var.

Returns: mixed false or item object

Reimplemented from ilFormPropertyGUI.

Reimplemented in ilCheckboxGroupInputGUI, ilRadioGroupInputGUI, and ilIncomingMailInputGUI.

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

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

References $ret, ilFormPropertyGUI\getPostVar(), and getSubItems().

Here is the call graph for this function:

◆ getSubForm()

ilSubEnabledFormPropertyGUI::getSubForm ( )

final

Get sub form html.

Reimplemented from ilFormPropertyGUI.

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

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

Returns: array

Reimplemented in ilIncomingMailInputGUI.

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

    {
        $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 ( )

Get Subitems.

Returns: array Array of items

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

    {
        return $this->sub_items;
    }

References $sub_items.

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

Here is the caller graph for this function:

Field Documentation

◆ $sub_items

ilSubEnabledFormPropertyGUI::$sub_items = array()

protected

Definition at line 35 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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addSubItem()

◆ checkSubItemsInput()

◆ getItemByPostVar()

◆ getSubForm()

◆ getSubInputItemsRecursive()

◆ getSubItems()

Field Documentation

◆ $sub_items