Class: SForm_Elm_Text

Source Location: /SForm.php

Class SForm_Elm_Text

Class Overview

A text element

A text element is a small input box for text. If the attribute 'maxlength' is set, the rule SForm_Rule_Maxlength will be added, and the maximum length of this attribute will be enforced on the server.

Located in /SForm.php [line 3618]

SForm_Element
   |
   --SForm_Elm_Text

Methods

[ Top ]

Inherited Properties, Constants, and Methods

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

SForm_Elm_Text	__construct()	Add text type info
void	setAttribute()	Handle 'maxlength'

[ Top ]

Properties

Methods

Constructor __construct [line 3626]

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

Add text type info

Parameters:

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

API Tags:

Access:

public

Redefinition of:

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

[ Top ]

setAttribute [line 3645]

void setAttribute(
string
$attr, [string
$value = null] 
)

Handle 'maxlength'

SForm_Elm_Text will automatically add the rule SForm_Rule_Maxlength to itself if the attribute 'maxlength' is set.

Parameters:

string	$attr:	Attribute to set
string	$value:	Value to set (sets value = attribute if null)

API Tags:

Access:	public
Uses:	SForm_Element::$attributes

Redefinition of:

SForm_Element::setAttribute(): Set an attribute in $this

[ Top ]

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

	SForm Elements

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