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é
|
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 () | |
activateUser | ( | $activation | ) |
Helper wrapper method for activateUser
string | $activation | Activation string |
Joomla\CMS\User\UserHelper
directly Références User\$activation, et UserHelper\activateUser().
addUserToGroup | ( | $userId, | |
$groupId | |||
) |
Helper wrapper method for addUserToGroup
integer | $userId | The id of the user. |
integer | $groupId | The id of the group. |
Références $userId, et UserHelper\addUserToGroup().
clearExpiredTokens | ( | ) |
Helper wrapper method for clearExpiredTokens
Références UserHelper\clearExpiredTokens().
genRandomPassword | ( | $length = 8 | ) |
Helper wrapper method for genRandomPassword
integer | $length | Length of the password to generate |
Joomla\CMS\User\UserHelper
directly Références UserHelper\genRandomPassword().
getCryptedPassword | ( | $plaintext, | |
$salt = '' , |
|||
$encryption = 'md5-hex' , |
|||
$showEncrypt = false |
|||
) |
Helper wrapper method for getCryptedPassword
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. |
Références UserHelper\getCryptedPassword().
getProfile | ( | $userId = 0 | ) |
Helper wrapper method for getProfile
integer | $userId | The id of the user. |
Joomla\CMS\User\UserHelper
directly Références $userId, et UserHelper\getProfile().
getRememberCookieData | ( | ) |
Helper wrapper method for getRememberCookieData
Références UserHelper\getRememberCookieData().
getSalt | ( | $encryption = 'md5-hex' , |
|
$seed = '' , |
|||
$plaintext = '' |
|||
) |
Helper wrapper method for getSalt
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. |
Références UserHelper\getSalt().
getShortHashedUserAgent | ( | ) |
Helper wrapper method for getShortHashedUserAgent
Joomla\CMS\User\UserHelper
directly Références UserHelper\getShortHashedUserAgent().
getUserGroups | ( | $userId | ) |
Helper wrapper method for getUserGroups
integer | $userId | The id of the user. |
Joomla\CMS\User\UserHelper
directly Références $userId, et UserHelper\getUserGroups().
getUserId | ( | $username | ) |
Helper wrapper method for getUserId
string | $username | The username to search on. |
Joomla\CMS\User\UserHelper
directly Références User\$username, et UserHelper\getUserId().
hashPassword | ( | $password, | |
$algorithm = PASSWORD_BCRYPT , |
|||
array | $options = array() |
||
) |
Helper wrapper method for hashPassword
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. |
Joomla\CMS\User\UserHelper
directly Références $options, User\$password, et UserHelper\hashPassword().
invalidateCookie | ( | $userId, | |
$cookieName | |||
) |
Helper wrapper method for invalidateCookie
string | $userId | User ID for this user |
string | $cookieName | Series id (cookie name decoded) |
Références $userId, et UserHelper\invalidateCookie().
removeUserFromGroup | ( | $userId, | |
$groupId | |||
) |
Helper wrapper method for removeUserFromGroup
integer | $userId | The id of the user. |
integer | $groupId | The id of the group. |
Joomla\CMS\User\UserHelper
directly Références $userId, et UserHelper\removeUserFromGroup().
setUserGroups | ( | $userId, | |
$groups | |||
) |
Helper wrapper method for setUserGroups
integer | $userId | The id of the user. |
array | $groups | An array of group ids to put the user in. |
Joomla\CMS\User\UserHelper
directly Références User\$groups, $userId, et UserHelper\setUserGroups().
verifyPassword | ( | $password, | |
$hash, | |||
$userId = 0 |
|||
) |
Helper wrapper method for verifyPassword
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 |
Joomla\CMS\User\UserHelper
directly Références $hash, User\$password, $userId, et UserHelper\verifyPassword().