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 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)
 
static verifyPassword ($password, $hash, $user_id=0)
 
static getCryptedPassword ($plaintext, $salt='', $encryption='md5-hex', $show_encrypt=false)
 
static getSalt ($encryption='md5-hex', $seed='', $plaintext='')
 
static genRandomPassword ($length=8)
 
static invalidateCookie ($userId, $cookieName)
 
static clearExpiredTokens ()
 
static getRememberCookieData ()
 
static getShortHashedUserAgent ()
 
static checkSuperUserInUsers (array $userIds)
 

Fonctions membres protégées statiques

static _toAPRMD5 ($value, $count)
 

Fonctions membres privées statiques

static _bin ($hex)
 

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
11.1

Documentation des fonctions membres

◆ _bin()

static _bin (   $hex)
staticprivate

Converts hexadecimal string to binary data.

Paramètres
string$hexHex data.
Renvoie
string Binary data.
Depuis
11.1

Références $i, et $tmp.

◆ _toAPRMD5()

static _toAPRMD5 (   $value,
  $count 
)
staticprotected

Converts to allowed 64 characters for APRMD5 passwords.

Paramètres
string$valueThe value to convert.
integer$countThe number of characters to convert.
Renvoie
string $value converted to the 64 MD5 characters.
Depuis
11.1

Références $count, et $value.

◆ activateUser()

static activateUser (   $activation)
static

Method to activate a user

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

Références User\$activation, $db, User\$id, $query, $user, et User\getInstance().

Référencé par UserWrapper\activateUser().

◆ 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
11.1
Exceptions

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

Référencé par UserWrapper\addUserToGroup().

◆ 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().

◆ clearExpiredTokens()

static clearExpiredTokens ( )
static

Clear all expired tokens for all users.

Renvoie
mixed Database query result
Depuis
3.2
Obsolète:
4.0 This is handled in the authentication plugin itself

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

Référencé par UserWrapper\clearExpiredTokens().

◆ genRandomPassword()

static genRandomPassword (   $length = 8)
static

Generate a random password

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

Références $base, et $i.

Référencé par Session\_createToken(), et UserWrapper\genRandomPassword().

◆ getCryptedPassword()

static getCryptedPassword (   $plaintext,
  $salt = '',
  $encryption = 'md5-hex',
  $show_encrypt = false 
)
static

Formats a password using the old encryption methods.

Paramètres
string$plaintextThe plaintext password to encrypt.
string$saltThe salt to use to encrypt the password. [] If not present, a new salt will be generated.
string$encryptionThe kind of password encryption to use. Defaults to md5-hex.
boolean$show_encryptSome password systems prepend the kind of encryption to the crypted password ({SHA}, etc). Defaults to false.
Renvoie
string The encrypted password.
Depuis
11.1
Obsolète:
4.0

Références $context, et $i.

Référencé par UserWrapper\getCryptedPassword().

◆ getProfile()

static getProfile (   $userId = 0)
static

Gets the user profile information

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

Références $data, $dispatcher, $user, $userId, JEventDispatcher\getInstance(), et PluginHelper\importPlugin().

Référencé par UserWrapper\getProfile().

◆ getRememberCookieData()

static getRememberCookieData ( )
static

Method to get the remember me cookie data

Renvoie
mixed An array of information from an authentication cookie or false if there is no cookie
Depuis
3.2
Obsolète:
4.0 This is handled in the authentication plugin itself

Références $app.

Référencé par UserWrapper\getRememberCookieData().

◆ getSalt()

static getSalt (   $encryption = 'md5-hex',
  $seed = '',
  $plaintext = '' 
)
static

Returns a salt for the appropriate kind of password encryption using the old encryption methods. Optionally takes a seed and a plaintext password, to extract the seed of an existing password, or for encryption types that use the plaintext in the generation of the salt.

Paramètres
string$encryptionThe kind of password encryption to use. Defaults to md5-hex.
string$seedThe seed to get the salt from (probably a previously generated password). Defaults to generating a new seed.
string$plaintextThe plaintext password that we're generating a salt for. Defaults to none.
Renvoie
string The generated or extracted salt.
Depuis
11.1
Obsolète:
4.0

Références $i.

Référencé par UserWrapper\getSalt().

◆ 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érencé par UserWrapper\getShortHashedUserAgent().

◆ 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
11.1

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

Référencé par UserWrapper\getUserGroups().

◆ 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
11.1

Références $db, $query, et User\$username.

Référencé par UserWrapper\getUserId().

◆ hashPassword()

static hashPassword (   $password)
static

Hashes a password using the current encryption.

Paramètres
string$passwordThe plaintext password to encrypt.
Renvoie
string The encrypted password.
Depuis
3.2.1

Références User\$password.

Référencé par UserWrapper\hashPassword().

◆ invalidateCookie()

static invalidateCookie (   $userId,
  $cookieName 
)
static

Method to remove a cookie record from the database and the browser

Paramètres
string$userIdUser ID for this user
string$cookieNameSeries id (cookie name decoded)
Renvoie
boolean True on success
Depuis
3.2
Obsolète:
4.0 This is handled in the authentication plugin itself. The 'invalid' column in the db should be removed as well

Références $app, $db, $query, et $userId.

Référencé par UserWrapper\invalidateCookie().

◆ 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
11.1

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

Référencé par UserWrapper\removeUserFromGroup().

◆ 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
11.1

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

Référencé par UserWrapper\setUserGroups().

◆ verifyPassword()

static verifyPassword (   $password,
  $hash,
  $user_id = 0 
)
static

Formats a password using the current encryption. If the user ID is given and the hash does not fit the current hashing algorithm, it automatically updates the hash.

Paramètres
string$passwordThe plaintext password to check.
string$hashThe hash to verify against.
integer$user_idID of the user if the password hash should be updated
Renvoie
boolean True if the password and hash match, false otherwise
Depuis
3.2.1

Références $hash, $parts, User\$password, $user, et elseif.

Référencé par UserWrapper\verifyPassword().


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