Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Fonctions membres publiques statiques | Champs de données
Référence de la classe UserHelper

Fonctions membres publiques statiques

static addUserToGroup ($userId, $groupId)
 
static getUserGroups ($userId)
 
static removeUserFromGroup ($userId, $groupId)
 
static setUserGroups ($userId, $groups)
 
static getProfile ($userId=0)
 
static activateUser ($activation)
 
static getUserId ($username)
 
static hashPassword ($password, $algorithm=self::HASH_BCRYPT, array $options=array())
 
static genRandomPassword ($length=8)
 
static getShortHashedUserAgent ()
 
static checkSuperUserInUsers (array $userIds)
 

Champs de données

const HASH_ARGON2I = 'argon2i'
 
const HASH_ARGON2I_BC = 2
 
const HASH_ARGON2ID = 'argon2id'
 
const HASH_ARGON2ID_BC = 3
 
const HASH_BCRYPT = '2y'
 
const HASH_BCRYPT_BC = 1
 
const HASH_MD5 = 'md5'
 
const HASH_PHPASS = 'phpass'
 
const HASH_ALGORITHMS
 

Description détaillée

Authorisation helper class, provides static methods to perform various tasks relevant to the Joomla user and authorisation classes

This class has influences and some method logic from the Horde Auth package

Depuis
1.7.0

Documentation des fonctions membres

◆ activateUser()

static activateUser (   $activation)
static

Method to activate a user

Paramètres
string$activationActivation string
Renvoie
boolean True on success
Depuis
1.7.0

Références User\$activation, $db, User\$id, $query, $user, Text\_(), Log\add(), User\bind(), Factory\getDbo(), User\getInstance(), et Log\WARNING.

◆ addUserToGroup()

static addUserToGroup (   $userId,
  $groupId 
)
static

Method to add a user to a group.

Paramètres
integer$userIdThe id of the user.
integer$groupIdThe id of the group.
Renvoie
boolean True on success
Depuis
1.7.0
Exceptions

Références $db, $query, $temp, $user, $userId, User\bind(), Factory\getDbo(), User\getInstance(), Factory\getSession(), Factory\getUser(), ParameterType\INTEGER, et null.

Référencé par AddUserToGroupCommand\doExecute().

◆ checkSuperUserInUsers()

static checkSuperUserInUsers ( array  $userIds)
static

Check if there is a super user in the user ids.

Paramètres
array$userIdsAn array of user IDs on which to operate
Renvoie
boolean True on success, false on failure
Depuis
3.6.5

Références $userId, et Access\checkGroup().

Référencé par UserModel\batchReset(), et UserModel\batchUser().

◆ genRandomPassword()

static genRandomPassword (   $length = 8)
static

Generate a random password

Paramètres
integer$lengthLength of the password to generate
Renvoie
string Random Password
Depuis
1.7.0

Références $base, $i, et Crypt\genRandomBytes().

Référencé par RegistrationModel\activate(), User\bind(), DatabaseHelper\checkRemoteDbHost(), ConfigurationModel\createConfiguration(), UpdateModel\createUpdateFile(), MD5Handler\hashPassword(), ResetModel\processResetRequest(), RegistrationModel\register(), et ApplicationModel\save().

◆ getProfile()

static getProfile (   $userId = 0)
static

Gets the user profile information

Paramètres
integer$userIdThe id of the user.
Renvoie
object
Depuis
1.7.0

Références $data, $user, $userId, Factory\getApplication(), Factory\getUser(), et PluginHelper\importPlugin().

◆ getShortHashedUserAgent()

static getShortHashedUserAgent ( )
static

Method to get a hashed user agent string that does not include browser version. Used when frequent version changes cause problems.

Renvoie
string A hashed user agent string with version replaced by 'abcd'
Depuis
3.2

Références Uri\base(), et Factory\getApplication().

◆ getUserGroups()

static getUserGroups (   $userId)
static

Method to get a list of groups a user is in.

Paramètres
integer$userIdThe id of the user.
Renvoie
array List of groups
Depuis
1.7.0

Références $user, $userId, et User\getInstance().

Référencé par DeleteUserCommand\doExecute(), et UserModel\getAssignedGroups().

◆ getUserId()

static getUserId (   $username)
static

Returns userid if a user exists

Paramètres
string$usernameThe username to search on.
Renvoie
integer The user id or 0 if not found.
Depuis
1.7.0

Références $db, $query, User\$username, User\bind(), et Factory\getDbo().

Référencé par ChangeUserPasswordCommand\doExecute(), DeleteUserCommand\doExecute(), et RemoveUserFromGroupCommand\doExecute().

◆ hashPassword()

static hashPassword (   $password,
  $algorithm = self::HASH_BCRYPT,
array  $options = array() 
)
static

Hashes a password using the current encryption.

Paramètres
string$passwordThe plaintext password to encrypt.
string | integer$algorithmThe hashing algorithm to use, represented by HASH_* class constants, or a container service ID.
array$optionsThe options for the algorithm to use.
Renvoie
string The encrypted password.
Depuis
3.2.1
Exceptions

Références $container, $options, User\$password, et Factory\getContainer().

Référencé par User\bind(), ConfigurationModel\createRootUser(), ChangeUserPasswordCommand\doExecute(), Basic\onUserAuthenticate(), et ResetModel\processResetRequest().

◆ removeUserFromGroup()

static removeUserFromGroup (   $userId,
  $groupId 
)
static

Method to remove a user from a group.

Paramètres
integer$userIdThe id of the user.
integer$groupIdThe id of the group.
Renvoie
boolean True on success
Depuis
1.7.0

Références $key, $temp, $user, $userId, User\getInstance(), et Factory\getUser().

Référencé par RemoveUserFromGroupCommand\doExecute().

◆ setUserGroups()

static setUserGroups (   $userId,
  $groups 
)
static

Method to set the groups for a user.

Paramètres
integer$userIdThe id of the user.
array$groupsAn array of group ids to put the user in.
Renvoie
boolean True on success
Depuis
1.7.0

Références $db, User\$groups, $i, $n, $query, $results, $temp, $user, $userId, Factory\getDbo(), User\getInstance(), Factory\getSession(), Factory\getUser(), et ArrayHelper\toInteger().

Documentation des champs

◆ HASH_ALGORITHMS

const HASH_ALGORITHMS
Valeur initiale :
= [
self::HASH_ARGON2I => Argon2iHandler::class

◆ HASH_ARGON2I

const HASH_ARGON2I = 'argon2i'

◆ HASH_ARGON2I_BC

const HASH_ARGON2I_BC = 2

◆ HASH_ARGON2ID

const HASH_ARGON2ID = 'argon2id'

◆ HASH_ARGON2ID_BC

const HASH_ARGON2ID_BC = 3

◆ HASH_BCRYPT

const HASH_BCRYPT = '2y'

◆ HASH_BCRYPT_BC

const HASH_BCRYPT_BC = 1

◆ HASH_MD5

const HASH_MD5 = 'md5'

◆ HASH_PHPASS

const HASH_PHPASS = 'phpass'
La documentation de cette classe a été générée à partir du fichier suivant :