4.10.2、TemplateMessageApi · Endor Wechat SDK

# 模板消息推送類 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(); ```