Inheritance diagram for HTML_QuickForm_group:

Collaboration diagram for HTML_QuickForm_group:

Public Member Functions
	HTML_QuickForm_group ($elementName=null, $elementLabel=null, $elements=null, $separator=null, $appendName=true)
	setName ($name)
	getName ()
	setValue ($value)
	getValue ()
	setElements ($elements)
&	getElements ()
	getGroupType ()
	toHtml ()
	getElementName ($index)
	getFrozenHtml ()
	onQuickFormEvent ($event, $arg, &$caller)
	accept (&$renderer, $required=false, $error=null)
	exportValue (&$submitValues, $assoc=false)
	_createElements ()
	_createElementsIfNotExist ()
	freeze ()
	unfreeze ()
	setPersistantFreeze ($persistant=false)
Data Fields
	$_name = ''
	$_elements = array()
	$_separator = null
	$_required = array()
	$_appendName = true

Detailed Description

HTML class for a form element group

Author:: Adam Daniel <adaniel1@eesus.jnj.com>; Bertrand Mansion <bmansion@mamasam.com>

Version:: 1.0

Since:: PHP4.04pl1 public

Definition at line 33 of file group.php.

Member Function Documentation

_createElements ( )

Creates the group's elements.

This should be overriden by child classes that need to create their elements. The method will be called automatically when needed, calling it from the constructor is discouraged as the constructor is usually called _twice_ on element creation, first time with _no_ parameters.

private

Reimplemented in HTML_QuickForm_date, HTML_QuickForm_hierselect, MoodleQuickForm_duration, MoodleQuickForm_tags, MoodleQuickForm_date_time_selector, and MoodleQuickForm_date_selector.

Definition at line 517 of file group.php.

Here is the caller graph for this function:

_createElementsIfNotExist ( )

A wrapper around _createElements()

This method calls _createElements() if the group's _elements array is empty. It also performs some updates, e.g. freezes the created elements if the group is already frozen.

private

Definition at line 534 of file group.php.

Here is the call graph for this function:

Here is the caller graph for this function:

accept	(	&$	renderer,
		$	required = `false`,
		$	error = `null`
	)

Accepts a renderer

Parameters:

object	An HTML_QuickForm_Renderer object
bool	Whether a group is required
string	An error message associated with a group public

Returns:: void

Reimplemented from HTML_QuickForm_element.

Reimplemented in HTML_QuickForm_date, HTML_QuickForm_hierselect, MoodleQuickForm_tags, MoodleQuickForm_date_time_selector, and MoodleQuickForm_date_selector.

Definition at line 425 of file group.php.

Here is the call graph for this function:

Here is the caller graph for this function:

exportValue	(	&$	submitValues,
		$	assoc = `false`
	)

As usual, to get the group's value we access its elements and call their exportValue() methods

Reimplemented from HTML_QuickForm_element.

Reimplemented in MoodleQuickForm_date_time_selector, MoodleQuickForm_tags, and MoodleQuickForm_date_selector.

Definition at line 461 of file group.php.

Here is the call graph for this function:

freeze ( )

Freeze the element so that only its value is returned

public

Returns:: void

Reimplemented from HTML_QuickForm_element.

Definition at line 547 of file group.php.

Here is the caller graph for this function:

getElementName ( $ index )

Returns the element name inside the group such as found in the html form

Parameters:

mixed $index Element name or element index in the group

Since:: 3.0 public

Returns:: mixed string with element name, false if not found

Definition at line 310 of file group.php.

Here is the call graph for this function:

& getElements ( )

Gets the grouped elements

Since:: 2.4 public

Returns:: array

Definition at line 249 of file group.php.

Here is the call graph for this function:

getFrozenHtml ( )

Returns the value of field without HTML tags

Since:: 1.3 public

Returns:: string

Reimplemented from HTML_QuickForm_element.

Definition at line 353 of file group.php.

Here is the call graph for this function:

getGroupType ( )

Gets the group type based on its elements Will return 'mixed' if elements contained in the group are of different types.

public

Returns:: string group elements type

Definition at line 266 of file group.php.

Here is the call graph for this function:

Here is the caller graph for this function:

getName ( )

Returns the group name

Since:: 1.0 public

Returns:: string

Reimplemented from HTML_QuickForm_element.

Definition at line 136 of file group.php.

Here is the caller graph for this function:

getValue ( )

Returns the value of the group

Since:: 1.0 public

Returns:: mixed

Reimplemented from HTML_QuickForm_element.

Definition at line 186 of file group.php.

Here is the caller graph for this function:

HTML_QuickForm_group	(	$	elementName = `null`,
		$	elementLabel = `null`,
		$	elements = `null`,
		$	separator = `null`,
		$	appendName = `true`
	)

Class constructor

Parameters:

string	$elementName	(optional)Group name
array	$elementLabel	(optional)Group label
array	$elements	(optional)Group elements
mixed	$separator	(optional)Use a string for one separator, use an array to alternate the separators.
bool	$appendName	(optional)whether to change elements' names to the form $groupName[$elementName] or leave them as is.