Class: FormTextArea

Source Location: /FormTextArea.class.php

Class Overview

FormField
   |
   --FormTextArea

The FormField class.

Author(s):

Sean Monahan

Version:

Copyright:

2008 Sean Monahan

Methods

Inherited Methods

Class: FormField

FormField::__construct(): This is the base class for all HTML form fields.
FormField::addClassName(): Adds a class name to the existing list of classes.
FormField::addEventListener(): Adds an event listeners to the field.
FormField::className(): Getter for $_action.
FormField::eventListeners(): Getter for $_eventListeners.
FormField::fieldType(): Getter for $_fieldType;
FormField::isDisabled(): Getter for $_isDisabled.
FormField::label(): Getter for $_method.
FormField::name(): Getter for $_name.
FormField::setClassName(): Setter for $_className.
FormField::setFieldType(): Setter for $_fieldType.
FormField::setIsDisabled(): Setter for $_isDisabled.
FormField::setLabel(): Setter for $_label.
FormField::setName(): Setter for $_name
FormField::setSize(): Setter for $_size.
FormField::size(): Getter for $_size.
FormField::type(): Getter for $_type.

Class Details

[line 18]
The FormField class.

PHP Version 5

LICENSE: This source file is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License. http://creativecommons.org/licenses/by-sa/3.0/us/

Tags:

author:	Sean Monahan
version:	1.0
copyright:	2008 Sean Monahan

[ Top ]

Class Methods

constructor __construct [line 53]

FormTextArea __construct(
[
$value = ""], [string
$name = ""], [string
$label = ""], [string
$className = ""], [int
$columns = -1], [
$rows = -1], [bool
$isDisabled = false], array
$options)

This class builds an HTML <textarea>.

Tags:

access:

public

Overrides FormField::__construct() (This is the base class for all HTML form fields.)

Parameters:

array	$options	The list of options for the <textarea>.
string	$name	The name for the <textarea>. Also sets the id.
string	$label	The label for the <textarea>.
string	$className	The CSS class for the <textarea>.
int	$columns	The number of columns for the <textarea>.
bool	$isDisabled	Sets the <textarea> to disabled. Default: false.
	$value
	$rows

[ Top ]

method columns [line 72]

int columns(
)

Getter for $_columns.

Tags:

return:	The number of set columns.
access:	public

[ Top ]

method rows [line 82]

int rows(
)

Getter for $_rows.

Tags:

return:	The number of set rows.
access:	public

[ Top ]

method setColumns [line 102]

void setColumns(
string
$value)

Setter for $_columns.

Tags:

access:

public

Parameters:

string

$value

The options for the select.

[ Top ]

method setRows [line 115]

void setRows(
string
$value)

Setter for $_rows.

Tags:

access:

public

Parameters:

string

$value

The options for the select.

[ Top ]

method setValue [line 128]

void setValue(
string
$value)

Setter for $_value;

Tags:

access:

public

Parameters:

string

$value

The contents for $_value.

[ Top ]

method value [line 92]

string value(
)

Getter for $_value.

Tags:

return:	The value for the text area.
access:	public

[ Top ]

Documentation generated on Mon, 15 Dec 2008 21:14:25 -0700 by phpDocumentor 1.4.1