Client
用于与 OAuth 1.0 和 1.0a 服务器交互的 Joomla 框架类。
| 自版本 |
1.0 |
|---|---|
| 包 |
Joomla 框架 |
方法
__construct
构造函数。
__construct(\Joomla\Application\SessionAwareWebApplicationInterface application, \Joomla\Http\Http client = null, \Joomla\Input\Input input = null, array|\ArrayAccess options = [], version = '1.0a') :
authenticate
用于形成 oauth 流程的方法。
authenticate() : array|null
| 自版本 |
1.0 |
|---|---|
| 抛出异常 |
|
返回值
array<string|int, mixed>|null访问令牌。
authorise
用于授权应用程序的方法。
authorise() :
| 自版本 |
1.1.2 |
|---|
返回值
void
baseString
准备签名基础字符串。
baseString( url, method, mixed||string|int parameters) :
| 自版本 |
1.1.2 |
|---|
参数
- url
string要签名的 URL。- method
string请求方法。- parameters
array<string|int, mixed>包含请求参数的数组。
返回值
string基础字符串。
createHeader
用于为 POST 请求创建标头的方法。
createHeader(mixed||string|int parameters) :
| 自版本 |
1.1.2 |
|---|
参数
- parameters
array<string|int, mixed>包含请求参数的数组。
返回值
string标头。
generateAccessToken
用于获取访问令牌的方法。
generateAccessToken() :
| 自版本 |
1.1.2 |
|---|
返回值
void
generateNonce
用于生成当前 nonce 的方法。
generateNonce() :
| 自版本 |
1.0 |
|---|
返回值
string当前 nonce。
generateRequestToken
用于获取请求令牌的方法。
generateRequestToken() :
| 自版本 |
1.1.2 |
|---|---|
| 抛出异常 |
|
返回值
void
getOption
从 OAuth1 客户端实例获取选项。
getOption( key, default = null) :
| 自版本 |
1.0 |
|---|
参数
- key
string要获取的选项的名称- default
mixed如果选项不存在，则可选的默认值
返回值
mixed选项值
getToken
获取 oauth 令牌密钥或密钥。
getToken() : mixed||string|int
| 自版本 |
1.0 |
|---|
返回值
array<string|int, mixed>oauth 令牌密钥和密钥。
oauthRequest
用于发出 OAuth 请求的方法。
oauthRequest( url, method, mixed||string|int parameters, data = [], mixed||string|int headers = []) : \Joomla\Http\Response
| 自版本 |
1.0 |
|---|---|
| 抛出异常 |
|
参数
- url
string请求 URL。- method
string请求方法。- parameters
array<string|int, mixed>包含请求参数的数组。- data
mixedPOST 请求数据。- headers
array<string|int, mixed>要在请求标头中包含的名称-值对数组
返回值
prepareSigningKey
准备 OAuth 签名密钥。
prepareSigningKey() :
| 自版本 |
1.1.2 |
|---|
返回值
string准备好的签名密钥。
safeEncode
以与 OAuth 兼容的方式编码传入的字符串或数组。
safeEncode(string|string[] data) : string|string[]
如果传递数组，则每个数组值都将被编码。
| 自版本 |
1.0 |
|---|
参数
- data
string|array<string|int, string>要编码的标量或数组。
返回值
string|array<string|int, string>以与 OAuth 兼容的方式编码的 $data。
setOption
为 OAuth1 客户端实例设置选项。
setOption( key, value) :
| 自版本 |
1.0 |
|---|
参数
- key
string要设置的选项的名称- value
mixed要设置的选项值
返回值
$this
setToken
设置 oauth 令牌。
setToken(mixed||string|int token) :
| 自版本 |
1.0 |
|---|
参数
- token
array<string|int, mixed>访问令牌密钥和密钥。
返回值
$this
signRequest
用于签署请求的方法。
signRequest( url, method, mixed||string|int parameters) : mixed||string|int
| 自版本 |
1.1.2 |
|---|
参数
- url
string要签名的 URL。- method
string请求方法。- parameters
array<string|int, mixed>包含请求参数的数组。
返回值
array<string|int, mixed>包含请求参数（包括签名）的数组。
toUrl
用于创建包含参数的 URL 格式化字符串的方法。
toUrl( url, mixed||string|int parameters) :
| 自版本 |
1.0 |
|---|
参数
- url
string请求 URL。- parameters
array<string|int, mixed>包含请求参数的数组。
返回值
string生成的 URL。
validateResponse
用于验证响应的方法。
validateResponse( url, \Joomla\OAuth1\Response response) :
| 自版本 |
1.0 |
|---|---|
| 抛出异常 |
|
参数
- url
string请求 URL。- response
Response要验证的响应。
返回值
void
verifyCredentials
如果身份验证成功，则返回 HTTP 200 OK 响应代码和请求用户的表示；如果失败，则返回 401 状态代码和错误消息。
verifyCredentials() : mixed||string|int
| 自版本 |
1.0 |
|---|
返回值
array<string|int, mixed>解码的 JSON 响应
属性
options
客户端对象的选项。
| 自版本 |
1.0 |
|---|
类型
array<string|int, mixed>|ArrayAccess
token
包含访问令牌密钥、密钥和验证器。
| 自版本 |
1.0 |
|---|
类型
array<string|int, mixed>
version
选择要使用的 OAuth 版本：1.0 或 1.0a。
| 自版本 |
1.0 |
|---|
类型
string