Documentation

Oauth extends BasicWeChat
in

微信网页授权 Class Oauth

Table of Contents

$config 当前微信配置 DataArray
$access_token 访问AccessToken string
$currentMethod 当前请求方法参数 array
$isTry 当前模式 bool
$cache 静态缓存 static
$GetAccessTokenCallback 注册代替函数 string
getOauthRedirect() Oauth 授权跳转接口 string
getOauthAccessToken() 通过 code 获取 AccessToken 和 openid bool|array
getOauthRefreshToken() 刷新AccessToken并续期 bool|array
checkOauthAccessToken() 检验授权凭证(access_token)是否有效 array
getUserInfo() 拉取用户信息(需scope为 snsapi_userinfo) array
__construct() BasicWeChat constructor. mixed
instance() 静态创建对象 static
getAccessToken() 获取访问accessToken string
setAccessToken() 设置外部接口 AccessToken mixed
delAccessToken() 清理删除 AccessToken bool
httpGetForJson() 以GET获取接口数据并转为数组 array
httpPostForJson() 以POST获取接口数据并转为数组 array
registerApi() 注册当前请求接口 mixed
callPostApi() 接口通用POST请求方法 array
callGetApi() 接口通用GET请求方法 array

Properties

$access_token

访问AccessToken

public string $access_token = ''

$currentMethod

当前请求方法参数

protected array $currentMethod = []

$GetAccessTokenCallback

注册代替函数

protected string $GetAccessTokenCallback

Methods

getOauthRedirect()

Oauth 授权跳转接口

public getOauthRedirect( $redirect_url : string [, $state : string = '' ] [, $scope : string = 'snsapi_base' ] ) : string
Parameters
$redirect_url : string

授权回跳地址

$state : string = ''

为重定向后会带上state参数(填写a-zA-Z0-9的参数值,最多128字节)

$scope : string = 'snsapi_base'

授权类类型(可选值snsapi_base|snsapi_userinfo)

Return values
string

getOauthAccessToken()

通过 code 获取 AccessToken 和 openid

public getOauthAccessToken( ) : bool|array
Tags
throws
throws
Return values
bool|array

getOauthRefreshToken()

刷新AccessToken并续期

public getOauthRefreshToken( $refresh_token : string ) : bool|array
Parameters
$refresh_token : string
Tags
throws
throws
Return values
bool|array

checkOauthAccessToken()

检验授权凭证(access_token)是否有效

public checkOauthAccessToken( $access_token : string , $openid : string ) : array
Parameters
$access_token : string

网页授权接口调用凭证,注意:此access_token与基础支持的access_token不同

$openid : string

用户的唯一标识

Tags
throws
throws
Return values
array

getUserInfo()

拉取用户信息(需scope为 snsapi_userinfo)

public getUserInfo( $access_token : string , $openid : string [, $lang : string = 'zh_CN' ] ) : array
Parameters
$access_token : string

网页授权接口调用凭证,注意:此access_token与基础支持的access_token不同

$openid : string

用户的唯一标识

$lang : string = 'zh_CN'

返回国家地区语言版本,zh_CN 简体,zh_TW 繁体,en 英语

Tags
throws
throws
Return values
array

__construct()

BasicWeChat constructor.

public __construct( $options : array ) : mixed
Parameters
$options : array
Return values
mixed

instance()

静态创建对象

public static instance( $config : array ) : static
Parameters
$config : array
Return values
static

getAccessToken()

获取访问accessToken

public getAccessToken( ) : string
Tags
throws
throws
Return values
string

setAccessToken()

设置外部接口 AccessToken

public setAccessToken( $access_token : string ) : mixed
Parameters
$access_token : string
Tags
throws
author

高一平 iam@gaoyiping.com

当用户使用自己的缓存驱动时,直接实例化对象后可直接设置 AccessToekn

  • 多用于分布式项目时保持 AccessToken 统一
  • 使用此方法后就由用户来保证传入的 AccessToekn 为有效 AccessToekn
Return values
mixed

delAccessToken()

清理删除 AccessToken

public delAccessToken( ) : bool
Return values
bool

httpGetForJson()

以GET获取接口数据并转为数组

protected httpGetForJson( $url : string ) : array
Parameters
$url : string

接口地址

Tags
throws
throws
Return values
array

httpPostForJson()

以POST获取接口数据并转为数组

protected httpPostForJson( $url : string , $data : array [, $buildToJson : bool = true ] ) : array
Parameters
$url : string

接口地址

$data : array

请求数据

$buildToJson : bool = true
Tags
throws
throws
Return values
array

registerApi()

注册当前请求接口

protected registerApi( &$url : string , $method : string [, $arguments : array = [] ] ) : mixed
Parameters
$url : string

接口地址

$method : string

当前接口方法

$arguments : array = []

请求参数

Tags
throws
throws
Return values
mixed

callPostApi()

接口通用POST请求方法

public callPostApi( $url : string , $data : array [, $isBuildJson : bool = true ] ) : array
Parameters
$url : string

接口URL

$data : array

POST提交接口参数

$isBuildJson : bool = true
Tags
throws
throws
Return values
array

callGetApi()

接口通用GET请求方法

public callGetApi( $url : string ) : array
Parameters
$url : string

接口URL

Tags
throws
throws
Return values
array

Search results