PHP Class org\oauth\Driver

Datei anzeigen Open project: top-think/thinkphp-extend Class Usage Examples

Protected Properties

Property Type Description
$apiBase string API根路径
$appKey string 申请应用时分配的app_key
$appSecret string 申请应用时分配的 app_secret
$callback string 回调页面URL 可以通过配置文件配置
$getAccessTokenURL string 获取access_token请求的URL
$getRequestCodeURL string 获取request_code请求的URL
$grantType string grant_type 目前只能为 authorization_code
$responseType string 授权类型 response_type 目前只能为code
$token array 授权后获取到的TOKEN信息
$version string oauth版本

Public Methods

Method Description
__construct ( array $config = [] ) 构造方法,配置应用信息
getAccessToken ( string $code ) 获取access_token
getOauthInfo ( ) 抽象方法 获取当前授权用户的用户信息
getOpenId ( ) 抽象方法,在SNSSDK中实现 获取当前授权用户的SNS标识
getRequestCodeURL ( ) 请求code
login ( $callback = '' ) 跳转到授权登录页面
setToken ( string $token ) 设置access_token

Protected Methods

Method Description
call ( $api, $param = '', $method = 'GET', $multi = false ) 抽象方法,在SNSSDK中实现 组装接口调用参数 并调用接口
http ( string $url, array $params, string $method = 'GET', $header = [], $multi = false ) : array 发送HTTP请求方法,目前只支持CURL发送请求
param ( array $params, array/string $param ) : array: 合并默认参数和额外参数
parseToken ( $result ) 抽象方法,在SNSSDK中实现 解析access_token方法请求后的返回值
url ( string $api, string $fix = '' ) : string 获取指定API请求的URL

Method Details

__construct() public method

构造方法,配置应用信息
public __construct ( array $config = [] )
$config array

call() abstract protected method

抽象方法,在SNSSDK中实现 组装接口调用参数 并调用接口
abstract protected call ( $api, $param = '', $method = 'GET', $multi = false )

getAccessToken() public method

获取access_token
public getAccessToken ( string $code )
$code string 授权登录成功后得到的code信息

getOauthInfo() abstract public method

抽象方法 获取当前授权用户的用户信息
abstract public getOauthInfo ( )

getOpenId() abstract public method

抽象方法,在SNSSDK中实现 获取当前授权用户的SNS标识
abstract public getOpenId ( )

getRequestCodeURL() public method

请求code
public getRequestCodeURL ( )

http() protected method

发送HTTP请求方法,目前只支持CURL发送请求
protected http ( string $url, array $params, string $method = 'GET', $header = [], $multi = false ) : array
$url string 请求URL
$params array 请求参数
$method string 请求方法GET/POST
return array $data 响应数据

login() public method

跳转到授权登录页面
public login ( $callback = '' )

param() protected method

合并默认参数和额外参数
protected param ( array $params, array/string $param ) : array:
$params array 默认参数
$param array/string
return array:

parseToken() abstract protected method

抽象方法,在SNSSDK中实现 解析access_token方法请求后的返回值
abstract protected parseToken ( $result )

setToken() public method

设置access_token
public setToken ( string $token )
$token string

url() protected method

获取指定API请求的URL
protected url ( string $api, string $fix = '' ) : string
$api string API名称
$fix string api后缀
return string 请求的完整URL

Property Details

$apiBase protected_oe property

API根路径
protected string $apiBase
return string

$appKey protected_oe property

申请应用时分配的app_key
protected string $appKey
return string

$appSecret protected_oe property

申请应用时分配的 app_secret
protected string $appSecret
return string

$callback protected_oe property

回调页面URL 可以通过配置文件配置
protected string $callback
return string

$getAccessTokenURL protected_oe property

获取access_token请求的URL
protected string $getAccessTokenURL
return string

$getRequestCodeURL protected_oe property

获取request_code请求的URL
protected string $getRequestCodeURL
return string

$grantType protected_oe property

grant_type 目前只能为 authorization_code
protected string $grantType
return string

$responseType protected_oe property

授权类型 response_type 目前只能为code
protected string $responseType
return string

$token protected_oe property

授权后获取到的TOKEN信息
protected array $token
return array

$version protected_oe property

oauth版本
protected string $version
return string