Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Référence de la classe UserWrapper

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$activationActivation 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$userIdThe id of the user.
integer$groupIdThe 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$lengthLength 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$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$showEncryptSome 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$userIdThe 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$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.
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$userIdThe 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$usernameThe 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$passwordThe plaintext password to encrypt.
integer$algorithmThe hashing algorithm to use, represented by PASSWORD_* constants.
array$optionsThe 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$userIdUser ID for this user
string$cookieNameSeries 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$userIdThe id of the user.
integer$groupIdThe 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$userIdThe id of the user.
array$groupsAn 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$passwordThe plaintext password to check.
string$hashThe hash to verify against.
integer$userIdID of the user if the password hash should be updated
Renvoie
boolean True if the password and hash match, false otherwise
Voir également
UserHelper::verifyPassword()
Depuis
3.4
Obsolète:
4.0 Use Joomla\CMS\User\UserHelper directly

Références $hash, User\$password, $userId, et UserHelper\verifyPassword().


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