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=PASSWORD_BCRYPT, array $options=array())

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

static	getCryptedPassword ($plaintext, $salt='', $encryption='md5-hex', $showEncrypt=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)

static	destroyUserSessions ($userId, $keepCurrent=false, $clientId=null)

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: 1.7.0

Documentation des fonctions membres

◆ _bin()

static _bin ( $hex )

staticprivate

Converts hexadecimal string to binary data.

Paramètres

string $hex Hex data.

Renvoie: string Binary data.

Depuis: 1.7.0

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

◆ _toAPRMD5()

static _toAPRMD5	(	$value,
		$count
	)

staticprotected

Converts to allowed 64 characters for APRMD5 passwords.

Paramètres

string	$value	The value to convert.
integer	$count	The number of characters to convert.

Renvoie: string $value converted to the 64 MD5 characters.

Depuis: 1.7.0

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

◆ activateUser()

static activateUser ( $activation )

static

Method to activate a user

Paramètres

string $activation Activation string

Renvoie: boolean True on success

Depuis: 1.7.0

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	$userId	The id of the user.
integer	$groupId	The id of the group.

Renvoie: boolean True on success

Depuis: 1.7.0

Exceptions

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

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 $userIds An 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, $now, et $query.

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

◆ destroyUserSessions()

static destroyUserSessions	(	$userId,
		$keepCurrent = `false`,
		$clientId = `null`
	)

static

Destroy all active session for a given user id

Paramètres

int	$userId	Id of user
boolean	$keepCurrent	Keep the session of the currently acting user
int	$clientId	Application client id

Renvoie: boolean

Depuis: 3.9.28

Références $clientId, $db, $query, $userId, et null.

Référencé par UsersModelUser\block(), PlgPrivacyUser\onPrivacyRemoveData(), et UsersModelUser\save().

◆ genRandomPassword()

static genRandomPassword ( $length = 8 )

static

Generate a random password

Paramètres

integer $length Length of the password to generate

Renvoie: string Random Password

Depuis: 1.7.0

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

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

◆ getCryptedPassword()

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

static

Formats a password using the old encryption methods.

Paramètres

string	$plaintext	The plaintext password to encrypt.
string	$salt	The salt to use to encrypt the password. [] If not present, a new salt will be generated.
string	$encryption	The kind of password encryption to use. Defaults to md5-hex.
boolean	$showEncrypt	Some password systems prepend the kind of encryption to the crypted password ({SHA}, etc). Defaults to false.

Renvoie: string The encrypted password.

Depuis: 1.7.0

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 $userId The id of the user.

Renvoie: object

Depuis: 1.7.0

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	$encryption	The kind of password encryption to use. Defaults to md5-hex.
string	$seed	The seed to get the salt from (probably a previously generated password). Defaults to generating a new seed.
string	$plaintext	The plaintext password that we're generating a salt for. Defaults to none.

Renvoie: string The generated or extracted salt.

Depuis: 1.7.0

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 $userId The 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 UserWrapper\getUserGroups().

◆ getUserId()

static getUserId ( $username )

static

Returns userid if a user exists

Paramètres

string $username The username to search on.

Renvoie: integer The user id or 0 if not found.

Depuis: 1.7.0

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

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

◆ hashPassword()

static hashPassword	(		$password,
			$algorithm = `PASSWORD_BCRYPT`,
		array	$options = `array()`
	)

static

Hashes a password using the current encryption.

Paramètres

string	$password	The plaintext password to encrypt.
integer	$algorithm	The hashing algorithm to use, represented by `PASSWORD_*` constants.
array	$options	The options for the algorithm to use.

Renvoie: string The encrypted password.

Depuis: 3.2.1

Références $options, et 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	$userId	User ID for this user
string	$cookieName	Series 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	$userId	The id of the user.
integer	$groupId	The id of the group.

Renvoie: boolean True on success

Depuis: 1.7.0

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	$userId	The id of the user.
array	$groups	An 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, $user, $userId, User\getInstance(), et ArrayHelper\toInteger().

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

◆ verifyPassword()

static verifyPassword	(	$password,
		$hash,
		$userId = `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	$password	The plaintext password to check.
string	$hash	The hash to verify against.
integer	$userId	ID 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, $userId, et elseif.

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

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

UserHelper.php

Fonctions membres publiques statiques

Fonctions membres protégées statiques

Fonctions membres privées statiques

Description détaillée

Documentation des fonctions membres

◆ _bin()

◆ _toAPRMD5()

◆ activateUser()

◆ addUserToGroup()

◆ checkSuperUserInUsers()

◆ clearExpiredTokens()

◆ destroyUserSessions()

◆ genRandomPassword()

◆ getCryptedPassword()

◆ getProfile()

◆ getRememberCookieData()

◆ getSalt()

◆ getShortHashedUserAgent()

◆ getUserGroups()

◆ getUserId()

◆ hashPassword()

◆ invalidateCookie()

◆ removeUserFromGroup()

◆ setUserGroups()

◆ verifyPassword()