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

Class: HTML_QuickForm_radio

Source Location: /HTML_QuickForm-3.2.14/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):

Version:

  • Release: 3.2.14

Methods


Inherited Variables

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 Details

[line 40]
HTML class for a radio type element


[ Top ]


Method Detail

HTML_QuickForm_radio (Constructor)   [line 67]

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

Class constructor
  • 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 ]

exportValue   [line 238]

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 ]

getChecked   [line 109]

string getChecked( )

Returns whether radio button is checked
  • Since: 1.0
  • Access: public

[ Top ]

getFrozenHtml   [line 146]

string getFrozenHtml( )

Returns the value of field without HTML tags
  • Since: 1.0
  • Access: public

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

getText   [line 182]

string getText( )

Returns the radio text
  • Since: 1.1
  • Access: public

[ Top ]

onQuickFormEvent   [line 200]

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

Called by HTML_QuickForm whenever form event is made on this element
  • 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

[ Top ]

setChecked   [line 90]

void setChecked( bool $checked)

Sets whether radio button is checked
  • Since: 1.0
  • Access: public

Parameters:

bool   $checked     Whether the field is checked or not

[ Top ]

setText   [line 167]

void setText( string $text)

Sets the radio text
  • Since: 1.1
  • Access: public

Parameters:

string   $text     Text to display near the radio button

[ Top ]

toHtml   [line 124]

string toHtml( )

Returns the radio element in HTML
  • Since: 1.0
  • Access: public

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


Documentation generated on Thu, 20 Nov 2014 16:00:21 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.