Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe User
+ Graphe d'héritage de User:

Fonctions membres publiques

 __construct ($identifier=0, UserWrapper $userHelper=null)
 
 getParam ($key, $default=null)
 
 setParam ($key, $value)
 
 defParam ($key, $value)
 
 authorise ($action, $assetname=null)
 
 getAuthorisedCategories ($component, $action)
 
 getAuthorisedViewLevels ()
 
 getAuthorisedGroups ()
 
 clearAccessRights ()
 
 setLastVisit ($timestamp=null)
 
 getParameters ()
 
 getTimezone ()
 
 setParameters ($params)
 
 bind (&$array)
 
 save ($updateOnly=false)
 
 delete ()
 
 load ($id)
 
 __sleep ()
 
 __wakeup ()
 

Fonctions membres publiques statiques

static getInstance ($identifier=0, UserWrapper $userHelper=null)
 
static getTable ($type=null, $prefix='JTable')
 

Champs de données

 $id = null
 
 $name = null
 
 $username = null
 
 $email = null
 
 $password = null
 
 $password_clear = ''
 
 $block = null
 
 $sendEmail = null
 
 $registerDate = null
 
 $lastvisitDate = null
 
 $activation = null
 
 $params = null
 
 $groups = array()
 
 $guest = null
 
 $lastResetTime = null
 
 $resetCount = null
 
 $requireReset = null
 

Attributs protégés

 $isRoot = null
 
 $_params = null
 
 $_authGroups = null
 
 $_authLevels = null
 
 $_authActions = null
 
 $_errorMsg = null
 
 $userHelper = null
 

Attributs protégés statiques

static $instances = array()
 

Description détaillée

User class. Handles all application interaction with a user

Depuis
11.1

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $identifier = 0,
UserWrapper  $userHelper = null 
)

Constructor activating the default information of the language

Paramètres
integer$identifierThe primary key of the user to load (optional).
UserWrapper$userHelperThe UserWrapper for the static methods. [
Obsolète:
4.0]
Depuis
11.1

Références User\$userHelper, User\load(), et null.

Documentation des fonctions membres

◆ __sleep()

__sleep ( )

Method to allow serialize the object with minimal properties.

Renvoie
array The names of the properties to include in serialization.
Depuis
3.6.0

◆ __wakeup()

__wakeup ( )

Method to recover the full object on unserialize.

Renvoie
void
Depuis
3.6.0

Références User\$id, et User\load().

◆ authorise()

authorise (   $action,
  $assetname = null 
)

Method to check User object authorisation against an access control object and optionally an access extension object

Paramètres
string$actionThe name of the action to check for permission.
string$assetnameThe name of the asset on which to perform the action.
Renvoie
boolean True if authorised
Depuis
11.1

Références $action, Access\check(), elseif, Access\getAssetRules(), User\getAuthorisedGroups(), null, et true.

Référencé par UsersControllerUser\allowEdit(), et User\getAuthorisedCategories().

◆ bind()

bind ( $array)

Method to bind an associative array of data to a user object

Paramètres
array&$arrayThe associative array to bind to the object
Renvoie
boolean True on success
Depuis
11.1

Références User\$params, User\$password, User\$username, et ArrayHelper\getValue().

◆ clearAccessRights()

clearAccessRights ( )

Clears the access rights cache of this user

Renvoie
void
Depuis
3.4.0

Références Access\clearStatics(), et null.

◆ defParam()

defParam (   $key,
  $value 
)

Method to set a default parameter if it does not exist

Paramètres
string$keyParameter key
mixed$valueParameter value
Renvoie
mixed Set parameter value
Depuis
11.1

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

◆ delete()

delete ( )

Method to delete the User object from the database

Renvoie
boolean True on success
Depuis
11.1

Références $dispatcher, JEventDispatcher\getInstance(), User\getTable(), et PluginHelper\importPlugin().

◆ getAuthorisedCategories()

getAuthorisedCategories (   $component,
  $action 
)

Method to return a list of all categories that a user has permission for a given action

Paramètres
string$componentThe component from which to retrieve the categories
string$actionThe name of the section within the component from which to retrieve the actions.
Renvoie
array List of categories that this group can do this action to (empty array if none). Categories must be published.
Depuis
11.1

Références $action, $category, $component, $db, $query, et User\authorise().

◆ getAuthorisedGroups()

getAuthorisedGroups ( )

Gets an array of the authorised user groups

Renvoie
array
Depuis
11.1

Références User\$_authGroups, Access\getGroupsByUser(), et null.

Référencé par User\authorise().

◆ getAuthorisedViewLevels()

getAuthorisedViewLevels ( )

Gets an array of the authorised access levels for the user

Renvoie
array
Depuis
11.1

Références User\$_authLevels, Access\getAuthorisedViewLevels(), et null.

◆ getInstance()

static getInstance (   $identifier = 0,
UserWrapper  $userHelper = null 
)
static

Returns the global User object, only creating it if it doesn't already exist.

Paramètres
integer$identifierThe primary key of the user to load (optional).
UserWrapper$userHelperThe UserWrapper for the static methods. [
Obsolète:
4.0]
Renvoie
User The User object.
Depuis
11.1

Références User\$id, $user, User\$userHelper, et null.

Référencé par UserHelper\activateUser(), UserHelper\addUserToGroup(), UserField\getLayoutData(), Factory\getUser(), UserHelper\getUserGroups(), UserHelper\removeUserFromGroup(), et UserHelper\setUserGroups().

◆ getParam()

getParam (   $key,
  $default = null 
)

Method to get a parameter value

Paramètres
string$keyParameter key
mixed$defaultParameter default value
Renvoie
mixed The value or the default if it did not exist
Depuis
11.1

Références $default, et $key.

Référencé par User\getTimezone().

◆ getParameters()

getParameters ( )

Method to get the user parameters

This method used to load the user parameters from a file.

Renvoie
object The user parameters object.
Depuis
11.1
Obsolète:
12.3 (Platform) & 4.0 (CMS) - Instead use User::getParam()

Références User\$_params.

◆ getTable()

static getTable (   $type = null,
  $prefix = 'JTable' 
)
static

Method to get the user table object

This function uses a static variable to store the table name of the user table to instantiate. You can call this function statically to set the table name if needed.

Paramètres
string$typeThe user table name to be used
string$prefixThe user table prefix to be used
Renvoie
object The user table object
Note
At 4.0 this method will no longer be static
Depuis
11.1

Références $prefix, $type, et Table\getInstance().

Référencé par UsersModelUser\activate(), UsersModelUser\block(), UsersModelUser\delete(), User\delete(), User\load(), User\save(), et User\setLastVisit().

◆ getTimezone()

getTimezone ( )

Method to get the user timezone.

If the user didn't set a timezone, it will return the server timezone

Renvoie
Depuis
3.7.0

Références User\getParam().

◆ load()

load (   $id)

Method to load a User object by user id number

Paramètres
mixed$idThe user id of the user to load
Renvoie
boolean True on success
Depuis
11.1

Références User\$id, et User\getTable().

Référencé par User\__construct(), et User\__wakeup().

◆ save()

save (   $updateOnly = false)

Method to save the User object to the database

Paramètres
boolean$updateOnlySave the object only if not a new user Currently only used in the user reset password method.
Renvoie
boolean True on success
Depuis
11.1
Exceptions

Références $dispatcher, User\$password, Access\check(), Access\checkGroup(), JEventDispatcher\getInstance(), User\getTable(), PluginHelper\importPlugin(), et null.

◆ setLastVisit()

setLastVisit (   $timestamp = null)

Pass through method to the table for setting the last visit date

Paramètres
integer$timestampThe timestamp, defaults to 'now'.
Renvoie
boolean True on success.
Depuis
11.1

Références User\getTable().

◆ setParam()

setParam (   $key,
  $value 
)

Method to set a parameter

Paramètres
string$keyParameter key
mixed$valueParameter value
Renvoie
mixed Set parameter value
Depuis
11.1

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

◆ setParameters()

setParameters (   $params)

Method to get the user parameters

Paramètres
object$paramsThe user parameters object
Renvoie
void
Depuis
11.1

Références User\$params.

Documentation des champs

◆ $_authActions

$_authActions = null
protected

◆ $_authGroups

$_authGroups = null
protected

Référencé par User\getAuthorisedGroups().

◆ $_authLevels

$_authLevels = null
protected

Référencé par User\getAuthorisedViewLevels().

◆ $_errorMsg

$_errorMsg = null
protected

◆ $_params

$_params = null
protected

Référencé par User\getParameters().

◆ $activation

$activation = null

◆ $block

$block = null

◆ $email

$email = null

◆ $groups

$groups = array()

◆ $guest

$guest = null

◆ $id

◆ $instances

$instances = array()
staticprotected

◆ $isRoot

$isRoot = null
protected

◆ $lastResetTime

$lastResetTime = null

◆ $lastvisitDate

$lastvisitDate = null

◆ $name

$name = null

◆ $params

$params = null

Référencé par User\bind(), et User\setParameters().

◆ $password

◆ $password_clear

$password_clear = ''

◆ $registerDate

$registerDate = null

◆ $requireReset

$requireReset = null

◆ $resetCount

$resetCount = null

◆ $sendEmail

$sendEmail = null

◆ $userHelper

$userHelper = null
protected

Référencé par User\__construct(), et User\getInstance().

◆ $username

$username = null

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