From c20f8cb9eda55e2ac31fbe0719ad634cf40c830f Mon Sep 17 00:00:00 2001
From: fanbo <3412853751@qq.com>
Date: Fri, 27 Dec 2024 11:06:34 +0800
Subject: [PATCH] =?UTF-8?q?=E5=AF=B9templatemessage.lib.php=E4=BB=A3?=
 =?UTF-8?q?=E7=A0=81=E6=96=87=E4=BB=B6=E8=BF=9B=E8=A1=8C=E6=B3=A8=E9=87=8A?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: fanbo <3412853751@qq.com>
---
 core/templatemessage.lib.php | 53 +++++++++++++++++++++++++++++++++---
 1 file changed, 49 insertions(+), 4 deletions(-)

diff --git a/core/templatemessage.lib.php b/core/templatemessage.lib.php
index 7d70e4b..bc05de4 100644
--- a/core/templatemessage.lib.php
+++ b/core/templatemessage.lib.php
@@ -1,36 +1,81 @@
 <?php
 namespace LaneWeChat\Core;
 
-class TemplateMessage{
-    public static function setIndustry($industryId1, $industryId2){
+/**
+ * 模板消息接口
+ * 此类提供了微信公众号模板消息的相关操作，包括设置行业、获取模板ID和发送模板消息。
+ * 模板消息用于公众号向用户发送重要的服务通知，如信用卡刷卡通知、商品购买成功通知等。
+ * 不支持广告等营销类消息以及其它所有可能对用户造成骚扰的消息。
+ */
+class TemplateMessage {
+
+    /**
+     * 设置所属行业
+     * 公众号模板消息需要设置所属行业，每月可更改1次所选行业。
+     * @param int $industryId1 公众号模板消息所属行业编号，第一个行业编号
+     * @param int $industryId2 公众号模板消息所属行业编号，第二个行业编号
+     * @return mixed 返回调用结果，通常是一个数组或者JSON字符串
+     */
+    public static function setIndustry($industryId1, $industryId2) {
+        // 构建请求URL，包含access_token
         $queryUrl = 'https://api.weixin.qq.com/cgi-bin/template/api_set_industry?access_token=' . AccessToken::getAccessToken(); 
+        // 设置请求方法为POST
         $queryAction = 'POST';
+        // 构建请求数据数组
         $template = array();
         $template['industry_id1'] = "$industryId1";
         $template['industry_id2'] = "$industryId2";
+        // 将数组转换为JSON格式
         $template = json_encode($template);
+        // 调用Curl类发送请求
         return Curl::callWebServer($queryUrl, $template, $queryAction);
     }
 
-    public static function getTemplateId($templateIdShort){
+    /**
+     * 获得模板ID
+     * 从模板库中添加模板，获取模板ID。
+     * @param string $templateIdShort 模板库中模板的编号，有“TM**”和“OPENTMTM**”等形式
+     * @return mixed 返回调用结果，通常是一个数组或者JSON字符串
+     */
+    public static function getTemplateId($templateIdShort) {
+        // 构建请求URL，包含access_token
         $queryUrl = 'https://api.weixin.qq.com/cgi-bin/template/api_add_template?access_token=' . AccessToken::getAccessToken(); 
+        // 设置请求方法为POST
         $queryAction = 'POST';
+        // 构建请求数据数组
         $template = array();
         $template['template_id_short'] = "$templateIdShort";
+        // 将数组转换为JSON格式
         $template = json_encode($template);
+        // 调用Curl类发送请求
         return Curl::callWebServer($queryUrl, $template, $queryAction);
     }
 
-    public static function sendTemplateMessage($data, $touser, $templateId, $url, $topcolor='#FF0000'){
+    /**
+     * 向用户推送模板消息
+     * 发送模板消息给指定的用户。
+     * @param array $data 模板数据，包含多个键值对，每个键对应模板中的一个参数
+     * @param string $touser 接收方的OpenId
+     * @param string $templateId 模板Id，在公众平台线上模板库中选用模板获得ID
+     * @param string $url 点击模板消息会跳转到的链接
+     * @param string $topcolor 顶部颜色，可以为空，默认是红色
+     * @return mixed 返回调用结果，通常是一个数组或者JSON字符串
+     */
+    public static function sendTemplateMessage($data, $touser, $templateId, $url, $topcolor = '#FF0000') {
+        // 构建请求URL，包含access_token
         $queryUrl = 'https://api.weixin.qq.com/cgi-bin/message/template/send?access_token=' . AccessToken::getAccessToken(); 
+        // 设置请求方法为POST
         $queryAction = 'POST';
+        // 构建请求数据数组
         $template = array();
         $template['touser'] = $touser;
         $template['template_id'] = $templateId;
         $template['url'] = $url;
         $template['topcolor'] = $topcolor;
         $template['data'] = $data;
+        // 将数组转换为JSON格式
         $template = json_encode($template);
+        // 调用Curl类发送请求
         return Curl::callWebServer($queryUrl, $template, $queryAction);
     }
 }
\ No newline at end of file