Class JFormFieldUser

Description

Field to select a user ID from a modal list.

  • since: 1.6

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

JFormField
   |
   --JFormFieldUser
Direct descendents
Class Description
 class JFormFieldUserMessages Supports an modal select of user that have access to com_messages
 class FOFFormFieldUser Form Field class for the FOF framework A user selection box / display field
Variable Summary
 string $type
Method Summary
 mixed getExcluded ()
 mixed getGroups ()
 string getInput ()
Variables
Methods
getExcluded (line 126)

Method to get the users to exclude from the list of users

  • return: Array of users to exclude or null to to not exclude them
  • since: 1.6
  • access: protected
mixed getExcluded ()

Redefined in descendants as:
getGroups (line 114)

Method to get the filtering groups (null means no filtering)

  • return: array of filtering groups or null.
  • since: 1.6
  • access: protected
mixed getGroups ()

Redefined in descendants as:
getInput (line 36)

Method to get the user field input markup.

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

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

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()

Documentation generated on Tue, 19 Nov 2013 15:16:20 +0100 by phpDocumentor 1.4.3