JFormFieldTextarea

Extends \JFormField

Form Field class for the Joomla Platform.

Supports a multi line area for entry of plain text

link

http://www.w3.org/TR/html-markup/textarea.html#textarea

since

1.7.0

package

Joomla.Platform

Methods

__get

Method to get certain otherwise inaccessible properties from the form field object.

__get(string $name) : mixed
since

3.2

Arguments

$name

stringThe property name for which to get the value.

Response

mixedThe property value or null.

__set

Method to set certain otherwise inaccessible properties of the form field object.

__set(string $name, mixed $value) : void
since

3.2

Arguments

$name

stringThe property name for which to set the value.

$value

mixedThe value of the property.

getInput

Method to get the textarea field input markup.

getInput() : string

Use the rows and columns attributes to specify the dimensions of the area.

since

1.7.0

Response

stringThe field input markup.

getLayoutData

Method to get the data to be passed to the layout for rendering.

getLayoutData() : array
since

3.7

Response

array

setup

Method to attach a JForm object to the field.

setup(\SimpleXMLElement $element, mixed $value, string $group = null) : boolean
see \JFormField::setup()
since

3.2

Arguments

$element

\SimpleXMLElementThe SimpleXMLElement object representing the <field> tag for the form field object.

$value

mixedThe form field value to validate.

$group

stringThe field name group control value. This acts as an array container for the field. For example if the field has name="foo" and the group value is set to "bar" then the full field name would end up being "bar[foo]".

Response

booleanTrue on success.

Properties

type

The form field type.

since

1.7.0

Type(s)

string

rows

The number of rows in textarea.

since

3.2

Type(s)

mixed

columns

The number of columns in textarea.

since

3.2

Type(s)

mixed

maxlength

The maximum number of characters in textarea.

since

3.4

Type(s)

mixed

layout

Name of the layout being used to render the field

since

3.7

Type(s)

string