Référence de la classe JUser

Graphe d'héritage de JUser:

Graphe de collaboration de JUser:

Liste de tous les membres

Fonctions membres publiques
	__construct ($identifier=0)
	getParam ($key, $default=null)
	setParam ($key, $value)
	defParam ($key, $value)
	authorize ($action, $assetname=null)
	authorise ($action, $assetname=null)
	authorisedLevels ()
	getAuthorisedCategories ($component, $action)
	getAuthorisedViewLevels ()
	getAuthorisedGroups ()
	setLastVisit ($timestamp=null)
	getParameters ($loadsetupfile=false, $path=null)
	setParameters ($params)
	bind (&$array)
	save ($updateOnly=false)
	delete ()
	load ($id)
Fonctions membres publiques inherited from JObject
	__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)
	toString ()

Fonctions membres publiques statiques
static	getInstance ($identifier=0)
static	getTable ($type=null, $prefix= 'JTable')

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

Attributs protégés
	$isRoot = null
	$_params = null
	$_authGroups = null
	$_authLevels = null
	$_authActions = null
	$_errorMsg = null
Attributs protégés inherited from JObject
	$_errors = array()

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

---

Documentation des constructeurs et destructeur

JUser::__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:

11.1

Réimplémentée à partir de JObject.

---

Documentation des fonctions membres

JUser::authorise	(		$action,
			$assetname = null
	)

Method to check JUser 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:

11.1

Références $config, JAccess\check(), elseif, JAccess\getAssetRules(), JFactory\getConfig(), et null.

Voici le graphe d'appel pour cette fonction :

JUser::authorisedLevels

(

)

Gets an array of the authorised access levels for the user

Renvoie:

array

Obsolète:

12.1

Note:

Use the getAuthorisedViewLevels method instead.

Depuis:

11.1

Références JLog\add(), et JLog\WARNING.

Voici le graphe d'appel pour cette fonction :

JUser::authorize	(		$action,
			$assetname = null
	)

Proxy to authorise

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

Obsolète:

12.1

Note:

Use the authorise method instead.

Depuis:

11.1

Références JLog\add(), et JLog\WARNING.

Voici le graphe d'appel pour cette fonction :

JUser::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:

11.1

Références $params, JText\_(), JUserHelper\genRandomPassword(), JFactory\getDate(), JArrayHelper\getValue(), et JUserHelper\hashPassword().

Voici le graphe d'appel pour cette fonction :

JUser::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:

11.1

Références $key.

JUser::delete

(

)

Method to delete the JUser object from the database

Renvoie:

boolean True on success

Depuis:

11.1

Références $dispatcher, JDispatcher\getInstance(), et JPluginHelper\importPlugin().

Voici le graphe d'appel pour cette fonction :

JUser::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:

11.1

Références $category, $db, $query, et JFactory\getDbo().

Voici le graphe d'appel pour cette fonction :

JUser::getAuthorisedGroups

(

)

Gets an array of the authorised user groups

Renvoie:

array

Depuis:

11.1

Références JAccess\getGroupsByUser(), et null.

Voici le graphe d'appel pour cette fonction :

JUser::getAuthorisedViewLevels

(

)

Gets an array of the authorised access levels for the user

Renvoie:

array

Depuis:

11.1

Références JAccess\getAuthorisedViewLevels(), et null.

Voici le graphe d'appel pour cette fonction :

static JUser::getInstance (   $identifier = 0 )

static

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

Paramètres:

integer

$identifier

The user to load - Can be an integer or string - If string, it is converted to ID automatically.

Renvoie:

JUser The User object.

Depuis:

11.1

Références $id, $user, JUserHelper\getUserId(), JError\raiseWarning(), et JText\sprintf().

Référencé par plgUserJoomla\_getUser(), ContactControllerContact\_sendEmail(), JUserHelper\activateUser(), MessagesViewMessage\addToolbar(), JFactory\getUser(), JUserHelper\getUserGroups(), plgContentJoomla\onContentAfterSave(), plgAuthenticationJoomla\onUserAuthenticate(), UsersModelReset\processResetComplete(), UsersModelReset\processResetRequest(), JUserHelper\removeUserFromGroup(), UsersModelUser\save(), MessagesModelMessage\save(), et JUserHelper\setUserGroups().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

JUser::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:

11.1

Références $key.

JUser::getParameters	(		$loadsetupfile = false,
			$path = null
	)

Method to get the user parameters

This function tries to load an XML file based on the user's usertype. The filename of the xml file is the same as the usertype. The functionals has a static variable to store the parameters setup file base path. You can call this function statically to set the base path if needed.

Paramètres:

boolean	$loadsetupfile	If true, loads the parameters setup file. Default is false.
path	$path	Set the parameters setup file base path to be used to load the user parameters.

Renvoie:

object The user parameters object.

Depuis:

11.1

Références $file, $path, $type, et JPATH_ADMINISTRATOR.

static JUser::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:

object The user table object

Depuis:

11.1

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

Voici le graphe d'appel pour cette fonction :

JUser::load

(

$id

)

Method to load a JUser object by user id number

Paramètres:

mixed

$id

The user id of the user to load

Renvoie:

boolean True on success

Depuis:

11.1

Références $id, JError\raiseWarning(), et JText\sprintf().

Voici le graphe d'appel pour cette fonction :

JUser::save

(

$updateOnly = false

)

Method to save the JUser 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:

11.1

Exceptions:

exception

Références $dispatcher, JText\_(), JAccess\check(), JAccess\checkGroup(), JDispatcher\getInstance(), JFactory\getUser(), JPluginHelper\importPlugin(), JRegistry\loadString(), et null.

Voici le graphe d'appel pour cette fonction :

JUser::setLastVisit

(

$timestamp = null

)

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

Paramètres:

integer

$timestamp

The timestamp, defaults to 'now'.

Renvoie:

boolean True on success.

Depuis:

11.1

JUser::setParam	(		$key,
			$value
	)

Method to set a parameter

Paramètres:

string	$key	Parameter key
mixed	$value	Parameter value

Renvoie:

mixed Set parameter value

Depuis:

11.1

Références $key.

JUser::setParameters

(

$params

)

Method to get the user parameters

Paramètres:

object

$params

The user parameters object

Renvoie:

void

Depuis:

11.1

Références $params.

---

Documentation des données membres

JUser::$_authActions = null

protected

JUser::$_authGroups = null

protected

JUser::$_authLevels = null

protected

JUser::$_errorMsg = null

protected

JUser::$_params = null

protected

JUser::$activation = null

JUser::$block = null

JUser::$email = null

JUser::$groups = array()

JUser::$guest = null

JUser::$id = null

JUser::$instances = array()

staticprotected

JUser::$isRoot = null

protected

JUser::$lastResetTime = null

JUser::$lastvisitDate = null

JUser::$name = null

JUser::$params = null

JUser::$password = null

JUser::$password_clear = ''

JUser::$registerDate = null

JUser::$resetCount = null

JUser::$sendEmail = null

JUser::$username = null

JUser::$usertype = null

---

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

• libraries/joomla/user/user.php