Class SimpleOptionTag

Description

Option for selection field.

Located in /tag.php (line 990)

SimpleTag
   |
   --SimpleWidget
      |
      --SimpleOptionTag
Method Summary
 SimpleOptionTag __construct ( $attributes)
 string getDefault ()
 boolean isPrivateContent ()
 boolean isValue (string $compare)
 boolean setValue (string $value)
Methods
Constructor __construct (line 995)

Stashes the attributes.

SimpleOptionTag __construct ( $attributes)
  • $attributes

Redefinition of:
SimpleWidget::__construct()
Starts with a named tag with attributes only.
getDefault (line 1029)

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

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

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

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::__construct()
 SimpleWidget::getDefault()
 SimpleWidget::getName()
 SimpleWidget::getValue()
 SimpleWidget::isLabel()
 SimpleWidget::resetValue()
 SimpleWidget::setLabel()
 SimpleWidget::setValue()
 SimpleWidget::write()

Inherited From SimpleTag

 SimpleTag::__construct()
 SimpleTag::addContent()
 SimpleTag::addTag()
 SimpleTag::addTags()
 SimpleTag::expectEndTag()
 SimpleTag::getAttribute()
 SimpleTag::getChildElements()
 SimpleTag::getContent()
 SimpleTag::getTagName()
 SimpleTag::getText()
 SimpleTag::isId()
 SimpleTag::isPrivateContent()
 SimpleTag::setAttribute()

Documentation generated on Sun, 31 Oct 2010 16:32:37 -0500 by phpDocumentor 1.4.3