Class SimpleRadioGroup

Description

A group of tags with the same name within a form.

Used for radio buttons.

Located in /tag.php (line 1385)

SimpleTagGroup
   |
   --SimpleRadioGroup
Method Summary
 string/boolean getDefault ()
 string/boolean getValue ()
 boolean setValue (string $value)
 boolean valueIsPossible (string $value)
Methods
getDefault (line 1448)

Accessor for starting value that is active.

  • return: Value of first checked widget or false if none.
  • access: public
string/boolean getDefault ()
getValue (line 1432)

Accessor for current selected widget or false if none.

  • return: Value attribute or content of opton.
  • access: public
string/boolean getValue ()
setValue (line 1395)

Each tag is tried in turn until one is successfully set. The others will be unchecked if successful.

  • return: True if any allowed.
  • access: public
boolean setValue (string $value)
  • string $value: New value.
valueIsPossible (line 1415)

Tests to see if a value is allowed.

  • return: True if a valid value.
  • access: protected
boolean valueIsPossible (string $value)
  • string $value: Attempted value.

Inherited Methods

Inherited From SimpleTagGroup

 SimpleTagGroup::addWidget()
 SimpleTagGroup::getAttribute()
 SimpleTagGroup::getName()
 SimpleTagGroup::getWidgets()
 SimpleTagGroup::isId()
 SimpleTagGroup::isLabel()
 SimpleTagGroup::write()

Documentation generated on Sun, 31 Oct 2010 16:32:37 -0500 by phpDocumentor 1.4.3