Documentation

Shake extends BasicWeChat
in

揺一揺周边 Class Shake

Table of Contents

$config 当前微信配置 DataArray
$access_token 访问AccessToken string
$currentMethod 当前请求方法参数 array
$isTry 当前模式 bool
$cache 静态缓存 static
$GetAccessTokenCallback 注册代替函数 string
register() 申请开通功能 array
auditStatus() 查询审核状态 array
createApply() 申请设备ID array
getApplyStatus() 查询设备ID申请审核状态 array
updateApply() 编辑设备信息 array
bindLocation() 配置设备与门店的关联关系 array
search() 查询设备列表 array
createPage() 页面管理 array
updatePage() 编辑页面信息 array
searchPage() 查询页面列表 array
deletePage() 删除页面 array
upload() 上传图片素材 array
bindPage() 配置设备与页面的关联关系 array
queryPage() 查询设备与页面的关联关系 array
totalDevice() 以设备为维度的数据统计接口 array
totalDeviceList() 批量查询设备统计数据接口 array
totalPage() 以页面为维度的数据统计接口 array
updateGroup() 编辑分组信息 array
deleteGroup() 删除分组 array
getGroupList() 查询分组列表 array
getGroupDetail() 查询分组详情 array
addDeviceGroup() 添加设备到分组 array
deleteDeviceGroup() 从分组中移除设备 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

register()

申请开通功能

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

auditStatus()

查询审核状态

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

createApply()

申请设备ID

public createApply( $quantity : string , $apply_reason : string [, $comment : null|string = null ] [, $poi_id : null|string = null ] ) : array
Parameters
$quantity : string

申请的设备ID的数量,单次新增设备超过500个,需走人工审核流程

$apply_reason : string

申请理由,不超过100个汉字或200个英文字母

$comment : null|string = null

备注,不超过15个汉字或30个英文字母

$poi_id : null|string = null

设备关联的门店ID,关联门店后,在门店1KM的范围内有优先摇出信息的机会。

Tags
throws
throws
Return values
array

getApplyStatus()

查询设备ID申请审核状态

public getApplyStatus( $applyId : int ) : array
Parameters
$applyId : int

批次ID,申请设备ID时所返回的批次ID

Tags
throws
throws
Return values
array

updateApply()

编辑设备信息

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

bindLocation()

配置设备与门店的关联关系

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

search()

查询设备列表

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

createPage()

页面管理

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

updatePage()

编辑页面信息

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

searchPage()

查询页面列表

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

deletePage()

删除页面

public deletePage( $page_id : mixed ) : array
Parameters
$page_id : mixed
Tags
throws
throws
Return values
array

upload()

上传图片素材

public upload( $filename : string [, $type : string = 'icon' ] ) : array
Parameters
$filename : string

图片名字

$type : string = 'icon'

Icon:摇一摇页面展示的icon图;License:申请开通摇一摇周边功能时需上传的资质文件;若不传type,则默认type=icon

Tags
throws
throws
Return values
array

bindPage()

配置设备与页面的关联关系

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

queryPage()

查询设备与页面的关联关系

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

totalDevice()

以设备为维度的数据统计接口

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

totalDeviceList()

批量查询设备统计数据接口

public totalDeviceList( $date : int [, $page_index : int = 1 ] ) : array
Parameters
$date : int

指定查询日期时间戳,单位为秒

$page_index : int = 1

指定查询的结果页序号;返回结果按摇周边人数降序排序,每50条记录为一页

Tags
throws
throws
Return values
array

totalPage()

以页面为维度的数据统计接口

public totalPage( $page_id : int , $begin_date : int , $end_date : int ) : array
Parameters
$page_id : int

指定页面的设备ID

$begin_date : int

起始日期时间戳,最长时间跨度为30天,单位为秒

$end_date : int

结束日期时间戳,最长时间跨度为30天,单位为秒

Tags
throws
throws
Return values
array

updateGroup()

编辑分组信息

public updateGroup( $group_id : int , $group_name : string ) : array
Parameters
$group_id : int

分组唯一标识,全局唯一

$group_name : string

分组名称,不超过100汉字或200个英文字母

Tags
throws
throws
Return values
array

deleteGroup()

删除分组

public deleteGroup( $group_id : int ) : array
Parameters
$group_id : int

分组唯一标识,全局唯一

Tags
throws
throws
Return values
array

getGroupList()

查询分组列表

public getGroupList( $begin : int [, $count : int = 10 ] ) : array
Parameters
$begin : int

分组列表的起始索引值

$count : int = 10

待查询的分组数量,不能超过1000个

Tags
throws
throws
Return values
array

getGroupDetail()

查询分组详情

public getGroupDetail( $group_id : int , $begin : int [, $count : int = 100 ] ) : array
Parameters
$group_id : int

分组唯一标识,全局唯一

$begin : int

分组里设备的起始索引值

$count : int = 100

待查询的分组里设备的数量,不能超过1000个

Tags
throws
throws
Return values
array

addDeviceGroup()

添加设备到分组

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

deleteDeviceGroup()

从分组中移除设备

public deleteDeviceGroup( $data : array ) : array
Parameters
$data : array
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