Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe UserField
+ Graphe d'héritage de UserField:

Fonctions membres publiques

 setup (\SimpleXMLElement $element, $value, $group=null)
 
 getLayoutData ()
 
- Fonctions membres publiques hérités de FormField
 __construct ($form=null)
 
 __get ($name)
 
 __set ($name, $value)
 
 setForm (Form $form)
 
 setup (\SimpleXMLElement $element, $value, $group=null)
 
 setValue ($value)
 
 getAttribute ($name, $default=null)
 
 getControlGroup ()
 
 render ($layoutId, $data=array())
 
 renderField ($options=array())
 

Champs de données

 $type = 'User'
 
- Champs de données hérités de FormField
 $repeat = false
 

Fonctions membres protégées

 getInput ()
 
 getGroups ()
 
 getExcluded ()
 
- Fonctions membres protégées hérités de FormField
 getId ($fieldId, $fieldName)
 
 getInput ()
 
 getTitle ()
 
 getLabel ()
 
 getName ($fieldName)
 
 getFieldName ($fieldName)
 
 getLayoutData ()
 
 getLayoutPaths ()
 
 getRenderer ($layoutId='default')
 
 isDebugEnabled ()
 

Attributs protégés

 $groups = null
 
 $excluded = null
 
 $layout = 'joomla.form.field.user'
 
- Attributs protégés hérités de FormField
 $description
 
 $hint
 
 $autocomplete = 'on'
 
 $spellcheck = true
 
 $autofocus = false
 
 $element
 
 $form
 
 $formControl
 
 $hidden = false
 
 $translateLabel = true
 
 $translateDescription = true
 
 $translateHint = true
 
 $id
 
 $input
 
 $label
 
 $multiple = false
 
 $pattern
 
 $validationtext
 
 $name
 
 $fieldname
 
 $group
 
 $required = false
 
 $disabled = false
 
 $readonly = false
 
 $type
 
 $validate
 
 $value
 
 $default
 
 $size
 
 $class
 
 $labelclass
 
 $onchange
 
 $onclick
 
 $showon
 
 $layout
 
 $renderLayout = 'joomla.form.renderfield'
 
 $renderLabelLayout = 'joomla.form.renderlabel'
 

Membres hérités additionnels

- Attributs protégés statiques hérités de FormField
static $count = 0
 
static $generated_fieldname = '__field'
 

Description détaillée

Field to select a user ID from a modal list.

Depuis
1.6

Documentation des fonctions membres

◆ getExcluded()

getExcluded ( )
protected

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

Renvoie
mixed Array of users to exclude or null to to not exclude them
Depuis
1.6

◆ getGroups()

getGroups ( )
protected

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

Renvoie
mixed Array of filtering groups or null.
Depuis
1.6

◆ getInput()

getInput ( )
protected

Method to get the user field input markup.

Renvoie
string The field input markup.
Depuis
1.6

Références name.

◆ getLayoutData()

getLayoutData ( )

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

Renvoie
array
Depuis
3.5

Références $current, $data, $name, $value, elseif, User\getInstance(), Factory\getUser(), null, et value.

◆ setup()

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

Method to attach a JForm object to the field.

Paramètres
\SimpleXMLElement$elementThe SimpleXMLElement object representing the <field> tag for the form field object.
mixed$valueThe form field value to validate.
string$groupThe 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]".
Renvoie
boolean True on success.
Depuis
3.7.0
Voir également
JFormField::setup()

Références $return, $value, et Factory\getUser().

Documentation des champs

◆ $excluded

$excluded = null
protected

◆ $groups

$groups = null
protected

◆ $layout

$layout = 'joomla.form.field.user'
protected

◆ $type

$type = 'User'

La documentation de cette classe a été générée à partir du fichier suivant :