Documentation

Script extends BasicWeChat
in

微信前端支持 Class Script

Table of Contents

$config 当前微信配置 DataArray
$access_token 访问AccessToken string
$currentMethod 当前请求方法参数 array
$isTry 当前模式 bool
$cache 静态缓存 static
$GetAccessTokenCallback 注册代替函数 string
delTicket() 删除JSAPI授权TICKET void
getTicket() 获取JSAPI_TICKET接口 string
getJsSign() 获取JsApi使用签名 array
getSignature() 数据生成签名 bool|string
__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

delTicket()

删除JSAPI授权TICKET

public delTicket( [ $type : string = 'jsapi' ] [, $appid : string = null ] ) : void
Parameters
$type : string = 'jsapi'

TICKET类型(wx_card|jsapi)

$appid : string = null

强制指定有效APPID

getTicket()

获取JSAPI_TICKET接口

public getTicket( [ $type : string = 'jsapi' ] [, $appid : string = null ] ) : string
Parameters
$type : string = 'jsapi'

TICKET类型(wx_card|jsapi)

$appid : string = null

强制指定有效APPID

Tags
throws
throws
Return values
string

getJsSign()

获取JsApi使用签名

public getJsSign( $url : string [, $appid : string = null ] [, $ticket : string = null ] ) : array
Parameters
$url : string

网页的URL

$appid : string = null

用于多个appid时使用(可空)

$ticket : string = null

强制指定ticket

Tags
throws
throws
Return values
array

getSignature()

数据生成签名

protected getSignature( $data : array [, $method : string = "sha1" ] [, $params : array = [] ] ) : bool|string
Parameters
$data : array

签名数组

$method : string = "sha1"

签名方法

$params : array = []

签名参数

Return values
bool|string —

签名值

__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