Class SimpleCheckboxGroup

Description

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

Located in /libraries/pear/simpletest/tag.php (line 748)


	
			
Variable Summary
 mixed $_widgets
Method Summary
 SimpleCheckboxGroup SimpleCheckboxGroup ()
 void addWidget (SimpleWidget &$widget)
 string/array getDefault ()
 string/array getValue ()
 boolean setValue (string/array/boolean $values)
 string/array/boolean _coerceValues (array $values)
 array _makeArray (string/array/boolean $value)
 boolean _valuesArePossible (string/array/boolean $values)
Variables
mixed $_widgets (line 749)
Methods
Constructor SimpleCheckboxGroup (line 755)

Starts empty.

  • access: public
SimpleCheckboxGroup SimpleCheckboxGroup ()
addWidget (line 764)

Adds a tag to the group.

  • access: public
void addWidget (SimpleWidget &$widget)
getDefault (line 789)

Accessor for starting value that is active.

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

Accessor for current selected widget or false if none.

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

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.
_coerceValues (line 849)

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: private
string/array/boolean _coerceValues (array $values)
  • array $values: List of values of widgets.
_makeArray (line 868)

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

  • return: List of values, possibly empty.
  • access: private
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.
_valuesArePossible (line 830)

Tests to see if a possible value set is legal.

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

Documentation generated on Fri, 24 Dec 2004 13:03:37 +0000 by phpDocumentor 1.3.0RC3