Properties

$access_token

$access_token : string

访问AccessToken

Type

string

$currentMethod

$currentMethod : array

当前请求方法参数

Type

array

$isTry

$isTry : boolean

当前模式

Type

boolean

$cache

$cache : static

静态缓存

Type

static

$GetAccessTokenCallback

$GetAccessTokenCallback : string

注册代替函数

Type

string

Methods

__construct()

__construct(array  $options) 

BasicWeChat constructor.

Parameters

array $options

instance()

instance(array  $config) : static

静态创建对象

Parameters

array $config

Returns

static

getAccessToken()

getAccessToken() : string

获取访问 AccessToken

Throws

\WeChat\Exceptions\InvalidResponseException
\WeChat\Exceptions\LocalCacheException

Returns

string

setAccessToken()

setAccessToken(string  $accessToken) 

设置外部接口 AccessToken

Parameters

string $accessToken

Throws

\WeChat\Exceptions\LocalCacheException

delAccessToken()

delAccessToken() : boolean

清理删除 AccessToken

Returns

boolean

callPostApi()

callPostApi(string  $url, array  $data, boolean  $isBuildJson = true) : array

接口通用POST请求方法

Parameters

string $url

接口URL

array $data

POST提交接口参数

boolean $isBuildJson

Throws

\WeChat\Exceptions\InvalidResponseException
\WeChat\Exceptions\LocalCacheException

Returns

array

callGetApi()

callGetApi(string  $url) : array

接口通用GET请求方法

Parameters

string $url

接口URL

Throws

\WeChat\Exceptions\InvalidResponseException
\WeChat\Exceptions\LocalCacheException

Returns

array

decode()

decode(string  $iv, string  $sessionKey, string  $encryptedData) : boolean

数据签名校验

Parameters

string $iv
string $sessionKey
string $encryptedData

Returns

boolean

session()

session(string  $code) : array

登录凭证校验

Parameters

string $code

登录时获取的 code

Throws

\WeChat\Exceptions\LocalCacheException

Returns

array

userInfo()

userInfo(string  $code, string  $iv, string  $encryptedData) : array

换取用户信息

Parameters

string $code

用户登录凭证(有效期五分钟)

string $iv

加密算法的初始向量

string $encryptedData

加密数据( encryptedData )

Throws

\WeChat\Exceptions\InvalidDecryptException
\WeChat\Exceptions\InvalidResponseException
\WeChat\Exceptions\LocalCacheException

Returns

array

getPaidUnionId()

getPaidUnionId(string  $openid, null|string  $transaction_id = null, null|string  $mch_id = null, null|string  $out_trade_no = null) : array

用户支付完成后,获取该用户的 UnionId

Parameters

string $openid

支付用户唯一标识

null|string $transaction_id

微信支付订单号

null|string $mch_id

微信支付分配的商户号,和商户订单号配合使用

null|string $out_trade_no

微信支付商户订单号,和商户号配合使用

Throws

\WeChat\Exceptions\InvalidResponseException
\WeChat\Exceptions\LocalCacheException

Returns

array

httpGetForJson()

httpGetForJson(string  $url) : array

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

Parameters

string $url

接口地址

Throws

\WeChat\Exceptions\InvalidResponseException
\WeChat\Exceptions\LocalCacheException

Returns

array

httpPostForJson()

httpPostForJson(string  $url, array  $data, boolean  $buildToJson = true) : array

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

Parameters

string $url

接口地址

array $data

请求数据

boolean $buildToJson

Throws

\WeChat\Exceptions\InvalidResponseException
\WeChat\Exceptions\LocalCacheException

Returns

array

registerApi()

registerApi(string  $url, string  $method, array  $arguments = array()) : string

注册当前请求接口

Parameters

string $url

接口地址

string $method

当前接口方法

array $arguments

请求参数

Throws

\WeChat\Exceptions\InvalidResponseException
\WeChat\Exceptions\LocalCacheException

Returns

string