From af75fc2f9472726a4e97c40175ec9b607cf8d5c4 Mon Sep 17 00:00:00 2001 From: crazywhalecc Date: Wed, 3 Aug 2022 17:14:40 +0800 Subject: [PATCH] update docs --- docs/.vuepress/api.js | 2 +- docs/api/ZM/Utils/DataProvider.md | 8 ++++---- docs/component/store/data-provider.md | 4 +++- docs/update/build-update.md | 4 ++++ docs/update/v2.md | 6 ++++++ 5 files changed, 18 insertions(+), 6 deletions(-) diff --git a/docs/.vuepress/api.js b/docs/.vuepress/api.js index 7d2371b7..45b24371 100644 --- a/docs/.vuepress/api.js +++ b/docs/.vuepress/api.js @@ -1 +1 @@ -module.exports = [{"title":"ZM","collapsable":true,"children":["ZM/ZMServer"]},{"title":"ZM/API","collapsable":true,"children":["ZM/API/GoCqhttpAPIV11","ZM/API/TuringAPI","ZM/API/OneBotV11","ZM/API/ZMRobot","ZM/API/CQ"]},{"title":"ZM/API/Proxies/Bot","collapsable":true,"children":["ZM/API/Proxies/Bot/AbstractBotProxy","ZM/API/Proxies/Bot/AllGroupsProxy","ZM/API/Proxies/Bot/AllBotsProxy"]},{"title":"ZM/Annotation/Swoole","collapsable":true,"children":["ZM/Annotation/Swoole/OnSwooleEventBase"]},{"title":"ZM/Command","collapsable":true,"children":["ZM/Command/CheckConfigCommand"]},{"title":"ZM/Command/Module","collapsable":true,"children":["ZM/Command/Module/ModulePackCommand","ZM/Command/Module/ModuleListCommand"]},{"title":"ZM/Container","collapsable":true,"children":["ZM/Container/WorkerContainer","ZM/Container/Container","ZM/Container/BoundMethod"]},{"title":"ZM/DB","collapsable":true,"children":["ZM/DB/SelectBody","ZM/DB/InsertBody","ZM/DB/Table","ZM/DB/DB","ZM/DB/UpdateBody","ZM/DB/DeleteBody"]},{"title":"ZM/Event","collapsable":true,"children":["ZM/Event/EventTracer","ZM/Event/EventDispatcher","ZM/Event/EventManager"]},{"title":"ZM/Event/SwooleEvent","collapsable":true,"children":["ZM/Event/SwooleEvent/OnMessage","ZM/Event/SwooleEvent/OnTask"]},{"title":"ZM/Http","collapsable":true,"children":["ZM/Http/Response"]},{"title":"ZM/Module","collapsable":true,"children":["ZM/Module/ModulePacker","ZM/Module/ModuleUnpacker","ZM/Module/ModuleBase"]},{"title":"ZM/MySQL","collapsable":true,"children":["ZM/MySQL/MySQLConnection","ZM/MySQL/MySQLStatement","ZM/MySQL/MySQLWrapper","ZM/MySQL/MySQLPool","ZM/MySQL/MySQLQueryBuilder","ZM/MySQL/MySQLStatementWrapper"]},{"title":"ZM/Store","collapsable":true,"children":["ZM/Store/ZMAtomic","ZM/Store/LightCache","ZM/Store/LightCacheInside"]},{"title":"ZM/Store/Redis","collapsable":true,"children":["ZM/Store/Redis/ZMRedis"]},{"title":"ZM/Utils","collapsable":true,"children":["ZM/Utils/SignalListener","ZM/Utils/MessageUtil","ZM/Utils/CommandInfoUtil","ZM/Utils/ReflectionUtil","ZM/Utils/Terminal","ZM/Utils/CoMessage","ZM/Utils/DataProvider","ZM/Utils/HttpUtil"]},{"title":"ZM/Utils/Manager","collapsable":true,"children":["ZM/Utils/Manager/WorkerManager","ZM/Utils/Manager/CronManager","ZM/Utils/Manager/ModuleManager"]}] \ No newline at end of file +module.exports = [{"title":"ZM","collapsable":true,"children":["ZM/ZMServer"]},{"title":"ZM/API","collapsable":true,"children":["ZM/API/GoCqhttpAPIV11","ZM/API/ZMRobot","ZM/API/CQ","ZM/API/TuringAPI","ZM/API/OneBotV11"]},{"title":"ZM/API/Proxies/Bot","collapsable":true,"children":["ZM/API/Proxies/Bot/AbstractBotProxy","ZM/API/Proxies/Bot/AllGroupsProxy","ZM/API/Proxies/Bot/AllBotsProxy"]},{"title":"ZM/Annotation/Swoole","collapsable":true,"children":["ZM/Annotation/Swoole/OnSwooleEventBase"]},{"title":"ZM/Command","collapsable":true,"children":["ZM/Command/CheckConfigCommand"]},{"title":"ZM/Command/Module","collapsable":true,"children":["ZM/Command/Module/ModulePackCommand","ZM/Command/Module/ModuleListCommand"]},{"title":"ZM/Container","collapsable":true,"children":["ZM/Container/Container","ZM/Container/WorkerContainer","ZM/Container/BoundMethod"]},{"title":"ZM/DB","collapsable":true,"children":["ZM/DB/DeleteBody","ZM/DB/UpdateBody","ZM/DB/InsertBody","ZM/DB/DB","ZM/DB/Table","ZM/DB/SelectBody"]},{"title":"ZM/Event","collapsable":true,"children":["ZM/Event/EventTracer","ZM/Event/EventDispatcher","ZM/Event/EventManager"]},{"title":"ZM/Event/SwooleEvent","collapsable":true,"children":["ZM/Event/SwooleEvent/OnTask","ZM/Event/SwooleEvent/OnMessage"]},{"title":"ZM/Http","collapsable":true,"children":["ZM/Http/Response"]},{"title":"ZM/Module","collapsable":true,"children":["ZM/Module/ModulePacker","ZM/Module/ModuleUnpacker","ZM/Module/ModuleBase"]},{"title":"ZM/MySQL","collapsable":true,"children":["ZM/MySQL/MySQLWrapper","ZM/MySQL/MySQLPool","ZM/MySQL/MySQLConnection","ZM/MySQL/MySQLQueryBuilder","ZM/MySQL/MySQLStatement","ZM/MySQL/MySQLStatementWrapper"]},{"title":"ZM/Store","collapsable":true,"children":["ZM/Store/LightCache","ZM/Store/ZMAtomic","ZM/Store/LightCacheInside"]},{"title":"ZM/Store/Redis","collapsable":true,"children":["ZM/Store/Redis/ZMRedis"]},{"title":"ZM/Utils","collapsable":true,"children":["ZM/Utils/MessageUtil","ZM/Utils/Terminal","ZM/Utils/ReflectionUtil","ZM/Utils/HttpUtil","ZM/Utils/DataProvider","ZM/Utils/ZMUtil","ZM/Utils/SignalListener","ZM/Utils/CommandInfoUtil","ZM/Utils/CoMessage"]},{"title":"ZM/Utils/Manager","collapsable":true,"children":["ZM/Utils/Manager/CronManager","ZM/Utils/Manager/ModuleManager","ZM/Utils/Manager/WorkerManager"]}] \ No newline at end of file diff --git a/docs/api/ZM/Utils/DataProvider.md b/docs/api/ZM/Utils/DataProvider.md index b863af61..5d529466 100644 --- a/docs/api/ZM/Utils/DataProvider.md +++ b/docs/api/ZM/Utils/DataProvider.md @@ -158,12 +158,12 @@ public function loadFromJson(string $filename): null|mixed ## scanDirFiles ```php -public function scanDirFiles(string $dir, bool $recursive, bool|string $relative, bool $include_dir): array|false +public function scanDirFiles(string $dir, bool $recursive, bool|mixed|string $relative, bool $include_dir): array|false ``` ### 描述 -递归或非递归扫描目录，可返回相对目录或绝对目录的文件或目录列表 +递归或非递归扫描目录，可返回相对目录的文件列表或绝对目录的文件列表 ### 参数 @@ -171,8 +171,8 @@ public function scanDirFiles(string $dir, bool $recursive, bool|string $relative | -------- | ---- | ----------- | | dir | string | 目录 | | recursive | bool | 是否递归扫描子目录 | -| relative | bool|string | 是否返回相对目录，如果为true则返回相对目录，如果为false则返回绝对目录 | -| $include_dir | bool | 如果为true则返回目录，为false则只返回文件 +| relative | bool|mixed|string | 是否返回相对目录，如果为true则返回相对目录，如果为false则返回绝对目录 | +| include_dir | bool | 非递归模式下，是否包含目录 | ### 返回 diff --git a/docs/component/store/data-provider.md b/docs/component/store/data-provider.md index 602226c1..5a60a4c9 100644 --- a/docs/component/store/data-provider.md +++ b/docs/component/store/data-provider.md @@ -54,10 +54,12 @@ DataProvider::getDataFolder("TestModule"); // 例如返回 /root/zhamao-framewor 递归或非递归扫描目录，返回相对目录的文件列表或绝对目录的文件列表。（非常好用） -定义：`scanDirFiles($dir, $recursive = true, $relative = false)` +定义：`scanDirFiles($dir, $recursive = true, $relative = false, $include_dir = false)` `$dir` 为要扫描的目录，`$recursive` 为是否递归，`$relative` 为是否返回相对目录的文件列表。 +`$include_dir` 只有在 `$recursive === false` 的情况才生效，当 `$include_dir` 为 `true` 时，返回的非递归文件列表会包含目录，否则只包含文件。 + 从给定的目录下开始遍历整个目录，如果将 `$recursive` 设置为 `true`，则会递归扫描子目录，否则将返回包含目录的文件列表。 如果将 `$relative` 设置为 `true`，则会返回文件列表的相对路径，否则返回绝对路径。 diff --git a/docs/update/build-update.md b/docs/update/build-update.md index 1ac8920c..27a4cea5 100644 --- a/docs/update/build-update.md +++ b/docs/update/build-update.md @@ -4,6 +4,10 @@ 同时此处将只使用 build 版本号进行区分。 +## build 476 (2022-8-3) + +- `DataProvider::scanDirFiles()` 新增参数 `$include_dir`，用于控制非递归模式下是否包含目录 + ## build 475 (2022-7-3) - 修复 `match_args` 全局方法对于 `0` 字符串处理的 Bug（#136） diff --git a/docs/update/v2.md b/docs/update/v2.md index c18ce961..ac10d137 100644 --- a/docs/update/v2.md +++ b/docs/update/v2.md @@ -1,5 +1,11 @@ # 更新日志（v2 版本） +## v2.8.2（build 476） + +> 更新时间：2022.8.3 + +- `DataProvider::scanDirFiles()` 新增参数 `$include_dir`，用于控制非递归模式下是否包含目录 + ## v2.8.1（build 475） > 更新时间：2022.7.3