Client
Joomla 框架类，用于与 OAuth 2.0 服务器交互。
| 自 |
1.0 |
|---|---|
| 包 |
Joomla 框架 |
方法
__construct
构造函数。
__construct(array|\ArrayAccess options = [], \Joomla\Http\Http http = null, \Joomla\Input\Input input = null, \Joomla\Application\WebApplicationInterface application = null) :
| 自 |
1.0 |
|---|
参数
- options
array<string|int, mixed>|ArrayAccessOAuth2 客户端选项对象- http
HttpHTTP 客户端对象- input
Input输入对象- application
WebApplicationInterface应用程序对象
Response
mixed
authenticate
获取访问令牌或重定向到身份验证 URL。
authenticate() : array|bool
| 自 |
1.0 |
|---|---|
| 抛出 |
|
Response
array<string|int, mixed>|bool访问令牌或失败时的 false
createUrl
创建身份验证的 URL。
createUrl() :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
Response
string
getOption
从 OAuth2 客户端实例中获取选项。
getOption( key, default = null) :
| 自 |
1.0 |
|---|
参数
- key
string要获取的选项名称- default
mixed可选的默认值，如果请求的选项不存在，则返回。
Response
mixed选项值
getToken
从客户端实例中获取访问令牌。
getToken() : mixed||string|int
| 自 |
1.0 |
|---|
Response
array<string|int, mixed>访问令牌
isAuthenticated
验证客户端是否已通过身份验证
isAuthenticated() :
| 自 |
1.0 |
|---|
Response
bool是否已通过身份验证
query
发送签名的 OAuth 请求。
query( url, data = null, mixed||string|int headers = [], method = 'get', timeout = null) : \Joomla\Http\Response
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- url
string请求的 URL- data
mixed与请求一起发送的关联数组或字符串- headers
array<string|int, mixed>与请求一起发送的标头- method
string用于发送请求的方法- timeout
int请求的超时时间
Response
refreshToken
刷新访问令牌实例。
refreshToken( token = null) : mixed||string|int
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- token
string刷新令牌
Response
array<string|int, mixed>新的访问令牌
setOption
为 OAuth2 客户端实例设置选项。
setOption( key, value) : \Joomla\OAuth2\Client
setToken
为客户端实例设置选项。
setToken(mixed||string|int value) : \Joomla\OAuth2\Client
属性
options
客户端对象的选项。
| 自 |
1.0 |
|---|
类型(s)
array<string|int, mixed>|ArrayAccess