Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe JHtmlUsers

Fonctions membres publiques statiques

static image ($src)
 
static addNote ($userId)
 
static filterNotes ($count, $userId)
 
static notes ($count, $userId)
 
static notesModal ($count, $userId)
 
static blockStates ( $self=false)
 
static activateStates ()
 
static value ($value)
 
static spacer ($value)
 
static helpsite ($value)
 
static templatestyle ($value)
 
static admin_language ($value)
 
static language ($value)
 
static editor ($value)
 

Description détaillée

Extended Utility class for the Users component.

Depuis
2.5

Users Html Helper

Depuis
1.6

Documentation des fonctions membres

◆ activateStates()

static activateStates ( )
static

Build an array of activate states to be used by jgrid.state,

Renvoie
array a list of possible states to display
Depuis
3.0

◆ addNote()

static addNote (   $userId)
static

Displays an icon to add a note for this user.

Paramètres
integer$userIdThe user ID
Renvoie
string A link to add a note
Depuis
2.5

Références $title, et $userId.

◆ admin_language()

static admin_language (   $value)
static

Get the sanitized language

Paramètres
mixed$valueValue of the field
Renvoie
mixed String/void
Depuis
1.6

Références $file, $value, ENT_COMPAT, JPATH_ADMINISTRATOR, null, et value.

◆ blockStates()

static blockStates (   $self = false)
static

Build an array of block/unblock user states to be used by jgrid.state, State options will be different for any user and for currently logged in user

Paramètres
boolean$selfTrue if state array is for currently logged in user
Renvoie
array a list of possible states to display
Depuis
3.0

◆ editor()

static editor (   $value)
static

Get the sanitized editor name

Paramètres
mixed$valueValue of the field
Renvoie
mixed String/void
Depuis
1.6

Références $db, $lang, $query, $title, $value, JPATH_ADMINISTRATOR, JPATH_PLUGINS, null, et value.

◆ filterNotes()

static filterNotes (   $count,
  $userId 
)
static

Displays an icon to filter the notes list on this user.

Paramètres
integer$countThe number of notes for the user
integer$userIdThe user ID
Renvoie
string A link to apply a filter
Depuis
2.5

Références $count, $title, et $userId.

◆ helpsite()

static helpsite (   $value)
static

Get the sanitized helpsite link

Paramètres
mixed$valueValue of the field
Renvoie
mixed String/void
Depuis
1.6

Références $text, $value, ENT_COMPAT, JPATH_ADMINISTRATOR, et value.

◆ image()

static image (   $src)
static

Display an image.

Paramètres
string$srcThe source of the image
Renvoie
string A element if the specified file exists, otherwise, a null string
Depuis
2.5

Références $file, JPath\check(), jimport(), et JPATH_SITE.

◆ language()

static language (   $value)
static

Get the sanitized language

Paramètres
mixed$valueValue of the field
Renvoie
mixed String/void
Depuis
1.6

Références $file, $value, ENT_COMPAT, JPATH_SITE, null, et value.

◆ notes()

static notes (   $count,
  $userId 
)
static

Displays a note icon.

Paramètres
integer$countThe number of notes for the user
integer$userIdThe user ID
Renvoie
string A link to a modal window with the user notes
Depuis
2.5

Références $count, $title, et $userId.

◆ notesModal()

static notesModal (   $count,
  $userId 
)
static

Renders the modal html.

Paramètres
integer$countThe number of notes for the user
integer$userIdThe user ID
Renvoie
string The html for the rendered modal
Depuis
3.4.1

Références $count, $title, et $userId.

◆ spacer()

static spacer (   $value)
static

Get the space symbol

Paramètres
mixed$valueValue of the field
Renvoie
string
Depuis
1.6

◆ templatestyle()

static templatestyle (   $value)
static

Get the sanitized template style

Paramètres
mixed$valueValue of the field
Renvoie
mixed String/void
Depuis
1.6

Références $db, $query, $title, $value, ENT_COMPAT, et value.

◆ value()

static value (   $value)
static

Get the sanitized value

Paramètres
mixed$valueValue of the field
Renvoie
mixed String/void
Depuis
1.6

Références $value, elseif, et ENT_COMPAT.


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