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)
• & getInstance ($id=0)
• getParam ($key, $default=null)
• setParam ($key, $value)
• defParam ($key, $value)
• authorize ($acoSection, $aco, $axoSection=null, $axo=null)
• setLastVisit ($timestamp=null)
• & getParameters ($loadsetupfile=false, $path=null)
• setParameters ($params)
• & getTable ($type=null, $prefix= 'JTable')
• bind (&$array)
• save ($updateOnly=false)
• delete ()
• load ($id)

Attributs publics

• $id = null
• $name = null
• $username = null
• $email = null
• $password = null
• $password_clear = ''
• $usertype = null
• $block = null
• $sendEmail = null
• $gid = null
• $registerDate = null
• $lastvisitDate = null
• $activation = null
• $params = null
• $aid = null
• $guest = null
• $_params = null
• $_errorMsg = null

---

Documentation des constructeurs et destructeur

JUser::__construct

(

$

identifier = 0

)

Constructor activating the default information of the language

protected

---

Documentation des fonctions membres

JUser::authorize	(	$	acoSection,
		$	aco,
		$	axoSection = null,
		$	axo = null
	)

Method to check JUser object authorization against an access control object and optionally an access extension object

public

Paramètres:

string	$acoSection	The ACO section value
string	$aco	The ACO value
string	$axoSection	The AXO section value [optional]
string	$axo	The AXO value [optional]

Renvoie:

boolean True if authorized

Depuis:

1.5

Références $acl, et JFactory::getACL().

Voici le graphe d'appel pour cette fonction :

JUser::bind

(

&$

array

)

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

public

Paramètres:

array

$array

The associative array to bind to the object

Renvoie:

boolean True on success

Depuis:

1.5

Références $array, $db, $now, $params, $query, JText::_(), JUserHelper::genRandomPassword(), JUserHelper::getCryptedPassword(), JFactory::getDate(), JFactory::getDBO(), JArrayHelper::getValue(), jimport(), et params.

Voici le graphe d'appel pour cette fonction :

JUser::defParam	(	$	key,
		$	value
	)

Method to set a default parameter if it does not exist

public

Paramètres:

string	$key	Parameter key
mixed	$value	Parameter value

Renvoie:

mixed Set parameter value

Depuis:

1.5

JUser::delete

(

)

Method to delete the JUser object from the database

public

Paramètres:

boolean

$updateOnly

Save the object only if not a new user

Renvoie:

boolean True on success

Depuis:

1.5

Références JDispatcher::getInstance(), et JPluginHelper::importPlugin().

Voici le graphe d'appel pour cette fonction :

& JUser::getInstance

(

$

id = 0

)

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

This method must be invoked as:

  $user =& JUser::getInstance($id);

public

Paramètres:

int

$id

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

Renvoie:

JUser The User object.

Depuis:

1.5

Références $id, $user, JUserHelper::getUserId(), jimport(), et JError::raiseWarning().

Référencé par JUserHelper::activateUser(), UsersController::block(), UsersViewUser::display(), JFactory::getUser(), plgAuthenticationJoomla::onAuthenticate(), UsersController::remove(), et ContactController::submit().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

JUser::getParam	(	$	key,
		$	default = null
	)

Method to get a parameter value

public

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.5

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

Method to get the user parameters

This function tries to load an xml file based on the users 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.

public

Paramètres:

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

Renvoie:

object The user parameters object

Depuis:

1.5

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

& JUser::getTable	(	$	type = null,
		$	prefix = 'JTable'
	)

Method to get the user table object

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

public

Paramètres:

string	The user table name to be used
string	The user table prefix to be used

Renvoie:

object The user table object

Depuis:

1.5

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

public

Paramètres:

mixed	$identifier	The user id of the user to load
string	$path	Path to a parameters xml file

Renvoie:

boolean True on success

Depuis:

1.5

Références JError::raiseWarning().

Voici le graphe d'appel pour cette fonction :

JUser::save

(

$

updateOnly = false

)

Method to save the JUser object to the database

public

Paramètres:

boolean

$updateOnly

Save the object only if not a new user

Renvoie:

boolean True on success

Depuis:

1.5

Références JText::_(), JDispatcher::getInstance(), JFactory::getUser(), JPluginHelper::importPlugin(), et params.

Voici le graphe d'appel pour cette fonction :

JUser::setLastVisit

(

$

timestamp = null

)

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

public

Paramètres:

int

$timestamp

The timestamp, defaults to 'now'

Renvoie:

boolean True on success

Depuis:

1.5

JUser::setParam	(	$	key,
		$	value
	)

Method to set a parameter

public

Paramètres:

string	$key	Parameter key
mixed	$value	Parameter value

Renvoie:

mixed Set parameter value

Depuis:

1.5

JUser::setParameters

(

$

params

)

Method to get the user parameters

public

Paramètres:

object

The user parameters object

Depuis:

1.5

Références $params.

---

Documentation des données membres

JUser::$_errorMsg = null

JUser::$_params = null

JUser::$activation = null

JUser::$aid = null

JUser::$block = null

JUser::$email = null

JUser::$gid = null

JUser::$guest = null

JUser::$id = null

JUser::$lastvisitDate = null

JUser::$name = null

JUser::$params = null

JUser::$password = null

JUser::$password_clear = ''

JUser::$registerDate = 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