Documentation

Card extends BasicWeChat
in

卡券管理 Class Card

Table of Contents

$config 当前微信配置 DataArray
$access_token 访问AccessToken string
$currentMethod 当前请求方法参数 array
$isTry 当前模式 bool
$cache 静态缓存 static
$GetAccessTokenCallback 注册代替函数 string
create() 创建卡券 array
setPaycell() 设置买单接口 array
setConsumeCell() 设置自助核销接口 array
createQrc() 创建二维码接口 array
createLandingPage() 创建货架接口 array
deposit() 导入自定义code array
getDepositCount() 查询导入code数目 array
checkCode() 核查code接口 array
getNewsHtml() 图文消息群发卡券 array
setTestWhiteList() 设置测试白名单 array
getCode() 线下核销查询Code array
consume() 线下核销核销Code array
decrypt() Code解码接口 array
getCardList() 获取用户已领取卡券接口 array
getCard() 查看卡券详情 array
batchGet() 批量查询卡券列表 array
updateCard() 更改卡券信息接口 array
modifyStock() 修改库存接口 array
updateCode() 更改Code接口 array
deleteCard() 删除卡券接口 array
unAvailable() 设置卡券失效接口 array
getCardBizuininfo() 拉取卡券概况数据接口 array
getCardCardinfo() 获取免费券数据接口 array
activateMemberCard() 激活会员卡 array
setActivateMemberCardUser() 设置开卡字段接口 用户激活时需要填写的选项 array
getActivateMemberCardTempinfo() 获取用户提交资料 根据activate_ticket获取到用户填写的信息 array
updateMemberCardUser() 更新会员信息 array
getCardMemberCardinfo() 拉取会员卡概况数据接口 array
getCardMemberCardDetail() 拉取单张会员卡数据接口 array
getCardMemberCard() 拉取会员信息（积分查询）接口 array
payGiftCard() 设置支付后投放卡券接口 array
delPayGiftCard() 删除支付后投放卡券规则 array
getPayGiftCard() 查询支付后投放卡券规则详情 array
batchGetPayGiftCard() 批量查询支付后投放卡券规则 array
addActivity() 创建支付后领取立减金活动 array
payActivate() 开通券点账户接口 array
getPayprice() 对优惠券批价 array
getCoinsInfo() 查询券点余额接口 array
payConfirm() 确认兑换库存接口 array
payRecharge() 充值券点接口 array
payGetOrder() 查询订单详情接口 array
payGetList() 查询券点流水详情接口 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

create()

创建卡券

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

setPaycell()

设置买单接口

public setPaycell( $card_id : string [, $is_open : bool = true ] ) : array
Parameters
$card_id : string
$is_open : bool = true
Tags
throws
throws
Return values
array

setConsumeCell()

设置自助核销接口

public setConsumeCell( $card_id : string [, $is_open : bool = true ] ) : array
Parameters
$card_id : string
$is_open : bool = true
Tags
throws
throws
Return values
array

createQrc()

创建二维码接口

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

createLandingPage()

创建货架接口

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

deposit()

导入自定义code

public deposit( $card_id : string , $code : array ) : array
Parameters
$card_id : string
$code : array
Tags
throws
throws
Return values
array

getDepositCount()

查询导入code数目

public getDepositCount( $card_id : string ) : array
Parameters
$card_id : string
Tags
throws
throws
Return values
array

checkCode()

核查code接口

public checkCode( $card_id : string , $code : array ) : array
Parameters
$card_id : string

进行导入code的卡券ID

$code : array

已经微信卡券后台的自定义code，上限为100个

Tags
throws
throws
Return values
array

getNewsHtml()

图文消息群发卡券

public getNewsHtml( $card_id : string ) : array
Parameters
$card_id : string
Tags
throws
throws
Return values
array

setTestWhiteList()

设置测试白名单

public setTestWhiteList( [ $openids : array = [] ] [, $usernames : array = [] ] ) : array
Parameters
$openids : array = []
$usernames : array = []
Tags
throws
throws
Return values
array

getCode()

线下核销查询Code

public getCode( $code : string [, $card_id : string = null ] [, $check_consume : bool = null ] ) : array
Parameters
$code : string

单张卡券的唯一标准

$card_id : string = null

卡券ID代表一类卡券。自定义code卡券必填

$check_consume : bool = null

是否校验code核销状态，填入true和false时的code异常状态返回数据不同

Tags
throws
throws
Return values
array

consume()

线下核销核销Code

public consume( $code : string [, $card_id : null = null ] ) : array
Parameters
$code : string

需核销的Code码

$card_id : null = null

券ID。创建卡券时use_custom_code填写true时必填。非自定义Code不必填写

Tags
throws
throws
Return values
array

decrypt()

Code解码接口

public decrypt( $encrypt_code : string ) : array
Parameters
$encrypt_code : string
Tags
throws
throws
Return values
array

getCardList()

获取用户已领取卡券接口

public getCardList( $openid : string [, $card_id : null|string = null ] ) : array
Parameters
$openid : string
$card_id : null|string = null
Tags
throws
throws
Return values
array

getCard()

查看卡券详情

public getCard( $card_id : string ) : array
Parameters
$card_id : string
Tags
throws
throws
Return values
array

batchGet()

批量查询卡券列表

public batchGet( $offset : int [, $count : int = 50 ] [, $status_list : array = [] ] ) : array
Parameters
$offset : int

查询卡列表的起始偏移量，从0开始，即offset: 5是指从从列表里的第六个开始读取

$count : int = 50

需要查询的卡片的数量（数量最大50）

$status_list : array = []

支持开发者拉出指定状态的卡券列表

Tags
throws
throws
Return values
array

updateCard()

更改卡券信息接口

public updateCard( $card_id : string , $member_card : array ) : array
Parameters
$card_id : string
$member_card : array
Tags
throws
throws
Return values
array

modifyStock()

修改库存接口

public modifyStock( $card_id : string [, $increase_stock_value : null|int = null ] [, $reduce_stock_value : null|int = null ] ) : array
Parameters
$card_id : string

卡券ID

$increase_stock_value : null|int = null

增加多少库存，支持不填或填0

$reduce_stock_value : null|int = null

减少多少库存，可以不填或填0

Tags
throws
throws
Return values
array

updateCode()

更改Code接口

public updateCode( $code : string , $new_code : string [, $card_id : null|string = null ] ) : array
Parameters
$code : string

需变更的Code码

$new_code : string

变更后的有效Code码

$card_id : null|string = null

卡券ID

Tags
throws
throws
Return values
array

deleteCard()

删除卡券接口

public deleteCard( $card_id : string ) : array
Parameters
$card_id : string
Tags
throws
throws
Return values
array

unAvailable()

设置卡券失效接口

public unAvailable( $code : string , $card_id : string [, $reason : null|string = null ] ) : array
Parameters
$code : string
$card_id : string
$reason : null|string = null
Tags
throws
throws
Return values
array

getCardBizuininfo()

拉取卡券概况数据接口

public getCardBizuininfo( $begin_date : string , $end_date : string , $cond_source : string ) : array
Parameters
$begin_date : string

查询数据的起始时间

$end_date : string

查询数据的截至时间

$cond_source : string

卡券来源(0为公众平台创建的卡券数据 1是API创建的卡券数据)

Tags
throws
throws
Return values
array

getCardCardinfo()

获取免费券数据接口

public getCardCardinfo( $begin_date : string , $end_date : string , $cond_source : int [, $card_id : null = null ] ) : array
Parameters
$begin_date : string

查询数据的起始时间

$end_date : string

查询数据的截至时间

$cond_source : int

卡券来源，0为公众平台创建的卡券数据、1是API创建的卡券数据

$card_id : null = null

卡券ID

Tags
throws
throws
Return values
array

activateMemberCard()

激活会员卡

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

setActivateMemberCardUser()

设置开卡字段接口 用户激活时需要填写的选项

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

getActivateMemberCardTempinfo()

获取用户提交资料 根据activate_ticket获取到用户填写的信息

public getActivateMemberCardTempinfo( $activate_ticket : string ) : array
Parameters
$activate_ticket : string
Tags
throws
throws
Return values
array

updateMemberCardUser()

更新会员信息

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

getCardMemberCardinfo()

拉取会员卡概况数据接口

public getCardMemberCardinfo( $begin_date : string , $end_date : string , $cond_source : string ) : array
Parameters
$begin_date : string

查询数据的起始时间

$end_date : string

查询数据的截至时间

$cond_source : string

卡券来源(0为公众平台创建的卡券数据 1是API创建的卡券数据)

Tags
throws
throws
Return values
array

getCardMemberCardDetail()

拉取单张会员卡数据接口

public getCardMemberCardDetail( $begin_date : string , $end_date : string , $card_id : string ) : array
Parameters
$begin_date : string

查询数据的起始时间

$end_date : string

查询数据的截至时间

$card_id : string

卡券id

Tags
throws
throws
Return values
array

getCardMemberCard()

拉取会员信息（积分查询）接口

public getCardMemberCard( $card_id : string , $code : string ) : array
Parameters
$card_id : string

查询会员卡的cardid

$code : string

所查询用户领取到的code值

Tags
throws
throws
Return values
array

payGiftCard()

设置支付后投放卡券接口

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

delPayGiftCard()

删除支付后投放卡券规则

public delPayGiftCard( $rule_id : int ) : array
Parameters
$rule_id : int

支付即会员的规则名称

Tags
throws
throws
Return values
array

getPayGiftCard()

查询支付后投放卡券规则详情

public getPayGiftCard( $rule_id : int ) : array
Parameters
$rule_id : int

要查询规则id

Tags
throws
throws
Return values
array

batchGetPayGiftCard()

批量查询支付后投放卡券规则

public batchGetPayGiftCard( $offset : int [, $count : int = 10 ] [, $effective : bool = true ] ) : array
Parameters
$offset : int

起始偏移量

$count : int = 10

查询的数量

$effective : bool = true

是否仅查询生效的规则

Tags
throws
throws
Return values
array

addActivity()

创建支付后领取立减金活动

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

payActivate()

开通券点账户接口

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

getPayprice()

对优惠券批价

public getPayprice( $card_id : string , $quantity : int ) : array
Parameters
$card_id : string

需要来配置库存的card_id

$quantity : int

本次需要兑换的库存数目

Tags
throws
throws
Return values
array

getCoinsInfo()

查询券点余额接口

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

payConfirm()

确认兑换库存接口

public payConfirm( $card_id : string , $quantity : int , $order_id : string ) : array
Parameters
$card_id : string

需要来兑换库存的card_id

$quantity : int

本次需要兑换的库存数目

$order_id : string

仅可以使用上面得到的订单号，保证批价有效性

Tags
throws
throws
Return values
array

payRecharge()

充值券点接口

public payRecharge( $coin_count : int ) : array
Parameters
$coin_count : int
Tags
throws
throws
Return values
array

payGetOrder()

查询订单详情接口

public payGetOrder( $order_id : string ) : array
Parameters
$order_id : string
Tags
throws
throws
Return values
array

payGetList()

查询券点流水详情接口

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