\FOFFormFieldUser

Form Field class for the FOF framework A user selection box / display field

Synopsis

class FOFFormFieldUser extends JFormFieldUser implements FOFFormField {

• // members
• protected  $static;
• protected  $repeatable;
• public FOFTable  $item;
• public  $rowid;
• // Inherited members from JFormFieldUser
• public  $type;
• // Inherited members from JFormField
• protected  $description;
• protected  $hint;
• protected  $autocomplete;
• protected  $spellcheck;
• protected  $autofocus;
• protected SimpleXMLElement  $element;
• protected JForm  $form;
• protected  $formControl;
• protected  $hidden;
• protected  $translateLabel;
• protected  $translateDescription;
• protected  $translateHint;
• protected  $id;
• protected  $input;
• protected  $label;
• protected  $multiple;
• public  $repeat;
• protected  $pattern;
• protected  $name;
• protected  $fieldname;
• protected  $group;
• protected  $required;
• protected  $disabled;
• protected  $readonly;
• protected  $type;
• protected  $validate;
• protected  $value;
• protected  $default;
• protected  $size;
• protected  $class;
• protected  $labelclass;
• protected  $onchange;
• protected  $onclick;
• protected  $count;
• protected  $generated_fieldname;
• // methods
• public mixed __get()
• public string getStatic()
• public string getRepeatable()
• // Inherited methods from JFormFieldUser
• protected string getInput()
• protected mixed getGroups()
• protected mixed getExcluded()
• // Inherited methods from JFormField
• public void __construct()
• public mixed __get()
• public void __set()
• public JFormField setForm()
• public boolean setup()
• public void setValue()
• protected string getId()
• protected abstract string getInput()
• protected string getTitle()
• protected string getLabel()
• protected string getName()
• protected string getFieldName()
• public mixed getAttribute()
• public string getControlGroup()
}


Hierarchy

Extends

• JFormFieldUser

Implements

• FOFFormField

Members

protected

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

public

• $item — FOFTable
• $repeat — mixed
  Allows extensions to create repeat elements
• $rowid — int
• $type — string
  The form field type.

Methods

public

• __get() — Method to get certain otherwise inaccessible properties from the form field object.
• getRepeatable() — Get the rendering of this field type for a repeatable (grid) display, e.g. in a view listing many item (typically a "browse" task)
• getStatic() — Get the rendering of this field type for static display, e.g. in a single item view (typically a "read" task).

Inherited from JFormFieldUser

protected

• getExcluded() — Method to get the users to exclude from the list of users
• getGroups() — Method to get the filtering groups (null means no filtering)
• getInput() — Method to get the user field input markup.

Inherited from JFormField

protected

• getFieldName() — Method to get the field name used.
• getId() — Method to get the id used for the field input tag.
• getInput() — Method to get the field input markup.
• getLabel() — Method to get the field label markup.
• getName() — Method to get the name used for the field input tag.
• getTitle() — Method to get the field title.

public

• __get() — Method to get certain otherwise inaccessible properties from the form field object.
• __set() — Method to set certain otherwise inaccessible properties of the form field object.
• getAttribute() — Method to get an attribute of the field
• getControlGroup() — Method to get a control group with label and input.
• setForm() — Method to attach a JForm object to the field.
• setValue() — Simple method to set the value
• setup() — Method to attach a JForm object to the field.