User
User 类。处理所有应用程序与用户的交互
自 |
1.7.0 |
---|---|
包 |
Joomla CMS |
方法
__construct
构造函数激活语言的默认信息
__construct( identifier) :
自 |
1.7.0 |
---|
参数
- 标识符
int
要加载的用户的主键(可选)。
响应
混合
__sleep
允许以最少属性序列化对象的方法。
__sleep() : mixed||string|int
自 |
3.6.0 |
---|
响应
array<string|int, mixed>
要包含在序列化中的属性名称。
__wakeup
在反序列化时恢复完整对象的方法。
__wakeup() :
自 |
3.6.0 |
---|
响应
空
authorise
检查 User 对象授权是否针对访问控制对象以及可选的访问扩展对象的方法
authorise( action, assetname = null) :
自 |
1.7.0 |
---|
参数
- 操作
string
要检查权限的操作名称。- 资产名称
string
要执行操作的资产名称。
响应
bool
如果授权则为真
bind
将关联数据数组绑定到用户对象的方法
bind(mixed||string|int &array) :
自 |
1.7.0 |
---|
参数
- 数组
array<string|int, mixed>
要绑定到对象的关联数组
响应
bool
成功则为真
clearAccessRights
清除此用户的访问权限缓存
clearAccessRights() :
自 |
3.4.0 |
---|
响应
空
def
如果尚未分配,则设置默认值
def( property, default = null) :
自 |
1.7.0 |
---|---|
已弃用 |
4.3.0 将在 6.0 中删除 不应再使用定义动态属性 |
参数
- 属性
string
属性的名称。- 默认
mixed
默认值。
响应
混合
defParam
设置默认参数(如果不存在)的方法
defParam( key, value) :
自 |
1.7.0 |
---|
参数
- 键
string
参数键- 值
mixed
参数值
响应
mixed
设置参数值
delete
从数据库中删除 User 对象的方法
delete() :
自 |
1.7.0 |
---|
响应
bool
成功则为真
get
返回对象的属性或属性未设置时的默认值。
get( property, default = null) :
自 |
1.7.0 |
---|---|
见 | CMSObject::getProperties() |
已弃用 |
4.3.0 将在 6.0 中删除 为属性创建适当的 getter 函数 |
参数
- 属性
string
属性的名称。- 默认
mixed
默认值。
响应
mixed
属性的值。
getAuthorisedCategories
返回用户对给定操作有权限的所有类别的列表的方法
getAuthorisedCategories( component, action) : mixed||string|int
自 |
1.7.0 |
---|
参数
- 组件
string
要从中检索类别的组件- 操作
string
要从中检索操作的组件内的部分名称。
响应
array<string|int, mixed>
该组可以对此执行操作的类别列表(如果不存在则为空数组)。类别必须发布。
getAuthorisedGroups
获取已授权用户组的数组
getAuthorisedGroups() : mixed||string|int
自 |
1.7.0 |
---|
响应
array<string|int, mixed>
getAuthorisedViewLevels
获取用户的已授权访问级别数组
getAuthorisedViewLevels() : mixed||string|int
自 |
1.7.0 |
---|
响应
array<string|int, mixed>
getError
获取最新的错误消息。
getError( i = null, toString = true) :
自 |
1.7.0 |
---|---|
已弃用 |
3.1.4 将在 6.0 中删除 将被删除,没有替代品 捕获抛出的异常,而不是 getError |
参数
- i
int
可选错误索引。- toString
bool
指示 Exception 对象是否应返回其错误消息。
响应
string
错误消息
getErrors
返回所有错误(如果有)。
getErrors() : mixed||string|int
自 |
1.7.0 |
---|---|
已弃用 |
3.1.4 将在 6.0 中删除 将被删除,没有替代品 捕获抛出的异常,而不是 getErrors |
响应
array<string|int, mixed>
错误消息数组。
getInstance
返回全局 User 对象,仅在它不存在时创建它。
getInstance( identifier) : \Joomla\CMS\User\User
自 |
1.7.0 |
---|---|
已弃用 |
4.3 将在 6.0 中删除 从依赖注入容器或通过 $app->getIdentity() 加载用户服务 示例:Factory::getContainer()->get(UserFactoryInterface::class)->loadUserById($id) |
参数
- 标识符
int
要加载的用户的主键(可选)。
响应
User
User 对象。
getParam
获取参数值的方法
getParam( key, default = null) :
自 |
1.7.0 |
---|
参数
- 键
string
参数键- 默认
mixed
参数默认值
响应
mixed
值或如果不存在则为默认值
getProperties
返回对象属性的关联数组。
getProperties( public = true) : mixed||string|int
自 |
1.7.0 |
---|---|
见 | CMSObject::get() |
已弃用 |
4.3.0 将在 6.0 中删除 为属性创建适当的 getter 函数 |
参数
- 公开
bool
如果为真,则仅返回公共属性。
响应
array<string|int, mixed>
getTable
获取用户表格对象的方法
getTable( type = null, prefix = 'JoomlaCMSTable\') : \Joomla\CMS\Table\Table
此函数使用静态变量来存储用户表格的表格名称以进行实例化。如果需要,可以静态地调用此函数来设置表格名称。
注意 |
在 4.0 中,此方法将不再是静态的 |
---|---|
自 |
1.7.0 |
参数
- 类型
string
要使用的用户表格名称- 前缀
string
要使用的用户表格前缀
响应
Table
用户表格对象
getTimezone
获取用户时区的方法。
getTimezone() : \DateTimeZone
如果用户没有设置时区,它将返回服务器时区
自 |
3.7.0 |
---|
响应
DateTimeZone
load
通过用户 ID 号加载 User 对象的方法
load( id) :
自 |
1.7.0 |
---|
参数
- id
mixed
要加载的用户的用户 ID
响应
bool
成功则为真
save
将 User 对象保存到数据库的方法
save( updateOnly = false) :
自 |
1.7.0 |
---|---|
抛出 |
|
参数
- updateOnly
bool
仅在不是新用户时保存对象 目前仅在用户重置密码方法中使用。
响应
bool
成功则为真
set
修改对象属性,如果不存在则创建它。
set( property, value = null) :
自 |
1.7.0 |
---|---|
已弃用 |
4.3.0 将在 6.0 中删除 为属性创建适当的 setter 函数 |
参数
- 属性
string
属性的名称。- 值
mixed
要设置的属性的值。
响应
mixed
属性的先前值。
setError
添加错误消息。
setError( error) :
自 |
1.7.0 |
---|---|
已弃用 |
3.1.4 将在 6.0 中删除 将被删除,没有替代品 抛出异常,而不是使用 setError |
参数
- 错误
string
错误消息。
响应
空
setLastVisit
将方法传递给表格以设置上次访问日期
setLastVisit( timestamp = null) :
自 |
1.7.0 |
---|
参数
- 时间戳
int
时间戳,默认为“现在”。
响应
bool
成功则为真。
setParam
设置参数的方法
setParam( key, value) :
自 |
1.7.0 |
---|
参数
- 键
string
参数键- 值
mixed
参数值
响应
mixed
设置参数值
setParameters
获取用户参数的方法
setParameters( params) :
自 |
1.7.0 |
---|
参数
- 参数
object
用户参数对象
响应
空
setProperties
根据命名数组/哈希设置对象属性。
setProperties( properties) :
自 |
1.7.0 |
---|---|
见 | CMSObject::set() |
已弃用 |
4.3.0 将在 6.0 中删除 为属性创建适当的 setter 函数 |
参数
- 属性
mixed
关联数组或其他对象。
响应
bool
属性
_errors
错误消息或 Exception 对象的数组。
自 |
1.7.0 |
---|---|
已弃用 |
3.1.4 JError 已弃用 |
类型
array<string|int, mixed>
isRoot
如果此用户具有 root 访问权限,则为缓存的开关。
自 |
1.7.0 |
---|
类型
bool
id
唯一 ID
自 |
1.7.0 |
---|
类型
int
姓名
用户的真实姓名(或昵称)
自 |
1.7.0 |
---|
类型
string
用户名
登录名
自 |
1.7.0 |
---|
类型
string
电子邮件
电子邮件
自 |
1.7.0 |
---|
类型
string
密码
MD5 加密的密码
自 |
1.7.0 |
---|
类型
string
password_clear
明文密码,仅在为用户设置新密码时可用
自 |
1.7.0 |
---|
类型
string
阻止
阻止状态
自 |
1.7.0 |
---|
类型
int
sendEmail
此用户是否应接收系统电子邮件
自 |
1.7.0 |
---|
类型
int
注册日期
用户注册日期
自 |
1.7.0 |
---|
类型
string
lastvisitDate
上次访问日期
自 |
1.7.0 |
---|
类型
string
激活
激活哈希
自 |
1.7.0 |
---|
类型
string
参数
用户参数
自 |
1.7.0 |
---|
类型
注册表
组
用户名称 => 组 ID 的关联数组
自 |
1.7.0 |
---|
类型
array<string|int, mixed>
访客
访客状态
自 |
1.7.0 |
---|
类型
int
lastResetTime
上次重置时间
自 |
3.0.1 |
---|
类型
string
resetCount
自上次重置时间以来的计数
自 |
3.0.1 |
---|
类型
int
requireReset
要求用户重置密码的标志
自 |
3.2 |
---|
类型
int
typeAlias
类型别名
自 |
5.0.0 |
---|
类型
string
otpKey
otp 密钥
自 |
5.0.0 |
---|
类型
string
otep
otp
自 |
5.0.0 |
---|
类型
string
authProvider
身份验证提供者
自 |
5.0.0 |
---|
类型
string
_params
用户参数
自 |
1.7.0 |
---|
类型
注册表
_authGroups
已授权访问组
自 |
1.7.0 |
---|
类型
array<string|int, mixed>
_authLevels
已授权访问级别
自 |
1.7.0 |
---|
类型
array<string|int, mixed>
_authActions
已授权访问操作
自 |
1.7.0 |
---|
类型
array<string|int, mixed>
_errorMsg
错误消息
自 |
1.7.0 |
---|
类型
string
实例
User 实例容器。
自 |
1.7.3 |
---|
类型
array<string|int, mixed>