Fonctions membres publiques
	addUserToGroup ($userId, $groupId)

	getUserGroups ($userId)

	removeUserFromGroup ($userId, $groupId)

	setUserGroups ($userId, $groups)

	getProfile ($userId=0)

	activateUser ($activation)

	getUserId ($username)

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

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

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

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

	genRandomPassword ($length=8)

	invalidateCookie ($userId, $cookieName)

	clearExpiredTokens ()

	getRememberCookieData ()

	getShortHashedUserAgent ()

Description détaillée

Wrapper class for UserHelper

Depuis: 3.4

Obsolète:: 4.0 Use Joomla\CMS\User\UserHelper directly

Documentation des fonctions membres

◆ activateUser()

activateUser ( $activation )

Helper wrapper method for activateUser

Paramètres

string $activation Activation string

Renvoie: boolean True on success

Voir également: UserHelper::activateUser()

Depuis: 3.4

Obsolète:: 4.0 Use Joomla\CMS\User\UserHelper directly

Références User\$activation, et UserHelper\activateUser().

◆ addUserToGroup()

addUserToGroup	(	$userId,
		$groupId
	)

Helper wrapper method for addUserToGroup

Paramètres

integer	$userId	The id of the user.
integer	$groupId	The id of the group.

Renvoie: boolean True on success

Voir également: UserHelper::addUserToGroup()

Depuis: 3.4

Exceptions

Références $userId, et UserHelper\addUserToGroup().

◆ clearExpiredTokens()

clearExpiredTokens ( )

Helper wrapper method for clearExpiredTokens

Renvoie: mixed Database query result

Voir également: UserHelper::clearExpiredTokens()

Depuis: 3.4

Obsolète:: 4.0

Références UserHelper\clearExpiredTokens().

◆ genRandomPassword()

genRandomPassword ( $length = 8 )

Helper wrapper method for genRandomPassword

Paramètres

integer $length Length of the password to generate

Renvoie: string Random Password

Voir également: UserHelper::genRandomPassword()

Depuis: 3.4

Obsolète:: 4.0 Use Joomla\CMS\User\UserHelper directly

Références UserHelper\genRandomPassword().

◆ getCryptedPassword()

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

Helper wrapper method for getCryptedPassword

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.

Voir également: UserHelper::getCryptedPassword()

Depuis: 3.4

Obsolète:: 4.0

Références UserHelper\getCryptedPassword().

◆ getProfile()

getProfile ( $userId = 0 )

Helper wrapper method for getProfile

Paramètres

integer $userId The id of the user.

Renvoie: object

Voir également: UserHelper::getProfile()

Depuis: 3.4

Obsolète:: 4.0 Use Joomla\CMS\User\UserHelper directly

Références $userId, et UserHelper\getProfile().

◆ getRememberCookieData()

getRememberCookieData ( )

Helper wrapper method for getRememberCookieData

Renvoie: mixed An array of information from an authentication cookie or false if there is no cookie

Voir également: UserHelper::getRememberCookieData()

Depuis: 3.4

Obsolète:: 4.0

Références UserHelper\getRememberCookieData().

◆ getSalt()

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

Helper wrapper method for getSalt

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.

Voir également: UserHelper::getSalt()

Depuis: 3.4

Obsolète:: 4.0

Références UserHelper\getSalt().

◆ getShortHashedUserAgent()

getShortHashedUserAgent ( )

Helper wrapper method for getShortHashedUserAgent

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

Voir également: UserHelper::getShortHashedUserAgent()

Depuis: 3.4

Obsolète:: 4.0 Use Joomla\CMS\User\UserHelper directly

Références UserHelper\getShortHashedUserAgent().

◆ getUserGroups()

getUserGroups ( $userId )

Helper wrapper method for getUserGroups

Paramètres

integer $userId The id of the user.

Renvoie: array List of groups

Voir également: UserHelper::addUserToGroup()

Depuis: 3.4

Obsolète:: 4.0 Use Joomla\CMS\User\UserHelper directly

Références $userId, et UserHelper\getUserGroups().

◆ getUserId()

getUserId ( $username )

Helper wrapper method for getUserId

Paramètres

string $username The username to search on.

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

Voir également: UserHelper::getUserId()

Depuis: 3.4

Obsolète:: 4.0 Use Joomla\CMS\User\UserHelper directly

Références User\$username, et UserHelper\getUserId().

◆ hashPassword()

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

Helper wrapper method for hashPassword

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.

Voir également: UserHelper::hashPassword()

Depuis: 3.4

Obsolète:: 4.0 Use Joomla\CMS\User\UserHelper directly

Références $options, User\$password, et UserHelper\hashPassword().

◆ invalidateCookie()

invalidateCookie	(	$userId,
		$cookieName
	)

Helper wrapper method for invalidateCookie

Paramètres

string	$userId	User ID for this user
string	$cookieName	Series id (cookie name decoded)

Renvoie: boolean True on success

Voir également: UserHelper::invalidateCookie()

Depuis: 3.4

Obsolète:: 4.0

Références $userId, et UserHelper\invalidateCookie().

◆ removeUserFromGroup()

removeUserFromGroup	(	$userId,
		$groupId
	)

Helper wrapper method for removeUserFromGroup

Paramètres

integer	$userId	The id of the user.
integer	$groupId	The id of the group.

Renvoie: boolean True on success

Voir également: UserHelper::removeUserFromGroup()

Depuis: 3.4

Obsolète:: 4.0 Use Joomla\CMS\User\UserHelper directly

Références $userId, et UserHelper\removeUserFromGroup().

◆ setUserGroups()

setUserGroups	(	$userId,
		$groups
	)

Helper wrapper method for setUserGroups

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

Voir également: UserHelper::setUserGroups()

Depuis: 3.4

Obsolète:: 4.0 Use Joomla\CMS\User\UserHelper directly

Références User\$groups, $userId, et UserHelper\setUserGroups().

◆ verifyPassword()

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

Helper wrapper method for verifyPassword

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