YurunOAuthLogin 微博
目錄
[TOC]
說明
微博登錄授權類
命名空間
Yurun\OAuthLogin\Weibo\OAuth2
屬性
| 名稱 | 類型 | 說明 |
|---|---|---|
| $display | string | 授權頁面的終端類型，取值見微博文檔。http://open.weibo.com/wiki/Oauth2/authorize<br/>; |
| $forcelogin | bool | 是否強制用戶重新登錄，true：是，false：否。默認false。<br/> |
| $language | string | 授權頁語言，缺省為中文簡體版，en為英文版。<br/> |
| $screenName | string | 獲取用戶資料時傳的參數(shù)，可空<br/> |
| $http | Yurun\Until\HttpRequest | http請求類<br/> |
| $appid | string | 應用的唯一標識。<br/> |
| $appSecret | string | appid對應的密鑰<br/> |
| $callbackUrl | string | 登錄回調地址<br/> |
| $state | string | state值，調用getAuthUrl方法后可以獲取到<br/> |
| $scope | array | 授權權限列表<br/> |
| $result | array | 接口調用結果<br/> |
| $accessToken | string | AccessToken，調用相應方法后可以獲取到<br/> |
| $openid | string | openid，調用相應方法后可以獲取到<br/> |
方法
getUrl
獲取url地址<br/>
定義： public function getUrl($name, $params = [])
參數(shù)：
| 名稱 | 類型 | 描述 |
|---|---|---|
| $name | string | 跟在域名后的文本 |
| $params | array | GET參數(shù) |
返回值： string
getAuthUrl
第一步:獲取登錄頁面跳轉url<br/>
定義： public function getAuthUrl($callbackUrl = null, $state = null, $scope = null)
參數(shù)：
| 名稱 | 類型 | 描述 |
|---|---|---|
| $callbackUrl | string | 登錄回調地址 |
| $state | string | 狀態(tài)值，不傳則自動生成，隨后可以通過->state獲取。用于第三方應用防止CSRF攻擊，成功授權后回調時會原樣帶回。一般為每個用戶登錄時隨機生成state存在session中，登錄回調中判斷state是否和session中相同 |
| $scope | array | 請求用戶授權時向用戶顯示的可進行授權的列表。可空 |
返回值： string
getUserInfo
獲取用戶資料<br/>
定義： public function getUserInfo($accessToken = null)
參數(shù)：
| 名稱 | 類型 | 描述 |
|---|---|---|
| $accessToken | string | / |
返回值： array
refreshToken
刷新AccessToken續(xù)期<br/>
定義： public function refreshToken($refreshToken)
參數(shù)：
| 名稱 | 類型 | 描述 |
|---|---|---|
| $refreshToken | string | / |
返回值： bool
validateAccessToken
檢驗授權憑證AccessToken是否有效<br/>
定義： public function validateAccessToken($accessToken = null)
參數(shù)：
| 名稱 | 類型 | 描述 |
|---|---|---|
| $accessToken | string | / |
返回值： bool
__construct
構造方法<br/>
定義： public function __construct($appid, $appSecret, $callbackUrl)
參數(shù)：
| 名稱 | 類型 | 描述 |
|---|---|---|
| $appid | string | 應用的唯一標識 |
| $appSecret | string | appid對應的密鑰 |
| $callbackUrl | string | 登錄回調地址 |
返回值： 無
jsonp_decode
把jsonp轉為php數(shù)組<br/>
定義： public function jsonp_decode($jsonp, $assoc = false)
參數(shù)：
| 名稱 | 類型 | 描述 |
|---|---|---|
| $jsonp | string | jsonp字符串 |
| $assoc | boolean | 當該參數(shù)為true時，將返回array而非object |
返回值： array
checkState
檢測state是否相等<br/>
定義： public function checkState($storeState, $state = null)
參數(shù)：
| 名稱 | 類型 | 描述 |
|---|---|---|
| $storeState | string | 本地存儲的正確的state |
| $state | string | 回調傳遞過來的state |
返回值： bool
getAccessToken
第二步:處理回調并獲取access_token。與getAccessToken不同的是會驗證state值是否匹配，防止csrf攻擊。<br/>
定義： public function getAccessToken($storeState, $code = null, $state = null)
參數(shù)：
| 名稱 | 類型 | 描述 |
|---|---|---|
| $storeState | string | 存儲的正確的state |
| $code | string | 第一步里$redirectUri地址中傳過來的code，為null則通過get參數(shù)獲取 |
| $state | string | 回調接收到的state，為null則通過get參數(shù)獲取 |
返回值： string
更多建議：