\WeMiniLogistics

小程序物流助手 Class Logistics

Summary

Methods

Properties

Constants

__construct()
instance()
getAccessToken()
setAccessToken()
delAccessToken()
callPostApi()
callGetApi()
addOrder()
cancelOrder()
getAllDelivery()
getOrder()
getPath()
getPrinter()
getQuota()
testUpdateOrder()
updatePrinter()
getContact()
previewTemplate()
updateBusiness()
updatePath()

$config
$access_token

No constants found

httpGetForJson()
httpPostForJson()
registerApi()

$currentMethod
$isTry
$cache
$GetAccessTokenCallback

N/A

No private methods found

No private properties found

N/A

Properties

$config

$config : \WeChat\Contracts\DataArray

当前微信配置

Type

\WeChat\Contracts\DataArray

$access_token

$access_token : string

访问AccessToken

Type

string

$currentMethod

$currentMethod : array

当前请求方法参数

Type

array

$isTry

$isTry : boolean

当前模式

Type

boolean

$cache

$cache : static

静态缓存

Type

static

$GetAccessTokenCallback

$GetAccessTokenCallback : string

注册代替函数

Type

string

Methods

__construct()

__construct(array  $options)

BasicWeChat constructor.

Parameters

array

$options

instance()

instance(array  $config) : static

静态创建对象

Parameters

array

$config

Returns

static

getAccessToken()

getAccessToken() : string

获取访问 AccessToken

Throws

\WeChat\Exceptions\InvalidResponseException
\WeChat\Exceptions\LocalCacheException

Returns

string

setAccessToken()

setAccessToken(string  $accessToken)

设置外部接口 AccessToken

Parameters

string

$accessToken

Throws

\WeChat\Exceptions\LocalCacheException

Inherited from: \WeChat\Contracts\BasicWeChat

Tags

author

高一平 iam@gaoyiping.com

当用户使用自己的缓存驱动时，直接实例化对象后可直接设置 AccessToken

多用于分布式项目时保持 AccessToken 统一
使用此方法后就由用户来保证传入的 AccessToken 为有效 AccessToken

delAccessToken()

delAccessToken() : boolean

清理删除 AccessToken

Returns

boolean

callPostApi()

callPostApi(string  $url, array  $data, boolean  $isBuildJson = true) : array

接口通用POST请求方法

Parameters

string	$url	接口URL
array	$data	POST提交接口参数
boolean	$isBuildJson

Throws

\WeChat\Exceptions\InvalidResponseException
\WeChat\Exceptions\LocalCacheException

Returns

array

callGetApi()

callGetApi(string  $url) : array

接口通用GET请求方法

Parameters

string

$url

接口URL

Throws

\WeChat\Exceptions\InvalidResponseException
\WeChat\Exceptions\LocalCacheException

Returns

array

addOrder()

addOrder(array  $data) : array

生成运单

Parameters

array

$data

Throws

\WeChat\Exceptions\InvalidResponseException
\WeChat\Exceptions\LocalCacheException

Returns

array

cancelOrder()

cancelOrder(array  $data) : array

取消运单

Parameters

array

$data

Throws

\WeChat\Exceptions\InvalidResponseException
\WeChat\Exceptions\LocalCacheException

Returns

array

getAllDelivery()

getAllDelivery() : array

获取支持的快递公司列表

Throws

\WeChat\Exceptions\InvalidResponseException
\WeChat\Exceptions\LocalCacheException

Returns

array

getOrder()

getOrder(array  $data) : array

获取运单数据

Parameters

array

$data

Throws

\WeChat\Exceptions\InvalidResponseException
\WeChat\Exceptions\LocalCacheException

Returns

array

getPath()

getPath(array  $data) : array

查询运单轨迹

Parameters

array

$data

Throws

\WeChat\Exceptions\InvalidResponseException
\WeChat\Exceptions\LocalCacheException

Returns

array

getPrinter()

getPrinter() : array

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

Throws

\WeChat\Exceptions\InvalidResponseException
\WeChat\Exceptions\LocalCacheException

Returns

array

getQuota()

getQuota(array  $data) : array

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

Parameters

array

$data

Throws

\WeChat\Exceptions\InvalidResponseException
\WeChat\Exceptions\LocalCacheException

Returns

array

testUpdateOrder()

testUpdateOrder(array  $data) : array

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

Parameters

array

$data

Throws

\WeChat\Exceptions\InvalidResponseException
\WeChat\Exceptions\LocalCacheException

Returns

array

updatePrinter()

updatePrinter(array  $data) : array

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

Parameters

array

$data

Throws

\WeChat\Exceptions\InvalidResponseException
\WeChat\Exceptions\LocalCacheException

Returns

array

getContact()

getContact(array  $data) : array

获取面单联系人信息

Parameters

array

$data

Throws

\WeChat\Exceptions\InvalidResponseException
\WeChat\Exceptions\LocalCacheException

Returns

array

previewTemplate()

previewTemplate(array  $data) : array

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

Parameters

array

$data

Throws

\WeChat\Exceptions\InvalidResponseException
\WeChat\Exceptions\LocalCacheException

Returns

array

updateBusiness()

updateBusiness(array  $data) : array

更新商户审核结果

Parameters

array

$data

Throws

\WeChat\Exceptions\InvalidResponseException
\WeChat\Exceptions\LocalCacheException

Returns

array

updatePath()

updatePath(array  $data) : array

更新运单轨迹

Parameters

array

$data

Throws

\WeChat\Exceptions\InvalidResponseException
\WeChat\Exceptions\LocalCacheException

Returns

array

httpGetForJson()

httpGetForJson(string  $url) : array

以GET获取接口数据并转为数组

Parameters

string

$url

接口地址

Throws

\WeChat\Exceptions\InvalidResponseException
\WeChat\Exceptions\LocalCacheException

Returns

array

httpPostForJson()

httpPostForJson(string  $url, array  $data, boolean  $buildToJson = true) : array

以POST获取接口数据并转为数组

Parameters

string	$url	接口地址
array	$data	请求数据
boolean	$buildToJson

Throws

\WeChat\Exceptions\InvalidResponseException
\WeChat\Exceptions\LocalCacheException

Returns

array

registerApi()

registerApi(string  $url, string  $method, array  $arguments = array()) : string

注册当前请求接口

Parameters

string	$url	接口地址
string	$method	当前接口方法
array	$arguments	请求参数

Throws

\WeChat\Exceptions\InvalidResponseException
\WeChat\Exceptions\LocalCacheException

Returns

string