From be5b58387c821526bfa1f0eb4b9dada86a6c1958 Mon Sep 17 00:00:00 2001
From: fanbo <3412853751@qq.com>
Date: Wed, 25 Dec 2024 08:26:36 +0800
Subject: [PATCH] =?UTF-8?q?=E5=AF=B9core=E6=96=87=E4=BB=B6=E5=A4=B9?=
 =?UTF-8?q?=E4=B8=AD=E7=9A=84=E4=BB=A3=E7=A0=81=E6=96=87=E4=BB=B6msg.lib.p?=
 =?UTF-8?q?hp=E5=92=8Cmsgconstant.lib.php=E5=81=9A=E6=A0=87=E8=AE=B0?=
 =?UTF-8?q?=E6=B3=A8=E9=87=8A?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 core/msg.lib.php         | 25 ++++++++-----
 core/msgconstant.lib.php | 76 ++++++++++++++++++++++++++++++++++------
 2 files changed, 83 insertions(+), 18 deletions(-)

diff --git a/core/msg.lib.php b/core/msg.lib.php
index 8fdf508..359f963 100644
--- a/core/msg.lib.php
+++ b/core/msg.lib.php
@@ -1,19 +1,28 @@
 <?php
 namespace LaneWeChat\Core;
-
+// 错误提示类
+// 该类用于处理和返回错误信息，方便在程序中统一管理和显示错误。
 class Msg {
-	
-	@param int 
-	@param string 
-	@return Ambigous 
-	 
+ /**
+     * 返回错误信息
+     * 根据提供的错误码和错误信息，构造一个错误消息数组，并退出程序。
+     *
+     * @param int $code 错误码，用于标识具体的错误类型。
+     * @param string $errorMsg 自定义错误信息，如果为空，则使用默认错误信息。
+     * @return Ambigous <multitype:unknown , multitype:, boolean> 返回类型可能不明确，因为exit函数会导致脚本终止。
+     */
 	public static function returnErrMsg($code,  $errorMsg = null) {
+		// 初始化错误消息数组，包含错误码
 		$returnMsg = array('error_code' => $code);
+		// 如果提供了自定义错误信息，则添加到错误消息数组中
 		if (!empty($errorMsg)) {
 			$returnMsg['custom_msg'] = $errorMsg;
 		}
-        $returnMsg['custom_msg'] = '出错啦！'.$returnMsg['custom_msg'];
-        exit($returnMsg['custom_msg']);
+		// 如果没有提供自定义错误信息，则使用默认错误信息
+            // 这里可以根据错误码从错误码常量类中获取对应的错误信息
+            // $returnMsg['custom_msg'] = MsgConstant::ERROR_NO_BINDING_TEXT;
+        $returnMsg['custom_msg'] = '出错啦！'.$returnMsg['custom_msg'];// 添加默认错误前缀信息
+        exit($returnMsg['custom_msg']);// 退出程序并输出错误信息
 	}
 }
 ?>
diff --git a/core/msgconstant.lib.php b/core/msgconstant.lib.php
index 0025dc5..4248500 100644
--- a/core/msgconstant.lib.php
+++ b/core/msgconstant.lib.php
@@ -1,20 +1,76 @@
 <?php
 namespace LaneWeChat\Core;
-
+// 错误码常量类
+// 该类定义了一系列的错误码常量，用于标识和处理微信开发过程中可能遇到的错误。
 class MsgConstant {
-    const ERROR_SYSTEM = 101;
+    //-------系统错误相关--101 到200 ------
+    /**
+     * 系统错误常量
+     * 当系统发生未知错误时使用此常量。
+     */
+    const ERROR_SYSTEM = 101;//系统错误
+     /**
+     * 图文消息项数超过限制错误常量
+     * 当尝试发送的图文消息项数超过10时使用此常量。
+     */
     const ERROR_NEWS_ITEM_COUNT_MORE_TEN = 102;
-    const ERROR_MENU_CLICK = 103;
+    /**
+     * 菜单点击错误常量
+     * 当微信菜单点击跳转失败时使用此常量。
+     */
+    const ERROR_MENU_CLICK = 103; //菜单跳转失败，请重试
+
+
+    //-------用户输入相关--1001到1100------
+    /**
+     * 输入错误常量
+     * 当用户输入的数据有误时使用此常量。
+     */
+    const ERROR_INPUT_ERROR = 1001;//输入有误，请重新输入
+    /**
+     * 未知类型消息错误常量
+     * 当接收到未知类型的消息时使用此常量。
+     */
+    const ERROR_UNKNOW_TYPE = 1002;//收到了未知类型的消息
+    /**
+     * 验证码错误常量
+     * 当用户输入的验证码不正确时使用此常量。
+     */
+    const ERROR_CAPTCHA_ERROR = 1003;//验证码错误
+    /**
+     * 必填项未填写全错误常量
+     * 当用户提交的数据缺少必填项时使用此常量。
+     */
+    const ERROR_REQUIRED_FIELDS = 1004;//必填项未填写全
+
+    //-------远程调用相关--1201到1300------
+    /**
+     * 远程服务器未响应错误常量
+     * 当远程服务器没有响应时使用此常量。
+     */
+    const ERROR_REMOTE_SERVER_NOT_RESPOND = 1201;//远程服务器未响应
+    /**
+     * 获取ACCESS_TOKEN失败错误常量
+     * 当尝试获取微信ACCESS_TOKEN失败时使用此常量。
+     */
+    const ERROR_GET_ACCESS_TOKEN = 1202;//获取ACCESS_TOKEN失败
+
 
-    const ERROR_INPUT_ERROR = 1001;
-    const ERROR_UNKNOW_TYPE = 1002;
-    const ERROR_CAPTCHA_ERROR = 1003;
-    const ERROR_REQUIRED_FIELDS = 1004;
+    //-------文章管理相关--1301到1400------
+    // 文章管理相关的错误码常量可以在这里定义
 
-    const ERROR_REMOTE_SERVER_NOT_RESPOND = 1201;
-    const ERROR_GET_ACCESS_TOKEN = 1202;
+    //-------分类管理相关--1401到1500------
+    /**
+     * 菜单不存在错误常量
+     * 当尝试访问的菜单不存在时使用此常量。
+     */
+    const ERROR_MENU_NOT_EXISTS = 1401;//菜单不存在
 
-    const ERROR_MENU_NOT_EXISTS = 1401;
 
+    //-------文案类------------
+    /**
+     * 未绑定微信错误文案常量
+     * 当用户未绑定微信时显示的错误文案。
+     */
     const ERROR_NO_BINDING_TEXT = '对不起，您尚未绑定微信，轻松绑定微信，即可查询实时流量，享受便捷服务!';
 }
\ No newline at end of file