Documentation

Logistics extends BasicWeChat
in

小程序物流助手 Class Logistics

Table of Contents

$config 当前微信配置 DataArray
$access_token 访问AccessToken string
$currentMethod 当前请求方法参数 array
$isTry 当前模式 bool
$cache 静态缓存 static
$GetAccessTokenCallback 注册代替函数 string
addOrder() 生成运单 array
cancelOrder() 取消运单 array
getAllDelivery() 获取支持的快递公司列表 array
getOrder() 获取运单数据 array
getPath() 查询运单轨迹 array
getPrinter() 获取打印员。若需要使用微信打单 PC 软件,才需要调用 array
getQuota() 获取电子面单余额。仅在使用加盟类快递公司时,才可以调用 array
testUpdateOrder() 模拟快递公司更新订单状态, 该接口只能用户测试 array
updatePrinter() 配置面单打印员,若需要使用微信打单 PC 软件,才需要调用 array
getContact() 获取面单联系人信息 array
previewTemplate() 预览面单模板。用于调试面单模板使用 array
updateBusiness() 更新商户审核结果 array
updatePath() 更新运单轨迹 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

addOrder()

生成运单

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

cancelOrder()

取消运单

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

getAllDelivery()

获取支持的快递公司列表

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

getOrder()

获取运单数据

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

getPath()

查询运单轨迹

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

getPrinter()

获取打印员。若需要使用微信打单 PC 软件,才需要调用

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

getQuota()

获取电子面单余额。仅在使用加盟类快递公司时,才可以调用

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

testUpdateOrder()

模拟快递公司更新订单状态, 该接口只能用户测试

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

updatePrinter()

配置面单打印员,若需要使用微信打单 PC 软件,才需要调用

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

getContact()

获取面单联系人信息

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

previewTemplate()

预览面单模板。用于调试面单模板使用

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

updateBusiness()

更新商户审核结果

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

updatePath()

更新运单轨迹

public updatePath( $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