Class: HTML_QuickForm_input

Source Location: /HTML_QuickForm-3.2.14/QuickForm/input.php

Class Overview

HTML_Common
   |
   --HTML_QuickForm_element
      |
      --HTML_QuickForm_input

Base class for <input /> form elements

Author(s):

Adam Daniel <adaniel1 at eesus.jnj.com>
Bertrand Mansion <bmansion at mamasam.com>

Version:

Release: 3.2.14

Methods

Child classes:

HTML_QuickForm_reset: HTML class for a reset type element

HTML_QuickForm_button: HTML class for an <input type="button" /> elements

HTML_QuickForm_image: HTML class for an <input type="image" /> element

HTML_QuickForm_file: HTML class for a file upload field

HTML_QuickForm_radio: HTML class for a radio type element

HTML_QuickForm_text: HTML class for a text field

HTML_QuickForm_hidden: HTML class for a hidden type element

HTML_QuickForm_password: HTML class for a password type field

HTML_QuickForm_submit: HTML class for a submit type element

HTML_QuickForm_checkbox: HTML class for a checkbox type field

Inherited Variables

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 Details

[line 41]
Base class for <input /> form elements

Author: Adam Daniel <adaniel1@eesus.jnj.com>
Author: Bertrand Mansion <bmansion@mamasam.com>
Version: Release: 3.2.14
Abstract:
Since: 1.0

[ Top ]

Method Detail

HTML_QuickForm_input (Constructor) [line 55]

void HTML_QuickForm_input(
[string
$elementName = null], [mixed
$elementLabel = null], [mixed
$attributes = null])

Class constructor

Since: 1.0
Access: public

Parameters:

string	`$elementName`	—	Input field name attribute
mixed	`$elementLabel`	—	Label(s) for the input field
mixed	`$attributes`	—	Either a typical HTML attribute string or an associative array

[ Top ]

exportValue [line 197]

void exportValue(

&$submitValues, [
$assoc = false])

We don't need values from button-type elements (except submit) and files

Overridden in child classes as:

HTML_QuickForm_radio::exportValue(): Returns the value attribute if the radio is checked, null if it is not

HTML_QuickForm_submit::exportValue(): Only return the value if it is found within $submitValues (i.e. if

HTML_QuickForm_checkbox::exportValue(): Return true if the checkbox is checked, null if it is not checked (getValue() returns false)

HTML_QuickForm_advcheckbox::exportValue(): This element has a value even if it is not checked, thus we override

Overrides HTML_QuickForm_element::exportValue() (Returns a 'safe' element's value)

Parameters:

	`&$submitValues`	—
	`$assoc`	—

[ Top ]

getName [line 103]

string getName(
)

Returns the element name

Since: 1.0
Access: public

Overrides HTML_QuickForm_element::getName() (Returns the element name)

[ Top ]

getValue [line 134]

string getValue(
)

Returns the value of the form element

Since: 1.0
Access: public

Overridden in child classes as:

HTML_QuickForm_file::getValue(): Returns information about the uploaded file

HTML_QuickForm_checkbox::getValue(): Returns the value of the form element

HTML_QuickForm_advcheckbox::getValue(): Returns the element's value

Overrides HTML_QuickForm_element::getValue() (Returns the value of the form element)

[ Top ]

onQuickFormEvent [line 172]

void onQuickFormEvent(
string
$event, mixed
$arg, object
&$caller)

Called by HTML_QuickForm whenever form event is made on this element

Since: 1.0
Throws:
Access: public

Overridden in child classes as:

HTML_QuickForm_file::onQuickFormEvent(): Called by HTML_QuickForm whenever form event is made on this element

HTML_QuickForm_radio::onQuickFormEvent(): Called by HTML_QuickForm whenever form event is made on this element

HTML_QuickForm_checkbox::onQuickFormEvent(): Called by HTML_QuickForm whenever form event is made on this element

HTML_QuickForm_advcheckbox::onQuickFormEvent(): Called by HTML_QuickForm whenever form event is made on this element

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

[ Top ]

setName [line 88]

void setName(
string
$name)

Sets the input field name

Since: 1.0
Access: public

Overrides HTML_QuickForm_element::setName() (Sets the input field name)

Parameters:

string $name — Input field name attribute

[ Top ]

setType [line 71]

void setType(
string
$type)

Sets the element type

Since: 1.0
Access: public

Parameters:

string $type — Element type

[ Top ]

setValue [line 119]

void setValue(
string
$value)

Sets the value of the form element

Since: 1.0
Access: public

Overridden in child classes as:

HTML_QuickForm_file::setValue(): Sets value for file element.

HTML_QuickForm_checkbox::setValue(): Sets the value of the form element

HTML_QuickForm_advcheckbox::setValue(): Sets the element's value

Overrides HTML_QuickForm_element::setValue() (Sets the value of the form element)

Parameters:

string $value — Default value of the form element

[ Top ]

toHtml [line 149]

string toHtml(
)

Returns the input field in HTML

Since: 1.0
Access: public

Overridden in child classes as:

HTML_QuickForm_radio::toHtml(): Returns the radio element in HTML

HTML_QuickForm_autocomplete::toHtml(): Returns Html for the autocomplete input text element

HTML_QuickForm_checkbox::toHtml(): Returns the checkbox element in HTML

HTML_QuickForm_advcheckbox::toHtml(): Returns the checkbox element in HTML and the additional hidden element in HTML

[ Top ]