HTML_Common
[ class tree: HTML_Common ] [ index: HTML_Common ] [ all elements ]

Class: HTML_QuickForm_input

Source Location: /pear/HTML/QuickForm/input.php

Class Overview

HTML_Common
   |
   --HTML_QuickForm_element
      |
      --HTML_QuickForm_input

Base class for input form elements


Author(s):

Version:

  • 1.0

Methods


Child classes:

HTML_QuickForm_button
HTML class for a button type element
HTML_QuickForm_checkbox
HTML class for a checkbox type field
HTML_QuickForm_file
HTML class for a file type element
HTML_QuickForm_hidden
HTML class for a hidden type element
HTML_QuickForm_image
HTML class for a image type element
HTML_QuickForm_password
HTML class for a password type field
HTML_QuickForm_radio
HTML class for a radio type element
HTML_QuickForm_reset
HTML class for a reset type element
HTML_QuickForm_submit
HTML class for a submit type element
HTML_QuickForm_text
HTML class for a text field

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

HTML_Common::HTML_Common()
Class constructor
HTML_Common::apiVersion()
Returns the current API version
HTML_Common::charset()
Sets the charset to use by htmlspecialchars() function
HTML_Common::display()
Displays the HTML to the screen
HTML_Common::getAttribute()
Returns the value of the given attribute
HTML_Common::getAttributes()
Returns the assoc array (default) or string of attributes
HTML_Common::getComment()
Returns the HTML comment
HTML_Common::getTabOffset()
Returns the tabOffset
HTML_Common::removeAttribute()
Removes an attribute
HTML_Common::setAttribute()
Sets the value of the attribute
HTML_Common::setAttributes()
Sets the HTML attributes
HTML_Common::setComment()
Sets the HTML comment to be displayed at the beginning of the HTML string
HTML_Common::setLineEnd()
Sets the line end style to Windows, Mac, Unix or a custom string.
HTML_Common::setTab()
Sets the string used to indent HTML
HTML_Common::setTabOffset()
Sets the tab offset
HTML_Common::toHtml()
Abstract method. Must be extended to return the objects HTML
HTML_Common::updateAttributes()
Updates the passed attributes without changing the other existing attributes

Class Details

[line 34]
Base class for input form elements



Tags:

author:  Adam Daniel <adaniel1@eesus.jnj.com>
author:  Bertrand Mansion <bmansion@mamasam.com>
version:  1.0
abstract:  
since:  PHP4.04pl1
access:  public


[ Top ]


Class Methods


constructor HTML_QuickForm_input [line 48]

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

Class constructor



Tags:

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 ]

method exportValue [line 190]

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

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

Parameters:

   &$submitValues  
   $assoc  

[ Top ]

method getName [line 96]

string getName( )

Returns the element name



Tags:

since:  1.0
access:  public


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

[ Top ]

method getValue [line 127]

string getValue( )

Returns the value of the form element



Tags:

since:  1.0
access:  public


Overridden in child classes as:

HTML_QuickForm_checkbox::getValue()
Returns the value of the form element
HTML_QuickForm_advcheckbox::getValue()
Returns the element's value
HTML_QuickForm_file::getValue()
Returns information about the uploaded file

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

[ Top ]

method onQuickFormEvent [line 165]

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

Called by HTML_QuickForm whenever form event is made on this element



Tags:

since:  1.0
throws:  
access:  public


Overridden in child classes as:

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

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
   &$caller  

[ Top ]

method setName [line 81]

void setName( string $name)

Sets the input field name



Tags:

since:  1.0
access:  public


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

Parameters:

string   $name   Input field name attribute

[ Top ]

method setType [line 64]

void setType( string $type)

Sets the element type



Tags:

since:  1.0
access:  public


Parameters:

string   $type   Element type

[ Top ]

method setValue [line 112]

void setValue( string $value)

Sets the value of the form element



Tags:

since:  1.0
access:  public


Overridden in child classes as:

HTML_QuickForm_checkbox::setValue()
Sets the value of the form element
HTML_QuickForm_advcheckbox::setValue()
Sets the element's value
HTML_QuickForm_file::setValue()
Sets value for file element.

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

Parameters:

string   $value   Default value of the form element

[ Top ]

method toHtml [line 142]

string toHtml( )

Returns the input field in HTML



Tags:

since:  1.0
access:  public


Overridden in child classes as:

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
HTML_QuickForm_radio::toHtml()
Returns the radio element in HTML
HTML_QuickForm_autocomplete::toHtml()
Returns Html for the autocomplete input text element

Overrides HTML_Common::toHtml() (Abstract method. Must be extended to return the objects HTML)

[ Top ]


Documentation generated on Sun, 08 Jan 2012 17:51:52 +0100 by phpDocumentor 1.4.3