Class: HTML_QuickForm_radio

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

Class Overview

HTML_Common
   |
   --HTML_QuickForm_element
      |
      --HTML_QuickForm_input
         |
         --HTML_QuickForm_radio

HTML class for a radio type element

Author(s):

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

Version:

Methods

Inherited Methods

Class: HTML_QuickForm_input

HTML_QuickForm_input::HTML_QuickForm_input(): Class constructor
HTML_QuickForm_input::exportValue(): We don't need values from button-type elements (except submit) and files
HTML_QuickForm_input::getName(): Returns the element name
HTML_QuickForm_input::getValue(): Returns the value of the form element
HTML_QuickForm_input::onQuickFormEvent(): Called by HTML_QuickForm whenever form event is made on this element
HTML_QuickForm_input::setName(): Sets the input field name
HTML_QuickForm_input::setType(): Sets the element type
HTML_QuickForm_input::setValue(): Sets the value of the form element
HTML_QuickForm_input::toHtml(): Returns the input field in HTML

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 33]
HTML class for a radio type element

Tags:

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

[ Top ]

Class Methods

constructor HTML_QuickForm_radio [line 60]

void HTML_QuickForm_radio(
[string
$elementName = null], [mixed
$elementLabel = null], [string
$text = null], [string
$value = null], [mixed
$attributes = null])

Class constructor

Tags:

since:	1.0
access:	public

Parameters:

string	$elementName	Input field name attribute
mixed	$elementLabel	Label(s) for a field
string	$text	Text to display near the radio
string	$value	Input field value
mixed	$attributes	Either a typical HTML attribute string or an associative array

[ Top ]

method exportValue [line 231]

void exportValue(

&$submitValues, [
$assoc = false])

Returns the value attribute if the radio is checked, null if it is not

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

Parameters:

	&$submitValues
	$assoc

[ Top ]

method getChecked [line 102]

string getChecked(
)

Returns whether radio button is checked

Tags:

since:	1.0
access:	public

[ Top ]

method getFrozenHtml [line 139]

string getFrozenHtml(
)

Returns the value of field without HTML tags

Tags:

since:	1.0
access:	public

Overrides HTML_QuickForm_element::getFrozenHtml() (Returns the value of field without HTML tags)

[ Top ]

method getText [line 175]

string getText(
)

Returns the radio text

Tags:

since:	1.1
access:	public

[ Top ]

method onQuickFormEvent [line 193]

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
access:	public

Overrides HTML_QuickForm_input::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 setChecked [line 83]

void setChecked(
bool
$checked)

Sets whether radio button is checked

Tags:

since:	1.0
access:	public

Parameters:

bool

$checked

Whether the field is checked or not

[ Top ]

method setText [line 160]

void setText(
string
$text)

Sets the radio text

Tags:

since:	1.1
access:	public

Parameters:

string

$text

Text to display near the radio button

[ Top ]

method toHtml [line 117]

string toHtml(
)

Returns the radio element in HTML

Tags:

since:	1.0
access:	public

Overrides HTML_QuickForm_input::toHtml() (Returns the input field in HTML)

[ Top ]

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