Class: HTML_QuickForm_group

Source Location: /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:

Methods

Child classes:

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

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.

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

Class: HTML_Common

HTML_Common::HTML_Common(): Class constructor
HTML_Common::apiVersion(): Returns the current API version
HTML_Common::charset(): Sets the charset to use by htmlspecialchars() function
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::setAttribute(): Sets the value of the 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

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

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_date::onQuickFormEvent()

HTML_QuickForm_hierselect::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_date::setValue()

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

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_date::toHtml()

HTML_QuickForm_hierselect::toHtml()

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 ]

Documentation generated on Sun, 08 Jan 2012 17:51:50 +0100 by phpDocumentor 1.4.3