Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class UserField - list of methods

Field to select a user ID from a modal list.

Extends

FormField
Package: Joomla\CMS\Form\Field
Copyright: (C) 2009 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Form/Field/UserField.php
Project: Joomla

Method Summary

public bool
(\SimpleXMLElement $element, mixed $value, mixed $group = null)

Method to attach a Form object to the field.
Parameters
  • \SimpleXMLElement $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 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
  • bool True on success.
Since
  • 3.7.0
-
  • \Joomla\CMS\Form\FormField::setup()
Show source code of this method: setup Source Code

protected string
()

Method to get the user field input markup.
Returns
  • string The field input markup.
Since
  • 1.6
Show source code of this method: getInput Source Code

public array
()

Get the data that is going to be passed to the layout
Returns
  • array
Since
  • 3.5
Show source code of this method: getLayoutData Source Code

protected mixed
()

Method to get the filtering groups (null means no filtering)
Returns
  • mixed Array of filtering groups or null.
Since
  • 1.6
Show source code of this method: getGroups Source Code

protected mixed
()

Method to get the users to exclude from the list of users
Returns
  • mixed Array of users to exclude or null to to not exclude them
Since
  • 1.6
Show source code of this method: getExcluded Source Code

Properties Summary

public string
$type
The form field type.
Since
  • 1.6
protected array
$groups
Filtering groups
Since
  • 3.5
protected array
$excluded
Users to exclude from the list of users
Since
  • 3.5
protected string
$layout
Layout to render
Since
  • 3.5

Tags Summary

Since
1.6