Référence de la classe UsersHelper

Fonctions membres publiques statiques
static	addSubmenu ($vName)
static	getActions ()
static	getStateOptions ()
static	getActiveOptions ()
static	getGroups ()
static	getRangeOptions ()
static	getTwoFactorMethods ()
static	getVisibleByGroups ($rules)
static	validateSection ($section)
static	getContexts ()

Attributs protégés statiques
static	$actions

Description détaillée

Users component helper.

Depuis

1.6

Documentation des fonctions membres

addSubmenu()

static addSubmenu (   $vName )

static

Configure the Linkbar.

Paramètres

string

$vName

The name of the active view.

Renvoie

void

Depuis

1.6

Références JHtmlSidebar\addEntry().

Référencé par UsersViewGroups\display(), UsersViewLevels\display(), UsersViewNotes\display(), et UsersViewUsers\display().

getActions()

static getActions ( )

static

Gets a list of the actions that can be performed.

Renvoie

JObject

Obsolète:

3.2 Use JHelperContent::getActions() instead

getActiveOptions()

static getActiveOptions ( )

static

Get a list of filter options for the activated state of a user.

Renvoie

array An array of JHtmlOption elements.

Depuis

1.6

Références $options.

getContexts()

static getContexts ( )

static

Returns valid contexts

Renvoie

array

Depuis

3.7.0

Références JPATH_ADMINISTRATOR.

getGroups()

static getGroups ( )

static

Get a list of the user groups for filtering.

Renvoie

array An array of JHtmlOption elements.

Depuis

1.6

Références $option, et $options.

getRangeOptions()

static getRangeOptions ( )

static

Creates a list of range options used in filter select list used in com_users on users view

Renvoie

array

Depuis

2.5

Références $options.

getStateOptions()

static getStateOptions ( )

static

Get a list of filter options for the blocked state of a user.

Renvoie

array An array of JHtmlOption elements.

Depuis

1.6

Références $options.

getTwoFactorMethods()

static getTwoFactorMethods ( )

static

Creates a list of two factor authentication methods used in com_users on user view

Renvoie

array

Depuis

3.2.0

Références $options, et FOFPlatform\getInstance().

Référencé par UsersViewProfile\display(), et AdminViewProfile\display().

getVisibleByGroups()

static getVisibleByGroups (   $rules )

static

Get a list of the User Groups for Viewing Access Levels

Paramètres

string

$rules

User Groups in JSON format

Renvoie

string $groups Comma separated list of User Groups

Depuis

3.6

Références $db, $groups, et $query.

validateSection()

static validateSection (   $section )

static

Returns a valid section for users. If it is not valid then null is returned.

Paramètres

string

$section

The section to get the mapping for

Renvoie

string|null The new section

Depuis

3.7.0

Références $section, et null.

Documentation des champs

$actions

$actions

staticprotected

---

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

• administrator/components/com_users/helpers/users.php