Class: HTML_QuickForm_group

Source Location: /main/inc/lib/pear/HTML/QuickForm/group.php

Class Overview

HTML_Common
   |
   --HTML_QuickForm_element
      |
      --HTML_QuickForm_group

HTML class for a form element group

Author(s):

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

Version:

Child classes:

HTML_QuickForm_hierselect: Class to dynamically create two or more HTML Select elements The first select changes the content of the second select and so on.

HTML_QuickForm_date: Class for a group of elements used to input dates (and times).

HTML_QuickForm_receivers: Form element to select receivers

Inherited Variables

Class: HTML_QuickForm_element

HTML_QuickForm_element::$_flagFrozen
HTML_QuickForm_element::$_label
HTML_QuickForm_element::$_persistantFreeze
HTML_QuickForm_element::$_type

Class: HTML_Common

HTML_Common::$_attributes
HTML_Common::$_comment
HTML_Common::$_lineEnd
HTML_Common::$_tab
HTML_Common::$_tabOffset

Inherited Methods

Class: HTML_QuickForm_element

HTML_QuickForm_element::HTML_QuickForm_element(): Class constructor
HTML_QuickForm_element::accept(): Accepts a renderer
HTML_QuickForm_element::apiVersion(): Returns the current API version
HTML_QuickForm_element::exportValue(): Returns a 'safe' element's value
HTML_QuickForm_element::freeze(): Freeze the element so that only its value is returned
HTML_QuickForm_element::getFrozenHtml(): Returns the value of field without HTML tags
HTML_QuickForm_element::getLabel(): Returns display text for the element
HTML_QuickForm_element::getName(): Returns the element name
HTML_QuickForm_element::getType(): Returns element type
HTML_QuickForm_element::getValue(): Returns the value of the form element
HTML_QuickForm_element::isFrozen(): Returns whether or not the element is frozen
HTML_QuickForm_element::onQuickFormEvent(): Called by HTML_QuickForm whenever form event is made on this element
HTML_QuickForm_element::setLabel(): Sets display text for the element
HTML_QuickForm_element::setName(): Sets the input field name
HTML_QuickForm_element::setPersistantFreeze(): Sets wether an element value should be kept in an hidden field when the element is frozen or not
HTML_QuickForm_element::setValue(): Sets the value of the form element
HTML_QuickForm_element::unfreeze(): Unfreezes the element so that it becomes editable
HTML_QuickForm_element::_findValue(): Tries to find the element value from the values array
HTML_QuickForm_element::_generateId(): Automatically generates and assigns an 'id' attribute for the element.
HTML_QuickForm_element::_getPersistantData(): Used by getFrozenHtml() to pass the element's value if _persistantFreeze is on
HTML_QuickForm_element::_prepareValue(): Used by exportValue() to prepare the value for returning

Class: HTML_Common

HTML_Common::HTML_Common(): Class constructor
HTML_Common::apiVersion(): Returns the current API version
HTML_Common::display(): Displays the HTML to the screen
HTML_Common::getAttribute(): Returns the value of the given attribute
HTML_Common::getAttributes(): Returns the assoc array (default) or string of attributes
HTML_Common::getComment(): Returns the HTML comment
HTML_Common::getTabOffset(): Returns the tabOffset
HTML_Common::removeAttribute(): Removes an attribute
HTML_Common::setAttributes(): Sets the HTML attributes
HTML_Common::setComment(): Sets the HTML comment to be displayed at the beginning of the HTML string
HTML_Common::setLineEnd(): Sets the line end style to Windows, Mac, Unix or a custom string.
HTML_Common::setTab(): Sets the string used to indent HTML
HTML_Common::setTabOffset(): Sets the tab offset
HTML_Common::toHtml(): Abstract method. Must be extended to return the objects HTML
HTML_Common::updateAttributes(): Updates the passed attributes without changing the other existing attributes
HTML_Common::_getAttrKey(): Returns the array key for the given non-name-value pair attribute
HTML_Common::_getAttrString(): Returns an HTML formatted attribute string
HTML_Common::_getLineEnd(): Returns the lineEnd
HTML_Common::_getTab(): Returns a string containing the unit for indenting HTML
HTML_Common::_getTabs(): Returns a string containing the offset for the whole HTML code
HTML_Common::_parseAttributes(): Returns a valid atrributes array from either a string or array
HTML_Common::_removeAttr(): Removes the given attribute from the given array
HTML_Common::_updateAttrArray(): Updates the attributes in $attr1 with the values in $attr2 without changing the other existing attributes

Class Details

[line 33]
HTML class for a form element group

Tags:

author:	Adam Daniel <adaniel1@eesus.jnj.com>
author:	Bertrand Mansion <bmansion@mamasam.com>
version:	1.0
since:	PHP4.04pl1
access:	public

[ Top ]

Class Variables

$_appendName = true

[line 75]

Whether to change elements' names to $groupName[$elementName] or leave them as is

Tags:

since:	3.0
access:	private

Type:

bool

[ Top ]

$_elements = array()

[line 51]

Array of grouped elements

Tags:

since:	1.0
access:	private

Type:

array

[ Top ]

$_name = ''

[line 43]

Name of the element

Tags:

since:	1.0
access:	private

Type:

string

[ Top ]

$_required = array()

[line 67]

Required elements in this group

Tags:

since:	2.5
access:	private

Type:

array

[ Top ]

$_separator = null

[line 59]

String to separate elements

Tags:

since:	2.5
access:	private

Type:

mixed

[ Top ]

Class Methods

constructor HTML_QuickForm_group [line 95]

void HTML_QuickForm_group(
[string
$elementName = null], [array
$elementLabel = null], [array
$elements = null], [mixed
$separator = null], [bool
$appendName = true])

Class constructor

Tags:

since:	1.0
access:	public

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.

[ Top ]

method accept [line 425]

void accept(
object An
&$renderer, [bool
$required = false], [string
$error = null])

Accepts a renderer

Parameters:

object An	&$renderer	HTML_QuickForm_Renderer object
bool	$required	Whether a group is required
string	$error	An error message associated with a group

[ Top ]

method exportValue [line 461]

void exportValue(

&$submitValues, [
$assoc = false])

As usual, to get the group's value we access its elements and call

their exportValue() methods

Overridden in child classes as:

HTML_QuickForm_datepicker::exportValue(): Export the date value in MySQL format

HTML_QuickForm_datepickerdate::exportValue(): Export the date value in MySQL format

Overrides HTML_QuickForm_element::exportValue() (Returns a 'safe' element's value)

Parameters:

	&$submitValues
	$assoc

[ Top ]

method freeze [line 547]

void freeze(
)

Overrides HTML_QuickForm_element::freeze() (Freeze the element so that only its value is returned)

[ Top ]

method getElementName [line 310]

mixed getElementName(
mixed
$index)

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

Tags:

return:	string with element name, false if not found
since:	3.0
access:	public

Parameters:

mixed

$index

Element name or element index in the group

[ Top ]

method getElements [line 249]

array &getElements(
)

Gets the grouped elements

Tags:

since:	2.4
access:	public

[ Top ]

method getFrozenHtml [line 353]

string getFrozenHtml(
)

Returns the value of field without HTML tags

Tags:

since:	1.3
access:	public

Overrides HTML_QuickForm_element::getFrozenHtml() (Returns the value of field without HTML tags)

[ Top ]

method getGroupType [line 266]

string getGroupType(
)

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

Tags:

return:	group elements type
access:	public

[ Top ]

method getName [line 136]

string getName(
)

Returns the group name

Tags:

since:	1.0
access:	public

Overrides HTML_QuickForm_element::getName() (Returns the element name)

[ Top ]

method getValue [line 186]

mixed getValue(
)

Returns the value of the group

Tags:

since:	1.0
access:	public

Overrides HTML_QuickForm_element::getValue() (Returns the value of the form element)

[ Top ]

method onQuickFormEvent [line 384]

void onQuickFormEvent(
string
$event, mixed
$arg, 
&$caller, object
$caller)

Called by HTML_QuickForm whenever form event is made on this element

Tags:

since:	1.0
access:	public

Overridden in child classes as:

HTML_QuickForm_hierselect::onQuickFormEvent()

HTML_QuickForm_date::onQuickFormEvent()

Overrides HTML_QuickForm_element::onQuickFormEvent() (Called by HTML_QuickForm whenever form event is made on this element)

Parameters:

string	$event	Name of event
mixed	$arg	event arguments
object	$caller	calling object
	&$caller

[ Top ]

method setElements [line 231]

void setElements(
array
$elements)

Sets the grouped elements

Tags:

since:	1.1
access:	public

Parameters:

array

$elements

Array of elements

[ Top ]

method setName [line 121]

void setName(
string
$name)

Sets the group name

Tags:

since:	1.0
access:	public

Overrides HTML_QuickForm_element::setName() (Sets the input field name)

Parameters:

string

$name

Group name

[ Top ]

method setPersistantFreeze [line 569]

void setPersistantFreeze(
[
$persistant = false])

Overrides HTML_QuickForm_element::setPersistantFreeze() (Sets wether an element value should be kept in an hidden field when the element is frozen or not)

Parameters:

$persistant

[ Top ]

method setValue [line 152]

void setValue(
mixed
$value)

Sets values for group's elements

Tags:

since:	1.0
access:	public

Overridden in child classes as:

HTML_QuickForm_hierselect::setValue(): Sets values for group's elements

HTML_QuickForm_date::setValue()

Overrides HTML_QuickForm_element::setValue() (Sets the value of the form element)

Parameters:

mixed

$value

Values for group's elements

[ Top ]

method toHtml [line 290]

string toHtml(
)

Returns Html for the group

Tags:

since:	1.0
access:	public

Overridden in child classes as:

HTML_QuickForm_hierselect::toHtml()

HTML_QuickForm_date::toHtml()

HTML_QuickForm_datepicker::toHtml(): HTML code to display this datepicker

HTML_QuickForm_datepickerdate::toHtml(): HTML code to display this datepicker

HTML_QuickForm_receivers::toHtml(): HTML representation

Overrides HTML_Common::toHtml() (Abstract method. Must be extended to return the objects HTML)

[ Top ]

method unfreeze [line 558]

void unfreeze(
)

Overrides HTML_QuickForm_element::unfreeze() (Unfreezes the element so that it becomes editable)

[ Top ]

method _createElements [line 517]

void _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.

Tags:

abstract:
access:	private

Overridden in child classes as:

HTML_QuickForm_hierselect::_createElements(): Creates all the elements for the group

HTML_QuickForm_date::_createElements()

HTML_QuickForm_receivers::_createElements(): Create the form elements to build this element group

[ Top ]

method _createElementsIfNotExist [line 534]

void _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.

Tags:

access:

private

[ Top ]

Documentation generated on Thu, 12 Jun 2008 13:35:58 -0500 by phpDocumentor 1.4.1