\WechatWechatOauth

微信网页授权

Summary

Methods

Properties

Constants

__construct()
getErrorCode()
getError()
getAppid()
getConfig()
valid()
getAccessToken()
resetAuth()
getOauthRedirect()
getOauthAccessToken()
getOauthRefreshToken()
getOauthUserInfo()
getOauthAuth()

$token
$encodingAesKey
$encrypt_type
$appid
$appsecret
$access_token
$postxml
$_msg
$errCode
$errMsg
$config

API_BASE_URL_PREFIX
API_URL_PREFIX
GET_TICKET_URL
AUTH_URL
OAUTH_PREFIX
OAUTH_AUTHORIZE_URL
OAUTH_TOKEN_URL
OAUTH_REFRESH_URL
OAUTH_USERINFO_URL
OAUTH_AUTH_URL

checkRetry()

No protected properties found

N/A

checkSignature()

$_retry

N/A

File: Wechat/WechatOauth.php
Package: Default
Class hierarchy: \Wechat\Lib\Common

\Wechat\WechatOauth

Constants

API_BASE_URL_PREFIX

API_BASE_URL_PREFIX = 'https://api.weixin.qq.com'

API接口URL需要使用此前缀

API_URL_PREFIX

API_URL_PREFIX = 'https://api.weixin.qq.com/cgi-bin'

GET_TICKET_URL

GET_TICKET_URL = '/ticket/getticket?'

AUTH_URL

AUTH_URL = '/token?grant_type=client_credential&'

OAUTH_PREFIX

OAUTH_PREFIX = 'https://open.weixin.qq.com/connect/oauth2'

OAUTH_AUTHORIZE_URL

OAUTH_AUTHORIZE_URL = '/authorize?'

OAUTH_TOKEN_URL

OAUTH_TOKEN_URL = '/sns/oauth2/access_token?'

OAUTH_REFRESH_URL

OAUTH_REFRESH_URL = '/sns/oauth2/refresh_token?'

OAUTH_USERINFO_URL

OAUTH_USERINFO_URL = '/sns/userinfo?'

OAUTH_AUTH_URL

OAUTH_AUTH_URL = '/sns/auth?'

Properties

$token

$token :

Type

$encodingAesKey

$encodingAesKey :

Type

$encrypt_type

$encrypt_type :

Type

$appid

$appid :

Type

$appsecret

$appsecret :

Type

$access_token

$access_token :

Type

$postxml

$postxml :

Type

$_msg

$_msg :

Type

$errCode

$errCode :

Type

$errMsg

$errMsg :

Type

$config

$config :

Type

$_retry

$_retry :

Type

Methods

__construct()

__construct(array  $options = array())

构造方法

Parameters

array

$options

getErrorCode()

getErrorCode() : integer

当前当前错误代码

Returns

integer

getError()

getError() : string

获取当前错误内容

Returns

string

getAppid()

getAppid() : string

获取当前操作公众号APPID

Returns

string

getConfig()

getConfig() : array

获取SDK配置参数

Returns

array

valid()

valid() : boolean

接口验证

Returns

boolean

getAccessToken()

getAccessToken(string  $appid = '', string  $appsecret = '', string  $token = '') : boolean|string

获取公众号访问 access_token

Parameters

string	$appid	如在类初始化时已提供，则可为空
string	$appsecret	如在类初始化时已提供，则可为空
string	$token	手动指定access_token，非必要情况不建议用

Returns

boolean|string

resetAuth()

resetAuth(string  $appid = '') : boolean

删除验证数据

Parameters

string

$appid

如在类初始化时已提供，则可为空

Returns

boolean

getOauthRedirect()

getOauthRedirect(string  $callback, string  $state = '', string  $scope = 'snsapi_base') : string

Oauth 授权跳转接口

Parameters

string	$callback	授权回跳地址
string	$state	为重定向后会带上state参数（填写a-zA-Z0-9的参数值，最多128字节）
string	$scope	授权类类型(可选值snsapi_base\|snsapi_userinfo)

Returns

string

getOauthAccessToken()

getOauthAccessToken() : boolean|array

通过 code 获取 AccessToken 和 openid

Returns

boolean|array

getOauthRefreshToken()

getOauthRefreshToken(string  $refresh_token) : boolean|array

刷新access token并续期

Parameters

string

$refresh_token

Returns

boolean|array

getOauthUserInfo()

getOauthUserInfo(string  $access_token, string  $openid) : boolean|array

获取授权后的用户资料

Parameters

string	$access_token
string	$openid

Returns

boolean|array —

{openid,nickname,sex,province,city,country,headimgurl,privilege,[unionid]} 注意：unionid字段只有在用户将公众号绑定到微信开放平台账号后，才会出现。建议调用前用isset()检测一下

getOauthAuth()

getOauthAuth(string  $access_token, string  $openid) : boolean

检验授权凭证是否有效

Parameters

string	$access_token
string	$openid

Returns

boolean —

是否有效

checkRetry()

checkRetry(string  $method, array  $arguments = array()) : boolean|mixed

接口失败重试

Parameters

string	$method	SDK方法名称
array	$arguments	SDK方法参数

Returns

boolean|mixed

checkSignature()

checkSignature(string  $str = '') : boolean

验证来自微信服务器

Parameters

string

$str

Returns

boolean