Authentication
Authentication 类，提供 Joomla 身份验证系统的接口
| 自 |
1.7.0 |
|---|---|
| 包 |
Joomla CMS |
方法
__construct
构造函数
__construct( pluginType = 'authentication', \Joomla\Event\DispatcherInterface dispatcher = null) :
| 自 |
1.7.0 |
|---|
参数
- pluginType
string要运行授权和身份验证的插件类型- dispatcher
DispatcherInterface我们将使用的事件调度程序
响应
混合
authenticate
通过要求所有观察对象运行各自的身份验证例程来确定一组登录凭据是否有效。
authenticate(mixed||string|int credentials, mixed||string|int options = []) : \Joomla\CMS\Authentication\AuthenticationResponse
| 参见 | AuthenticationResponse |
|---|---|
| 自 |
1.7.0 |
参数
- credentials
array<string|int, mixed>包含用户凭据的数组。- options
array<string|int, mixed>包含用户选项的数组。
响应
AuthenticationResponse包含最后一个插件或第一个成功插件的 status 变量的响应对象。
authorise
授权特定用户可以登录
authorise(\Joomla\CMS\Authentication\AuthenticationResponse response, mixed||string|int options = []) : \Joomla\CMS\Authentication\AuthenticationResponse||string|int
| 自 |
1.7.0 |
|---|---|
| 抛出 |
|
参数
- response
AuthenticationResponse包含要授权的用户名的响应- options
array<string|int, mixed>选项列表
响应
array<string|int, AuthenticationResponse>身份验证响应对象数组
getInstance
返回全局身份验证对象，仅在它不存在时创建。
getInstance( pluginType = 'authentication') : \Joomla\CMS\Authentication\Authentication
静态
常量
STATUS_SUCCESS
这是身份验证成功（允许登录）时返回的状态代码
| 值 | 1 |
|---|---|
| 自 |
1.7.0 |
类型
int
STATUS_CANCEL
指示身份验证取消（未使用）的状态
| 值 | 2 |
|---|---|
| 自 |
1.7.0 |
类型
int
STATUS_FAILURE
这是身份验证失败（如果未成功则阻止登录）时返回的状态代码
| 值 | 4 |
|---|---|
| 自 |
1.7.0 |
类型
int
STATUS_EXPIRED
这是帐户已过期（阻止登录）时返回的状态代码
| 值 | 8 |
|---|---|
| 自 |
1.7.0 |
类型
int
STATUS_DENIED
这是帐户被拒绝（阻止登录）时返回的状态代码
| 值 | 16 |
|---|---|
| 自 |
1.7.0 |
类型
int
STATUS_UNKNOWN
这是帐户不存在（不是错误）时返回的状态代码
| 值 | 32 |
|---|---|
| 自 |
1.7.0 |
类型
int
属性
pluginType
要运行的插件类型
| 自 |
4.0.0 |
|---|
类型
string