Class JFormField

Description

Abstract Form Field class for the Joomla Platform.

  • abstract:
  • since: 11.1

Located in /libraries/joomla/form/field.php (line 19)


	
			
Direct descendents
Class Description
JFormFieldModuleOrder Form Field class for the Joomla Framework.
Supports an HTML select list of banners
JFormFieldModal_Newsfeeds Supports a modal newsfeeds picker.
JFormFieldFilters Text Filters form field.
JFormFieldSearch Form Field Search class.
JFormFieldType Form Field Place class.
JFormFieldClient Form Field Place class.
JFormFieldGroup Form Field Place class.
JFormFieldModal_Contacts Supports a modal contact picker.
JFormFieldModal_Article Supports a modal article picker.
JFormFieldImpTotal Impressions Field class for the Joomla Framework.
JFormFieldClicks Clicks Field class for the Joomla Framework.
JFormFieldImpMade Clicks Field class for the Joomla Framework.
JFormFieldCheckbox Form Field class for the Joomla Platform.
JFormFieldPassword Form Field class for the Joomla Platform.
JFormFieldFile Form Field class for the Joomla Platform.
JFormFieldCheckboxes Form Field class for the Joomla Platform.
JFormFieldList Form Field class for the Joomla Platform.
JFormFieldRadio Form Field class for the Joomla Platform.
JFormFieldMedia Form Field class for the Joomla Platform.
JFormFieldEditor Form Field class for the Joomla Platform.
JFormFieldCalendar Form Field class for the Joomla Platform.
JFormFieldSpacer Form Field class for the Joomla Platform.
JFormFieldUsergroup Form Field class for the Joomla Platform.
JFormFieldEMail Form Field class for the Joomla Platform.
JFormFieldRules Form Field class for the Joomla Platform.
JFormFieldGroupedList Form Field class for the Joomla Platform.
JFormFieldTextarea Form Field class for the Joomla Platform.
JFormFieldModuleLayout Form Field to display a list of the layouts for module display from the module or template overrides.
JFormFieldComponentLayout Form Field to display a list of the layouts for a component view from the extension or template overrides.
JFormFieldHidden Form Field class for the Joomla Platform.
JFormFieldText Form Field class for the Joomla Platform.
JFormFieldColor Color Form Field class for the Joomla Platform.
JFormFieldUser Field to select a user id from a modal list.
JFormFieldCaptcha Form Field class for the Joomla Framework.
JFormFieldPrefix Form Field class for the Joomla Framework.
Variable Summary
static integer $count
static integer $generated_fieldname
string $description
SimpleXMLElement $element
string $fieldname
string $formControl
string $group
boolean $hidden
string $id
string $input
string $label
mixed $labelClass
boolean $multiple
string $name
boolean $required
boolean $translateLabel
string $type
string $validate
mixed $value
Method Summary
JFormField __construct ([object $form = null])
string getFieldName (string $fieldName)
string getId (string $fieldId, string $fieldName)
string getInput ()
string getLabel ()
string getName (string $fieldName)
string getTitle ()
object The setForm (JForm $form)
boolean setup (object &$element, mixed $value, [string $group = null])
mixed __get (string $name)
Variables
static integer $count = 0 (line 182)

The count value for generated name field

  • since: 11.1
  • access: protected
static integer $generated_fieldname = '__field' (line 190)

The string used for generated fields names

  • since: 11.1
  • access: protected
string $description (line 27)

The description text for the form field. Usually used in tooltips.

  • since: 11.1
  • access: protected
SimpleXMLElement $element (line 35)

The SimpleXMLElement object of the <field /> XML element that describes the form field.

  • since: 11.1
  • access: protected
string $fieldname (line 124)

The name of the field.

  • since: 11.1
  • access: protected
JForm $form (line 43)

The JForm object of the form attached to the form field.

  • since: 11.1
  • access: protected
string $formControl (line 51)

The form control prefix for field names from the JForm object attached to the form field.

  • since: 11.1
  • access: protected
string $group (line 132)

The group of the field.

  • since: 11.1
  • access: protected
boolean $hidden = false (line 59)

The hidden state for the form field.

  • since: 11.1
  • access: protected
string $id (line 83)

The document id for the form field.

  • since: 11.1
  • access: protected
string $input (line 91)

The input for the form field.

  • since: 11.1
  • access: protected
string $label (line 99)

The label for the form field.

  • since: 11.1
  • access: protected
mixed $labelClass (line 174)

The label's CSS class of the form field

  • since: 11.1
  • access: protected
boolean $multiple = false (line 108)

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
  • access: protected
string $name (line 116)

The name of the form field.

  • since: 11.1
  • access: protected
boolean $required = false (line 141)

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
  • access: protected
boolean $translateDescription = true (line 75)

True to translate the field description string.

  • since: 11.1
  • access: protected
boolean $translateLabel = true (line 67)

True to translate the field label string.

  • since: 11.1
  • access: protected
string $type (line 149)

The form field type.

  • since: 11.1
  • access: protected

Redefined in descendants as:
string $validate (line 158)

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
  • access: protected
mixed $value (line 166)

The value of the form field.

  • since: 11.1
  • access: protected
Methods
Constructor __construct (line 199)

Method to instantiate the form field object.

  • since: 11.1
  • access: public
JFormField __construct ([object $form = null])
  • object $form: The form to attach to the form field object.
getFieldName (line 596)

Method to get the field name used.

  • return: The field name
  • since: 11.1
  • access: protected
string getFieldName (string $fieldName)
  • string $fieldName: The field element name.
getId (line 399)

Method to get the id used for the field input tag.

  • return: The id to be used for the field input tag.
  • since: 11.1
  • access: protected
string getId (string $fieldId, string $fieldName)
  • string $fieldId: The field element id.
  • string $fieldName: The field element name.
getInput (line 447)

Method to get the field input markup.

  • return: The field input markup.
  • abstract:
  • since: 11.1
  • access: protected
string getInput ()

Redefined in descendants as:
getLabel (line 481)

Method to get the field label markup.

  • return: The field label markup.
  • since: 11.1
  • access: protected
string getLabel ()

Redefined in descendants as:
getName (line 535)

Method to get the name used for the field input tag.

  • return: The name to be used for the field input tag.
  • since: 11.1
  • access: protected
string getName (string $fieldName)
  • string $fieldName: The field element name.
getTitle (line 456)

Method to get the field title.

  • return: The field title.
  • since: 11.1
  • access: protected
string getTitle ()

Redefined in descendants as:
setForm (line 289)

Method to attach a JForm object to the field.

  • return: form field object so that the method can be used in a chain.
  • since: 11.1
  • access: public
object The setForm (JForm $form)
  • JForm $form: The JForm object to attach to the form field.
setup (line 310)

Method to attach a JForm object to the field.

  • return: True on success.
  • since: 11.1
  • access: public
boolean setup (object &$element, mixed $value, [string $group = null])
  • object &$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]".

Redefined in descendants as:
__get (line 232)

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

  • return: The property value or null.
  • since: 11.1
  • access: public
mixed __get (string $name)
  • string $name: The property name for which to the the value.

Documentation generated on Mon, 25 Jun 2012 13:54:42 -0500 by phpDocumentor 1.4.4