Class: SForm_Elm_Header

Source Location: /SForm/Elm/Header.php

Class SForm_Elm_Header

Class Overview

A header element

The header element simply puts a header on the page. It is here for QuickForm compatability; Really though, SForm isn't a templating engine. You should find a more appropriate method for placing a header on the page.

Located in /SForm/Elm/Header.php [line 48]

SForm_Element
   |
   --SForm_Elm_Header

Author(s):

API Tags:

Deprecated:

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From SForm_Element

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::$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 ]

Property Summary

boolean	$addName	Don't add the name attribute
boolean	$emptyTag	It contains text
string	$tag	It's a header

[ Top ]

Method Summary

void	getLabel()	Disable the label
void	getLabelHtml()
string	toHtml()	Return the header
string	toString()	Return the header

[ Top ]

Properties

boolean $addName = false [line 69]

Don't add the name attribute

API Tags:

Access:

protected

Redefinition of:

SForm_Element::$addName: Should we add the 'name' attribute?

[ Top ]

boolean $emptyTag = false [line 62]

It contains text

API Tags:

Access:

protected

Redefinition of:

SForm_Element::$emptyTag: Is this element's tag empty?

[ Top ]

string $tag = 'h1' [line 55]

It's a header

API Tags:

Access:

protected

Redefinition of:

SForm_Element::$tag: This is the element's tag ('input', 'select', 'form', etc) and should be set by the children as needed.

[ Top ]

Methods

getLabel [line 74]

void getLabel(
)

Disable the label

API Tags:

Access:

public

Redefinition of:

SForm_Element::getLabel(): Return the label string (no markup)

[ Top ]

getLabelHtml [line 75]

void getLabelHtml(
[
$ak = true] 
)

Parameters:

$ak:

API Tags:

Access:

public

Redefinition of:

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

[ Top ]

toHtml [line 91]

string toHtml(
)

Return the header

API Tags:

Return:	The header
Access:	public

Redefinition of:

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

[ Top ]

toString [line 82]

string toString(
)

Return the header

API Tags:

Return:	The header
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:06:50 -0500 by phpDocumentor 1.3.0

	SForm Elements

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