phpDocumentor SForm
[ class tree: SForm ] [ index: SForm ] [ all elements ]

Class: SForm_Group

Source Location: /SForm.php

Class SForm_Group

Class Overview

Group elements

Located in /SForm.php [line 2124]

SForm_Element
   |
   --SForm_Container
      |
      --SForm_Group

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From SForm_Container

SForm_Container::$chFilters
SForm_Container::$chRules
SForm_Container::$emptyTag

Inherited From SForm_Element

SForm_Element::$addName
SForm_Element::$attributes
SForm_Element::$defId
SForm_Element::$errors
SForm_Element::$filters
SForm_Element::$locked
SForm_Element::$parent
SForm_Element::$required
SForm_Element::$rules
SForm_Element::$tag
SForm_Element::$validated
SForm_Element::$valueSet

Inherited From SForm_Container

SForm_Container::addElement()
Adds an element to this container
SForm_Container::applyFilter()
Apply a filter to the elements
SForm_Container::count()
Return number of children
SForm_Container::createElement()
Creates an element
SForm_Container::current()
Return the current element
SForm_Container::freeze()
Set the frozen status of this container and its children
SForm_Container::getChildren()
Return the current element
SForm_Container::getElement()
Returns an element using the Local ID
SForm_Container::getGlobalElement()
Returns an element using the Global ID
SForm_Container::hasChildren()
Does the current element have children?
SForm_Container::key()
Return the key of the current element
SForm_Container::lock()
Add any requested filters and rules, then lock this container
SForm_Container::next()
Advance pointer and return the new current
SForm_Container::removeElement()
Removes an element from this group
SForm_Container::render()
Render this container and all elements in it
SForm_Container::rewind()
Move the current element to the first one
SForm_Container::toHtml()
Create a HTML representation of this container
SForm_Container::valid()
Is the current ponter valid?
SForm_Container::validate()
Is this valid?

Inherited From SForm_Element

SForm_Element::__construct()
Construct with an identity. Optionally add a label and more attributes.
SForm_Element::addRule()
Add a rule to this element
SForm_Element::assignParent()
Assign this element's parent
SForm_Element::autoAK()
Generates an access key and updated label
SForm_Element::createRule()
Creates & returns a rule
SForm_Element::escHtml()
Escape HTML in a consistant manner
SForm_Element::filter()
Apply a filter to the value
SForm_Element::filterValue()
Filters the value
SForm_Element::freeze()
Set if this element is frozen
SForm_Element::getAttribute()
Get an attribute in $this
SForm_Element::getAttributesString()
Creates an HTML attribute string from an array
SForm_Element::getErrorHtml()
Do we have any errors?
SForm_Element::getGlobalId()
This is the page-wide unique ID
SForm_Element::getLabel()
Return the label string (no markup)
SForm_Element::getLabelHtml()
Return the label with markup added
SForm_Element::getLocalId()
A Locally usable ID
SForm_Element::getOption()
Get a global option
SForm_Element::getRequest()
Returns a value from the request
SForm_Element::getValue()
The value of this element
SForm_Element::isFrozen()
Is this element marked as frozen?
SForm_Element::isRequired()
Is this element required?
SForm_Element::lock()
Locks & adds any last minute stuff
SForm_Element::render()
Append this leaf element to the render queue
SForm_Element::setAttribute()
Set an attribute in $this
SForm_Element::setDefault()
Set the default value of this element
SForm_Element::setOption()
Set a global option
SForm_Element::setValue()
Set the value of this element
SForm_Element::toHidden()
Do we have any hidden tags to append?
SForm_Element::toHtml()
Create a HTML representation of this element
SForm_Element::toHtmlFin()
Close an open HTML tags
SForm_Element::toJavaScript()
Retrieve any JavaScript that should be run onsubmit
SForm_Element::toString()
How does this value look as a HTML string?
SForm_Element::unsetAttribute()
Unset an attribute
SForm_Element::validate()
Is this a valid element?
SForm_Element::wasSubmitted()
Was this form submitted?

[ Top ]
Method Summary
string   getLabelHtml()   Return the label
string   toHtml()   Open the group
string   toHtmlFin()   Close this element group

[ Top ]
Methods
getLabelHtml  [line 2131]

  string getLabelHtml( [boolean $accesskey = true]  )

Return the label

Parameters:
boolean   $accesskey:  This isn't used here

API Tags:
Return:  The label
Access:  public


Redefinition of:
SForm_Element::getLabelHtml()
Return the label with markup added

[ Top ]
toHtml  [line 2144]

  string toHtml( )

Open the group


API Tags:
Return:  Nothing. It's a boring group.
Access:  public


Redefinition of:
SForm_Container::toHtml()
Create a HTML representation of this container

[ Top ]
toHtmlFin  [line 2153]

  string toHtmlFin( )

Close this element group


API Tags:
Return:  Nothing. It's a boring group.
Access:  public


Redefinition of:
SForm_Element::toHtmlFin()
Close an open HTML tags

[ Top ]

Documentation generated on Mon, 09 Apr 2007 19:08:45 -0500 by phpDocumentor 1.3.0