Class: HTML_QuickForm2_Element_Input

Source Location: /HTML_QuickForm2-2.1.0/HTML/QuickForm2/Element/Input.php

Class Overview

HTML_Common2
   |
   --HTML_QuickForm2_Node
      |
      --HTML_QuickForm2_Element
         |
         --HTML_QuickForm2_Element_Input

Base class for <input> elements

Author(s):

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

Version:

Release: 2.1.0

Variables

$watchedAttributes

Methods

Child classes:

HTML_QuickForm2_Element_InputHidden: Class for <input type="hidden" /> elements

HTML_QuickForm2_Element_InputReset: Class for <input type="reset" /> elements

HTML_QuickForm2_Element_InputSubmit: Class for <input type="submit" /> elements

HTML_QuickForm2_Element_InputPassword: Class for <input type="password" /> elements

HTML_QuickForm2_Element_InputFile: Class for <input type="file" /> elements

HTML_QuickForm2_Element_InputCheckable: Base class for <input> elements having 'checked' attribute (checkboxes and radios)

HTML_QuickForm2_Element_InputText: Class for <input type="text" /> elements

HTML_QuickForm2_Element_InputImage: Class for <input type="image" /> elements

HTML_QuickForm2_Element_InputButton: Class for <input type="button" /> elements

Inherited Variables

Class: HTML_QuickForm2_Node

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

Inherited Methods

Class: HTML_QuickForm2_Element

HTML_QuickForm2_Element::applyFilters(): Applies recursive and non-recursive filters on element value
HTML_QuickForm2_Element::getJavascriptTriggers()
HTML_QuickForm2_Element::getJavascriptValue(): Returns Javascript code for getting the element's value
HTML_QuickForm2_Element::getPersistentContent(): Generates hidden form field containing the element's value
HTML_QuickForm2_Element::render(): Renders the element using the given renderer
HTML_QuickForm2_Element::setName()
HTML_QuickForm2_Element::updateValue(): Called when the element needs to update its value from form's data sources

Class: HTML_QuickForm2_Node

HTML_QuickForm2_Node::__construct(): Class constructor
HTML_QuickForm2_Node::addFilter(): Adds a filter
HTML_QuickForm2_Node::addRecursiveFilter(): Adds a recursive filter
HTML_QuickForm2_Node::addRule(): Adds a validation rule
HTML_QuickForm2_Node::applyFilter(): Helper function for applying filter callback to a value
HTML_QuickForm2_Node::applyFilters(): Applies non-recursive filters on element value
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::getData(): Returns the element options
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::getJavascriptTriggers(): Returns IDs of form fields that should trigger "live" Javascript validation
HTML_QuickForm2_Node::getJavascriptValue(): Returns Javascript code for getting the element's value
HTML_QuickForm2_Node::getLabel(): Returns the element's label(s)
HTML_QuickForm2_Node::getName(): Returns the element's name
HTML_QuickForm2_Node::getRawValue(): Returns the element's value without filters applied
HTML_QuickForm2_Node::getType(): Returns the element's type
HTML_QuickForm2_Node::getValue(): Returns the element's value, possibly with filters applied
HTML_QuickForm2_Node::isRequired(): Checks whether an element is required
HTML_QuickForm2_Node::onAttributeChange(): Intercepts setting 'name' and 'id' attributes
HTML_QuickForm2_Node::persistentFreeze(): Changes the element's persistent freeze behaviour
HTML_QuickForm2_Node::removeRule(): Removes a validation rule
HTML_QuickForm2_Node::render(): Renders the element using the given renderer
HTML_QuickForm2_Node::renderClientRules(): Adds element's client-side validation rules to a builder object
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 element's 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 38]
Base class for <input> elements

Author: Bertrand Mansion <golgote@mamasam.com>
Author: Alexey Borzov <avb@php.net>
Version: Release: 2.1.0
Link: https://pear.php.net/package/HTML_QuickForm2
License: BSD 3-Clause License

[ Top ]

Class Variables

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

[line 44]

'type' attribute should not be changeable

Access: protected

Type:	array
Overrides:	Array

[ Top ]

Method Detail

getFrozenHtml [line 85]

string getFrozenHtml(
)

Returns the field's value without HTML tags

Access: protected

Overridden in child classes as:

HTML_QuickForm2_Element_InputPassword::getFrozenHtml()

HTML_QuickForm2_Element_InputCheckable::getFrozenHtml()

[ Top ]

getRawValue [line 67]

void getRawValue(
)

Access: public

Overridden in child classes as:

HTML_QuickForm2_Element_InputReset::getRawValue(): Reset elements cannot have any submit values

HTML_QuickForm2_Element_InputSubmit::getRawValue(): Returns the element's value

HTML_QuickForm2_Element_InputFile::getRawValue(): Returns the information on uploaded file

HTML_QuickForm2_Element_InputCheckable::getRawValue()

HTML_QuickForm2_Element_InputImage::getRawValue(): Returns the element's value

HTML_QuickForm2_Element_InputButton::getRawValue(): Button elements cannot have any submit values

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

[ Top ]

getType [line 56]

void getType(
)

Access: public

Overrides HTML_QuickForm2_Node::getType() (Returns the element's type)

[ Top ]

onAttributeChange [line 46]

void onAttributeChange(

$name, [
$value = null])

Access: protected

Overridden in child classes as:

HTML_QuickForm2_Element_InputCheckable::onAttributeChange()

HTML_QuickForm2_Controller_DefaultAction::onAttributeChange(): Disallow changing the 'id' attribute

Overrides HTML_QuickForm2_Node::onAttributeChange() (Intercepts setting 'name' and 'id' attributes)

Parameters:

	`$name`	—
	`$value`	—

[ Top ]

setValue [line 61]

void setValue(

$value)

Access: public

Overridden in child classes as:

HTML_QuickForm2_Element_InputReset::setValue(): Reset elements cannot have any submit values

HTML_QuickForm2_Element_InputSubmit::setValue(): Submit's value cannot be set via this method

HTML_QuickForm2_Element_InputFile::setValue(): File upload's value cannot be set here

HTML_QuickForm2_Element_InputCheckable::setValue()

HTML_QuickForm2_Element_InputImage::setValue(): Image button's value cannot be set via this method

HTML_QuickForm2_Element_InputButton::setValue(): Button elements cannot have any submit values

Overrides HTML_QuickForm2_Node::setValue() (Sets the element's value)

Parameters:

$value —

[ Top ]

__toString [line 72]

void __toString(
)

Access: public

Overridden in child classes as:

HTML_QuickForm2_Element_InputCheckable::__toString()

HTML_QuickForm2_Element_InputImage::__toString(): Returns the HTML representation of the element

[ Top ]