# 模板消息推送类 TemplateMessageApi **目录 (Table of Contents)** [TOC] ## 类基本信息 **类简要描述：** - 用于构造微信公众号模板消息内容，一个TemplateContext结构是模板消息中的一行 **类成员变量说明：** |成员变量|类型|访问修饰|说明 |:---- |:---|:----- |----- | |$tpl_data | array | private| 模板数据数组 | |$to_userid| string | private| 接收模板消息的用户ID | |$tpl_id| string | private| 模板消息id | |$url| string | private| 点击模板消息跳转的页面 | |$topcolor| string | private| 顶部字体颜色 | **类名字空间：** - endor/wechat/template/ ## 类成员函数/方法 ### __construct($configure) + 参数列表： |参数名|类型|必填项|说明 |:---- |:---|:----- |----- | |$configure| object (WechatConfig) | 是 | 微信配置参数对象 | + 返回值： `无` + 函数说明： `构造函数` ### to($user_id) + 参数列表： |参数名|类型|必填项|说明 |:---- |:---|:----- |----- | |$user_id| string| 是 | 接收模板消息的用户ID | + 返回值： `Object 返回 this 以支持链式操作` + 函数说明： `设置消息接收人` ### url($url = '' ) + 参数列表： |参数名|类型|必填项|说明 |:---- |:---|:----- |----- | |$url| string| 否 | 点击模板消息跳转的页面 | + 返回值： `Object 返回 this 以支持链式操作` + 函数说明： `设置模板消息点击后的跳转页面，**注：** 如果url为空，则IOS进入空白页面，Android无法点击 ### tpl($template_id) + 参数列表： |参数名|类型|必填项|说明 |:---- |:---|:----- |----- | |$template_id| string| 是 | 模板消息的id | + 返回值： `Object 返回 this 以支持链式操作` + 函数说明： `设置模板消息的id` ### topColor($topcolor) + 参数列表： |参数名|类型|必填项|说明 |:---- |:---|:----- |----- | |$topcolor| string| 是 | 模板消息顶部文字颜色 | + 返回值： `Object 返回 this 以支持链式操作` + 函数说明： `设置模板消息顶部文字颜色` ### tplData($tplContextArray) + 参数列表： |参数名|类型|必填项|说明 |:---- |:---|:----- |----- | |$tplContextArray| Array| 是 | 模板消息上下文对象数组 | + 返回值： `Object 返回 this 以支持链式操作` + 函数说明： `设置模板消息上下文对象数组，该数组是通过 TempateContext::pushArray 构造` ### send($options = null) + 参数列表： |参数名|类型|必填项|说明 |:---- |:---|:----- |----- | |$options| Array| 否 | 模板消息配置参数 | + 返回值： `Array` + 函数说明： `发送模板消息，如果不采用链式调用，则必要参数通过options初始化` + options 参数项 |参数名|类型|必填项|说明 |:---- |:---|:----- |----- | |$to_userid| string | 是 | 接收模板消息的用户ID | |$data| Array| 是 | 模板消息上下文对象数组 | |$template_id| Array| 是 | 模板消息ID | >[danger] 该类下面支持链式操作的函数，除了send必须放置在最后外，其余的调用部分先手顺序 ```PHP // 这里 to(), url(), tpl(),tplData() 四个方法调用不区分顺序，但send必须放在最后 $tplMsgApi ->to($userOpenid) ->url("https://www.baidu.com") ->tpl("MFJCNBZO7m40qhddSgpqMfhoo8aVa_27_hdp8MwPGAA") ->tplData($arrayDatas) ->send(); ```