Properties

$access_token

$access_token : string

访问AccessToken

Type

string

$currentMethod

$currentMethod : array

当前请求方法参数

Type

array

$isTry

$isTry : boolean

当前模式

Type

boolean

$GetAccessTokenCallback

$GetAccessTokenCallback : string

注册代替函数

Type

string

Methods

__construct()

__construct(array  $options) 

BasicWeChat constructor.

Parameters

array $options

getAccessToken()

getAccessToken() : string

获取访问accessToken

Throws

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

Returns

string

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

commit()

commit(string  $templateId, string  $extJson, string  $userVersion, string  $userDesc) : array

1. 为授权的小程序帐号上传小程序代码

Parameters

string $templateId

代码库中的代码模版ID

string $extJson

第三方自定义的配置

string $userVersion

代码版本号,开发者可自定义

string $userDesc

代码描述,开发者可自定义

Throws

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

Returns

array

getQrcode()

getQrcode(null|string  $path = null, null|string  $outType = null) : array|boolean|string

2. 获取体验小程序的体验二维码

Parameters

null|string $path

指定体验版二维码跳转到某个具体页面

null|string $outType

指定输出类型

Throws

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

Returns

array|boolean|string

getCategory()

getCategory() : array

3. 获取授权小程序帐号的可选类目

Throws

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

Returns

array

getPage()

getPage() : array

4. 获取小程序的第三方提交代码的页面配置(仅供第三方开发者代小程序调用)

Throws

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

Returns

array

submitAudit()

submitAudit(array  $itemList) : array

5. 将第三方提交的代码包提交审核(仅供第三方开发者代小程序调用)

Parameters

array $itemList

提交审核项的一个列表

Throws

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

Returns

array

getNotify()

getNotify() : array

6. 获取审核结果

Returns

array

getAuditstatus()

getAuditstatus(string  $auditid) : array

7. 查询某个指定版本的审核状态(仅供第三方代小程序调用)

Parameters

string $auditid

提交审核时获得的审核id

Throws

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

Returns

array

getLatestAuditatus()

getLatestAuditatus() : array

8、查询最新一次提交的审核状态(仅供第三方代小程序调用)

Throws

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

Returns

array

publishRelease()

publishRelease() : array

9、发布已通过审核的小程序(仅供第三方代小程序调用)

Throws

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

Returns

array

changeVisitStatus()

changeVisitStatus(string  $action) : array

10、修改小程序线上代码的可见状态(仅供第三方代小程序调用)

Parameters

string $action

设置可访问状态,发布后默认可访问,close为不可见,open为可见

Throws

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

Returns

array

revertCodeRelease()

revertCodeRelease() : array

11. 小程序版本回退(仅供第三方代小程序调用)

Throws

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

Returns

array

getWeappSupportVersion()

getWeappSupportVersion() : array

12. 查询当前设置的最低基础库版本及各版本用户占比 (仅供第三方代小程序调用)

Throws

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

Returns

array

setWeappSupportVersion()

setWeappSupportVersion(string  $version) : array

13. 设置最低基础库版本(仅供第三方代小程序调用)

Parameters

string $version

版本

Throws

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

Returns

array

addQrcodeJump()

addQrcodeJump(array  $data) : array

14. 设置小程序“扫普通链接二维码打开小程序”能力 (1) 增加或修改二维码规则

Parameters

array $data

Throws

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

Returns

array

getQrcodeJump()

getQrcodeJump(array  $data) : array

14. 设置小程序“扫普通链接二维码打开小程序”能力 (2) 获取已设置的二维码规则

Parameters

array $data

Throws

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

Returns

array

downloadQrcodeJump()

downloadQrcodeJump() : array

14. 设置小程序“扫普通链接二维码打开小程序”能力 (3)获取校验文件名称及内容

Throws

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

Returns

array

deleteQrcodeJump()

deleteQrcodeJump(string  $prefix) : array

14. 设置小程序“扫普通链接二维码打开小程序”能力 (4)删除已设置的二维码规则

Parameters

string $prefix

二维码规则

Throws

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

Returns

array

publishQrcodeJump()

publishQrcodeJump(string  $prefix) : array

14. 设置小程序“扫普通链接二维码打开小程序”能力 (5)发布已设置的二维码规则

Parameters

string $prefix

二维码规则

Throws

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

Returns

array

undoCodeAudit()

undoCodeAudit() : array

16. 小程序审核撤回

Throws

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

Returns

array

grayRelease()

grayRelease(integer  $gray_percentage) : array

17.小程序分阶段发布 (1)分阶段发布接口

Parameters

integer $gray_percentage

灰度的百分比,1到100的整数

Throws

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

Returns

array

revertGrayRelease()

revertGrayRelease() : array

17.小程序分阶段发布 (2)取消分阶段发布

Throws

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

Returns

array

getGrayreLeasePlan()

getGrayreLeasePlan() : array

17.小程序分阶段发布 (3)查询当前分阶段发布详情

Throws

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

Returns

array

httpGetForJson()

httpGetForJson(string  $url) : array

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

Parameters

string $url

接口地址

Throws

\WeChat\Exceptions\InvalidResponseException

Returns

array

httpPostForJson()

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

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

Parameters

string $url

接口地址

array $data

请求数据

boolean $buildToJson

Throws

\WeChat\Exceptions\InvalidResponseException

Returns

array

registerApi()

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

注册当前请求接口

Parameters

string $url

接口地址

string $method

当前接口方法

array $arguments

请求参数

Throws

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

Returns

mixed