Documentation

Scan extends BasicWeChat
in

扫一扫接入管理 Class Scan

Table of Contents

$config 当前微信配置 DataArray
$access_token 访问AccessToken string
$currentMethod 当前请求方法参数 array
$isTry 当前模式 bool
$cache 静态缓存 static
$GetAccessTokenCallback 注册代替函数 string
getMerchantInfo() 获取商户信息 array
addProduct() 创建商品 array
modProduct() 商品发布 array
setTestWhiteList() 设置测试人员白名单 array
getQrc() 获取商品二维码 array
getProductInfo() 查询商品信息 array
getProductList() 批量查询商品信息 array
updateProduct() 更新商品信息 array
clearProduct() 清除商品信息 array
checkTicket() 检查wxticket参数 array
clearScanTicket() 清除扫码记录 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

getMerchantInfo()

获取商户信息

public getMerchantInfo( ) : array
Tags
throws
throws
Return values
array

addProduct()

创建商品

public addProduct( $data : array ) : array
Parameters
$data : array
Tags
throws
throws
Return values
array

modProduct()

商品发布

public modProduct( $keystandard : string , $keystr : string [, $status : string = 'on' ] ) : array
Parameters
$keystandard : string

商品编码标准

$keystr : string

商品编码内容

$status : string = 'on'

设置发布状态。on为提交审核,off为取消发布

Tags
throws
throws
Return values
array

setTestWhiteList()

设置测试人员白名单

public setTestWhiteList( [ $openids : array = [] ] [, $usernames : array = [] ] ) : array
Parameters
$openids : array = []

测试人员的openid列表

$usernames : array = []

测试人员的微信号列表

Tags
throws
throws
Return values
array

getQrc()

获取商品二维码

public getQrc( $keystandard : string , $keystr : string [, $extinfo : null|string = null ] [, $qrcode_size : int = 64 ] ) : array
Parameters
$keystandard : string
$keystr : string
$extinfo : null|string = null
$qrcode_size : int = 64
Tags
throws
throws
Return values
array

getProductInfo()

查询商品信息

public getProductInfo( $keystandard : string , $keystr : string ) : array
Parameters
$keystandard : string

商品编码标准

$keystr : string

商品编码内容

Tags
throws
throws
Return values
array

getProductList()

批量查询商品信息

public getProductList( [ $offset : int = 1 ] [, $limit : int = 10 ] [, $status : string = null ] [, $keystr : string = null ] ) : array
Parameters
$offset : int = 1

批量查询的起始位置,从0开始,包含该起始位置。

$limit : int = 10

批量查询的数量。

$status : string = null

支持按状态拉取。on为发布状态,off为未发布状态,check为审核中状态,reject为审核未通过状态,all为所有状态。

$keystr : string = null

支持按部分编码内容拉取。填写该参数后,可将编码内容中包含所传参数的商品信息拉出。类似关键词搜索。

Tags
throws
throws
Return values
array

updateProduct()

更新商品信息

public updateProduct( $data : array ) : array
Parameters
$data : array
Tags
throws
throws
Return values
array

clearProduct()

清除商品信息

public clearProduct( $keystandard : string , $keystr : string ) : array
Parameters
$keystandard : string

商品编码标准

$keystr : string

商品编码内容

Tags
throws
throws
Return values
array

checkTicket()

检查wxticket参数

public checkTicket( $ticket : string ) : array
Parameters
$ticket : string
Tags
throws
throws
Return values
array

clearScanTicket()

清除扫码记录

public clearScanTicket( $keystandard : string , $keystr : string , $extinfo : string ) : array
Parameters
$keystandard : string

商品编码标准

$keystr : string

商品编码内容

$extinfo : string

调用“获取商品二维码接口”时传入的extinfo,为标识参数

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