HTML_QuickForm2
[ class tree: HTML_QuickForm2 ] [ index: HTML_QuickForm2 ] [ all elements ]
Packages:
HTML_QuickForm2


Classes:
HTML_QuickForm2
HTML_QuickForm2_Container
HTML_QuickForm2_ContainerIterator
HTML_QuickForm2_Container_Fieldset
HTML_QuickForm2_Container_Group
HTML_QuickForm2_DataSource_Array
HTML_QuickForm2_DataSource_SuperGlobal
HTML_QuickForm2_Element
HTML_QuickForm2_Element_Button
HTML_QuickForm2_Element_Input
HTML_QuickForm2_Element_InputButton
HTML_QuickForm2_Element_InputCheckable
HTML_QuickForm2_Element_InputCheckbox
HTML_QuickForm2_Element_InputFile
HTML_QuickForm2_Element_InputHidden
HTML_QuickForm2_Element_InputImage
HTML_QuickForm2_Element_InputPassword
HTML_QuickForm2_Element_InputRadio
HTML_QuickForm2_Element_InputReset
HTML_QuickForm2_Element_InputSubmit
HTML_QuickForm2_Element_InputText
HTML_QuickForm2_Element_Select
HTML_QuickForm2_Element_Select_Optgroup
HTML_QuickForm2_Element_Select_OptionContainer
HTML_QuickForm2_Element_Select_OptionIterator
HTML_QuickForm2_Element_Textarea
HTML_QuickForm2_Exception
HTML_QuickForm2_Factory
HTML_QuickForm2_InvalidArgumentException
HTML_QuickForm2_Loader
HTML_QuickForm2_Node
HTML_QuickForm2_NotFoundException
HTML_QuickForm2_Renderer
HTML_QuickForm2_Renderer_Array
HTML_QuickForm2_Renderer_Default
HTML_QuickForm2_Renderer_Plugin
HTML_QuickForm2_Renderer_Proxy
HTML_QuickForm2_Rule
HTML_QuickForm2_Rule_Callback
HTML_QuickForm2_Rule_Compare
HTML_QuickForm2_Rule_Empty
HTML_QuickForm2_Rule_Length
HTML_QuickForm2_Rule_MaxFileSize
HTML_QuickForm2_Rule_MimeType
HTML_QuickForm2_Rule_Nonempty
HTML_QuickForm2_Rule_Regex
HTML_QuickForm2_Rule_Required
HTML_QuickForm2
   HTML_QuickForm2_Element_DualSelect
   HTML_QuickForm2_Renderer_Default_DualSelectPlugin
Files:
Array.php
Array.php
basic-elements.php
builtin-rules.php
Button.php
Callback.php
Compare.php
Container.php
DataSource.php
default-renderer.php
Default.php
dualselect.php
Element.php
Empty.php
Exception.php
Factory.php
Fieldset.php
Group.php
Input.php
InputButton.php
InputCheckable.php
InputCheckbox.php
InputFile.php
InputHidden.php
InputImage.php
InputPassword.php
InputRadio.php
InputReset.php
InputSubmit.php
InputText.php
Length.php
Loader.php
MaxFileSize.php
MimeType.php
Node.php
Nonempty.php
Plugin.php
Proxy.php
QuickForm2.php
Regex.php
Renderer.php
Required.php
Rule.php
Select.php
Submit.php
SuperGlobal.php
Textarea.php

Class: HTML_QuickForm2_Container

Source Location: /HTML_QuickForm2-0.3.0/QuickForm2/Container.php

Class Overview

HTML_Common2
   |
   --HTML_QuickForm2_Node
      |
      --HTML_QuickForm2_Container

Abstract base class for simple QuickForm2 containers


Author(s):

Version:

  • Release: 0.3.0

Variables

Methods

Child classes:

HTML_QuickForm2
Class representing a HTML form
HTML_QuickForm2_Container_Fieldset
Concrete implementation of a container for fieldsets
HTML_QuickForm2_Container_Group
Base class for QuickForm2 groups of elements

Inherited Variables

Class: HTML_QuickForm2_Node

HTML_QuickForm2_Node::$container
HTML_QuickForm2_Node::$data
HTML_QuickForm2_Node::$error
HTML_QuickForm2_Node::$frozen
HTML_QuickForm2_Node::$ids
HTML_QuickForm2_Node::$persistent
HTML_QuickForm2_Node::$rules

Inherited Methods

Class: HTML_QuickForm2_Node

HTML_QuickForm2_Node::__construct()
Class constructor
HTML_QuickForm2_Node::addRule()
Adds a validation rule
HTML_QuickForm2_Node::createRule()
Creates a validation rule
HTML_QuickForm2_Node::generateId()
Generates an id for the element
HTML_QuickForm2_Node::getContainer()
Returns the element containing current
HTML_QuickForm2_Node::getDataSources()
Returns the data sources for this element
HTML_QuickForm2_Node::getError()
Returns the error message for the element
HTML_QuickForm2_Node::getId()
Returns the element's id
HTML_QuickForm2_Node::getLabel()
Returns the element's label(s)
HTML_QuickForm2_Node::getName()
Returns the element's name
HTML_QuickForm2_Node::getType()
Returns the element's type
HTML_QuickForm2_Node::getValue()
Returns the element's value
HTML_QuickForm2_Node::isRequired()
Checks whether an element is required
HTML_QuickForm2_Node::persistentFreeze()
Changes the element's persistent freeze behaviour
HTML_QuickForm2_Node::setContainer()
Adds the link to the element containing current
HTML_QuickForm2_Node::setError()
Sets the error message to the element
HTML_QuickForm2_Node::setId()
Sets the elements id
HTML_QuickForm2_Node::setLabel()
Sets the element's label(s)
HTML_QuickForm2_Node::setName()
Sets the element's name
HTML_QuickForm2_Node::setValue()
Sets the element's value
HTML_QuickForm2_Node::storeId()
Stores the explicitly given id to prevent duplicate id generation
HTML_QuickForm2_Node::toggleFrozen()
Changes the element's frozen status
HTML_QuickForm2_Node::updateValue()
Called when the element needs to update its value from form's data sources
HTML_QuickForm2_Node::validate()
Performs the server-side validation

Class Details

[line 60]
Abstract base class for simple QuickForm2 containers


[ Top ]

Class Variables

$elements = array()

[line 67]

Array of elements contained in this container
  • Access: protected

Type:   array


[ Top ]

$watchedAttributes = array('id', 'name')

[line 74]

'name' and 'id' attributes should be always present and their setting should go through setName() and setId().
  • Access: protected

Type:   array


[ Top ]


Method Detail

addElement   [line 266]

HTML_QuickForm2_Node addElement( string|HTML_QuickForm2_Node $elementOrType, [mixed $name = null], [mixed $attributes = null], [array $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
mixed   $name   —  Element name
mixed   $attributes   —  Element attributes
array   $data   —  Element-specific data

[ Top ]

appendChild   [line 237]

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_Group::appendChild()
Appends an element to the container

Parameters:

HTML_QuickForm2_Node   $element   —  Element to add

[ Top ]

arrayMerge   [line 205]

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

Parameters:

array   $a   — 
array   $b   — 

[ Top ]

count   [line 397]

int count( )

Returns the number of elements in the container
  • Access: public

[ Top ]

getElementById   [line 311]

HTML_QuickForm2_Node|null getElementById( string $id)

Returns an element if its id is found
  • Access: public

Parameters:

string   $id   —  Element id to find

[ Top ]

getElements   [line 222]

array getElements( )

Returns an array of this container's elements
  • Return: Container elements
  • Access: public

[ Top ]

getElementsByName   [line 327]

array getElementsByName( string $name)

Returns an array of elements which name corresponds to element
  • Access: public

Parameters:

string   $name   —  Elements name to find

[ Top ]

getId   [line 108]

void getId( )

  • Access: public

Overrides HTML_QuickForm2_Node::getId() (Returns the element's id)
[ Top ]

getIterator   [line 374]

HTML_QuickForm2_ContainerIterator getIterator( )

Returns a recursive iterator for the container elements
  • Access: public

[ Top ]

getName   [line 97]

void getName( )

  • Access: public

Overridden in child classes as:

HTML_QuickForm2_Container_Fieldset::getName()
HTML_QuickForm2_Container_Group::getName()

Overrides HTML_QuickForm2_Node::getName() (Returns the element's name)
[ Top ]

getRecursiveIterator   [line 384]

RecursiveIteratorIterator getRecursiveIterator( )

Returns a recursive iterator iterator for the container elements
  • Access: public

[ Top ]

getValue   [line 163]

array|null getValue( )

Returns the element's value

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

Overridden in child classes as:

HTML_QuickForm2_Container_Group::getValue()

Overrides HTML_QuickForm2_Node::getValue() (Returns the element's value)
[ Top ]

insertBefore   [line 347]

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

onAttributeChange   [line 76]

void onAttributeChange( $name, [ $value = null])

  • Access: protected

Overridden in child classes as:

HTML_QuickForm2::onAttributeChange()
HTML_QuickForm2_Container_Fieldset::onAttributeChange()

Parameters:

   $name   — 
   $value   — 

[ Top ]

persistentFreeze   [line 134]

void persistentFreeze( [ $persistent = null])

  • Access: public

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

Parameters:

   $persistent   — 

[ Top ]

prependsName   [line 149]

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

HTML_QuickForm2_Node removeChild( HTML_QuickForm2_Node $element)

Removes the element from this container

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

  • Return: Removed object
  • Access: public

Overridden in child classes as:

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

Parameters:

HTML_QuickForm2_Node   $element   —  Element to remove

[ Top ]

render   [line 467]

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_Group::render()
Renders the group using the given renderer

Parameters:

HTML_QuickForm2_Renderer   $renderer   —  Renderer instance

[ Top ]

setId   [line 113]

void setId( [ $id = null])

  • Access: public

Overridden in child classes as:

HTML_QuickForm2::setId()

Overrides HTML_QuickForm2_Node::setId() (Sets the elements id)

Parameters:

   $id   — 

[ Top ]

setName   [line 102]

void setName( $name)

  • Access: public

Overridden in child classes as:

HTML_QuickForm2_Container_Fieldset::setName()
HTML_QuickForm2_Container_Group::setName()

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

Parameters:

   $name   — 

[ Top ]

toggleFrozen   [line 124]

void toggleFrozen( [ $freeze = null])

  • Access: public

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

Parameters:

   $freeze   — 

[ Top ]

updateValue   [line 408]

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

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

validate   [line 423]

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

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

__call   [line 447]

HTML_QuickForm2_Node __call( mixed $m, mixed $a, array 2)

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:

array   2   —  Element-specific data
mixed   $m   —  Element name
mixed   $a   —  Element attributes

[ Top ]

__toString   [line 477]

void __toString( )

  • Access: public

Overridden in child classes as:

HTML_QuickForm2_Container_Group::__toString()

[ Top ]
Documentation generated on Mon, 11 Mar 2019 15:34:58 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.