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

Class SimpleOptionTag

Description
Description | Vars | Methods (details)

Option for selection field.

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

SimpleTag
   |
   --SimpleWidget
      |
      --SimpleOptionTag
Method Summary
Description | Vars | Methods (details)
SimpleOptionTag SimpleOptionTag ( $attributes)
string getDefault ()
boolean isPrivateContent ()
boolean isValue (string $compare)
boolean setValue (string $value)
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from SimpleWidget

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

Inherited from SimpleTag

SimpleTag::$_attributes
 SimpleTag::$_content
 SimpleTag::$_name
Methods
Description | Vars Methods (details)
Constructor SimpleOptionTag (line 886)

Stashes the attributes.

SimpleOptionTag SimpleOptionTag ( $attributes)
  • $attributes
getDefault (line 920)

Accessor for starting value. Will be set to the option label if no value exists.

  • return: Parsed value.
  • access: public
string getDefault ()
Redefinition of:
SimpleWidget::getDefault()
Accessor for default value parsed with the tag.
isPrivateContent (line 932)

The content of options is not part of the page.

  • return: True.
  • access: public
boolean isPrivateContent ()
Redefinition of:
SimpleTag::isPrivateContent()
The current tag should not swallow all content for itself as it's searchable page content. Private content tags are usually widgets that contain default values.
isValue (line 906)

Test to see if a value matches the option.

  • return: True if possible match.
  • access: public
boolean isValue (string $compare)
  • string $compare: Value to compare with.
setValue (line 896)

Does nothing.

  • return: Not allowed.
  • access: public
boolean setValue (string $value)
  • string $value: Ignored.
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:47 +1300 by phpDocumentor 1.3.2