Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class UsergrouplistField - list of methods

Field to load a dropdown list of available user groups

Extends

ListField
Package: Joomla\CMS\Form\Field
Copyright: (C) 2013 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Form/Field/UsergrouplistField.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
  • 1.7.0
Show source code of this method: setup Source Code

protected array
()

Method to get the options to populate list
Returns
  • array The field option objects.
Since
  • 3.2
Show source code of this method: getOptions Source Code

Properties Summary

protected string
$type
The form field type.
Since
  • 3.2
protected static array
$options
Cached array of the category items.
Since
  • 3.2

Tags Summary

Since
3.2