Joomla CMS  2.5.24 (avec JPlatform 11.4 inclus)
Documentation des API du CMS Joomla en version 2.5 et du framework Joomla Platform intégré
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JUserHelper

Liste de tous les membres

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)

Fonctions membres protégées statiques

static _toAPRMD5 ($value, $count)

Fonctions membres privées statiques

static _bin ($hex)

Documentation des fonctions membres

static JUserHelper::_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.

Référencé par getCryptedPassword().

+ Voici le graphe des appelants de cette fonction :

static JUserHelper::_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.

Référencé par getCryptedPassword().

+ Voici le graphe des appelants de cette fonction :

static JUserHelper::activateUser (   $activation)
static

Method to activate a user

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

Références $db, $id, $query, $user, JText\_(), JFactory\getDbo(), JUser\getInstance(), et JError\raiseWarning().

+ Voici le graphe d'appel pour cette fonction :

static JUserHelper::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:
mixed Boolean true on success, Exception on error.
Depuis:
11.1

Références $db, $query, $title, $user, $userId, JText\_(), JFactory\getDbo(), et JFactory\getUser().

+ Voici le graphe d'appel pour cette fonction :

static JUserHelper::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, $i, et JCrypt\genRandomBytes().

Référencé par JInstallationModelConfiguration\_createConfiguration(), UsersModelRegistration\activate(), JUser\bind(), JoomlaupdateModelDefault\createRestorationFile(), JPath\isOwner(), UsersModelReset\processResetRequest(), et UsersModelRegistration\register().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

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

Formats a password using the current encryption.

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 $i, _bin(), _toAPRMD5(), et getSalt().

Référencé par UsersModelReset\processResetConfirm().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

static JUserHelper::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, JDispatcher\getInstance(), JFactory\getUser(), et JPluginHelper\importPlugin().

+ Voici le graphe d'appel pour cette fonction :

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

Returns a salt for the appropriate kind of password encryption. 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

Références $i.

Référencé par getCryptedPassword(), et UsersModelReset\processResetRequest().

+ Voici le graphe des appelants de cette fonction :

static JUserHelper::getUserGroups (   $userId)
static

Method to get a list of groups a user is in.

Paramètres:
integer$userIdThe id of the user.
Renvoie:
mixed Array on success, JException on error.
Depuis:
11.1

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

Référencé par UsersModelUser\getAssignedGroups().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

static JUserHelper::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 JFactory\getDbo().

Référencé par plgUserJoomla\_getUser(), et JUser\getInstance().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

static JUserHelper::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érencé par JInstallationModelConfiguration\_createRootUser(), JUser\bind(), et UsersModelReset\processResetComplete().

+ Voici le graphe des appelants de cette fonction :

static JUserHelper::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:
mixed Boolean true on success, JException on error.
Depuis:
11.1

Références $key, $user, $userId, JUser\getInstance(), et JFactory\getUser().

+ Voici le graphe d'appel pour cette fonction :

static JUserHelper::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:
mixed Boolean true on success, Exception on error.
Depuis:
11.1

Références $db, $i, $n, $query, $user, $userId, JFactory\getDbo(), JUser\getInstance(), JFactory\getUser(), et JArrayHelper\toInteger().

+ Voici le graphe d'appel pour cette fonction :

static JUserHelper::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 $parts, $user, et JCrypt\timingSafeCompare().

Référencé par plgAuthenticationJoomla\onUserAuthenticate().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :


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