Documentation

Wifi extends BasicWeChat
in

门店 WIFI 管理 Class Wifi

Table of Contents

$config 当前微信配置 DataArray
$access_token 访问AccessToken string
$currentMethod 当前请求方法参数 array
$isTry 当前模式 bool
$cache 静态缓存 static
$GetAccessTokenCallback 注册代替函数 string
getShopList() 获取 Wi-Fi 门店列表 array
getShopWifi() 查询门店Wi-Fi信息 array
upShopWifi() 修改门店网络信息 array
clearShopWifi() 清空门店网络及设备 array
addShopWifi() 添加密码型设备 array
addShopPortal() 添加portal型设备 array
queryShopWifi() 查询设备 array
delShopWifi() 删除设备 array
getQrc() 获取物料二维码 array
setHomePage() 设置商家主页 array
getHomePage() 查询商家主页 array
setBar() 设置微信首页欢迎语 array
setFinishPage() 设置连网完成页 array
staticList() Wi-Fi 数据统计 array
setCouponput() 设置门店卡券投放信息 array
getCouponput() 查询门店卡券投放信息 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

getShopList()

获取 Wi-Fi 门店列表

public getShopList( [ $pageindex : int = 1 ] [, $pagesize : int = 2 ] ) : array
Parameters
$pageindex : int = 1

分页下标,默认从1开始

$pagesize : int = 2

每页的个数,默认10个,最大20个

Tags
throws
throws
Return values
array

getShopWifi()

查询门店Wi-Fi信息

public getShopWifi( $shop_id : int ) : array
Parameters
$shop_id : int

门店ID

Tags
throws
throws
Return values
array

upShopWifi()

修改门店网络信息

public upShopWifi( $shop_id : int , $old_ssid : string , $ssid : string [, $password : string = null ] ) : array
Parameters
$shop_id : int

门店ID

$old_ssid : string

旧的无线网络设备的ssid

$ssid : string

新的无线网络设备的ssid

$password : string = null

无线网络设备的密码(可选)

Tags
throws
throws
Return values
array

clearShopWifi()

清空门店网络及设备

public clearShopWifi( $shop_id : int ) : array
Parameters
$shop_id : int
Tags
throws
throws
Return values
array

addShopWifi()

添加密码型设备

public addShopWifi( $shop_id : int , $ssid : string [, $password : null|string = null ] ) : array
Parameters
$shop_id : int

门店ID

$ssid : string

无线网络设备的ssid

$password : null|string = null

无线网络设备的密码

Tags
throws
throws
Return values
array

addShopPortal()

添加portal型设备

public addShopPortal( $shop_id : int , $ssid : string [, $reset : bool = false ] ) : array
Parameters
$shop_id : int

门店ID

$ssid : string

无线网络设备的ssid

$reset : bool = false

重置secretkey,false-不重置,true-重置,默认为false

Tags
throws
throws
Return values
array

queryShopWifi()

查询设备

public queryShopWifi( [ $shop_id : null|int = null ] [, $pageindex : null|int = null ] [, $pagesize : null|int = null ] ) : array
Parameters
$shop_id : null|int = null

根据门店id查询

$pageindex : null|int = null

分页下标,默认从1开始

$pagesize : null|int = null

每页的个数,默认10个,最大20个

Tags
throws
throws
Return values
array

delShopWifi()

删除设备

public delShopWifi( $bssid : string ) : array
Parameters
$bssid : string

需要删除的无线网络设备无线mac地址,格式冒号分隔,字符长度17个,并且字母小写,例如:00:1f:7a:ad:5c:a8

Tags
throws
throws
Return values
array

getQrc()

获取物料二维码

public getQrc( $shop_id : int , $ssid : string [, $img_id : int = 1 ] ) : array
Parameters
$shop_id : int

门店ID

$ssid : string

已添加到门店下的无线网络名称

$img_id : int = 1

物料样式编号:0-纯二维码,可用于自由设计宣传材料;1-二维码物料,155mm×215mm(宽×高),可直接张贴

Tags
throws
throws
Return values
array

setHomePage()

设置商家主页

public setHomePage( $shop_id : int , $template_id : int [, $url : null|string = null ] ) : array
Parameters
$shop_id : int

门店ID

$template_id : int

模板ID,0-默认模板,1-自定义url

$url : null|string = null

自定义链接,当template_id为1时必填

Tags
throws
throws
Return values
array

getHomePage()

查询商家主页

public getHomePage( $shop_id : int ) : array
Parameters
$shop_id : int

查询的门店id

Tags
throws
throws
Return values
array

setBar()

设置微信首页欢迎语

public setBar( $shop_id : int [, $bar_type : int = 1 ] ) : array
Parameters
$shop_id : int

门店ID

$bar_type : int = 1

微信首页欢迎语的文本内容:0--欢迎光临+公众号名称;1--欢迎光临+门店名称;2--已连接+公众号名称+WiFi;3--已连接+门店名称+Wi-Fi。

Tags
throws
throws
Return values
array

setFinishPage()

设置连网完成页

public setFinishPage( $shop_id : int , $finishpage_url : string ) : array
Parameters
$shop_id : int

门店ID

$finishpage_url : string

连网完成页URL

Tags
throws
throws
Return values
array

staticList()

Wi-Fi 数据统计

public staticList( $begin_date : string , $end_date : string [, $shop_id : int = -1 ] ) : array
Parameters
$begin_date : string

起始日期时间,格式yyyy-mm-dd,最长时间跨度为30天

$end_date : string

结束日期时间戳,格式yyyy-mm-dd,最长时间跨度为30天

$shop_id : int = -1

按门店ID搜索,-1为总统计

Tags
throws
throws
Return values
array

setCouponput()

设置门店卡券投放信息

public setCouponput( $shop_id : int , $card_id : int , $card_describe : string , $start_time : string , $end_time : string ) : array
Parameters
$shop_id : int

门店ID,可设置为0,表示所有门店

$card_id : int

卡券ID

$card_describe : string

卡券描述,不能超过18个字符

$start_time : string

卡券投放开始时间(单位是秒)

$end_time : string

卡券投放结束时间(单位是秒) 注:不能超过卡券的有效期时间

Tags
throws
throws
Return values
array

getCouponput()

查询门店卡券投放信息

public getCouponput( $shop_id : int ) : array
Parameters
$shop_id : int

门店ID,可设置为0,表示所有门店

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