Docs For Class HTML_QuickForm2

addElement [line 279]

HTML_QuickForm2_Node addElement(
string|HTML_QuickForm2_Node
$elementOrType, [string
$name = null], [string|array
$attributes = null], [
$data = array()])

Appends an element to the container (possibly creating it first)

If the first parameter is an instance of HTML_QuickForm2_Node then all other parameters are ignored and the method just calls appendChild(). In the other case the element is first created via HTML_QuickForm2_Factory::createElement() and then added via the same method. This is a convenience method to reduce typing and ease porting from HTML_QuickForm.

Return: Added element
Throws: HTML_QuickForm2_NotFoundException
Throws: HTML_QuickForm2_InvalidArgumentException
Access: public

Parameters:

string\|HTML_QuickForm2_Node	`$elementOrType`	—	Either type name (treated case-insensitively) or an element instance
string	`$name`	—	Element name
string\|array	`$attributes`	—	Element attributes
array	`$data`	—	Element-specific data

[ Top ]

appendChild [line 249]

HTML_QuickForm2_Node appendChild(
HTML_QuickForm2_Node
$element)

Appends an element to the container

If the element was previously added to the container or to another container, it is first removed there.

Return: Added element
Throws: HTML_QuickForm2_InvalidArgumentException
Access: public

Overridden in child classes as:

HTML_QuickForm2_Container_Repeat::appendChild(): Appends an element to the prototype container

HTML_QuickForm2_Container_Group::appendChild(): Appends an element to the container

Parameters:

HTML_QuickForm2_Node $element — Element to add

[ Top ]

arrayMerge [line 216]

array arrayMerge(
array
$a, array
$b)

Merges two arrays

Merges two arrays like the PHP function array_merge_recursive does, the difference being that existing integer keys will not be renumbered.

Return: resulting array
Access: public

Parameters:

array	`$a`	—
array	`$b`	—

[ Top ]

count [line 419]

int count(
)

Returns the number of elements in the container

Access: public

[ Top ]

getChildValues [line 136]

array|null getChildValues(
[bool
$filtered = false])

Returns the array containing child elements' values

Access: protected

Overridden in child classes as:

HTML_QuickForm2_Container_Repeat::getChildValues(): Returns the array containing child elements' values

HTML_QuickForm2_Container_Group::getChildValues()

Parameters:

bool $filtered — Whether child elements should apply filters on values

[ Top ]

getElementById [line 330]

HTML_QuickForm2_Node|null getElementById(
string
$id)

Returns an element if its id is found

Access: public

Parameters:

string $id — Element id to search for

[ Top ]

getElements [line 233]

array getElements(
)

Returns an array of this container's elements

Return: Container elements
Access: public

[ Top ]

getElementsByName [line 347]

array getElementsByName(
string
$name)

Returns an array of elements which name corresponds to element

Access: public

Parameters:

string $name — Element name to search for

[ Top ]

getIterator [line 395]

HTML_QuickForm2_ContainerIterator getIterator(
)

Returns a recursive iterator for the container elements

Access: public

[ Top ]

getJavascriptTriggers [line 539]

void getJavascriptTriggers(
)

Access: public

Overrides HTML_QuickForm2_Node::getJavascriptTriggers() (Returns IDs of form fields that should trigger "live" Javascript validation)

[ Top ]

getJavascriptValue [line 528]

string getJavascriptValue(
[bool
$inContainer = false])

Returns Javascript code for getting the element's value

Access: public

Overrides HTML_QuickForm2_Node::getJavascriptValue() (Returns Javascript code for getting the element's value)

Parameters:

bool $inContainer — Whether it should return a parameter for qf.form.getContainerValue()

[ Top ]

getRawValue [line 185]

array|null getRawValue(
)

Returns the container's value without filters applied

The default implementation for Containers is to return an array with contained elements' values. The array is indexed the same way $_GET and $_POST arrays would be for these elements.

Access: public

Overrides HTML_QuickForm2_Node::getRawValue() (Returns the element's value without filters applied)

[ Top ]

getRecursiveIterator [line 407]

RecursiveIteratorIterator getRecursiveIterator(
[int
$mode = RecursiveIteratorIterator::SELF_FIRST])

Returns a recursive iterator iterator for the container elements

Access: public

Parameters:

int $mode — mode passed to RecursiveIteratorIterator

[ Top ]

getValue [line 199]

array|null getValue(
)

Returns the container's value, possibly with filters applied

The default implementation for Containers is to return an array with contained elements' values. The array is indexed the same way $_GET and $_POST arrays would be for these elements.

Access: public

Overrides HTML_QuickForm2_Node::getValue() (Returns the element's value, possibly with filters applied)

[ Top ]

insertBefore [line 368]

HTML_QuickForm2_Node insertBefore(
HTML_QuickForm2_Node
$element, [HTML_QuickForm2_Node
$reference = null])

Inserts an element in the container

If the reference object is not given, the element will be appended.

Return: Inserted element
Access: public

Overridden in child classes as:

HTML_QuickForm2_Container_Repeat::insertBefore(): Inserts an element to the prototype container

HTML_QuickForm2_Container_Group::insertBefore(): Inserts an element in the container

Parameters:

HTML_QuickForm2_Node	`$element`	—	Element to insert
HTML_QuickForm2_Node	`$reference`	—	Reference to insert before

[ Top ]

persistentFreeze [line 109]

void persistentFreeze(
[
$persistent = null])

Access: public

Overrides HTML_QuickForm2_Node::persistentFreeze() (Changes the element's persistent freeze behaviour)

Parameters:

$persistent —

[ Top ]

prependsName [line 124]

bool prependsName(
)

Whether container prepends its name to names of contained elements

Access: protected

Overridden in child classes as:

HTML_QuickForm2_Container_Group::prependsName()

[ Top ]

removeChild [line 299]

HTML_QuickForm2_Node removeChild(
HTML_QuickForm2_Node
$element)

Removes the element from this container

Return: Removed object
Throws: HTML_QuickForm2_NotFoundException
Access: public

Overridden in child classes as:

HTML_QuickForm2_Container_Repeat::removeChild(): Removes the element from the prototype container

HTML_QuickForm2_Container_Group::removeChild(): Removes the element from this container

Parameters:

HTML_QuickForm2_Node $element — Element to remove

[ Top ]

render [line 500]

HTML_QuickForm2_Renderer render(
HTML_QuickForm2_Renderer
$renderer)

Renders the container using the given renderer

Access: public

Overridden in child classes as:

HTML_QuickForm2::render(): Renders the form using the given renderer

HTML_QuickForm2_Container_Repeat::render(): Renders the container using the given renderer

HTML_QuickForm2_Container_Group::render(): Renders the group using the given renderer

HTML_QuickForm2_Element_Hierselect::render(): Renders the hierselect using the given renderer

Overrides HTML_QuickForm2_Node::render() (Renders the element using the given renderer)

Parameters:

HTML_QuickForm2_Renderer $renderer —

[ Top ]

setName [line 93]

void setName(

$name)

Access: public

Overridden in child classes as:

HTML_QuickForm2_Container_Group::setName()

HTML_QuickForm2_Element_Hierselect::setName(): Sets the element's name

HTML_QuickForm2_Container_Fieldset::setName()

Overrides HTML_QuickForm2_Node::setName() (Sets the element's name)

Parameters:

$name —

[ Top ]

toggleFrozen [line 99]

void toggleFrozen(
[
$freeze = null])

Access: public

Overrides HTML_QuickForm2_Node::toggleFrozen() (Changes the element's frozen status)

Parameters:

$freeze —

[ Top ]

updateValue [line 430]

void updateValue(
)

Called when the element needs to update its value from form's data sources

The default behaviour is just to call the updateValue() methods of contained elements, since default Container doesn't have any value itself

Access: protected

Overridden in child classes as:

HTML_QuickForm2_Container_Repeat::updateValue(): Called when the element needs to update its value from form's data sources

HTML_QuickForm2_Element_Date::updateValue(): Called when the element needs to update its value from form's data sources

HTML_QuickForm2_Element_Hierselect::updateValue(): Called when the element needs to update its value from form's data sources

Overrides HTML_QuickForm2_Node::updateValue() (Called when the element needs to update its value from form's data sources)

[ Top ]

validate [line 445]

boolean validate(
)

Performs the server-side validation

This method also calls validate() on all contained elements.

Return: Whether the container and all contained elements are valid
Access: protected

Overridden in child classes as:

HTML_QuickForm2::validate(): Performs the server-side validation

HTML_QuickForm2_Container_Repeat::validate(): Performs the server-side validation

Overrides HTML_QuickForm2_Node::validate() (Performs the server-side validation)

[ Top ]

__call [line 479]

HTML_QuickForm2_Node __call(
string
$m, array
$a)

Appends an element to the container, creating it first

The element will be created via HTML_QuickForm2_Factory::createElement() and then added via the appendChild() method. The element type is deduced from the method name. This is a convenience method to reduce typing.

Return: Added element
Throws: HTML_QuickForm2_NotFoundException
Throws: HTML_QuickForm2_InvalidArgumentException
Access: public

Parameters:

string	`$m`	—	Method name
array	`$a`	—	Method arguments

[ Top ]

__toString [line 511]

void __toString(
)

Access: public

Overridden in child classes as:

HTML_QuickForm2_Container_Group::__toString()

[ Top ]

Class: HTML_QuickForm2_Container

Class Overview

Author(s):

Version:

Variables

Methods

Child classes:

Inherited Variables

Class: HTML_QuickForm2_Node

Inherited Methods

Class: HTML_QuickForm2_Node

Class Details

Class Variables

$elements = array()

Method Detail

addElement [line 279]

Parameters:

appendChild [line 249]

Parameters:

arrayMerge [line 216]

Parameters:

count [line 419]

getChildValues [line 136]

Parameters:

getElementById [line 330]

Parameters:

getElements [line 233]

getElementsByName [line 347]

Parameters:

getIterator [line 395]

getJavascriptTriggers [line 539]

getJavascriptValue [line 528]

Parameters:

getRawValue [line 185]

getRecursiveIterator [line 407]

Parameters:

getValue [line 199]

insertBefore [line 368]

Parameters:

persistentFreeze [line 109]

Parameters:

prependsName [line 124]

removeChild [line 299]

Parameters:

render [line 500]

Parameters:

setName [line 93]

Parameters:

toggleFrozen [line 99]

Parameters:

updateValue [line 430]

validate [line 445]

__call [line 479]

Parameters:

__toString [line 511]