phpDocumentor SForm
Elements
[ 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

Class: SForm_Elm_Hidden

Source Location: /SForm.php

Class SForm_Elm_Hidden

Class Overview
Class Overview | Inherited Properties, Constants, and Methods | Properties | Method Summary | Methods Detail

The hidden element

Creates an element that is embeded in the form but hidden from the user. It's useful for passing data between submissions. But be careful: advanced users will be able to view and alter its value, so don't trust it completly.

Located in /SForm.php [line 3393] 

SForm_Element
   |
   --SForm_Elm_Hidden

Methods
[ Top ]
Inherited Properties, Constants, and Methods
Class Overview | | Inherited Properties, Constants, and Methods | Properties | Method Summary | Methods Detail
Inherited Properties Inherited Methods Inherited Constants

Inherited From SForm_Element

SForm_Element::$addName
SForm_Element::$attributes
SForm_Element::$defId
SForm_Element::$emptyTag
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_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
Class Overview | Inherited Properties and Methods | Properties Method Summary | Methods Detail
SForm_Elm_Hidden   __construct()   Add hidden type info
string   toHidden()   Return the normal tag
string   toHtml()   Hidden is seperate from regular HTML
string   toString()   Hidden elements don't look like anything

[ Top ]
Properties
Class Overview | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
Methods
Class Overview | Inherited Properties and Methods | | Properties | Method Summary | Methods Detail
Constructor __construct  [line 3405]

  SForm_Elm_Hidden __construct( [string $id = null], [string $label = null], [array $attributes = null]  )

Add hidden type info

Override the parent to ensure that the 'type' attribute is set to 'hidden'.

 Parameters:
string   $id:  Local ID of this element
string   $label:  Label of this element
array   $attributes:  Any extra attributes

API Tags:
Access:  public
Uses:  SForm_Element::__construct()

Redefinition of:
SForm_Element::__construct()
Construct with an identity. Optionally add a label and more attributes.

[ Top ]
toHidden  [line 3433]

  string toHidden( )

Return the normal tag

Returns the tag as a hidden element.
API Tags:
Return:  The hidden tag
Access:  public

Redefinition of:
SForm_Element::toHidden()
Do we have any hidden tags to append?

[ Top ]
toHtml  [line 3422]

  string toHtml( )

Hidden is seperate from regular HTML

Hidden elements don't return regular HTML. The tag is returned from toHidden().
API Tags:
Return:  Nothing
Access:  public

Redefinition of:
SForm_Element::toHtml()
Create a HTML representation of this element

[ Top ]
toString  [line 3445]

  string toString( )

Hidden elements don't look like anything

Because they are hidden, the user wouldn't see anything when viewing as a string.
API Tags:
Return:  Nothing
Access:  public

Redefinition of:
SForm_Element::toString()
How does this value look as a HTML string?

[ Top ]
Documentation generated on Mon, 09 Apr 2007 19:08:37 -0500 by phpDocumentor 1.3.0