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

Files:
SForm.php
Elements
Header.php
Rules
Boolean.php

Classes:
Rules
SForm_Rule
SForm_Rule_Boolean
SForm_Rule_Maxlenth
SForm_Rule_Required
SForm_Rule_Subset
Elements
SForm_Elm_Button
SForm_Elm_Checkable
SForm_Elm_Checkbox
SForm_Elm_Header
SForm_Elm_Hidden
SForm_Elm_Reset
SForm_Elm_Select
SForm_Elm_Submit
SForm_Elm_Text
SForm_Elm_Textarea
SForm
SForm_Container
SForm_Element
SForm_Fieldset
SForm_Group
Renderers
SForm_Renderer
SForm_Renderer_Array
SForm_Renderer_HTML

Element index for package SForm

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ j ] [ k ] [ l ] [ m ] [ n ] [ o ] [ p ] [ r ] [ s ] [ t ] [ u ] [ v ] [ w ] [ _ ]

_

_

__construct
in file SForm.php, method SForm_Element::__construct()
    Construct with an identity. Optionally add a label and more attributes.
__construct
in file SForm.php, method SForm::__construct()
    Create a form
__construct
in file SForm.php, method SForm_Elm_Text::__construct()
    Add text type info
__construct
in file SForm.php, method SForm_Elm_Textarea::__construct()
    Ensure the existence of 'rows' and 'cols' attributes.
__construct
in file SForm.php, method SForm_Elm_Select::__construct()
    Options can be passed to the constructor
__construct
in file SForm.php, method SForm_Elm_Hidden::__construct()
    Add hidden type info
__construct
in file SForm.php, method SForm_Elm_Checkbox::__construct()
    Add checkbox type attribute
__construct
in file SForm.php, method SForm_Elm_Button::__construct()
    Add button type info
__construct
in file SForm.php, method SForm_Rule_Subset::__construct()
    Construct this rule
__construct
in file SForm.php, method SForm_Rule_Maxlenth::__construct()
    Setup client side checking
__construct
in file SForm.php, method SForm_Rule::__construct()
    Construct a rule with one element and one error message
__construct
in file Boolean.php, method SForm_Rule_Boolean::__construct()
    Create a free form boolean rule
a

a

$addName
in file SForm.php, variable SForm_Element::$addName
    Should we add the 'name' attribute?
$attributes
in file SForm.php, variable SForm_Element::$attributes
    Attributes for this tag
addElement
in file SForm.php, method SForm_Container::addElement()
    Adds an element to this container
addGroup
in file SForm.php, method SForm::addGroup()
    Create a group and add it to this form
addRule
in file SForm.php, method SForm_Element::addRule()
    Add a rule to this element
addRuleDep
in file SForm.php, method SForm::addRuleDep()
    Add a rule to given field(s)
applyFilter
in file SForm.php, method SForm_Container::applyFilter()
    Apply a filter to the elements
assignParent
in file SForm.php, method SForm_Element::assignParent()
    Assign this element's parent
autoAK
in file SForm.php, method SForm_Element::autoAK()
    Generates an access key and updated label
$addName
in file Header.php, variable SForm_Elm_Header::$addName
    Don't add the name attribute
addOptGroup
in file SForm.php, method SForm_Elm_Select::addOptGroup()
    Add an optgroup.
addOption
in file SForm.php, method SForm_Elm_Select::addOption()
    Add an option to the list
append
in file SForm.php, method SForm_Renderer_Array::append()
    Append a new element to the output
append
in file SForm.php, method SForm_Renderer::append()
    Append the current element's value to the tree
append
in file SForm.php, method SForm_Renderer_HTML::append()
    Append the current element to the output string
applyJavaScript
in file SForm.php, method SForm_Renderer::applyJavaScript()
    Applies the rendered JavaScript to the given form
assignParent
in file SForm.php, method SForm_Rule::assignParent()
    Mark this rule as having a parent
b

b

$buffer
in file SForm.php, variable SForm_Renderer_HTML::$buffer
    The main body of the output string
Boolean.php
procedural page Boolean.php
c

c

$chFilters
in file SForm.php, variable SForm_Container::$chFilters
    Filters which will be applied to the children of this container
$chRules
in file SForm.php, variable SForm_Container::$chRules
    Rules which will be applied to the children of this container
count
in file SForm.php, method SForm_Container::count()
    Return number of children
createElement
in file SForm.php, method SForm_Container::createElement()
    Creates an element
createRule
in file SForm.php, method SForm_Element::createRule()
    Creates & returns a rule
current
in file SForm.php, method SForm_Container::current()
    Return the current element
$checkedSet
in file SForm.php, variable SForm_Elm_Checkable::$checkedSet
    Has the 'checked' attribute been explicitly set?
$currElms
in file SForm.php, variable SForm_Renderer::$currElms
    Array that we are currently rendering
createJSRule
in file SForm.php, method SForm_Rule::createJSRule()
    Create a basic if-then rule in JavaScript
d

d

$defaults
in file SForm.php, variable SForm::$defaults
    Defaults are stored here
$defId
in file SForm.php, variable SForm_Element::$defId
    Number the elements if not given an ID
display
in file SForm.php, method SForm::display()
    Prints this form to std out
e

e

$emptyTag
in file SForm.php, variable SForm_Element::$emptyTag
    Is this element's tag empty?
$emptyTag
in file SForm.php, variable SForm_Container::$emptyTag
    Containers are never empty tags
$errors
in file SForm.php, variable SForm_Element::$errors
    What were the results of the validation?
enableFileUpload
in file SForm.php, method SForm::enableFileUpload()
    Enables file uploading
escHtml
in file SForm.php, method SForm_Element::escHtml()
    Escape HTML in a consistant manner
exportValue
in file SForm.php, method SForm::exportValue()
    Returns an element's value
$emptyTag
in file SForm.php, variable SForm_Elm_Textarea::$emptyTag
    It contains text
$emptyTag
in file SForm.php, variable SForm_Elm_Select::$emptyTag
    This tag contains elements
$emptyTag
in file Header.php, variable SForm_Elm_Header::$emptyTag
    It contains text
$errors
in file SForm.php, variable SForm_Renderer::$errors
    Were errors reported?
$elements
in file SForm.php, variable SForm_Rule::$elements
    Which elements fall under this jurisdiction?
$exclusion
in file SForm.php, variable SForm_Rule_Subset::$exclusion
    Are we excluding this subset?
escClient
in file SForm.php, method SForm_Rule::escClient()
    Escape client side variables
exclude
in file SForm.php, method SForm_Rule_Subset::exclude()
    Do we exclude this subset (instead of include them)?
f

f

$filters
in file SForm.php, variable SForm_Element::$filters
    A list of filter callbacks
filter
in file SForm.php, method SForm_Element::filter()
    Apply a filter to the value
filterValue
in file SForm.php, method SForm_Element::filterValue()
    Filters the value
freeze
in file SForm.php, method SForm_Element::freeze()
    Set if this element is frozen
freeze
in file SForm.php, method SForm_Container::freeze()
    Set the frozen status of this container and its children
fetch
in file SForm.php, method SForm_Renderer_HTML::fetch()
    Finish the form
fetch
in file SForm.php, method SForm_Renderer_Array::fetch()
    Add the JavaScript and hidden elms
fetch
in file SForm.php, method SForm_Renderer::fetch()
    We need to retrieve the resulting data
$freeFormBool
in file Boolean.php, variable SForm_Rule_Boolean::$freeFormBool
    Define this rule
g

g

getAttribute
in file SForm.php, method SForm_Element::getAttribute()
    Get an attribute in $this
getAttributesString
in file SForm.php, method SForm_Element::getAttributesString()
    Creates an HTML attribute string from an array
getChildren
in file SForm.php, method SForm_Container::getChildren()
    Return the current element
getElement
in file SForm.php, method SForm_Container::getElement()
    Returns an element using the Local ID
getErrorHtml
in file SForm.php, method SForm_Element::getErrorHtml()
    Do we have any errors?
getGlobalElement
in file SForm.php, method SForm_Container::getGlobalElement()
    Returns an element using the Global ID
getGlobalElement
in file SForm.php, method SForm::getGlobalElement()
    Get an element by its Global ID
getGlobalId
in file SForm.php, method SForm::getGlobalId()
    All children of this form inheret their IDs from it.
getGlobalId
in file SForm.php, method SForm_Element::getGlobalId()
    This is the page-wide unique ID
getLabel
in file SForm.php, method SForm_Element::getLabel()
    Return the label string (no markup)
getLabelHtml
in file SForm.php, method SForm_Group::getLabelHtml()
    Return the label
getLabelHtml
in file SForm.php, method SForm_Fieldset::getLabelHtml()
    Return the label as a legend tag
getLabelHtml
in file SForm.php, method SForm_Element::getLabelHtml()
    Return the label with markup added
getLocalId
in file SForm.php, method SForm_Element::getLocalId()
    A Locally usable ID
getOption
in file SForm.php, method SForm_Element::getOption()
    Get a global option
getRequest
in file SForm.php, method SForm_Element::getRequest()
    Returns a value from the request
getRequest
in file SForm.php, method SForm::getRequest()
    Returns a value from the request
getValue
in file SForm.php, method SForm_Element::getValue()
    The value of this element
getLabel
in file Header.php, method SForm_Elm_Header::getLabel()
    Disable the label
getLabelHtml
in file Header.php, method SForm_Elm_Header::getLabelHtml()
genJSValue
in file SForm.php, method SForm_Rule::genJSValue()
    Returns JS to get a value and save it in the local variable
h

h

hasChildren
in file SForm.php, method SForm_Container::hasChildren()
    Does the current element have children?
Header.php
procedural page Header.php
$hidden
in file SForm.php, variable SForm_Renderer::$hidden
    Store the hidden elements in one string
$hasParent
in file SForm.php, variable SForm_Rule::$hasParent
    Has this rule been asigned to an element?
i

i

isFrozen
in file SForm.php, method SForm_Element::isFrozen()
    Is this element marked as frozen?
isRequired
in file SForm.php, method SForm_Element::isRequired()
    Is this element required?
$inOptGrp
in file SForm.php, variable SForm_Elm_Select::$inOptGrp
    Hash table of the optgroups
$invalid
in file SForm.php, variable SForm_Elm_Select::$invalid
    Any invalid options
invalidOption
in file SForm.php, method SForm_Elm_Select::invalidOption()
    Make an option invalid
isChecked
in file SForm.php, method SForm_Elm_Checkable::isChecked()
    Is this element checked?
isError
in file SForm.php, method SForm_Rule_Subset::isError()
    Is the value in the set?
isError
in file SForm.php, method SForm_Rule_Required::isError()
    Does the element have a value?
isError
in file SForm.php, method SForm_Rule_Maxlenth::isError()
    Is it too long?
isError
in file SForm.php, method SForm_Rule::isError()
    Returns true if this element(s) fail validation
isError
in file Boolean.php, method SForm_Rule_Boolean::isError()
    Does the statement evaluate to true?
j

j

$javascript
in file SForm.php, variable SForm_Renderer::$javascript
    Rendered JavaScript, to be run onsubmit
$jsPostfix
in file SForm.php, variable SForm_Renderer::$jsPostfix
$jsPrefix
in file SForm.php, variable SForm_Renderer::$jsPrefix
    Error message in the JavaScript
$jsElmNum
in file SForm.php, variable SForm_Rule::$jsElmNum
    The counter for temp local variables
$jsElmVar
in file SForm.php, variable SForm_Rule::$jsElmVar
    The names of local JavaScript variables
k

k

key
in file SForm.php, method SForm_Container::key()
    Return the key of the current element
l

l

$locked
in file SForm.php, variable SForm_Element::$locked
    Are the rules & filters prevented from being modified?
lock
in file SForm.php, method SForm_Element::lock()
    Locks & adds any last minute stuff
lock
in file SForm.php, method SForm_Container::lock()
    Add any requested filters and rules, then lock this container
lock
in file SForm.php, method SForm_Elm_Select::lock()
    Add a intrinsic rule to only accept valid options
m

m

$maxlen
in file SForm.php, variable SForm_Rule_Maxlenth::$maxlen
    Max number of chars
$message
in file SForm.php, variable SForm_Rule::$message
    NO YUO!
n

n

next
in file SForm.php, method SForm_Container::next()
    Advance pointer and return the new current
o

o

$optGroups
in file SForm.php, variable SForm_Elm_Select::$optGroups
    Group the children as needed
$options
in file SForm.php, variable SForm_Elm_Select::$options
    The option "children" of this element
p

p

$parent
in file SForm.php, variable SForm_Element::$parent
    What is the parent to this element?
process
in file SForm.php, method SForm::process()
    Process the results of the form
pop
in file SForm.php, method SForm_Renderer_HTML::pop()
    Exit the current contianer
pop
in file SForm.php, method SForm_Renderer::pop()
    Move back down in the stack
pop
in file SForm.php, method SForm_Renderer_Array::pop()
    Move back down
push
in file SForm.php, method SForm_Renderer_HTML::push()
    Enter an element container
push
in file SForm.php, method SForm_Renderer::push()
    Move up a level in the stack
push
in file SForm.php, method SForm_Renderer_Array::push()
    Move up a level in the stack
r

r

$required
in file SForm.php, variable SForm_Element::$required
    Is this a required element?
$rules
in file SForm.php, variable SForm_Element::$rules
    Rules to apply to this element
removeElement
in file SForm.php, method SForm_Container::removeElement()
    Removes an element from this group
render
in file SForm.php, method SForm_Container::render()
    Render this container and all elements in it
render
in file SForm.php, method SForm_Element::render()
    Append this leaf element to the render queue
render
in file SForm.php, method SForm::render()
    Renders a form with the provided renderer
rewind
in file SForm.php, method SForm_Container::rewind()
    Move the current element to the first one
$required
in file SForm.php, variable SForm_Renderer::$required
    Were any elements required?
rendJavaScript
in file SForm.php, method SForm_Renderer::rendJavaScript()
    Render the array of JavaScript into a script
s

s

setAttribute
in file SForm.php, method SForm_Element::setAttribute()
    Set an attribute in $this
setDefault
in file SForm.php, method SForm_Element::setDefault()
    Set the default value of this element
setDefaults
in file SForm.php, method SForm::setDefaults()
    Set the default values of local elements
setOption
in file SForm.php, method SForm_Element::setOption()
    Set a global option
setValue
in file SForm.php, method SForm_Element::setValue()
    Set the value of this element
SForm
in file SForm.php, class SForm
    I am the alpha and the omega, I am the form.
SForm.php
procedural page SForm.php
SForm_Container
in file SForm.php, class SForm_Container
    A container holds one or more elements
SForm_Element
in file SForm.php, class SForm_Element
    A element is a "leaf" that is actually rendered
SForm_Fieldset
in file SForm.php, class SForm_Fieldset
    Group elements in a '<fieldset>'
SForm_Group
in file SForm.php, class SForm_Group
    Group elements
setAttribute
in file SForm.php, method SForm_Elm_Text::setAttribute()
    Handle 'maxlength'
setChecked
in file SForm.php, method SForm_Elm_Checkable::setChecked()
    Set the checked attribute
setDefault
in file SForm.php, method SForm_Elm_Checkable::setDefault()
    Set the default checked status
SForm_Elm_Button
in file SForm.php, class SForm_Elm_Button
    A button element
SForm_Elm_Checkable
in file SForm.php, class SForm_Elm_Checkable
    A base for checkbox or radio elements
SForm_Elm_Checkbox
in file SForm.php, class SForm_Elm_Checkbox
    A checkbox element
SForm_Elm_Header
in file Header.php, class SForm_Elm_Header
    A header element
SForm_Elm_Hidden
in file SForm.php, class SForm_Elm_Hidden
    The hidden element
SForm_Elm_Reset
in file SForm.php, class SForm_Elm_Reset
    A reset element
SForm_Elm_Select
in file SForm.php, class SForm_Elm_Select
    A select list
SForm_Elm_Submit
in file SForm.php, class SForm_Elm_Submit
    A submit element
SForm_Elm_Text
in file SForm.php, class SForm_Elm_Text
    A text element
SForm_Elm_Textarea
in file SForm.php, class SForm_Elm_Textarea
    A textarea element
$stack
in file SForm.php, variable SForm_Renderer::$stack
    Array that holds rendered bits of elements
SForm_Renderer
in file SForm.php, class SForm_Renderer
    Render only the values by default
SForm_Renderer_Array
in file SForm.php, class SForm_Renderer_Array
    Render the form to an array
SForm_Renderer_HTML
in file SForm.php, class SForm_Renderer_HTML
    Render the form to plain (X)HTML
startForm
in file SForm.php, method SForm_Renderer::startForm()
    Start rendering the form
$set
in file SForm.php, variable SForm_Rule_Subset::$set
    The set of values
SForm_Rule
in file SForm.php, class SForm_Rule
    Create rules for elements
SForm_Rule_Boolean
in file Boolean.php, class SForm_Rule_Boolean
    Used to generate on-the-fly boolean rules
SForm_Rule_Maxlenth
in file SForm.php, class SForm_Rule_Maxlenth
    Set the maximum number of chars in a value
SForm_Rule_Required
in file SForm.php, class SForm_Rule_Required
    Is the given element required?
SForm_Rule_Subset
in file SForm.php, class SForm_Rule_Subset
    Is the value in (or out of) this subset?
t

t

$tag
in file SForm.php, variable SForm::$tag
    Why yes, this is a form
$tag
in file SForm.php, variable SForm_Element::$tag
    This is the element's tag ('input', 'select', 'form', etc) and should be set by the children as needed.
$tag
in file SForm.php, variable SForm_Fieldset::$tag
    By default, render this as a fieldset
$trackSubmit
in file SForm.php, variable SForm::$trackSubmit
    Are we tracking the submit?
toArray
in file SForm.php, method SForm::toArray()
    Returns a nested array of all returned values
toHidden
in file SForm.php, method SForm_Element::toHidden()
    Do we have any hidden tags to append?
toHtml
in file SForm.php, method SForm_Group::toHtml()
    Open the group
toHtml
in file SForm.php, method SForm_Element::toHtml()
    Create a HTML representation of this element
toHtml
in file SForm.php, method SForm_Container::toHtml()
    Create a HTML representation of this container
toHtmlFin
in file SForm.php, method SForm_Group::toHtmlFin()
    Close this element group
toHtmlFin
in file SForm.php, method SForm_Fieldset::toHtmlFin()
    Close this element group
toHtmlFin
in file SForm.php, method SForm_Element::toHtmlFin()
    Close an open HTML tags
toJavaScript
in file SForm.php, method SForm_Element::toJavaScript()
    Retrieve any JavaScript that should be run onsubmit
toString
in file SForm.php, method SForm_Element::toString()
    How does this value look as a HTML string?
$tag
in file SForm.php, variable SForm_Elm_Select::$tag
    Change the tag to match the element
$tag
in file SForm.php, variable SForm_Elm_Textarea::$tag
    It's a textarea
$tag
in file Header.php, variable SForm_Elm_Header::$tag
    It's a header
$type
in file SForm.php, variable SForm_Elm_Reset::$type
    reset button
$type
in file SForm.php, variable SForm_Elm_Submit::$type
    Submit button
$type
in file SForm.php, variable SForm_Elm_Button::$type
    Type of button
toHidden
in file SForm.php, method SForm_Elm_Hidden::toHidden()
    Return the normal tag
toHtml
in file SForm.php, method SForm_Elm_Textarea::toHtml()
    Return the header
toHtml
in file SForm.php, method SForm_Elm_Select::toHtml()
    Render the list of options as HTML
toHtml
in file SForm.php, method SForm_Elm_Hidden::toHtml()
    Hidden is seperate from regular HTML
toHtml
in file SForm.php, method SForm_Elm_Checkable::toHtml()
    Returns a checkable element
toHtml
in file Header.php, method SForm_Elm_Header::toHtml()
    Return the header
toHtml
in file SForm.php, method SForm_Elm_Button::toHtml()
    Frozen returns no button
toString
in file Header.php, method SForm_Elm_Header::toString()
    Return the header
toString
in file SForm.php, method SForm_Elm_Select::toString()
    Show this option as a string
toString
in file SForm.php, method SForm_Elm_Checkable::toString()
    Setup the string so it better represent a 'check'
toString
in file SForm.php, method SForm_Elm_Hidden::toString()
    Hidden elements don't look like anything
toJavaScript
in file SForm.php, method SForm_Rule_Required::toJavaScript()
    Generate JavaScript to determine if there is a value
toJavaScript
in file SForm.php, method SForm_Rule_Maxlenth::toJavaScript()
    Generate JavaScript to determine if the value is too long
toJavaScript
in file Boolean.php, method SForm_Rule_Boolean::toJavaScript()
    Generates JS that will execute the boolean statement
toJavaScript
in file SForm.php, method SForm_Rule::toJavaScript()
    Get the JavaScript that should be run onsubmit
toJavaScript
in file SForm.php, method SForm_Rule_Subset::toJavaScript()
    Generate JS to find if the value is in the set
toString
in file SForm.php, method SForm_Rule::toString()
    Returns a message describing the error and its cause
u

u

unsetAttribute
in file SForm.php, method SForm_Element::unsetAttribute()
    Unset an attribute
v

v

$validated
in file SForm.php, variable SForm_Element::$validated
    Has this element been validated?
$valueSet
in file SForm.php, variable SForm_Element::$valueSet
    Has the value for this element been set?
valid
in file SForm.php, method SForm_Container::valid()
    Is the current ponter valid?
validate
in file SForm.php, method SForm_Element::validate()
    Is this a valid element?
validate
in file SForm.php, method SForm_Container::validate()
    Is this valid?
validate
in file SForm.php, method SForm::validate()
    Is this valid?
$validateOnClient
in file SForm.php, variable SForm_Rule::$validateOnClient
    Should we use this rule with JavaScript?
validateOnClient
in file SForm.php, method SForm_Rule::validateOnClient()
    Should we run validation code on the client
w

w

wasSubmitted
in file SForm.php, method SForm_Element::wasSubmitted()
    Was this form submitted?
wasSubmitted
in file SForm.php, method SForm::wasSubmitted()
    Was this form submitted?
Documentation generated on Mon, 09 Apr 2007 19:06:26 -0500 by phpDocumentor 1.3.0