API Joomla 1.5.26
Documentation des API du CMS Joomla en version 1.5

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

Attributs publics


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$acoSectionThe ACO section value
string$acoThe ACO value
string$axoSectionThe AXO section value [optional]
string$axoThe 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$arrayThe 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$keyParameter key
mixed$valueParameter value
Renvoie:
mixed Set parameter value
Depuis:
1.5
JUser::delete ( )

Method to delete the JUser object from the database

public

Paramètres:
boolean$updateOnlySave 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$idThe 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$keyParameter key
mixed$defaultParameter 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:
booleanIf true, loads the parameters setup file. Default is false.
pathSet 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:
stringThe user table name to be used
stringThe 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$identifierThe user id of the user to load
string$pathPath 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$updateOnlySave 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$timestampThe 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$keyParameter key
mixed$valueParameter value
Renvoie:
mixed Set parameter value
Depuis:
1.5
JUser::setParameters ( params)

Method to get the user parameters

public

Paramètres:
objectThe 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 :