PHPXRef 0.7.1 : Joomla 4.2.2 documentation : Detail view of UserField.php

Joomla! Content Management System

Copyright:	(C) 2009 Open Source Matters, Inc.
License:	GNU General Public License version 2 or later; see LICENSE.txt
File Size:	173 lines (5 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

UserField:: (5 methods):
  setup()
  getInput()
  getLayoutData()
  getGroups()
  getExcluded()

Class: UserField - X-Ref

Field to select a user ID from a modal list.

setup(\SimpleXMLElement $element, $value, $group = null) X-Ref

Method to attach a Form object to the field.

param: \SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
param: mixed              $value    The form field value to validate.
param: string             $group    The field name group control value. This acts as an array container for the field.
return: boolean  True on success.

getInput() X-Ref

Method to get the user field input markup.

return: string The field input markup.

getLayoutData() X-Ref

Get the data that is going to be passed to the layout

return: array

getGroups() X-Ref

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

return: mixed Array of filtering groups or null.

getExcluded() X-Ref

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

return: mixed Array of users to exclude or null to to not exclude them

PHP Cross Reference of Joomla 4.2.2 documentation

/libraries/src/Form/Field/ -> UserField.php (summary)

Defines 1 class