Class JUser

User class. Handles all application interaction with a user

JObject

JUser

Package: Joomla\Platform\User
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 11.1
Located at joomla/user/user.php

Methods summary

`public`	# `__construct( integer $identifier = 0, JUserWrapperHelper $userHelper = null )` Constructor activating the default information of the language Constructor activating the default information of the language Parameters `$identifier` `integer` - $identifier The primary key of the user to load (optional). `$userHelper` `JUserWrapperHelper` - $userHelper The JUserWrapperHelper for the static methods. Since 11.1 Overrides `JObject::__construct`
`public static JUser`	# `getInstance( integer $identifier = 0, JUserWrapperHelper $userHelper = null )` Returns the global User object, only creating it if it doesn't already exist. Returns the global User object, only creating it if it doesn't already exist. Parameters `$identifier` `integer` - $identifier The primary key of the user to load (optional). `$userHelper` `JUserWrapperHelper` - $userHelper The JUserWrapperHelper for the static methods. Returns `JUser` - The User object. Since 11.1
`public mixed`	# `getParam( string $key, mixed $default = null )` Method to get a parameter value Method to get a parameter value Parameters `$key` `string` - $key Parameter key `$default` `mixed` - $default Parameter default value Returns `mixed` - The value or the default if it did not exist Since 11.1
`public mixed`	# `setParam( string $key, mixed $value )` Method to set a parameter Method to set a parameter Parameters `$key` `string` - $key Parameter key `$value` `mixed` - $value Parameter value Returns `mixed` - Set parameter value Since 11.1
`public mixed`	# `defParam( string $key, mixed $value )` Method to set a default parameter if it does not exist Method to set a default parameter if it does not exist Parameters `$key` `string` - $key Parameter key `$value` `mixed` - $value Parameter value Returns `mixed` - Set parameter value Since 11.1
`public boolean`	# `authorise( string $action, string $assetname = null )` Method to check JUser object authorisation against an access control object and optionally an access extension object Method to check JUser object authorisation against an access control object and optionally an access extension object Parameters `$action` `string` - $action The name of the action to check for permission. `$assetname` `string` - $assetname The name of the asset on which to perform the action. Returns `boolean` - True if authorised Since 11.1
`public array`	# `getAuthorisedCategories( string $component, string $action )` Method to return a list of all categories that a user has permission for a given action Method to return a list of all categories that a user has permission for a given action Parameters `$component` `string` - $component The component from which to retrieve the categories `$action` `string` - $action The name of the section within the component from which to retrieve the actions. Returns `array` - List of categories that this group can do this action to (empty array if none). Categories must be published. Since 11.1
`public array`	# `getAuthorisedViewLevels( )` Gets an array of the authorised access levels for the user Gets an array of the authorised access levels for the user Returns `array` Since 11.1
`public array`	# `getAuthorisedGroups( )` Gets an array of the authorised user groups Gets an array of the authorised user groups Returns `array` Since 11.1
`public`	# `clearAccessRights( )` Clears the access rights cache of this user Clears the access rights cache of this user Since 3.4.0
`public boolean`	# `setLastVisit( integer $timestamp = null )` Pass through method to the table for setting the last visit date Pass through method to the table for setting the last visit date Parameters `$timestamp` `integer` - $timestamp The timestamp, defaults to 'now'. Returns `boolean` - True on success. Since 11.1
`public object`	# `getParameters( )` Method to get the user parameters Method to get the user parameters This method used to load the user parameters from a file. Deprecated 12.3 (Platform) & 4.0 (CMS) - Instead use JUser::getParam() Returns `object` - The user parameters object. Since 11.1
`public DateTimeZone`	# `getTimezone( )` Method to get the user timezone. Method to get the user timezone. If the user didn't set a timezone, it will return the server timezone Returns `DateTimeZone` Since 3.7.0
`public`	# `setParameters( object $params )` Method to get the user parameters Method to get the user parameters Parameters `$params` `object` - $params The user parameters object Since 11.1
`public static object`	# `getTable( string $type = null, string $prefix = 'JTable' )` Method to get the user table object 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. Parameters `$type` `string` - $type The user table name to be used `$prefix` `string` - $prefix The user table prefix to be used Returns `object` - The user table object Since 11.1 Note At 4.0 this method will no longer be static
`public boolean`	# `bind( array & $array )` Method to bind an associative array of data to a user object Method to bind an associative array of data to a user object Parameters `$array` `array` - &$array The associative array to bind to the object Returns `boolean` - True on success Since 11.1
`public boolean`	# `save( boolean $updateOnly = false )` Method to save the JUser object to the database Method to save the JUser object to the database Parameters `$updateOnly` `boolean` - $updateOnly Save the object only if not a new user Currently only used in the user reset password method. Returns `boolean` - True on success Throws `RuntimeException` Since 11.1
`public boolean`	# `delete( )` Method to delete the JUser object from the database Method to delete the JUser object from the database Returns `boolean` - True on success Since 11.1
`public boolean`	# `load( mixed $id )` Method to load a JUser object by user id number Method to load a JUser object by user id number Parameters `$id` `mixed` - $id The user id of the user to load Returns `boolean` - True on success Since 11.1
`public array`	# `__sleep( )` Method to allow serialize the object with minimal properties. Method to allow serialize the object with minimal properties. Returns `array` - The names of the properties to include in serialization. Since 3.6.0
`public`	# `__wakeup( )` Method to recover the full object on unserialize. Method to recover the full object on unserialize. Since 3.6.0

Methods inherited from JObject

__toString(), def(), get(), getError(), getErrors(), getProperties(), set(), setError(), setProperties()

Magic methods summary

Properties summary

`protected boolean`	`$isRoot`	# A cached switch for if this user has root access rights. A cached switch for if this user has root access rights. Since 11.1
`public integer`	`$id`	# Unique id Unique id Since 11.1
`public string`	`$name`	# The user's real name (or nickname) The user's real name (or nickname) Since 11.1
`public string`	`$username`	# The login name The login name Since 11.1
`public string`	`$email`	# The email The email Since 11.1
`public string`	`$password`	# MD5 encrypted password MD5 encrypted password Since 11.1
`public string`	`$password_clear`	# Clear password, only available when a new password is set for a user Clear password, only available when a new password is set for a user Since 11.1
`public integer`	`$block`	# Block status Block status Since 11.1
`public integer`	`$sendEmail`	# Should this user receive system email Should this user receive system email Since 11.1
`public datetime`	`$registerDate`	# Date the user was registered Date the user was registered Since 11.1
`public datetime`	`$lastvisitDate`	# Date of last visit Date of last visit Since 11.1
`public string`	`$activation`	# Activation hash Activation hash Since 11.1
`public Joomla\Registry\Registry`	`$params`	# User parameters User parameters Since 11.1
`public array`	`$groups`	# Associative array of user names => group ids Associative array of user names => group ids Since 11.1
`public boolean`	`$guest`	# Guest status Guest status Since 11.1
`public string`	`$lastResetTime`	# Last Reset Time Last Reset Time Since 12.2
`public integer`	`$resetCount`	# Count since last Reset Time Count since last Reset Time Since 12.2
`public integer`	`$requireReset`	# Flag to require the user's password be reset Flag to require the user's password be reset Since 3.2
`protected Joomla\Registry\Registry`	`$_params`	# User parameters User parameters Since 11.1
`protected array`	`$_authGroups`	# Authorised access groups Authorised access groups Since 11.1
`protected array`	`$_authLevels`	# Authorised access levels Authorised access levels Since 11.1
`protected array`	`$_authActions`	# Authorised access actions Authorised access actions Since 11.1
`protected string`	`$_errorMsg`	# Error message Error message Since 11.1
`protected JUserWrapperHelper`	`$userHelper`	# JUserWrapperHelper object JUserWrapperHelper object Since 3.4
`protected static array`	`$instances`	# JUser instances container. JUser instances container. Since 11.3

Properties inherited from JObject

$_errors

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JUser

Methods summary

Parameters

Since

Overrides

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Returns

Since

Returns

Since

Since

Parameters

Returns

Since

Deprecated

Returns

Since

Returns

Since

Parameters

Since

Parameters

Returns

Since

Note

Parameters

Returns

Since

Parameters

Returns

Throws

Since

Returns

Since

Parameters

Returns

Since

Returns

Since

Since

Methods inherited from JObject

Magic methods summary

Properties summary

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since