Class SimpleCheckboxGroup

Description

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

Located in /tag.php (line 1262)

SimpleTagGroup
   |
   --SimpleCheckboxGroup
Method Summary
 string/array/boolean coerceValues (array $values)
 string/array getDefault ()
 string/array getValue ()
 array makeArray (string/array/boolean $value)
 boolean setValue (string/array/boolean $values)
 boolean valuesArePossible (string/array/boolean $values)
Methods
coerceValues (line 1349)

Converts the output to an appropriate format. This means that no values is false, a single value is just that value and only two or more are contained in an array.

  • return: Expected format for a tag.
  • access: protected
string/array/boolean coerceValues (array $values)
  • array $values: List of values of widgets.
getDefault (line 1286)

Accessor for starting value that is active.

  • return: Widget values or false if none.
  • access: public
string/array getDefault ()
getValue (line 1270)

Accessor for current selected widget or false if none.

  • return: Widget values or false if none.
  • access: public
string/array getValue ()
makeArray (line 1368)

Converts false or string into array. The opposite of the coercian method.

  • return: List of values, possibly empty.
  • access: protected
array makeArray (string/array/boolean $value)
  • string/array/boolean $value: A single item is converted to a one item list. False gives an empty list.
setValue (line 1304)

Accessor for current set values.

  • return: True if all values can be set.
  • access: public
boolean setValue (string/array/boolean $values)
  • string/array/boolean $values: Either a single string, a hash or false for nothing set.
valuesArePossible (line 1329)

Tests to see if a possible value set is legal.

  • return: False if trying to set a missing value.
  • access: protected
boolean valuesArePossible (string/array/boolean $values)
  • string/array/boolean $values: Either a single string, a hash or false for nothing set.

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:35 -0500 by phpDocumentor 1.4.3