User
Extends \JObjectUser class. Handles all application interaction with a user
since |
1.7.0 |
---|
Methods
__construct
Constructor activating the default information of the language
__construct(integer $identifier, \Joomla\CMS\User\UserWrapper $userHelper = null)
since |
1.7.0 |
---|
Arguments
- $identifier
integer
The primary key of the user to load (optional).- $userHelper
\Joomla\CMS\User\UserWrapper
The UserWrapper for the static methods. [@deprecated 4.0]
__sleep
Method to allow serialize the object with minimal properties.
__sleep() : array
since |
3.6.0 |
---|
Response
array
The names of the properties to include in serialization.
__wakeup
Method to recover the full object on unserialize.
__wakeup() : void
since |
3.6.0 |
---|
authorise
Method to check User object authorisation against an access control object and optionally an access extension object
authorise(string $action, string $assetname = null) : boolean
since |
1.7.0 |
---|
Arguments
- $action
string
The name of the action to check for permission.- $assetname
string
The name of the asset on which to perform the action.
Response
boolean
True if authorised
bind
Method to bind an associative array of data to a user object
bind( &$array) : boolean
since |
1.7.0 |
---|
Arguments
- $array
Response
boolean
True on success
clearAccessRights
Clears the access rights cache of this user
clearAccessRights() : void
since |
3.4.0 |
---|
defParam
Method to set a default parameter if it does not exist
defParam(string $key, mixed $value) : mixed
since |
1.7.0 |
---|
Arguments
- $key
string
Parameter key- $value
mixed
Parameter value
Response
mixed
Set parameter value
delete
Method to delete the User object from the database
delete() : boolean
since |
1.7.0 |
---|
Response
boolean
True on success
getAuthorisedCategories
Method to return a list of all categories that a user has permission for a given action
getAuthorisedCategories(string $component, string $action) : array
since |
1.7.0 |
---|
Arguments
- $component
string
The component from which to retrieve the categories- $action
string
The name of the section within the component from which to retrieve the actions.
Response
array
List of categories that this group can do this action to (empty array if none). Categories must be published.
getAuthorisedGroups
Gets an array of the authorised user groups
getAuthorisedGroups() : array
since |
1.7.0 |
---|
Response
array
getAuthorisedViewLevels
Gets an array of the authorised access levels for the user
getAuthorisedViewLevels() : array
since |
1.7.0 |
---|
Response
array
getInstance
Returns the global User object, only creating it if it doesn't already exist.
getInstance(integer $identifier, \Joomla\CMS\User\UserWrapper $userHelper = null) : \Joomla\CMS\User\User
since |
1.7.0 |
---|
Arguments
- $identifier
integer
The primary key of the user to load (optional).- $userHelper
\Joomla\CMS\User\UserWrapper
The UserWrapper for the static methods. [@deprecated 4.0]
Response
\Joomla\CMS\User\User
The User object.
getParam
Method to get a parameter value
getParam(string $key, mixed $default = null) : mixed
since |
1.7.0 |
---|
Arguments
- $key
string
Parameter key- $default
mixed
Parameter default value
Response
mixed
The value or the default if it did not exist
getParameters
Method to get the user parameters
getParameters() : object
This method used to load the user parameters from a file.
since |
1.7.0 |
---|---|
deprecated |
4.0 - Instead use User::getParam() |
Response
object
The user parameters object.
getTable
Method to get the user table object
getTable(string $type = null, string $prefix = 'JTable') : 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.
note |
At 4.0 this method will no longer be static |
---|---|
since |
1.7.0 |
Arguments
- $type
string
The user table name to be used- $prefix
string
The user table prefix to be used
Response
object
The user table object
getTimezone
Method to get the user timezone.
getTimezone() : \DateTimeZone
If the user didn't set a timezone, it will return the server timezone
since |
3.7.0 |
---|
Response
\DateTimeZone
load
Method to load a User object by user id number
load(mixed $id) : boolean
since |
1.7.0 |
---|
Arguments
- $id
mixed
The user id of the user to load
Response
boolean
True on success
save
Method to save the User object to the database
save(boolean $updateOnly = false) : boolean
since |
1.7.0 |
---|---|
throws |
|
Arguments
- $updateOnly
boolean
Save the object only if not a new user Currently only used in the user reset password method.
Response
boolean
True on success
setLastVisit
Pass through method to the table for setting the last visit date
setLastVisit(integer $timestamp = null) : boolean
since |
1.7.0 |
---|
Arguments
- $timestamp
integer
The timestamp, defaults to 'now'.
Response
boolean
True on success.
setParam
Method to set a parameter
setParam(string $key, mixed $value) : mixed
since |
1.7.0 |
---|
Arguments
- $key
string
Parameter key- $value
mixed
Parameter value
Response
mixed
Set parameter value
setParameters
Method to get the user parameters
setParameters(object $params) : void
since |
1.7.0 |
---|
Arguments
- $params
object
The user parameters object
Properties
isRoot
A cached switch for if this user has root access rights.
since |
1.7.0 |
---|
Type(s)
boolean
id
Unique id
since |
1.7.0 |
---|
Type(s)
integer
name
The user's real name (or nickname)
since |
1.7.0 |
---|
Type(s)
string
username
The login name
since |
1.7.0 |
---|
Type(s)
string
The email
since |
1.7.0 |
---|
Type(s)
string
password
MD5 encrypted password
since |
1.7.0 |
---|
Type(s)
string
password_clear
Clear password, only available when a new password is set for a user
since |
1.7.0 |
---|
Type(s)
string
block
Block status
since |
1.7.0 |
---|
Type(s)
integer
sendEmail
Should this user receive system email
since |
1.7.0 |
---|
Type(s)
integer
registerDate
Date the user was registered
since |
1.7.0 |
---|
Type(s)
string
lastvisitDate
Date of last visit
since |
1.7.0 |
---|
Type(s)
string
activation
Activation hash
since |
1.7.0 |
---|
Type(s)
string
groups
Associative array of user names => group ids
since |
1.7.0 |
---|
Type(s)
array
guest
Guest status
since |
1.7.0 |
---|
Type(s)
integer
lastResetTime
Last Reset Time
since |
3.0.1 |
---|
Type(s)
string
resetCount
Count since last Reset Time
since |
3.0.1 |
---|
Type(s)
integer
requireReset
Flag to require the user's password be reset
since |
3.2 |
---|
Type(s)
integer
_authGroups
Authorised access groups
since |
1.7.0 |
---|
Type(s)
array
_authLevels
Authorised access levels
since |
1.7.0 |
---|
Type(s)
array
_authActions
Authorised access actions
since |
1.7.0 |
---|
Type(s)
array
_errorMsg
Error message
since |
1.7.0 |
---|
Type(s)
string
userHelper
UserWrapper object
since |
3.4 |
---|---|
deprecated |
4.0 Use |
Type(s)
\Joomla\CMS\User\UserWrapper
instances
User instances container.
since |
1.7.3 |
---|
Type(s)
array