Docs For Class JFormFieldText

Description

Form Field class for the Joomla Platform.

Supports a one line text field.

link: http://www.w3.org/TR/html-markup/input.text.html#input.text
since: 11.1

Located in /libraries/joomla/form/fields/text.php (line 21)

JFormField
   |
   --JFormFieldText

Direct descendents

Class	Description
JFormFieldModulePosition	Form Field class for the Joomla! CMS.
FOFFormFieldText	Form Field class for the FOF framework Supports a one line text field.
JFormFieldEMail	Form Field class for the Joomla Platform.
JFormFieldTel	Form Field class for the Joomla Platform.
JFormFieldUrl	Form Field class for the Joomla Platform.

Variable Summary

string $dirname

mixed $inputmode

integer $maxLength

string $type

Method Summary

string getInput ()

array getSuggestions ()

boolean setup (SimpleXMLElement $element, mixed $value, [string $group = null])

mixed __get (string $name)

void __set (string $name, mixed $value)

Variables

string $dirname (line 54)

The name of the form field direction (ltr or rtl).

since: 3.2
access: protected

mixed $inputmode (line 46)

The mode of input associated with the field.

since: 3.2
access: protected

integer $maxLength (line 38)

The allowable maxlength of the field.

since: 3.2
access: protected

string $type = 'Text' (line 30)

The form field type.

since: 11.1
access: protected

Redefinition of:

JFormField::$type: The form field type.

Redefined in descendants as:

JFormFieldModulePosition::$type : The form field type.
JFormFieldEMail::$type : The form field type.
JFormFieldTel::$type : The form field type.
JFormFieldUrl::$type : The form field type.

Inherited Variables

Inherited from JFormField

JFormField::$autocomplete
JFormField::$autofocus
JFormField::$class
JFormField::$count
JFormField::$default
JFormField::$description
JFormField::$disabled
JFormField::$element
JFormField::$fieldname
JFormField::$form
JFormField::$formControl
JFormField::$generated_fieldname
JFormField::$group
JFormField::$hidden
JFormField::$hint
JFormField::$id
JFormField::$input
JFormField::$label
JFormField::$labelClass
JFormField::$multiple
JFormField::$name
JFormField::$onchange
JFormField::$onclick
JFormField::$pattern
JFormField::$readonly
JFormField::$repeat
JFormField::$required
JFormField::$size
JFormField::$spellcheck
JFormField::$translateDescription
JFormField::$translateHint
JFormField::$translateLabel
JFormField::$validate
JFormField::$value

Methods

getInput (line 165)

Method to get the field input markup.

return: The field input markup.
since: 11.1
access: protected

string getInput ()

Redefinition of:

JFormField::getInput(): Method to get the field input markup.

Redefined in descendants as:

JFormFieldModulePosition::getInput() : Method to get the field input markup.
FOFFormFieldButton::getInput() : Get the rendering of this field type for static display, e.g. in a single item view (typically a "read" task).
JFormFieldEMail::getInput() : Method to get the field input markup for e-mail addresses.
JFormFieldTel::getInput() : Method to get the field input markup.
JFormFieldUrl::getInput() : Method to get the field input markup.

getSuggestions (line 217)

Method to get the field suggestions.

return: The field option objects.
since: 11.1
access: protected

array getSuggestions ()

setup (line 123)

Method to attach a JForm object to the field.

return: True on success.
see: JFormField::setup()
since: 3.2
access: public

boolean setup (SimpleXMLElement $element, mixed $value, [string $group = null])

SimpleXMLElement $element: The SimpleXMLElement object representing the <field /> tag for the form field object.
mixed $value: The form field value to validate.
string $group: The field name group control value. This acts as 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]".

Redefinition of:

JFormField::setup(): Method to attach a JForm object to the field.

Redefined in descendants as:

JFormFieldModulePosition::setup() : Method to attach a JForm object to the field.

__get (line 65)

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

return: The property value or null.
since: 3.2
access: public

mixed __get (string $name)

string $name: The property name for which to the the value.

Redefinition of:

JFormField::__get(): Method to get certain otherwise inaccessible properties from the form field object.

Redefined in descendants as:

JFormFieldModulePosition::__get() : Method to get certain otherwise inaccessible properties from the form field object.
FOFFormFieldText::__get() : Method to get certain otherwise inaccessible properties from the form field object.
FOFFormFieldButton::__get() : Method to get certain otherwise inaccessible properties from the form field object.
FOFFormFieldEmail::__get() : Method to get certain otherwise inaccessible properties from the form field object.
FOFFormFieldTel::__get() : Method to get certain otherwise inaccessible properties from the form field object.
FOFFormFieldUrl::__get() : Method to get certain otherwise inaccessible properties from the form field object.

__set (line 88)

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

since: 3.2
access: public

void __set (string $name, mixed $value)

string $name: The property name for which to the the value.
mixed $value: The value of the property.

Redefinition of:

JFormField::__set(): Method to set certain otherwise inaccessible properties of the form field object.

Redefined in descendants as:

JFormFieldModulePosition::__set() : Method to set certain otherwise inaccessible properties of the form field object.

Inherited Methods

Inherited From JFormField

JFormField::__construct()
JFormField::getAttribute()
JFormField::getControlGroup()
JFormField::getFieldName()
JFormField::getId()
JFormField::getInput()
JFormField::getLabel()
JFormField::getName()
JFormField::getTitle()
JFormField::setForm()
JFormField::setup()
JFormField::setValue()
JFormField::__get()
JFormField::__set()