1.新增菜单后台操作指南，方便管理员查看使用

2026-05-30 17:48:55 +08:00
parent a4c8f623be
commit 90abab14a3
37 changed files with 678 additions and 1 deletions
--- a/server/plugin/saiadmin/app/logic/system/SystemAdminGuideLogic.php
+++ b/server/plugin/saiadmin/app/logic/system/SystemAdminGuideLogic.php
@@ -0,0 +1,72 @@
+<?php
+// +----------------------------------------------------------------------
+// | saiadmin [ saiadmin快速开发框架 ]
+// +----------------------------------------------------------------------
+namespace plugin\saiadmin\app\logic\system;
+
+use plugin\saiadmin\exception\ApiException;
+
+/**
+ * 后台操作指南逻辑（读写 server/docs/ADMIN_GUIDE.md）
+ */
+class SystemAdminGuideLogic
+{
+    private const GUIDE_FILENAME = 'ADMIN_GUIDE.md';
+
+    /**
+     * 获取指南 Markdown 文件绝对路径
+     */
+    public function getFilePath(): string
+    {
+        return base_path() . DIRECTORY_SEPARATOR . 'docs' . DIRECTORY_SEPARATOR . self::GUIDE_FILENAME;
+    }
+
+    /**
+     * 读取指南内容
+     * @return array{content: string, file_path: string, update_time: string|null}
+     */
+    public function read(): array
+    {
+        $filePath = $this->getFilePath();
+        if (! is_file($filePath)) {
+            throw new ApiException('admin guide file not found');
+        }
+        $content = file_get_contents($filePath);
+        if ($content === false) {
+            throw new ApiException('failed to read admin guide file');
+        }
+
+        return [
+            'content' => $content,
+            'file_path' => 'docs/' . self::GUIDE_FILENAME,
+            'update_time' => date('Y-m-d H:i:s', filemtime($filePath)),
+        ];
+    }
+
+    /**
+     * 保存指南内容到 Markdown 文件
+     * @param string $content
+     * @return array{content: string, file_path: string, update_time: string}
+     */
+    public function save(string $content): array
+    {
+        $filePath = $this->getFilePath();
+        $dir = dirname($filePath);
+        if (! is_dir($dir) && ! mkdir($dir, 0755, true) && ! is_dir($dir)) {
+            throw new ApiException('failed to create docs directory');
+        }
+
+        $result = file_put_contents($filePath, $content, LOCK_EX);
+        if ($result === false) {
+            throw new ApiException('failed to save admin guide file');
+        }
+
+        clearstatcache(true, $filePath);
+
+        return [
+            'content' => $content,
+            'file_path' => 'docs/' . self::GUIDE_FILENAME,
+            'update_time' => date('Y-m-d H:i:s', filemtime($filePath)),
+        ];
+    }
+}