Comments: on this page. Click to read or post your own.

Class MultipleSelectionTag

Description
Description | Vars (details) | Methods (details)

Drop down widget.

Located in /sapphire/dev/simpletest/tag.php (line 786) 

SimpleTag
   |
   --SimpleWidget
      |
      --MultipleSelectionTag
Variable Summary
Description | Vars (details) | Methods (details)
mixed $_options
mixed $_values
Method Summary
Description | Vars (details) | Methods (details)
MultipleSelectionTag MultipleSelectionTag (hash $attributes)
void addContent (string $content)
void addTag ( &$tag, SimpleOptionTag $tag)
array getDefault ()
array getValue ()
boolean setValue (array $desired)
Variables
Description | Vars (details) | Methods (details)
mixed $_options (line 787)
mixed $_values (line 788)

Inherited Variables

Inherited from SimpleWidget

SimpleWidget::$_is_set
 SimpleWidget::$_label
 SimpleWidget::$_value

Inherited from SimpleTag

SimpleTag::$_attributes
 SimpleTag::$_content
 SimpleTag::$_name
Methods
Description | Vars (details) Methods (details)
Constructor MultipleSelectionTag (line 795)

Starts with attributes only.

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

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 806)

Adds an option tag to a selection field.

  • access: public
void addTag ( &$tag, SimpleOptionTag $tag)
Redefinition of:
SimpleTag::addTag()
Adds an enclosed tag to the content.
getDefault (line 826)

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 868)

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 844)

Can only set allowed values. Any illegal value will result in a failure, but all correct values will be set.

  • return: True if all allowed.
  • access: public
boolean setValue (array $desired)
  • array $desired: 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::isLabel()
SimpleWidget::resetValue()
SimpleWidget::setLabel()
SimpleWidget::setValue()
SimpleWidget::write()

Inherited From SimpleTag

SimpleTag::SimpleTag()
SimpleTag::addContent()
SimpleTag::addTag()
SimpleTag::expectEndTag()
SimpleTag::getAttribute()
SimpleTag::getChildElements()
SimpleTag::getContent()
SimpleTag::getTagName()
SimpleTag::getText()
SimpleTag::isId()
SimpleTag::isPrivateContent()
SimpleTag::_setAttribute()
blog comments powered by Disqus

Documentation generated on Sun, 19 Oct 2008 06:46:46 +1300 by phpDocumentor 1.3.2