Class MultipleSelectionTag

Description

Drop down widget.

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

SimpleTag
   |
   --SimpleWidget
      |
      --MultipleSelectionTag
Variable Summary
 mixed $_options
 mixed $_values
Method Summary
 MultipleSelectionTag MultipleSelectionTag (hash $attributes)
 void addContent (string $content)
 void addTag (SimpleOptionTag &$tag)
 array getDefault ()
 array getValue ()
 boolean setValue (array $values)
Variables
mixed $_options (line 564)
mixed $_values (line 565)

Inherited Variables

Inherited from SimpleWidget

SimpleWidget::$_is_set
SimpleWidget::$_value

Inherited from SimpleTag

SimpleTag::$_attributes
SimpleTag::$_content
SimpleTag::$_name
Methods
Constructor MultipleSelectionTag (line 572)

Starts with attributes only.

MultipleSelectionTag MultipleSelectionTag (hash $attributes)
  • hash $attributes: Attribute names and string values.
addContent (line 594)

Text within the selection element is ignored.

  • access: public
void addContent (string $content)
  • string $content: Ignored.

Redefinition of:
SimpleTag::addContent()
Appends string content to the current content.
addTag (line 583)

Adds an option tag to a selection field.

  • access: public
void addTag (SimpleOptionTag &$tag)

Redefinition of:
SimpleTag::addTag()
Adds an enclosed tag to the content.
getDefault (line 603)

Scans options for defaults to populate the value array().

  • return: Selected fields.
  • access: public
array getDefault ()

Redefinition of:
SimpleWidget::getDefault()
Accessor for default value parsed with the tag.
getValue (line 641)

Accessor for current selection value.

  • return: List of currently set options.
  • access: public
array getValue ()

Redefinition of:
SimpleWidget::getValue()
Accessor for currently set value or default if none.
setValue (line 619)

Can only set allowed values.

  • return: True if allowed.
  • access: public
boolean setValue (array $values)
  • array $values: New choices.

Redefinition of:
SimpleWidget::setValue()
Sets the current form element value.

Inherited Methods

Inherited From SimpleWidget

 SimpleWidget::SimpleWidget()
 SimpleWidget::getDefault()
 SimpleWidget::getName()
 SimpleWidget::getValue()
 SimpleWidget::resetValue()
 SimpleWidget::setValue()

Inherited From SimpleTag

 SimpleTag::SimpleTag()
 SimpleTag::addContent()
 SimpleTag::addTag()
 SimpleTag::expectEndTag()
 SimpleTag::getAttribute()
 SimpleTag::getChildElements()
 SimpleTag::getContent()
 SimpleTag::getTagName()
 SimpleTag::_keysToLowerCase()
 SimpleTag::_setAttribute()

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