Référence de la classe User

Graphe d'héritage de User:

Fonctions membres publiques
	__construct ($identifier=0)
	getParam ($key, $default=null)
	setParam ($key, $value)
	defParam ($key, $value)
	authorise ($action, $assetname=null)
	getAuthorisedCategories ($component, $action)
	getAuthorisedViewLevels ()
	getAuthorisedGroups ()
	clearAccessRights ()
	getTimezone ()
	setParameters ($params)
	bind (&$array)
	save ($updateOnly=false)
	delete ()
	load ($id)
	__sleep ()
	__wakeup ()
Fonctions membres publiques hérités de CMSObject
	__construct ($properties=null)
	__toString ()
	def ($property, $default=null)
	get ($property, $default=null)
	getProperties ($public=true)
	getError ($i=null, $toString=true)
	getErrors ()
	set ($property, $value=null)
	setProperties ($properties)
	setError ($error)

Fonctions membres publiques statiques
static	getInstance ($identifier=0)
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
Attributs protégés hérités de CMSObject
	$_errors = array()

Attributs protégés statiques
static	$instances = array()

Description détaillée

User class. Handles all application interaction with a user

Depuis

1.7.0

Documentation des constructeurs et destructeur

__construct()

__construct

(

$identifier = 0

)

Constructor activating the default information of the language

Paramètres

integer

$identifier

The primary key of the user to load (optional).

Depuis

1.7.0

Références User\load().

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, $this, 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	$action	The name of the action to check for permission.
string	$assetname	The name of the asset on which to perform the action.

Renvoie

boolean True if authorised

Depuis

1.7.0

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

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

bind()

bind

(

&

$array

)

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

Paramètres

array

&$array

The associative array to bind to the object

Renvoie

boolean True on success

Depuis

1.7.0

Références User\$params, User\$password, Text\_(), UserHelper\genRandomPassword(), Factory\getApplication(), Factory\getDate(), ArrayHelper\getValue(), UserHelper\hashPassword(), CMSObject\setError(), et CMSObject\setProperties().

Référencé par UserHelper\activateUser(), UserHelper\addUserToGroup(), PlgPrivacyUser\createNotesDomain(), PlgPrivacyUser\createProfileDomain(), User\getAuthorisedCategories(), UserHelper\getUserId(), et UserFactory\loadUserByUsername().

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	$key	Parameter key
mixed	$value	Parameter value

Renvoie

mixed Set parameter value

Depuis

1.7.0

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

delete()

delete

(

)

Method to delete the User object from the database

Renvoie

boolean True on success

Depuis

1.7.0

Références $result, $this, Factory\getApplication(), CMSObject\getError(), CMSObject\getProperties(), User\getTable(), PluginHelper\importPlugin(), et CMSObject\setError().

getAuthorisedCategories()

getAuthorisedCategories	(		$component,
			$action
	)

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

Paramètres

string	$component	The component from which to retrieve the categories
string	$action	The 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

1.7.0

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

getAuthorisedGroups()

getAuthorisedGroups

(

)

Gets an array of the authorised user groups

Renvoie

array

Depuis

1.7.0

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

1.7.0

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

getInstance()

static getInstance (   $identifier = 0 )

static

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

Paramètres

integer

$identifier

The primary key of the user to load (optional).

Renvoie

User The User object.

Depuis

1.7.0

Obsolète:

5.0 Load the user service from the dependency injection container or via $app->getIdentity()

Références User\$id, class, et Factory\getContainer().

Référencé par PlgUserJoomla\_getUser(), ContactController\_sendEmail(), UserHelper\activateUser(), HtmlView\addToolbar(), UserHelper\addUserToGroup(), ChangeUserPasswordCommand\doExecute(), DeleteUserCommand\doExecute(), AddUserToGroupCommand\doExecute(), RemoveUserFromGroupCommand\doExecute(), AddUserCommand\doExecute(), Access\getAuthorisedViewLevels(), UserField\getLayoutData(), Factory\getUser(), UserHelper\getUserGroups(), PlgContentJoomla\onContentAfterSave(), PlgAuthenticationJoomla\onUserAuthenticate(), Joomla\onUserLogout(), ResetModel\processResetComplete(), ResetModel\processResetRequest(), UserHelper\removeUserFromGroup(), UserModel\save(), MessageModel\save(), et UserHelper\setUserGroups().

getParam()

getParam	(		$key,
			$default = null
	)

Method to get a parameter value

Paramètres

string	$key	Parameter key
mixed	$default	Parameter default value

Renvoie

mixed The value or the default if it did not exist

Depuis

1.7.0

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

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

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	$type	The user table name to be used
string	$prefix	The user table prefix to be used

Renvoie

Table The user table object

Note

At 4.0 this method will no longer be static

Depuis

1.7.0

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

Référencé par User\delete(), User\load(), et User\save().

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 Factory\getApplication(), et User\getParam().

load()

load

(

$id

)

Method to load a User object by user id number

Paramètres

mixed

$id

The user id of the user to load

Renvoie

boolean True on success

Depuis

1.7.0

Références User\$id, Log\add(), User\getTable(), CMSObject\setProperties(), Text\sprintf(), et Log\WARNING.

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

$updateOnly

Save the object only if not a new user Currently only used in the user reset password method.

Renvoie

boolean True on success

Depuis

1.7.0

Exceptions

Références User\$password, $result, $this, Access\check(), Access\checkGroup(), Factory\getApplication(), CMSObject\getError(), CMSObject\getProperties(), User\getTable(), Factory\getUser(), PluginHelper\importPlugin(), null, et CMSObject\setError().

setParam()

setParam	(		$key,
			$value
	)

Method to set a parameter

Paramètres

string	$key	Parameter key
mixed	$value	Parameter value

Renvoie

mixed Set parameter value

Depuis

1.7.0

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

setParameters()

setParameters

(

$params

)

Method to get the user parameters

Paramètres

object

$params

The user parameters object

Renvoie

void

Depuis

1.7.0

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

$activation

$activation = null

Référencé par UserHelper\activateUser().

$block

$block = null

$email

$email = null

$groups

$groups = array()

Référencé par UserHelper\setUserGroups().

$guest

$guest = null

$id

$id = null

Référencé par User\__wakeup(), UserHelper\activateUser(), User\getInstance(), User\load(), et UserFactory\loadUserById().

$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 = null

Référencé par User\bind(), UserHelper\hashPassword(), et User\save().

$password_clear

$password_clear = ''

$registerDate

$registerDate = null

$requireReset

$requireReset = null

$resetCount

$resetCount = null

$sendEmail

$sendEmail = null

$username

$username = null

Référencé par UserHelper\getUserId(), et UserFactory\loadUserByUsername().

---

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

• User/User.php