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.
	getSubItems ()
	Get Subitems.
	getSubInputItemsRecursive ()
	returns a flat array of possibly existing subitems recursively
	checkSubItemsInput ()
	Check SubItems.
	getSubForm ()
	Get sub form html.
	getItemByPostVar ($a_post_var)
	Get item by post var.
Public Member Functions inherited from ilFormPropertyGUI
	__construct ($a_title="", $a_postvar="")
	Constructor.
&	executeCommand ()
	Execute command.
	getType ()
	Get Type.
	setTitle ($a_title)
	Set Title.
	getTitle ()
	Get Title.
	setPostVar ($a_postvar)
	Set Post Variable.
	getPostVar ()
	Get Post Variable.
	getFieldId ()
	Get Post Variable.
	setInfo ($a_info)
	Set Information Text.
	getInfo ()
	Get Information Text.
	setAlert ($a_alert)
	Set Alert Text.
	getAlert ()
	Get Alert Text.
	setRequired ($a_required)
	Set Required.
	getRequired ()
	Get Required.
	setDisabled ($a_disabled)
	Set Disabled.
	getDisabled ()
	Get Disabled.
	checkInput ()
	Check input, strip slashes etc.
	setParentForm ($a_parentform)
	Set Parent Form.
	getParentForm ()
	Get Parent Form.
	setParent ($a_val)
	Set Parent GUI object.
	getParent ()
	Get Parent GUI object.
	hideSubForm ()
	Sub form hidden on init?
	setHiddenTitle ($a_val)
	Set hidden title (for screenreaders)
	getHiddenTitle ()
	Get hidden title.
	serializeData ()
	serialize data
	unserializeData ($a_data)
	unserialize data
	writeToSession ()
	Write to session.
	clearFromSession ()
	Clear session value.
	readFromSession ()
	Read from session.
	getHiddenTag ($a_post_var, $a_value)
	Get hidden tag (used for disabled properties)
	setMulti ($a_multi, $a_sortable=false, $a_addremove=true)
	Set Multi.
	getMulti ()
	Get Multi.
	setMultiValues (array $a_values)
	Set multi values.
	getMultiValues ()
	Get multi values.
	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g.

Protected Attributes
	$sub_items = array()
Protected Attributes inherited from ilFormPropertyGUI
	$type
	$title
	$postvar
	$info
	$alert
	$required = false
	$parentgui
	$parentform
	$hidden_title = ""
	$multi = false
	$multi_sortable = false
	$multi_addremove = true
	$multi_values

Additional Inherited Members
Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type.
	getMultiIconsHTML ()
	Get HTML for multiple value icons.

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

ilSubEnabledFormPropertyGUI::addSubItem ( $a_item )

Add Subitem.

Parameters

object $a_item Item

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

Referenced by ilObjAuthSettingsGUI\getApacheAuthSettingsForm(), ilPCMediaObjectGUI\initAliasForm(), ilSetupGUI\initDbSlaveForm(), ilObjPollGUI\initEditCustomForm(), ilObjBibliographicGUI\initEditForm(), ilDataCollectionRecordListViewdefinitionGUI\initForm(), ilRegistrationSettingsGUI\initForm(), ilDataCollectionFieldEditGUI\initForm(), ilObjMediaObjectGUI\initForm(), ilLDAPSettingsGUI\initForm(), ilObjectActivationGUI\initFormEdit(), ilObjUserFolderGUI\initFormGeneralSettings(), ilObjLinkResourceGUI\initFormLink(), ilPCListGUI\initListForm(), ilObjWikiGUI\initSettingsForm(), ilObjGlossaryGUI\initSettingsForm(), ilSettingsTemplateGUI\initSettingsTemplateForm(), and assTextQuestionGUI\populateAnswerSpecificFormPart().

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

Here is the caller graph for this function:

ilSubEnabledFormPropertyGUI::checkSubItemsInput ( )

final

Check SubItems.

Returns: boolean Input ok, true/false

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

References $ok, and getSubItems().

        {
                $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:

ilSubEnabledFormPropertyGUI::getItemByPostVar ( $a_post_var )

Get item by post var.

Returns: mixed false or item object

Reimplemented from ilFormPropertyGUI.

Reimplemented in ilRadioGroupInputGUI, and ilCheckboxGroupInputGUI.

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

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

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

Here is the call graph for this function:

ilSubEnabledFormPropertyGUI::getSubForm ( )

final

Get sub form html.

Reimplemented from ilFormPropertyGUI.

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

References getSubItems().

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

ilSubEnabledFormPropertyGUI::getSubInputItemsRecursive ( )

returns a flat array of possibly existing subitems recursively

Returns: array

Definition at line 62 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;
        }

ilSubEnabledFormPropertyGUI::getSubItems ( )

Get Subitems.

Returns: array Array of items

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

References $sub_items.

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

        {
                return $this->sub_items;
        }

Here is the caller graph for this function:

Field Documentation

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

Field Documentation