Class: HTML_QuickForm2_Element

Source Location: /HTML_QuickForm2-0.1.0/QuickForm2/Element.php

Class Overview

HTML_Common2
   |
   --HTML_QuickForm2_Node
      |
      --HTML_QuickForm2_Element

Abstract base class for simple QuickForm2 elements (not Containers)

Author(s):

Bertrand Mansion <golgote at mamasam.com>
Alexey Borzov <avb at php.net>

Version:

Release: 0.1.0

Variables

$watchedAttributes

Methods

Child classes:

HTML_QuickForm2_Element_Textarea: Class for <textarea> elements

HTML_QuickForm2_Element_Select: Class representing a <select> element

HTML_QuickForm2_Element_Input: Base class for <input> elements

HTML_QuickForm2_Element_Button: Class for <button> elements

Inherited Variables

Class: HTML_QuickForm2_Node

HTML_QuickForm2_Node::$container
HTML_QuickForm2_Node::$data
HTML_QuickForm2_Node::$frozen
HTML_QuickForm2_Node::$ids
HTML_QuickForm2_Node::$label
HTML_QuickForm2_Node::$persistent

Inherited Methods

Class: HTML_QuickForm2_Node

HTML_QuickForm2_Node::__construct(): Class constructor
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::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::persistentFreeze(): Changes the element's persistent freeze behaviour
HTML_QuickForm2_Node::setContainer(): Adds the link to the element containing current
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

Class Details

[line 60]
Abstract base class for simple QuickForm2 elements (not Containers)

Author: Bertrand Mansion <golgote@mamasam.com>
Author: Alexey Borzov <avb@php.net>
Version: Release: 0.1.0
Abstract:

[ Top ]

Class Variables

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

[line 67]

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

Access: protected

Type:

array

[ Top ]

Method Detail

getId [line 101]

void getId(
)

Access: public

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

[ Top ]

getName [line 90]

void getName(
)

Access: public

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

[ Top ]

getPersistentContent [line 124]

string getPersistentContent(
)

Generates hidden form field containing the element's value

This is used to pass the frozen element's value if 'persistent freeze' feature is on

Access: protected

[ Top ]

onAttributeChange [line 69]

void onAttributeChange(

$name, [
$value = null])

Access: protected

Overridden in child classes as:

HTML_QuickForm2_Element_Input::onAttributeChange()

Parameters:

	`$name`	—
	`$value`	—

[ Top ]

setId [line 106]

void setId(
[
$id = null])

Access: public

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

Parameters:

$id —

[ Top ]

setName [line 95]

void setName(

$name)

Access: public

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

Parameters:

$name —

[ Top ]

updateValue [line 142]

void updateValue(
)

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

The default behaviour is to go through the complete list of the data sources until the non-null value is found.

Access: protected

Overridden in child classes as:

HTML_QuickForm2_Element_Select::updateValue()

HTML_QuickForm2_Element_InputSubmit::updateValue()

HTML_QuickForm2_Element_InputFile::updateValue()

HTML_QuickForm2_Element_InputCheckbox::updateValue()

HTML_QuickForm2_Element_InputImage::updateValue()

HTML_QuickForm2_Element_Button::updateValue()

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

[ Top ]