Docs For Class JFormFieldUserMessages

Description

Supports an modal select of user that have access to com_messages

since: 1.6

Located in /administrator/components/com_messages/models/fields/usermessages.php (line 21)

JFormField
   |
   --JFormFieldUser
      |
      --JFormFieldUserMessages

Variable Summary

string $type

Method Summary

array|null getExcluded ()

array|null getGroups ()

Variables

string $type = 'UserMessages' (line 29)

The form field type.

since: 1.6
access: public

Redefinition of:

JFormFieldUser::$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

getExcluded (line 82)

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

array|null getExcluded ()

Redefinition of:

JFormFieldUser::getExcluded(): Method to get the users to exclude from the list of users

getGroups (line 37)

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

return: array of filtering groups or null.
since: 1.6
access: protected

array|null getGroups ()

Redefinition of:

JFormFieldUser::getGroups(): Method to get the filtering groups (null means no filtering)

Inherited Methods

Inherited From JFormFieldUser

JFormFieldUser::getExcluded()
JFormFieldUser::getGroups()
JFormFieldUser::getInput()

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