EditorField

Extends \JFormFieldTextarea

A textarea field for content creation

Supports a multi line area for entry of plain text

see \Joomla\CMS\Form\Field\JEditor
since

1.6

Methods

__get

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

__get(string $name) : mixed
inherited
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
inherited
since

3.2

Arguments

$name

stringThe property name for which to set the value.

$value

mixedThe value of the property.

getEditor

Method to get an Editor object based on the form field.

getEditor() : \Joomla\CMS\Editor\Editor
since

1.6

Response

\Joomla\CMS\Editor\EditorThe Editor object.

getInput

Method to get the textarea field input markup.

getInput() : string
inherited

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
inherited
since

3.7

Response

array

save

Method to get the JEditor output for an onSave event.

save() : string
deprecated
since

1.6

deprecated

4.0 Will be removed without replacement

see \Joomla\CMS\Editor\Editor::save()

Response

stringThe JEditor object output.

setup

Method to attach a JForm object to the field.

setup(\SimpleXMLElement $element, mixed $value, string $group = null) : boolean
inherited
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.

inherited
since

1.7.0

Type(s)

string

editor

The Editor object.

since

1.6

Type(s)

\Joomla\CMS\Editor\Editor

height

The height of the editor.

since

3.2

Type(s)

string

width

The width of the editor.

since

3.2

Type(s)

string

assetField

The assetField of the editor.

since

3.2

Type(s)

string

authorField

The authorField of the editor.

since

3.2

Type(s)

string

asset

The asset of the editor.

since

3.2

Type(s)

string

buttons

The buttons of the editor.

since

3.2

Type(s)

mixed

hide

The hide of the editor.

since

3.2

Type(s)

array

editorType

The editorType of the editor.

since

3.2

Type(s)

array

rows

The number of rows in textarea.

inherited
since

3.2

Type(s)

mixed

columns

The number of columns in textarea.

inherited
since

3.2

Type(s)

mixed

maxlength

The maximum number of characters in textarea.

inherited
since

3.4

Type(s)

mixed

layout

Name of the layout being used to render the field

inherited
since

3.7

Type(s)

string