Class JFormField

Abstract Form Field class for the Joomla Platform.

Direct known subclasses

FOFFormFieldOrdering, FOFFormFieldSelectrow, JFormFieldHidden, JFormFieldList, JFormFieldMedia, JFormFieldModulelayout, JFormFieldModuleOrder, JFormFieldNote, JFormFieldNumber, JFormFieldOrdering, JFormFieldPassword, JFormFieldRepeatable, JFormFieldCalendar, JFormFieldRules, JFormFieldSpacer, JFormFieldSubform, JFormFieldText, JFormFieldTextarea, JFormFieldUser, JFormFieldUsergroup, JFormFieldCaptcha, JFormFieldCheckbox, JFormFieldColor, JFormFieldComponentlayout, JFormFieldContenthistory, JFormFieldFile, JFormFieldGroupedList

Indirect known subclasses

FOFFormFieldAccesslevel, FOFFormFieldActions, FOFFormFieldEmail, FOFFormFieldGroupedbutton, FOFFormFieldGroupedlist, FOFFormFieldHidden, FOFFormFieldImage, FOFFormFieldImagelist, FOFFormFieldInteger, FOFFormFieldLanguage, FOFFormFieldList, FOFFormFieldMedia, FOFFormFieldButton, FOFFormFieldModel, FOFFormFieldPassword, FOFFormFieldPlugins, FOFFormFieldPublished, FOFFormFieldRadio, FOFFormFieldRelation, FOFFormFieldRules, FOFFormFieldSessionhandler, FOFFormFieldSpacer, FOFFormFieldTag, FOFFormFieldCachehandler, FOFFormFieldTel, FOFFormFieldText, FOFFormFieldTextarea, FOFFormFieldTimezone, FOFFormFieldTitle, FOFFormFieldUrl, FOFFormFieldUser, FOFFormFieldUsergroup, JFormFieldAccessLevel, JFormFieldAliastag, FOFFormFieldCalendar, JFormFieldAuthor, JFormFieldCacheHandler, JFormFieldCategory, JFormFieldCheckboxes, JFormFieldChromeStyle, JFormFieldCombo, JFormFieldComponents, JFormFieldContentlanguage, JFormFieldContenttype, JFormFieldDatabaseConnection, FOFFormFieldCaptcha, JFormFieldEditor, JFormFieldEMail, JFormFieldFileList, JFormFieldFolderList, JFormFieldFrontend_Language, JFormFieldHeadertag, JFormFieldHelpsite, JFormFieldImageList, JFormFieldInteger, JFormFieldLanguage, FOFFormFieldCheckbox, JFormFieldLastvisitDateRange, JFormFieldLimitbox, JFormFieldMenu, JFormFieldMenuitem, JFormFieldMeter, JFormFieldModulePosition, JFormFieldModuletag, JFormFieldPlugin_Status, JFormFieldPlugins, JFormFieldPredefinedList, FOFFormFieldCheckboxes, JFormFieldRadio, JFormFieldRange, JFormFieldRegistrationDateRange, JFormFieldSessionHandler, JFormFieldSQL, JFormFieldStatus, JFormFieldTag, JFormFieldTel, JFormFieldTemplatestyle, JFormFieldTimezone, FOFFormFieldComponents, JFormFieldUrl, JFormFieldUserActive, JFormFieldUserGroupList, JFormFieldUserState, FOFFormFieldEditor

Abstract
Package: Joomla\Platform\Form
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 11.1
Located at joomla/form/field.php

Methods summary

`public`	# `__construct( JForm $form = null )` Method to instantiate the form field object. Method to instantiate the form field object. Parameters `$form` `JForm` - $form The form to attach to the form field object. Since 11.1
`public mixed`	# `__get( string $name )` Method to get certain otherwise inaccessible properties from the form field object. Method to get certain otherwise inaccessible properties from the form field object. Parameters `$name` `string` - $name The property name for which to the the value. Returns `mixed` - The property value or null. Since 11.1
`public`	# `__set( string $name, mixed $value )` Method to set certain otherwise inaccessible properties of the form field object. Method to set certain otherwise inaccessible properties of the form field object. Parameters `$name` `string` - $name The property name for which to the the value. `$value` `mixed` - $value The value of the property. Since 3.2
`public JFormField`	# `setForm( JForm $form )` Method to attach a JForm object to the field. Method to attach a JForm object to the field. Parameters `$form` `JForm` - $form The JForm object to attach to the form field. Returns `JFormField` - The form field object so that the method can be used in a chain. Since 11.1
`public boolean`	# `setup( SimpleXMLElement $element, mixed $value, string $group = null )` Method to attach a JForm object to the field. Method to attach a JForm object to the field. Parameters `$element` `SimpleXMLElement` - $element The SimpleXMLElement object representing the `<field>` tag for the form field object. `$value` `mixed` - $value The form field value to validate. `$group` `string` - $group The 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]". Returns `boolean` - True on success. Since 11.1
`public`	# `setValue( mixed $value )` Simple method to set the value Simple method to set the value Parameters `$value` `mixed` - $value Value to set Since 3.2
`protected string`	# `getId( string $fieldId, string $fieldName )` Method to get the id used for the field input tag. Method to get the id used for the field input tag. Parameters `$fieldId` `string` - $fieldId The field element id. `$fieldName` `string` - $fieldName The field element name. Returns `string` - The id to be used for the field input tag. Since 11.1
`protected string`	# `getInput( )` Method to get the field input markup. Method to get the field input markup. Returns `string` - The field input markup. Since 11.1
`protected string`	# `getTitle( )` Method to get the field title. Method to get the field title. Returns `string` - The field title. Since 11.1
`protected string`	# `getLabel( )` Method to get the field label markup. Method to get the field label markup. Returns `string` - The field label markup. Since 11.1
`protected string`	# `getName( string $fieldName )` Method to get the name used for the field input tag. Method to get the name used for the field input tag. Parameters `$fieldName` `string` - $fieldName The field element name. Returns `string` - The name to be used for the field input tag. Since 11.1
`protected string`	# `getFieldName( string $fieldName )` Method to get the field name used. Method to get the field name used. Parameters `$fieldName` `string` - $fieldName The field element name. Returns `string` - The field name Since 11.1
`public mixed`	# `getAttribute( string $name, mixed $default = null )` Method to get an attribute of the field Method to get an attribute of the field Parameters `$name` `string` - $name Name of the attribute to get `$default` `mixed` - $default Optional value to return if attribute not found Returns `mixed` - Value of the attribute / default Since 3.2
`public string`	# `getControlGroup( )` Method to get a control group with label and input. Method to get a control group with label and input. Deprecated 3.2.3 Use renderField() instead Returns `string` - A string containing the html for the control group Since 3.2
`public string`	# `render( string $layoutId, array $data = array() )` Render a layout of this field Render a layout of this field Parameters `$layoutId` `string` - $layoutId Layout identifier `$data` `array` - $data Optional data for the layout Returns `string` Since 3.5
`public string`	# `renderField( array $options = array() )` Method to get a control group with label and input. Method to get a control group with label and input. Parameters `$options` `array` - $options Options to be passed into the rendering of the field Returns `string` - A string containing the html for the control group Since 3.2
`protected array`	# `getLayoutData( )` Method to get the data to be passed to the layout for rendering. Method to get the data to be passed to the layout for rendering. Returns `array` Since 3.5
`protected array`	# `getLayoutPaths( )` Allow to override renderer include paths in child fields Allow to override renderer include paths in child fields Returns `array` Since 3.5
`protected JLayout`	# `getRenderer( string $layoutId = 'default' )` Get the renderer Get the renderer Parameters `$layoutId` `string` - $layoutId Id to load Returns `JLayout` Since 3.5
`protected boolean`	# `isDebugEnabled( )` Is debug enabled for this field Is debug enabled for this field Returns `boolean` Since 3.5

Magic methods summary

Properties summary

`protected string`	`$description`	# The description text for the form field. Usually used in tooltips. The description text for the form field. Usually used in tooltips. Since 11.1
`protected string`	`$hint`	# The hint text for the form field used to display hint inside the field. The hint text for the form field used to display hint inside the field. Since 3.2
`protected mixed`	`$autocomplete`	# The autocomplete state for the form field. If 'off' element will not be automatically completed by browser. The autocomplete state for the form field. If 'off' element will not be automatically completed by browser. Since 3.2
`protected boolean`	`$spellcheck`	# The spellcheck state for the form field. The spellcheck state for the form field. Since 3.2
`protected boolean`	`$autofocus`	# The autofocus request for the form field. If true element will be automatically focused on document load. The autofocus request for the form field. If true element will be automatically focused on document load. Since 3.2
`protected SimpleXMLElement`	`$element`	# The SimpleXMLElement object of the `<field>` XML element that describes the form field. The SimpleXMLElement object of the `<field>` XML element that describes the form field. Since 11.1
`protected JForm`	`$form`	# The JForm object of the form attached to the form field. The JForm object of the form attached to the form field. Since 11.1
`protected string`	`$formControl`	# The form control prefix for field names from the JForm object attached to the form field. The form control prefix for field names from the JForm object attached to the form field. Since 11.1
`protected boolean`	`$hidden`	# The hidden state for the form field. The hidden state for the form field. Since 11.1
`protected boolean`	`$translateLabel`	# True to translate the field label string. True to translate the field label string. Since 11.1
`protected boolean`	`$translateDescription`	# True to translate the field description string. True to translate the field description string. Since 11.1
`protected boolean`	`$translateHint`	# True to translate the field hint string. True to translate the field hint string. Since 3.2
`protected string`	`$id`	# The document id for the form field. The document id for the form field. Since 11.1
`protected string`	`$input`	# The input for the form field. The input for the form field. Since 11.1
`protected string`	`$label`	# The label for the form field. The label for the form field. Since 11.1
`protected boolean`	`$multiple`	# The multiple state for the form field. If true then multiple values are allowed for the field. Most often used for list field types. The multiple state for the form field. If true then multiple values are allowed for the field. Most often used for list field types. Since 11.1
`public mixed`	`$repeat`	# Allows extensions to create repeat elements Allows extensions to create repeat elements Since 3.2
`protected string`	`$pattern`	# The pattern (Reg Ex) of value of the form field. The pattern (Reg Ex) of value of the form field. Since 11.1
`protected string`	`$name`	# The name of the form field. The name of the form field. Since 11.1
`protected string`	`$fieldname`	# The name of the field. The name of the field. Since 11.1
`protected string`	`$group`	# The group of the field. The group of the field. Since 11.1
`protected boolean`	`$required`	# The required state for the form field. If true then there must be a value for the field to be considered valid. The required state for the form field. If true then there must be a value for the field to be considered valid. Since 11.1
`protected boolean`	`$disabled`	# The disabled state for the form field. If true then the field will be disabled and user can't interact with the field. The disabled state for the form field. If true then the field will be disabled and user can't interact with the field. Since 3.2
`protected boolean`	`$readonly`	# The readonly state for the form field. If true then the field will be readonly. The readonly state for the form field. If true then the field will be readonly. Since 3.2
`protected string`	`$type`	# The form field type. The form field type. Since 11.1
`protected string`	`$validate`	# The validation method for the form field. This value will determine which method is used to validate the value for a field. The validation method for the form field. This value will determine which method is used to validate the value for a field. Since 11.1
`protected mixed`	`$value`	# The value of the form field. The value of the form field. Since 11.1
`protected mixed`	`$default`	# The default value of the form field. The default value of the form field. Since 11.1
`protected integer`	`$size`	# The size of the form field. The size of the form field. Since 3.2
`protected mixed`	`$class`	# The class of the form field The class of the form field Since 3.2
`protected mixed`	`$labelclass`	# The label's CSS class of the form field The label's CSS class of the form field Since 11.1
`protected string`	`$onchange`	# The javascript onchange of the form field. The javascript onchange of the form field. Since 3.2
`protected string`	`$onclick`	# The javascript onclick of the form field. The javascript onclick of the form field. Since 3.2
`protected string`	`$showon`	# The conditions to show/hide the field. The conditions to show/hide the field. Since 3.7.0
`protected static integer`	`$count`	# The count value for generated name field The count value for generated name field Since 11.1
`protected static string`	`$generated_fieldname`	# The string used for generated fields names The string used for generated fields names Since 11.1
`protected string`	`$layout`	# Name of the layout being used to render the field Name of the layout being used to render the field Since 3.5
`protected string`	`$renderLayout`	# Layout to render the form field Layout to render the form field
`protected string`	`$renderLabelLayout`	# Layout to render the label Layout to render the label

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JFormField

Direct known subclasses

Indirect known subclasses

Methods summary

Parameters

Since

Parameters

Returns

Since

Parameters

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Since

Parameters

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Deprecated

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Returns

Since

Returns

Since

Parameters

Returns

Since

Returns

Since

Magic methods summary

Properties summary

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since