From 4fbe2aa5af1ad74b76b6917057d484d0b0e43e00 Mon Sep 17 00:00:00 2001 From: sunxyw <31698606+sunxyw@users.noreply.github.com> Date: Sun, 27 Mar 2022 16:42:36 +0800 Subject: [PATCH] add api docs (#80) --- .gitignore | 2 +- docs/.vuepress/api.js | 1 + docs/.vuepress/config.js | 3 + docs/api/ZM/API/CQ.md | 463 +++++++++ docs/api/ZM/API/GoCqhttpAPIV11.md | 174 ++++ docs/api/ZM/API/OneBotV11.md | 932 ++++++++++++++++++ docs/api/ZM/API/TuringAPI.md | 24 + docs/api/ZM/API/ZMRobot.md | 1 + docs/api/ZM/Annotation/AnnotationBase.md | 1 + docs/api/ZM/Annotation/AnnotationParser.md | 98 ++ docs/api/ZM/Annotation/CQ/CQAPIResponse.md | 1 + docs/api/ZM/Annotation/CQ/CQAfter.md | 39 + docs/api/ZM/Annotation/CQ/CQBefore.md | 39 + docs/api/ZM/Annotation/CQ/CQCommand.md | 22 + docs/api/ZM/Annotation/CQ/CQMessage.md | 1 + docs/api/ZM/Annotation/CQ/CQMetaEvent.md | 39 + docs/api/ZM/Annotation/CQ/CQNotice.md | 22 + docs/api/ZM/Annotation/CQ/CQRequest.md | 22 + .../ZM/Annotation/Command/TerminalCommand.md | 1 + docs/api/ZM/Annotation/Cron/Cron.md | 61 ++ docs/api/ZM/Annotation/Http/Controller.md | 1 + docs/api/ZM/Annotation/Http/HandleAfter.md | 1 + docs/api/ZM/Annotation/Http/HandleBefore.md | 1 + .../api/ZM/Annotation/Http/HandleException.md | 1 + docs/api/ZM/Annotation/Http/Middleware.md | 1 + .../api/ZM/Annotation/Http/MiddlewareClass.md | 1 + docs/api/ZM/Annotation/Http/RequestMapping.md | 1 + docs/api/ZM/Annotation/Http/RequestMethod.md | 1 + docs/api/ZM/Annotation/Module/Closed.md | 1 + docs/api/ZM/Annotation/Swoole/OnCloseEvent.md | 1 + .../Annotation/Swoole/OnManagerStartEvent.md | 1 + .../ZM/Annotation/Swoole/OnMessageEvent.md | 1 + docs/api/ZM/Annotation/Swoole/OnOpenEvent.md | 1 + .../Annotation/Swoole/OnPipeMessageEvent.md | 1 + .../ZM/Annotation/Swoole/OnRequestEvent.md | 1 + docs/api/ZM/Annotation/Swoole/OnSave.md | 1 + docs/api/ZM/Annotation/Swoole/OnSetup.md | 1 + docs/api/ZM/Annotation/Swoole/OnStart.md | 1 + .../api/ZM/Annotation/Swoole/OnSwooleEvent.md | 1 + .../ZM/Annotation/Swoole/OnSwooleEventBase.md | 22 + docs/api/ZM/Annotation/Swoole/OnTask.md | 17 + docs/api/ZM/Annotation/Swoole/OnTaskEvent.md | 1 + docs/api/ZM/Annotation/Swoole/OnTick.md | 1 + .../api/ZM/Annotation/Swoole/SwooleHandler.md | 1 + docs/api/ZM/Command/BuildCommand.md | 1 + docs/api/ZM/Command/CheckConfigCommand.md | 24 + docs/api/ZM/Command/Daemon/DaemonCommand.md | 1 + .../ZM/Command/Daemon/DaemonReloadCommand.md | 1 + .../ZM/Command/Daemon/DaemonStatusCommand.md | 1 + .../ZM/Command/Daemon/DaemonStopCommand.md | 1 + .../Generate/APIDocsGenerateCommand.md | 91 ++ .../Generate/SystemdGenerateCommand.md | 1 + docs/api/ZM/Command/InitCommand.md | 1 + .../ZM/Command/Module/ModuleListCommand.md | 1 + .../ZM/Command/Module/ModulePackCommand.md | 1 + .../ZM/Command/Module/ModuleUnpackCommand.md | 1 + docs/api/ZM/Command/PureHttpCommand.md | 1 + docs/api/ZM/Command/RunServerCommand.md | 1 + .../ZM/Command/Server/ServerReloadCommand.md | 1 + .../ZM/Command/Server/ServerStatusCommand.md | 1 + .../ZM/Command/Server/ServerStopCommand.md | 1 + docs/api/ZM/ConsoleApplication.md | 44 + docs/api/ZM/Context/Context.md | 210 ++++ docs/api/ZM/DB/DB.md | 88 ++ docs/api/ZM/DB/DeleteBody.md | 39 + docs/api/ZM/DB/InsertBody.md | 40 + docs/api/ZM/DB/SelectBody.md | 134 +++ docs/api/ZM/DB/Table.md | 17 + docs/api/ZM/DB/UpdateBody.md | 40 + docs/api/ZM/Entity/CQObject.md | 1 + docs/api/ZM/Entity/MatchResult.md | 1 + docs/api/ZM/Event/EventDispatcher.md | 22 + docs/api/ZM/Event/EventManager.md | 39 + docs/api/ZM/Event/EventTracer.md | 34 + .../ZM/Event/SwooleEvent/OnBeforeReload.md | 1 + docs/api/ZM/Event/SwooleEvent/OnClose.md | 1 + .../ZM/Event/SwooleEvent/OnManagerStart.md | 1 + .../api/ZM/Event/SwooleEvent/OnManagerStop.md | 1 + docs/api/ZM/Event/SwooleEvent/OnMessage.md | 1 + docs/api/ZM/Event/SwooleEvent/OnOpen.md | 1 + .../api/ZM/Event/SwooleEvent/OnPipeMessage.md | 1 + docs/api/ZM/Event/SwooleEvent/OnRequest.md | 1 + docs/api/ZM/Event/SwooleEvent/OnShutdown.md | 1 + docs/api/ZM/Event/SwooleEvent/OnStart.md | 1 + docs/api/ZM/Event/SwooleEvent/OnTask.md | 23 + docs/api/ZM/Event/SwooleEvent/OnWorkerExit.md | 1 + .../api/ZM/Event/SwooleEvent/OnWorkerStart.md | 17 + docs/api/ZM/Event/SwooleEvent/OnWorkerStop.md | 1 + docs/api/ZM/Exception/AnnotationException.md | 1 + docs/api/ZM/Exception/DbException.md | 1 + docs/api/ZM/Exception/ExceptionHandler.md | 1 + docs/api/ZM/Exception/InitException.md | 1 + docs/api/ZM/Exception/InterruptException.md | 1 + .../ZM/Exception/InvalidArgumentException.md | 1 + docs/api/ZM/Exception/LightCacheException.md | 1 + .../ZM/Exception/MethodNotFoundException.md | 1 + docs/api/ZM/Exception/ModulePackException.md | 1 + .../ZM/Exception/NotInitializedException.md | 1 + docs/api/ZM/Exception/RedisException.md | 1 + .../ZM/Exception/RobotNotFoundException.md | 1 + docs/api/ZM/Exception/WaitTimeoutException.md | 1 + docs/api/ZM/Exception/ZMException.md | 1 + docs/api/ZM/Exception/ZMKnownException.md | 1 + docs/api/ZM/Framework.md | 127 +++ docs/api/ZM/Http/Response.md | 358 +++++++ docs/api/ZM/Http/RouteManager.md | 1 + docs/api/ZM/Http/StaticFileHandler.md | 1 + docs/api/ZM/Module/InstantModule.md | 1 + docs/api/ZM/Module/ModuleBase.md | 17 + docs/api/ZM/Module/ModulePacker.md | 151 +++ docs/api/ZM/Module/ModuleUnpacker.md | 120 +++ docs/api/ZM/Module/QQBot.md | 107 ++ docs/api/ZM/MySQL/MySQLConnection.md | 1 + docs/api/ZM/MySQL/MySQLDriver.md | 1 + docs/api/ZM/MySQL/MySQLManager.md | 1 + docs/api/ZM/MySQL/MySQLPool.md | 39 + docs/api/ZM/MySQL/MySQLQueryBuilder.md | 17 + docs/api/ZM/MySQL/MySQLStatement.md | 1 + docs/api/ZM/MySQL/MySQLStatementWrapper.md | 291 ++++++ docs/api/ZM/MySQL/MySQLWrapper.md | 901 +++++++++++++++++ docs/api/ZM/Store/LightCache.md | 174 ++++ docs/api/ZM/Store/LightCacheInside.md | 72 ++ docs/api/ZM/Store/Lock/SpinLock.md | 1 + docs/api/ZM/Store/MySQL/SqlPoolStorage.md | 1 + docs/api/ZM/Store/Redis/ZMRedis.md | 39 + docs/api/ZM/Store/Redis/ZMRedisPool.md | 1 + docs/api/ZM/Store/WorkerCache.md | 1 + docs/api/ZM/Store/ZMAtomic.md | 39 + docs/api/ZM/Store/ZMBuf.md | 1 + docs/api/ZM/Utils/CoMessage.md | 41 + docs/api/ZM/Utils/CoroutinePool.md | 1 + docs/api/ZM/Utils/DataProvider.md | 198 ++++ docs/api/ZM/Utils/HttpUtil.md | 50 + docs/api/ZM/Utils/Macroable.md | 1 + docs/api/ZM/Utils/Manager/CronManager.md | 42 + docs/api/ZM/Utils/Manager/ModuleManager.md | 62 ++ docs/api/ZM/Utils/Manager/ProcessManager.md | 1 + docs/api/ZM/Utils/Manager/RouteManager.md | 1 + docs/api/ZM/Utils/Manager/TaskManager.md | 1 + docs/api/ZM/Utils/Manager/WorkerManager.md | 64 ++ docs/api/ZM/Utils/MessageUtil.md | 203 ++++ docs/api/ZM/Utils/SignalListener.md | 79 ++ docs/api/ZM/Utils/SingletonTrait.md | 17 + docs/api/ZM/Utils/Terminal.md | 195 ++++ docs/api/ZM/Utils/ZMUtil.md | 76 ++ docs/api/ZM/ZMServer.md | 17 + docs/api/index.md | 0 147 files changed, 6425 insertions(+), 1 deletion(-) create mode 100644 docs/.vuepress/api.js create mode 100644 docs/api/ZM/API/CQ.md create mode 100644 docs/api/ZM/API/GoCqhttpAPIV11.md create mode 100644 docs/api/ZM/API/OneBotV11.md create mode 100644 docs/api/ZM/API/TuringAPI.md create mode 100644 docs/api/ZM/API/ZMRobot.md create mode 100644 docs/api/ZM/Annotation/AnnotationBase.md create mode 100644 docs/api/ZM/Annotation/AnnotationParser.md create mode 100644 docs/api/ZM/Annotation/CQ/CQAPIResponse.md create mode 100644 docs/api/ZM/Annotation/CQ/CQAfter.md create mode 100644 docs/api/ZM/Annotation/CQ/CQBefore.md create mode 100644 docs/api/ZM/Annotation/CQ/CQCommand.md create mode 100644 docs/api/ZM/Annotation/CQ/CQMessage.md create mode 100644 docs/api/ZM/Annotation/CQ/CQMetaEvent.md create mode 100644 docs/api/ZM/Annotation/CQ/CQNotice.md create mode 100644 docs/api/ZM/Annotation/CQ/CQRequest.md create mode 100644 docs/api/ZM/Annotation/Command/TerminalCommand.md create mode 100644 docs/api/ZM/Annotation/Cron/Cron.md create mode 100644 docs/api/ZM/Annotation/Http/Controller.md create mode 100644 docs/api/ZM/Annotation/Http/HandleAfter.md create mode 100644 docs/api/ZM/Annotation/Http/HandleBefore.md create mode 100644 docs/api/ZM/Annotation/Http/HandleException.md create mode 100644 docs/api/ZM/Annotation/Http/Middleware.md create mode 100644 docs/api/ZM/Annotation/Http/MiddlewareClass.md create mode 100644 docs/api/ZM/Annotation/Http/RequestMapping.md create mode 100644 docs/api/ZM/Annotation/Http/RequestMethod.md create mode 100644 docs/api/ZM/Annotation/Module/Closed.md create mode 100644 docs/api/ZM/Annotation/Swoole/OnCloseEvent.md create mode 100644 docs/api/ZM/Annotation/Swoole/OnManagerStartEvent.md create mode 100644 docs/api/ZM/Annotation/Swoole/OnMessageEvent.md create mode 100644 docs/api/ZM/Annotation/Swoole/OnOpenEvent.md create mode 100644 docs/api/ZM/Annotation/Swoole/OnPipeMessageEvent.md create mode 100644 docs/api/ZM/Annotation/Swoole/OnRequestEvent.md create mode 100644 docs/api/ZM/Annotation/Swoole/OnSave.md create mode 100644 docs/api/ZM/Annotation/Swoole/OnSetup.md create mode 100644 docs/api/ZM/Annotation/Swoole/OnStart.md create mode 100644 docs/api/ZM/Annotation/Swoole/OnSwooleEvent.md create mode 100644 docs/api/ZM/Annotation/Swoole/OnSwooleEventBase.md create mode 100644 docs/api/ZM/Annotation/Swoole/OnTask.md create mode 100644 docs/api/ZM/Annotation/Swoole/OnTaskEvent.md create mode 100644 docs/api/ZM/Annotation/Swoole/OnTick.md create mode 100644 docs/api/ZM/Annotation/Swoole/SwooleHandler.md create mode 100644 docs/api/ZM/Command/BuildCommand.md create mode 100644 docs/api/ZM/Command/CheckConfigCommand.md create mode 100644 docs/api/ZM/Command/Daemon/DaemonCommand.md create mode 100644 docs/api/ZM/Command/Daemon/DaemonReloadCommand.md create mode 100644 docs/api/ZM/Command/Daemon/DaemonStatusCommand.md create mode 100644 docs/api/ZM/Command/Daemon/DaemonStopCommand.md create mode 100644 docs/api/ZM/Command/Generate/APIDocsGenerateCommand.md create mode 100644 docs/api/ZM/Command/Generate/SystemdGenerateCommand.md create mode 100644 docs/api/ZM/Command/InitCommand.md create mode 100644 docs/api/ZM/Command/Module/ModuleListCommand.md create mode 100644 docs/api/ZM/Command/Module/ModulePackCommand.md create mode 100644 docs/api/ZM/Command/Module/ModuleUnpackCommand.md create mode 100644 docs/api/ZM/Command/PureHttpCommand.md create mode 100644 docs/api/ZM/Command/RunServerCommand.md create mode 100644 docs/api/ZM/Command/Server/ServerReloadCommand.md create mode 100644 docs/api/ZM/Command/Server/ServerStatusCommand.md create mode 100644 docs/api/ZM/Command/Server/ServerStopCommand.md create mode 100644 docs/api/ZM/ConsoleApplication.md create mode 100644 docs/api/ZM/Context/Context.md create mode 100644 docs/api/ZM/DB/DB.md create mode 100644 docs/api/ZM/DB/DeleteBody.md create mode 100644 docs/api/ZM/DB/InsertBody.md create mode 100644 docs/api/ZM/DB/SelectBody.md create mode 100644 docs/api/ZM/DB/Table.md create mode 100644 docs/api/ZM/DB/UpdateBody.md create mode 100644 docs/api/ZM/Entity/CQObject.md create mode 100644 docs/api/ZM/Entity/MatchResult.md create mode 100644 docs/api/ZM/Event/EventDispatcher.md create mode 100644 docs/api/ZM/Event/EventManager.md create mode 100644 docs/api/ZM/Event/EventTracer.md create mode 100644 docs/api/ZM/Event/SwooleEvent/OnBeforeReload.md create mode 100644 docs/api/ZM/Event/SwooleEvent/OnClose.md create mode 100644 docs/api/ZM/Event/SwooleEvent/OnManagerStart.md create mode 100644 docs/api/ZM/Event/SwooleEvent/OnManagerStop.md create mode 100644 docs/api/ZM/Event/SwooleEvent/OnMessage.md create mode 100644 docs/api/ZM/Event/SwooleEvent/OnOpen.md create mode 100644 docs/api/ZM/Event/SwooleEvent/OnPipeMessage.md create mode 100644 docs/api/ZM/Event/SwooleEvent/OnRequest.md create mode 100644 docs/api/ZM/Event/SwooleEvent/OnShutdown.md create mode 100644 docs/api/ZM/Event/SwooleEvent/OnStart.md create mode 100644 docs/api/ZM/Event/SwooleEvent/OnTask.md create mode 100644 docs/api/ZM/Event/SwooleEvent/OnWorkerExit.md create mode 100644 docs/api/ZM/Event/SwooleEvent/OnWorkerStart.md create mode 100644 docs/api/ZM/Event/SwooleEvent/OnWorkerStop.md create mode 100644 docs/api/ZM/Exception/AnnotationException.md create mode 100644 docs/api/ZM/Exception/DbException.md create mode 100644 docs/api/ZM/Exception/ExceptionHandler.md create mode 100644 docs/api/ZM/Exception/InitException.md create mode 100644 docs/api/ZM/Exception/InterruptException.md create mode 100644 docs/api/ZM/Exception/InvalidArgumentException.md create mode 100644 docs/api/ZM/Exception/LightCacheException.md create mode 100644 docs/api/ZM/Exception/MethodNotFoundException.md create mode 100644 docs/api/ZM/Exception/ModulePackException.md create mode 100644 docs/api/ZM/Exception/NotInitializedException.md create mode 100644 docs/api/ZM/Exception/RedisException.md create mode 100644 docs/api/ZM/Exception/RobotNotFoundException.md create mode 100644 docs/api/ZM/Exception/WaitTimeoutException.md create mode 100644 docs/api/ZM/Exception/ZMException.md create mode 100644 docs/api/ZM/Exception/ZMKnownException.md create mode 100644 docs/api/ZM/Framework.md create mode 100644 docs/api/ZM/Http/Response.md create mode 100644 docs/api/ZM/Http/RouteManager.md create mode 100644 docs/api/ZM/Http/StaticFileHandler.md create mode 100644 docs/api/ZM/Module/InstantModule.md create mode 100644 docs/api/ZM/Module/ModuleBase.md create mode 100644 docs/api/ZM/Module/ModulePacker.md create mode 100644 docs/api/ZM/Module/ModuleUnpacker.md create mode 100644 docs/api/ZM/Module/QQBot.md create mode 100644 docs/api/ZM/MySQL/MySQLConnection.md create mode 100644 docs/api/ZM/MySQL/MySQLDriver.md create mode 100644 docs/api/ZM/MySQL/MySQLManager.md create mode 100644 docs/api/ZM/MySQL/MySQLPool.md create mode 100644 docs/api/ZM/MySQL/MySQLQueryBuilder.md create mode 100644 docs/api/ZM/MySQL/MySQLStatement.md create mode 100644 docs/api/ZM/MySQL/MySQLStatementWrapper.md create mode 100644 docs/api/ZM/MySQL/MySQLWrapper.md create mode 100644 docs/api/ZM/Store/LightCache.md create mode 100644 docs/api/ZM/Store/LightCacheInside.md create mode 100644 docs/api/ZM/Store/Lock/SpinLock.md create mode 100644 docs/api/ZM/Store/MySQL/SqlPoolStorage.md create mode 100644 docs/api/ZM/Store/Redis/ZMRedis.md create mode 100644 docs/api/ZM/Store/Redis/ZMRedisPool.md create mode 100644 docs/api/ZM/Store/WorkerCache.md create mode 100644 docs/api/ZM/Store/ZMAtomic.md create mode 100644 docs/api/ZM/Store/ZMBuf.md create mode 100644 docs/api/ZM/Utils/CoMessage.md create mode 100644 docs/api/ZM/Utils/CoroutinePool.md create mode 100644 docs/api/ZM/Utils/DataProvider.md create mode 100644 docs/api/ZM/Utils/HttpUtil.md create mode 100644 docs/api/ZM/Utils/Macroable.md create mode 100644 docs/api/ZM/Utils/Manager/CronManager.md create mode 100644 docs/api/ZM/Utils/Manager/ModuleManager.md create mode 100644 docs/api/ZM/Utils/Manager/ProcessManager.md create mode 100644 docs/api/ZM/Utils/Manager/RouteManager.md create mode 100644 docs/api/ZM/Utils/Manager/TaskManager.md create mode 100644 docs/api/ZM/Utils/Manager/WorkerManager.md create mode 100644 docs/api/ZM/Utils/MessageUtil.md create mode 100644 docs/api/ZM/Utils/SignalListener.md create mode 100644 docs/api/ZM/Utils/SingletonTrait.md create mode 100644 docs/api/ZM/Utils/Terminal.md create mode 100644 docs/api/ZM/Utils/ZMUtil.md create mode 100644 docs/api/ZM/ZMServer.md create mode 100644 docs/api/index.md diff --git a/.gitignore b/.gitignore index 507b4543..d9029397 100644 --- a/.gitignore +++ b/.gitignore @@ -31,4 +31,4 @@ cghooks.lock # Vuepress 相关文件 /node_modules/ /docs/.vuepress/dist/ -package-lock.json \ No newline at end of file +package-lock.json diff --git a/docs/.vuepress/api.js b/docs/.vuepress/api.js new file mode 100644 index 00000000..e566b63d --- /dev/null +++ b/docs/.vuepress/api.js @@ -0,0 +1 @@ +module.exports = [{"title":"ZM","collapsable":true,"children":["ZM/ZMServer","ZM/ConsoleApplication","ZM/Framework"]},{"title":"ZM/API","collapsable":true,"children":["ZM/API/CQ","ZM/API/OneBotV11","ZM/API/TuringAPI","ZM/API/GoCqhttpAPIV11"]},{"title":"ZM/Annotation","collapsable":true,"children":["ZM/Annotation/AnnotationParser"]},{"title":"ZM/Annotation/Swoole","collapsable":true,"children":["ZM/Annotation/Swoole/OnSwooleEventBase"]},{"title":"ZM/Command","collapsable":true,"children":["ZM/Command/CheckConfigCommand"]},{"title":"ZM/Command/Generate","collapsable":true,"children":["ZM/Command/Generate/APIDocsGenerateCommand"]},{"title":"ZM/Context","collapsable":true,"children":["ZM/Context/Context"]},{"title":"ZM/DB","collapsable":true,"children":["ZM/DB/Table","ZM/DB/DeleteBody","ZM/DB/UpdateBody","ZM/DB/DB","ZM/DB/SelectBody","ZM/DB/InsertBody"]},{"title":"ZM/Event","collapsable":true,"children":["ZM/Event/EventManager","ZM/Event/EventTracer","ZM/Event/EventDispatcher"]},{"title":"ZM/Event/SwooleEvent","collapsable":true,"children":["ZM/Event/SwooleEvent/OnWorkerStart","ZM/Event/SwooleEvent/OnTask"]},{"title":"ZM/Http","collapsable":true,"children":["ZM/Http/Response"]},{"title":"ZM/Module","collapsable":true,"children":["ZM/Module/ModuleUnpacker","ZM/Module/ModulePacker","ZM/Module/ModuleBase","ZM/Module/QQBot"]},{"title":"ZM/MySQL","collapsable":true,"children":["ZM/MySQL/MySQLStatementWrapper","ZM/MySQL/MySQLQueryBuilder","ZM/MySQL/MySQLWrapper","ZM/MySQL/MySQLPool"]},{"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/Terminal","ZM/Utils/MessageUtil","ZM/Utils/DataProvider","ZM/Utils/SignalListener","ZM/Utils/ZMUtil","ZM/Utils/HttpUtil","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/.vuepress/config.js b/docs/.vuepress/config.js index f273183a..908522c6 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -1,3 +1,5 @@ +const apiConfig = require('./api') + module.exports = { title: '炸毛框架', description: '一个聊天机器人 + Web 框架', @@ -161,6 +163,7 @@ module.exports = { ] }, ], + '/api/': apiConfig, '/faq/': [ '', 'to-v2', diff --git a/docs/api/ZM/API/CQ.md b/docs/api/ZM/API/CQ.md new file mode 100644 index 00000000..d90e6e90 --- /dev/null +++ b/docs/api/ZM/API/CQ.md @@ -0,0 +1,463 @@ +# ZM\API\CQ + +## at + +```php +public function at(mixed $qq): string +``` + +### 描述 + +at一下QQ用户（仅在QQ群支持at全体） + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| qq | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string | | + + +## face + +```php +public function face(mixed $id): string +``` + +### 描述 + +发送QQ原生表情 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| id | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string | | + + +## image + +```php +public function image(mixed $file, bool $cache, bool $flash, bool $proxy, int $timeout): string +``` + +### 描述 + +发送图片 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| file | mixed | | +| cache | bool | | +| flash | bool | | +| proxy | bool | | +| timeout | int | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string | | + + +## record + +```php +public function record(mixed $file, bool $magic, bool $cache, bool $proxy, int $timeout): string +``` + +### 描述 + +发送语音 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| file | mixed | | +| magic | bool | | +| cache | bool | | +| proxy | bool | | +| timeout | int | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string | | + + +## video + +```php +public function video(mixed $file, bool $cache, bool $proxy, int $timeout): string +``` + +### 描述 + +发送短视频 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| file | mixed | | +| cache | bool | | +| proxy | bool | | +| timeout | int | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string | | + + +## rps + +```php +public function rps(): string +``` + +### 描述 + +发送投掷骰子（只能在单条回复中单独使用） + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string | | + + +## dice + +```php +public function dice(): string +``` + +### 描述 + +发送掷骰子表情（只能在单条回复中单独使用） + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string | | + + +## shake + +```php +public function shake(): string +``` + +### 描述 + +戳一戳（原窗口抖动，仅支持好友消息使用） + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string | | + + +## poke + +```php +public function poke(mixed $type, mixed $id, string $name): string +``` + +### 描述 + +发送新的戳一戳 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| type | mixed | | +| id | mixed | | +| name | string | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string | | + + +## anonymous + +```php +public function anonymous(int $ignore): string +``` + +### 描述 + +发送匿名消息 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| ignore | int | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string | | + + +## share + +```php +public function share(mixed $url, mixed $title, null $content, null $image): string +``` + +### 描述 + +发送链接分享（只能在单条回复中单独使用） + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| url | mixed | | +| title | mixed | | +| content | null | | +| image | null | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string | | + + +## contact + +```php +public function contact(mixed $type, mixed $id): string +``` + +### 描述 + +发送好友或群推荐名片 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| type | mixed | | +| id | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string | | + + +## location + +```php +public function location(mixed $lat, mixed $lon, string $title, string $content): string +``` + +### 描述 + +发送位置 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| lat | mixed | | +| lon | mixed | | +| title | string | | +| content | string | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string | | + + +## music + +```php +public function music(mixed $type, mixed $id_or_url, null $audio, null $title, null $content, null $image): string +``` + +### 描述 + +发送音乐分享（只能在单条回复中单独使用） +qq、163、xiami为内置分享，需要先通过搜索功能获取id后使用 +custom为自定义分享 +当为自定义分享时： +$id_or_url 为音乐卡片点进去打开的链接（一般是音乐介绍界面啦什么的） +$audio 为音乐（如mp3文件）的HTTP链接地址（不可为空） +$title 为音乐卡片的标题，建议12字以内（不可为空） +$content 为音乐卡片的简介（可忽略） +$image 为音乐卡片的图片链接地址（可忽略） + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| type | mixed | | +| id_or_url | mixed | | +| audio | null | | +| title | null | | +| content | null | | +| image | null | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string | | + + +## decode + +```php +public function decode(mixed $msg, mixed $is_content): mixed +``` + +### 描述 + +反转义字符串中的CQ码敏感符号 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| msg | mixed | | +| is_content | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## escape + +```php +public function escape(mixed $msg, mixed $is_content): mixed +``` + +### 描述 + +转义CQ码的特殊字符，同encode + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| msg | mixed | | +| is_content | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## encode + +```php +public function encode(mixed $msg, mixed $is_content): mixed +``` + +### 描述 + +转义CQ码的特殊字符 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| msg | mixed | | +| is_content | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## removeCQ + +```php +public function removeCQ(mixed $msg): string +``` + +### 描述 + +移除消息中所有的CQ码并返回移除CQ码后的消息 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| msg | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string | | + + +## getCQ + +```php +public function getCQ(mixed $msg, mixed $is_object): mixed +``` + +### 描述 + +获取消息中第一个CQ码 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| msg | mixed | | +| is_object | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## getAllCQ + +```php +public function getAllCQ(mixed $msg, mixed $is_object): mixed +``` + +### 描述 + +获取消息中所有的CQ码 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| msg | mixed | | +| is_object | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/API/GoCqhttpAPIV11.md b/docs/api/ZM/API/GoCqhttpAPIV11.md new file mode 100644 index 00000000..00662971 --- /dev/null +++ b/docs/api/ZM/API/GoCqhttpAPIV11.md @@ -0,0 +1,174 @@ +# ZM\API\GoCqhttpAPIV11 + +## getGuildServiceProfile + +```php +public function getGuildServiceProfile(): array|bool +``` + +### 描述 + +获取频道系统内BOT的资料 +响应字段：nickname, tiny_id, avatar_url + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array|bool | | + + +## getGuildList + +```php +public function getGuildList(): array|bool +``` + +### 描述 + +获取频道列表 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array|bool | | + + +## getGuildMetaByGuest + +```php +public function getGuildMetaByGuest(mixed $guild_id): array|bool +``` + +### 描述 + +通过访客获取频道元数据 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| guild_id | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array|bool | | + + +## getGuildChannelList + +```php +public function getGuildChannelList(mixed $guild_id, false $no_cache): array|bool +``` + +### 描述 + +获取子频道列表 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| guild_id | mixed | | +| no_cache | false | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array|bool | | + + +## getGuildMembers + +```php +public function getGuildMembers(mixed $guild_id): array|bool +``` + +### 描述 + +获取频道成员列表 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| guild_id | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array|bool | | + + +## sendGuildChannelMsg + +```php +public function sendGuildChannelMsg(mixed $guild_id, mixed $channel_id, mixed $message): array|bool +``` + +### 描述 + +发送信息到子频道 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| guild_id | mixed | | +| channel_id | mixed | | +| message | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array|bool | | + + +## processAPI + +```php +public function processAPI(mixed $connection, mixed $reply, |null $function): array|bool +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| connection | mixed | | +| reply | mixed | | +| function | |null | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array|bool | | + + +## processHttpAPI + +```php +public function processHttpAPI(mixed $connection, mixed $reply, null $function): bool +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| connection | mixed | | +| reply | mixed | | +| function | null | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| bool | | diff --git a/docs/api/ZM/API/OneBotV11.md b/docs/api/ZM/API/OneBotV11.md new file mode 100644 index 00000000..0e0096c3 --- /dev/null +++ b/docs/api/ZM/API/OneBotV11.md @@ -0,0 +1,932 @@ +# ZM\API\OneBotV11 + +## get + +```php +public function get(mixed $robot_id): ZMRobot +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| robot_id | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| ZMRobot | | + + +## getRandom + +```php +public function getRandom(): ZMRobot +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| ZMRobot | | + + +## getAllRobot + +```php +public function getAllRobot(): ZMRobot[] +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| ZMRobot[] | | + + +## sendPrivateMsg + +```php +public function sendPrivateMsg(mixed $user_id, mixed $message, bool $auto_escape): null|array|bool +``` + +### 描述 + +发送私聊消息 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| user_id | mixed | | +| message | mixed | | +| auto_escape | bool | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## sendGroupMsg + +```php +public function sendGroupMsg(mixed $group_id, mixed $message, bool $auto_escape): null|array|bool +``` + +### 描述 + +发送群消息 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| group_id | mixed | | +| message | mixed | | +| auto_escape | bool | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## sendMsg + +```php +public function sendMsg(mixed $message_type, mixed $target_id, mixed $message, bool $auto_escape): null|array|bool +``` + +### 描述 + +发送消息 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| message_type | mixed | | +| target_id | mixed | | +| message | mixed | | +| auto_escape | bool | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## deleteMsg + +```php +public function deleteMsg(mixed $message_id): null|array|bool +``` + +### 描述 + +撤回消息 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| message_id | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## getMsg + +```php +public function getMsg(mixed $message_id): null|array|bool +``` + +### 描述 + +获取消息 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| message_id | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## getForwardMsg + +```php +public function getForwardMsg(mixed $id): null|array|bool +``` + +### 描述 + +获取合并转发消息 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| id | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## sendLike + +```php +public function sendLike(mixed $user_id, int $times): null|array|bool +``` + +### 描述 + +发送好友赞 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| user_id | mixed | | +| times | int | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## setGroupKick + +```php +public function setGroupKick(mixed $group_id, mixed $user_id, bool $reject_add_request): null|array|bool +``` + +### 描述 + +群组踢人 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| group_id | mixed | | +| user_id | mixed | | +| reject_add_request | bool | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## setGroupBan + +```php +public function setGroupBan(mixed $group_id, mixed $user_id, int $duration): null|array|bool +``` + +### 描述 + +群组单人禁言 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| group_id | mixed | | +| user_id | mixed | | +| duration | int | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## setGroupAnonymousBan + +```php +public function setGroupAnonymousBan(mixed $group_id, mixed $anonymous_or_flag, int $duration): null|array|bool +``` + +### 描述 + +群组匿名用户禁言 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| group_id | mixed | | +| anonymous_or_flag | mixed | | +| duration | int | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## setGroupWholeBan + +```php +public function setGroupWholeBan(mixed $group_id, bool $enable): null|array|bool +``` + +### 描述 + +群组全员禁言 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| group_id | mixed | | +| enable | bool | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## setGroupAdmin + +```php +public function setGroupAdmin(mixed $group_id, mixed $user_id, bool $enable): null|array|bool +``` + +### 描述 + +群组设置管理员 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| group_id | mixed | | +| user_id | mixed | | +| enable | bool | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## setGroupAnonymous + +```php +public function setGroupAnonymous(mixed $group_id, bool $enable): null|array|bool +``` + +### 描述 + +群组匿名 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| group_id | mixed | | +| enable | bool | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## setGroupCard + +```php +public function setGroupCard(mixed $group_id, mixed $user_id, string $card): null|array|bool +``` + +### 描述 + +设置群名片（群备注） + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| group_id | mixed | | +| user_id | mixed | | +| card | string | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## setGroupName + +```php +public function setGroupName(mixed $group_id, mixed $group_name): null|array|bool +``` + +### 描述 + +设置群名 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| group_id | mixed | | +| group_name | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## setGroupLeave + +```php +public function setGroupLeave(mixed $group_id, bool $is_dismiss): null|array|bool +``` + +### 描述 + +退出群组 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| group_id | mixed | | +| is_dismiss | bool | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## setGroupSpecialTitle + +```php +public function setGroupSpecialTitle(mixed $group_id, mixed $user_id, string $special_title, int $duration): null|array|bool +``` + +### 描述 + +设置群组专属头衔 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| group_id | mixed | | +| user_id | mixed | | +| special_title | string | | +| duration | int | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## setFriendAddRequest + +```php +public function setFriendAddRequest(mixed $flag, bool $approve, string $remark): null|array|bool +``` + +### 描述 + +处理加好友请求 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| flag | mixed | | +| approve | bool | | +| remark | string | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## setGroupAddRequest + +```php +public function setGroupAddRequest(mixed $flag, mixed $sub_type, bool $approve, string $reason): null|array|bool +``` + +### 描述 + +处理加群请求／邀请 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| flag | mixed | | +| sub_type | mixed | | +| approve | bool | | +| reason | string | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## getLoginInfo + +```php +public function getLoginInfo(): null|array|bool +``` + +### 描述 + +获取登录号信息 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## getStrangerInfo + +```php +public function getStrangerInfo(mixed $user_id, bool $no_cache): null|array|bool +``` + +### 描述 + +获取陌生人信息 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| user_id | mixed | | +| no_cache | bool | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## getFriendList + +```php +public function getFriendList(): null|array|bool +``` + +### 描述 + +获取好友列表 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## getGroupInfo + +```php +public function getGroupInfo(mixed $group_id, bool $no_cache): null|array|bool +``` + +### 描述 + +获取群信息 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| group_id | mixed | | +| no_cache | bool | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## getGroupList + +```php +public function getGroupList(): null|array|bool +``` + +### 描述 + +获取群列表 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## getGroupMemberInfo + +```php +public function getGroupMemberInfo(mixed $group_id, mixed $user_id, bool $no_cache): null|array|bool +``` + +### 描述 + +获取群成员信息 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| group_id | mixed | | +| user_id | mixed | | +| no_cache | bool | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## getGroupMemberList + +```php +public function getGroupMemberList(mixed $group_id): null|array|bool +``` + +### 描述 + +获取群成员列表 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| group_id | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## getGroupHonorInfo + +```php +public function getGroupHonorInfo(mixed $group_id, mixed $type): null|array|bool +``` + +### 描述 + +获取群荣誉信息 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| group_id | mixed | | +| type | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## getCsrfToken + +```php +public function getCsrfToken(): null|array|bool +``` + +### 描述 + +获取 CSRF Token + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## getCredentials + +```php +public function getCredentials(string $domain): null|array|bool +``` + +### 描述 + +获取 QQ 相关接口凭证 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| domain | string | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## getRecord + +```php +public function getRecord(mixed $file, mixed $out_format): null|array|bool +``` + +### 描述 + +获取语音 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| file | mixed | | +| out_format | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## getImage + +```php +public function getImage(mixed $file): null|array|bool +``` + +### 描述 + +获取图片 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| file | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## canSendImage + +```php +public function canSendImage(): null|array|bool +``` + +### 描述 + +检查是否可以发送图片 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## canSendRecord + +```php +public function canSendRecord(): null|array|bool +``` + +### 描述 + +检查是否可以发送语音 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## getStatus + +```php +public function getStatus(): null|array|bool +``` + +### 描述 + +获取运行状态 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## getVersionInfo + +```php +public function getVersionInfo(): null|array|bool +``` + +### 描述 + +获取版本信息 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## setRestart + +```php +public function setRestart(int $delay): null|array|bool +``` + +### 描述 + +重启 OneBot 实现 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| delay | int | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## cleanCache + +```php +public function cleanCache(): null|array|bool +``` + +### 描述 + +清理缓存 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|bool | | + + +## getExtendedAPI + +```php +public function getExtendedAPI(string $package_name): mixed +``` + +### 描述 + +获取内置支持的扩展API对象 +现支持 go-cqhttp 的扩展API + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| package_name | string | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## processAPI + +```php +public function processAPI(mixed $connection, mixed $reply, |null $function): array|bool +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| connection | mixed | | +| reply | mixed | | +| function | |null | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array|bool | | + + +## processHttpAPI + +```php +public function processHttpAPI(mixed $connection, mixed $reply, null $function): bool +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| connection | mixed | | +| reply | mixed | | +| function | null | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| bool | | diff --git a/docs/api/ZM/API/TuringAPI.md b/docs/api/ZM/API/TuringAPI.md new file mode 100644 index 00000000..6957f75c --- /dev/null +++ b/docs/api/ZM/API/TuringAPI.md @@ -0,0 +1,24 @@ +# ZM\API\TuringAPI + +## getTuringMsg + +```php +public function getTuringMsg(mixed $msg, mixed $user_id, mixed $api): string +``` + +### 描述 + +请求图灵API，返回图灵的消息 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| msg | mixed | | +| user_id | mixed | | +| api | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string | | diff --git a/docs/api/ZM/API/ZMRobot.md b/docs/api/ZM/API/ZMRobot.md new file mode 100644 index 00000000..ae8c7946 --- /dev/null +++ b/docs/api/ZM/API/ZMRobot.md @@ -0,0 +1 @@ +# ZM\API\ZMRobot \ No newline at end of file diff --git a/docs/api/ZM/Annotation/AnnotationBase.md b/docs/api/ZM/Annotation/AnnotationBase.md new file mode 100644 index 00000000..1f51700a --- /dev/null +++ b/docs/api/ZM/Annotation/AnnotationBase.md @@ -0,0 +1 @@ +# ZM\Annotation\AnnotationBase \ No newline at end of file diff --git a/docs/api/ZM/Annotation/AnnotationParser.md b/docs/api/ZM/Annotation/AnnotationParser.md new file mode 100644 index 00000000..78722c28 --- /dev/null +++ b/docs/api/ZM/Annotation/AnnotationParser.md @@ -0,0 +1,98 @@ +# ZM\Annotation\AnnotationParser + +## __construct + +```php +public function __construct(): mixed +``` + +### 描述 + +AnnotationParser constructor. + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## registerMods + +```php +public function registerMods(): mixed +``` + +### 描述 + +注册各个模块类的注解和模块level的排序 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## addRegisterPath + +```php +public function addRegisterPath(mixed $path, mixed $indoor_name): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| path | mixed | | +| indoor_name | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## sortByLevel + +```php +public function sortByLevel(mixed $events, string $class_name, string $prefix): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| events | mixed | | +| class_name | string | | +| prefix | string | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## verifyMiddlewares + +```php +public function verifyMiddlewares(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/Annotation/CQ/CQAPIResponse.md b/docs/api/ZM/Annotation/CQ/CQAPIResponse.md new file mode 100644 index 00000000..54bf0fa7 --- /dev/null +++ b/docs/api/ZM/Annotation/CQ/CQAPIResponse.md @@ -0,0 +1 @@ +# ZM\Annotation\CQ\CQAPIResponse \ No newline at end of file diff --git a/docs/api/ZM/Annotation/CQ/CQAfter.md b/docs/api/ZM/Annotation/CQ/CQAfter.md new file mode 100644 index 00000000..e18500bb --- /dev/null +++ b/docs/api/ZM/Annotation/CQ/CQAfter.md @@ -0,0 +1,39 @@ +# ZM\Annotation\CQ\CQAfter + +## getLevel + +```php +public function getLevel(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## setLevel + +```php +public function setLevel(mixed $level): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| level | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/Annotation/CQ/CQBefore.md b/docs/api/ZM/Annotation/CQ/CQBefore.md new file mode 100644 index 00000000..9fc6d48a --- /dev/null +++ b/docs/api/ZM/Annotation/CQ/CQBefore.md @@ -0,0 +1,39 @@ +# ZM\Annotation\CQ\CQBefore + +## getLevel + +```php +public function getLevel(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## setLevel + +```php +public function setLevel(mixed $level): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| level | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/Annotation/CQ/CQCommand.md b/docs/api/ZM/Annotation/CQ/CQCommand.md new file mode 100644 index 00000000..69616fc9 --- /dev/null +++ b/docs/api/ZM/Annotation/CQ/CQCommand.md @@ -0,0 +1,22 @@ +# ZM\Annotation\CQ\CQCommand + +## setLevel + +```php +public function setLevel(int $level): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| level | int | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/Annotation/CQ/CQMessage.md b/docs/api/ZM/Annotation/CQ/CQMessage.md new file mode 100644 index 00000000..4d9529e5 --- /dev/null +++ b/docs/api/ZM/Annotation/CQ/CQMessage.md @@ -0,0 +1 @@ +# ZM\Annotation\CQ\CQMessage \ No newline at end of file diff --git a/docs/api/ZM/Annotation/CQ/CQMetaEvent.md b/docs/api/ZM/Annotation/CQ/CQMetaEvent.md new file mode 100644 index 00000000..bba036b4 --- /dev/null +++ b/docs/api/ZM/Annotation/CQ/CQMetaEvent.md @@ -0,0 +1,39 @@ +# ZM\Annotation\CQ\CQMetaEvent + +## getLevel + +```php +public function getLevel(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## setLevel + +```php +public function setLevel(int $level): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| level | int | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/Annotation/CQ/CQNotice.md b/docs/api/ZM/Annotation/CQ/CQNotice.md new file mode 100644 index 00000000..152494a7 --- /dev/null +++ b/docs/api/ZM/Annotation/CQ/CQNotice.md @@ -0,0 +1,22 @@ +# ZM\Annotation\CQ\CQNotice + +## setLevel + +```php +public function setLevel(int $level): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| level | int | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/Annotation/CQ/CQRequest.md b/docs/api/ZM/Annotation/CQ/CQRequest.md new file mode 100644 index 00000000..daa64f52 --- /dev/null +++ b/docs/api/ZM/Annotation/CQ/CQRequest.md @@ -0,0 +1,22 @@ +# ZM\Annotation\CQ\CQRequest + +## setLevel + +```php +public function setLevel(int $level): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| level | int | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/Annotation/Command/TerminalCommand.md b/docs/api/ZM/Annotation/Command/TerminalCommand.md new file mode 100644 index 00000000..7172677f --- /dev/null +++ b/docs/api/ZM/Annotation/Command/TerminalCommand.md @@ -0,0 +1 @@ +# ZM\Annotation\Command\TerminalCommand \ No newline at end of file diff --git a/docs/api/ZM/Annotation/Cron/Cron.md b/docs/api/ZM/Annotation/Cron/Cron.md new file mode 100644 index 00000000..95535f8c --- /dev/null +++ b/docs/api/ZM/Annotation/Cron/Cron.md @@ -0,0 +1,61 @@ +# ZM\Annotation\Cron\Cron + +## setStatus + +```php +public function setStatus(int $status): void +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| status | int | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| void | | + + +## getRecordNextTime + +```php +public function getRecordNextTime(): int +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| int | | + + +## setRecordNextTime + +```php +public function setRecordNextTime(int $record_next_time): void +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| record_next_time | int | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| void | | diff --git a/docs/api/ZM/Annotation/Http/Controller.md b/docs/api/ZM/Annotation/Http/Controller.md new file mode 100644 index 00000000..b1c2b707 --- /dev/null +++ b/docs/api/ZM/Annotation/Http/Controller.md @@ -0,0 +1 @@ +# ZM\Annotation\Http\Controller \ No newline at end of file diff --git a/docs/api/ZM/Annotation/Http/HandleAfter.md b/docs/api/ZM/Annotation/Http/HandleAfter.md new file mode 100644 index 00000000..81036d8b --- /dev/null +++ b/docs/api/ZM/Annotation/Http/HandleAfter.md @@ -0,0 +1 @@ +# ZM\Annotation\Http\HandleAfter \ No newline at end of file diff --git a/docs/api/ZM/Annotation/Http/HandleBefore.md b/docs/api/ZM/Annotation/Http/HandleBefore.md new file mode 100644 index 00000000..8d88feb6 --- /dev/null +++ b/docs/api/ZM/Annotation/Http/HandleBefore.md @@ -0,0 +1 @@ +# ZM\Annotation\Http\HandleBefore \ No newline at end of file diff --git a/docs/api/ZM/Annotation/Http/HandleException.md b/docs/api/ZM/Annotation/Http/HandleException.md new file mode 100644 index 00000000..af8e0057 --- /dev/null +++ b/docs/api/ZM/Annotation/Http/HandleException.md @@ -0,0 +1 @@ +# ZM\Annotation\Http\HandleException \ No newline at end of file diff --git a/docs/api/ZM/Annotation/Http/Middleware.md b/docs/api/ZM/Annotation/Http/Middleware.md new file mode 100644 index 00000000..ba3e2c8f --- /dev/null +++ b/docs/api/ZM/Annotation/Http/Middleware.md @@ -0,0 +1 @@ +# ZM\Annotation\Http\Middleware \ No newline at end of file diff --git a/docs/api/ZM/Annotation/Http/MiddlewareClass.md b/docs/api/ZM/Annotation/Http/MiddlewareClass.md new file mode 100644 index 00000000..ac53f6a0 --- /dev/null +++ b/docs/api/ZM/Annotation/Http/MiddlewareClass.md @@ -0,0 +1 @@ +# ZM\Annotation\Http\MiddlewareClass \ No newline at end of file diff --git a/docs/api/ZM/Annotation/Http/RequestMapping.md b/docs/api/ZM/Annotation/Http/RequestMapping.md new file mode 100644 index 00000000..d193124b --- /dev/null +++ b/docs/api/ZM/Annotation/Http/RequestMapping.md @@ -0,0 +1 @@ +# ZM\Annotation\Http\RequestMapping \ No newline at end of file diff --git a/docs/api/ZM/Annotation/Http/RequestMethod.md b/docs/api/ZM/Annotation/Http/RequestMethod.md new file mode 100644 index 00000000..6917eae5 --- /dev/null +++ b/docs/api/ZM/Annotation/Http/RequestMethod.md @@ -0,0 +1 @@ +# ZM\Annotation\Http\RequestMethod \ No newline at end of file diff --git a/docs/api/ZM/Annotation/Module/Closed.md b/docs/api/ZM/Annotation/Module/Closed.md new file mode 100644 index 00000000..422ccfca --- /dev/null +++ b/docs/api/ZM/Annotation/Module/Closed.md @@ -0,0 +1 @@ +# ZM\Annotation\Module\Closed \ No newline at end of file diff --git a/docs/api/ZM/Annotation/Swoole/OnCloseEvent.md b/docs/api/ZM/Annotation/Swoole/OnCloseEvent.md new file mode 100644 index 00000000..f88f8443 --- /dev/null +++ b/docs/api/ZM/Annotation/Swoole/OnCloseEvent.md @@ -0,0 +1 @@ +# ZM\Annotation\Swoole\OnCloseEvent \ No newline at end of file diff --git a/docs/api/ZM/Annotation/Swoole/OnManagerStartEvent.md b/docs/api/ZM/Annotation/Swoole/OnManagerStartEvent.md new file mode 100644 index 00000000..05cc1b94 --- /dev/null +++ b/docs/api/ZM/Annotation/Swoole/OnManagerStartEvent.md @@ -0,0 +1 @@ +# ZM\Annotation\Swoole\OnManagerStartEvent \ No newline at end of file diff --git a/docs/api/ZM/Annotation/Swoole/OnMessageEvent.md b/docs/api/ZM/Annotation/Swoole/OnMessageEvent.md new file mode 100644 index 00000000..95f59e25 --- /dev/null +++ b/docs/api/ZM/Annotation/Swoole/OnMessageEvent.md @@ -0,0 +1 @@ +# ZM\Annotation\Swoole\OnMessageEvent \ No newline at end of file diff --git a/docs/api/ZM/Annotation/Swoole/OnOpenEvent.md b/docs/api/ZM/Annotation/Swoole/OnOpenEvent.md new file mode 100644 index 00000000..20c0dd39 --- /dev/null +++ b/docs/api/ZM/Annotation/Swoole/OnOpenEvent.md @@ -0,0 +1 @@ +# ZM\Annotation\Swoole\OnOpenEvent \ No newline at end of file diff --git a/docs/api/ZM/Annotation/Swoole/OnPipeMessageEvent.md b/docs/api/ZM/Annotation/Swoole/OnPipeMessageEvent.md new file mode 100644 index 00000000..478ce4e3 --- /dev/null +++ b/docs/api/ZM/Annotation/Swoole/OnPipeMessageEvent.md @@ -0,0 +1 @@ +# ZM\Annotation\Swoole\OnPipeMessageEvent \ No newline at end of file diff --git a/docs/api/ZM/Annotation/Swoole/OnRequestEvent.md b/docs/api/ZM/Annotation/Swoole/OnRequestEvent.md new file mode 100644 index 00000000..bf94dde7 --- /dev/null +++ b/docs/api/ZM/Annotation/Swoole/OnRequestEvent.md @@ -0,0 +1 @@ +# ZM\Annotation\Swoole\OnRequestEvent \ No newline at end of file diff --git a/docs/api/ZM/Annotation/Swoole/OnSave.md b/docs/api/ZM/Annotation/Swoole/OnSave.md new file mode 100644 index 00000000..69b22d3e --- /dev/null +++ b/docs/api/ZM/Annotation/Swoole/OnSave.md @@ -0,0 +1 @@ +# ZM\Annotation\Swoole\OnSave \ No newline at end of file diff --git a/docs/api/ZM/Annotation/Swoole/OnSetup.md b/docs/api/ZM/Annotation/Swoole/OnSetup.md new file mode 100644 index 00000000..e1c94920 --- /dev/null +++ b/docs/api/ZM/Annotation/Swoole/OnSetup.md @@ -0,0 +1 @@ +# ZM\Annotation\Swoole\OnSetup \ No newline at end of file diff --git a/docs/api/ZM/Annotation/Swoole/OnStart.md b/docs/api/ZM/Annotation/Swoole/OnStart.md new file mode 100644 index 00000000..8f548c2c --- /dev/null +++ b/docs/api/ZM/Annotation/Swoole/OnStart.md @@ -0,0 +1 @@ +# ZM\Annotation\Swoole\OnStart \ No newline at end of file diff --git a/docs/api/ZM/Annotation/Swoole/OnSwooleEvent.md b/docs/api/ZM/Annotation/Swoole/OnSwooleEvent.md new file mode 100644 index 00000000..512d4d03 --- /dev/null +++ b/docs/api/ZM/Annotation/Swoole/OnSwooleEvent.md @@ -0,0 +1 @@ +# ZM\Annotation\Swoole\OnSwooleEvent \ No newline at end of file diff --git a/docs/api/ZM/Annotation/Swoole/OnSwooleEventBase.md b/docs/api/ZM/Annotation/Swoole/OnSwooleEventBase.md new file mode 100644 index 00000000..3ab07f91 --- /dev/null +++ b/docs/api/ZM/Annotation/Swoole/OnSwooleEventBase.md @@ -0,0 +1,22 @@ +# ZM\Annotation\Swoole\OnSwooleEventBase + +## setLevel + +```php +public function setLevel(int $level): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| level | int | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/Annotation/Swoole/OnTask.md b/docs/api/ZM/Annotation/Swoole/OnTask.md new file mode 100644 index 00000000..f08fabe2 --- /dev/null +++ b/docs/api/ZM/Annotation/Swoole/OnTask.md @@ -0,0 +1,17 @@ +# ZM\Annotation\Swoole\OnTask + +## getRule + +```php +public function getRule(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/Annotation/Swoole/OnTaskEvent.md b/docs/api/ZM/Annotation/Swoole/OnTaskEvent.md new file mode 100644 index 00000000..13a800ef --- /dev/null +++ b/docs/api/ZM/Annotation/Swoole/OnTaskEvent.md @@ -0,0 +1 @@ +# ZM\Annotation\Swoole\OnTaskEvent \ No newline at end of file diff --git a/docs/api/ZM/Annotation/Swoole/OnTick.md b/docs/api/ZM/Annotation/Swoole/OnTick.md new file mode 100644 index 00000000..63348022 --- /dev/null +++ b/docs/api/ZM/Annotation/Swoole/OnTick.md @@ -0,0 +1 @@ +# ZM\Annotation\Swoole\OnTick \ No newline at end of file diff --git a/docs/api/ZM/Annotation/Swoole/SwooleHandler.md b/docs/api/ZM/Annotation/Swoole/SwooleHandler.md new file mode 100644 index 00000000..a0a400f3 --- /dev/null +++ b/docs/api/ZM/Annotation/Swoole/SwooleHandler.md @@ -0,0 +1 @@ +# ZM\Annotation\Swoole\SwooleHandler \ No newline at end of file diff --git a/docs/api/ZM/Command/BuildCommand.md b/docs/api/ZM/Command/BuildCommand.md new file mode 100644 index 00000000..47d94c6d --- /dev/null +++ b/docs/api/ZM/Command/BuildCommand.md @@ -0,0 +1 @@ +# ZM\Command\BuildCommand \ No newline at end of file diff --git a/docs/api/ZM/Command/CheckConfigCommand.md b/docs/api/ZM/Command/CheckConfigCommand.md new file mode 100644 index 00000000..5dc21f1c --- /dev/null +++ b/docs/api/ZM/Command/CheckConfigCommand.md @@ -0,0 +1,24 @@ +# ZM\Command\CheckConfigCommand + +## check + +```php +public function check(mixed $remote, mixed $local, Symfony\Component\Console\Output\OutputInterface $out): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| remote | mixed | | +| local | mixed | | +| out | Symfony\Component\Console\Output\OutputInterface | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/Command/Daemon/DaemonCommand.md b/docs/api/ZM/Command/Daemon/DaemonCommand.md new file mode 100644 index 00000000..751f0241 --- /dev/null +++ b/docs/api/ZM/Command/Daemon/DaemonCommand.md @@ -0,0 +1 @@ +# ZM\Command\Daemon\DaemonCommand \ No newline at end of file diff --git a/docs/api/ZM/Command/Daemon/DaemonReloadCommand.md b/docs/api/ZM/Command/Daemon/DaemonReloadCommand.md new file mode 100644 index 00000000..d3f57d45 --- /dev/null +++ b/docs/api/ZM/Command/Daemon/DaemonReloadCommand.md @@ -0,0 +1 @@ +# ZM\Command\Daemon\DaemonReloadCommand \ No newline at end of file diff --git a/docs/api/ZM/Command/Daemon/DaemonStatusCommand.md b/docs/api/ZM/Command/Daemon/DaemonStatusCommand.md new file mode 100644 index 00000000..2d7cf795 --- /dev/null +++ b/docs/api/ZM/Command/Daemon/DaemonStatusCommand.md @@ -0,0 +1 @@ +# ZM\Command\Daemon\DaemonStatusCommand \ No newline at end of file diff --git a/docs/api/ZM/Command/Daemon/DaemonStopCommand.md b/docs/api/ZM/Command/Daemon/DaemonStopCommand.md new file mode 100644 index 00000000..bcdb4040 --- /dev/null +++ b/docs/api/ZM/Command/Daemon/DaemonStopCommand.md @@ -0,0 +1 @@ +# ZM\Command\Daemon\DaemonStopCommand \ No newline at end of file diff --git a/docs/api/ZM/Command/Generate/APIDocsGenerateCommand.md b/docs/api/ZM/Command/Generate/APIDocsGenerateCommand.md new file mode 100644 index 00000000..aa0daafd --- /dev/null +++ b/docs/api/ZM/Command/Generate/APIDocsGenerateCommand.md @@ -0,0 +1,91 @@ +# ZM\Command\Generate\APIDocsGenerateCommand + +## configure + +```php +public function configure(): void +``` + +### 描述 + +Configures the current command. + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| void | | + + +## execute + +```php +public function execute(Symfony\Component\Console\Input\InputInterface $input, Symfony\Component\Console\Output\OutputInterface $output): int +``` + +### 描述 + +Executes the current command. +This method is not abstract because you can use this class +as a concrete class. In this case, instead of defining the +execute() method, you set the code to execute by passing +a Closure to the setCode() method. + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| input | Symfony\Component\Console\Input\InputInterface | | +| output | Symfony\Component\Console\Output\OutputInterface | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| int | 0 if everything went fine, or an exit code * | + + +## getClassMetas + +```php +public function getClassMetas(string $class_name, Jasny\PhpdocParser\PhpdocParser $parser): array +``` + +### 描述 + +获取类的元数据 +包括类的注释、方法的注释、参数、返回值等 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| class_name | string | | +| parser | Jasny\PhpdocParser\PhpdocParser | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array | | + + +## convertMetaToMarkdown + +```php +public function convertMetaToMarkdown(string $method, array $meta): string +``` + +### 描述 + +将方法的元数据转换为 Markdown 格式 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| method | string | 方法名 | +| meta | array | 元数据 | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string | | diff --git a/docs/api/ZM/Command/Generate/SystemdGenerateCommand.md b/docs/api/ZM/Command/Generate/SystemdGenerateCommand.md new file mode 100644 index 00000000..ca5d40b4 --- /dev/null +++ b/docs/api/ZM/Command/Generate/SystemdGenerateCommand.md @@ -0,0 +1 @@ +# ZM\Command\Generate\SystemdGenerateCommand \ No newline at end of file diff --git a/docs/api/ZM/Command/InitCommand.md b/docs/api/ZM/Command/InitCommand.md new file mode 100644 index 00000000..2363e5c1 --- /dev/null +++ b/docs/api/ZM/Command/InitCommand.md @@ -0,0 +1 @@ +# ZM\Command\InitCommand \ No newline at end of file diff --git a/docs/api/ZM/Command/Module/ModuleListCommand.md b/docs/api/ZM/Command/Module/ModuleListCommand.md new file mode 100644 index 00000000..5075c52e --- /dev/null +++ b/docs/api/ZM/Command/Module/ModuleListCommand.md @@ -0,0 +1 @@ +# ZM\Command\Module\ModuleListCommand \ No newline at end of file diff --git a/docs/api/ZM/Command/Module/ModulePackCommand.md b/docs/api/ZM/Command/Module/ModulePackCommand.md new file mode 100644 index 00000000..c22ae01f --- /dev/null +++ b/docs/api/ZM/Command/Module/ModulePackCommand.md @@ -0,0 +1 @@ +# ZM\Command\Module\ModulePackCommand \ No newline at end of file diff --git a/docs/api/ZM/Command/Module/ModuleUnpackCommand.md b/docs/api/ZM/Command/Module/ModuleUnpackCommand.md new file mode 100644 index 00000000..31c7d466 --- /dev/null +++ b/docs/api/ZM/Command/Module/ModuleUnpackCommand.md @@ -0,0 +1 @@ +# ZM\Command\Module\ModuleUnpackCommand \ No newline at end of file diff --git a/docs/api/ZM/Command/PureHttpCommand.md b/docs/api/ZM/Command/PureHttpCommand.md new file mode 100644 index 00000000..4ebe259c --- /dev/null +++ b/docs/api/ZM/Command/PureHttpCommand.md @@ -0,0 +1 @@ +# ZM\Command\PureHttpCommand \ No newline at end of file diff --git a/docs/api/ZM/Command/RunServerCommand.md b/docs/api/ZM/Command/RunServerCommand.md new file mode 100644 index 00000000..71e5e134 --- /dev/null +++ b/docs/api/ZM/Command/RunServerCommand.md @@ -0,0 +1 @@ +# ZM\Command\RunServerCommand \ No newline at end of file diff --git a/docs/api/ZM/Command/Server/ServerReloadCommand.md b/docs/api/ZM/Command/Server/ServerReloadCommand.md new file mode 100644 index 00000000..a6d031cc --- /dev/null +++ b/docs/api/ZM/Command/Server/ServerReloadCommand.md @@ -0,0 +1 @@ +# ZM\Command\Server\ServerReloadCommand \ No newline at end of file diff --git a/docs/api/ZM/Command/Server/ServerStatusCommand.md b/docs/api/ZM/Command/Server/ServerStatusCommand.md new file mode 100644 index 00000000..8b6de08f --- /dev/null +++ b/docs/api/ZM/Command/Server/ServerStatusCommand.md @@ -0,0 +1 @@ +# ZM\Command\Server\ServerStatusCommand \ No newline at end of file diff --git a/docs/api/ZM/Command/Server/ServerStopCommand.md b/docs/api/ZM/Command/Server/ServerStopCommand.md new file mode 100644 index 00000000..717aea6d --- /dev/null +++ b/docs/api/ZM/Command/Server/ServerStopCommand.md @@ -0,0 +1 @@ +# ZM\Command\Server\ServerStopCommand \ No newline at end of file diff --git a/docs/api/ZM/ConsoleApplication.md b/docs/api/ZM/ConsoleApplication.md new file mode 100644 index 00000000..8fc5fca8 --- /dev/null +++ b/docs/api/ZM/ConsoleApplication.md @@ -0,0 +1,44 @@ +# ZM\ConsoleApplication + +## __construct + +```php +public function __construct(string $name): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| name | string | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## initEnv + +```php +public function initEnv(string $with_default_cmd): ZM\ConsoleApplication +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| with_default_cmd | string | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| ZM\ConsoleApplication | | diff --git a/docs/api/ZM/Context/Context.md b/docs/api/ZM/Context/Context.md new file mode 100644 index 00000000..048b9c57 --- /dev/null +++ b/docs/api/ZM/Context/Context.md @@ -0,0 +1,210 @@ +# ZM\Context\Context + +## getServer + +```php +public function getServer(): Server +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| Server | | + + +## getData + +```php +public function getData(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## reply + +```php +public function reply(mixed $msg, bool $yield): array|bool +``` + +### 描述 + +only can used by cq->message event function + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| msg | mixed | | +| yield | bool | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array|bool | | + + +## finalReply + +```php +public function finalReply(mixed $msg, bool $yield): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| msg | mixed | | +| yield | bool | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## waitMessage + +```php +public function waitMessage(string $prompt, int $timeout, string $timeout_prompt): string +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| prompt | string | | +| timeout | int | | +| timeout_prompt | string | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string | | + + +## getArgs + +```php +public function getArgs(mixed $mode, mixed $prompt_msg): mixed|string +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| mode | mixed | | +| prompt_msg | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed|string | | + + +## getNextArg + +```php +public function getNextArg(string $prompt_msg): int|mixed|string +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| prompt_msg | string | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| int|mixed|string | | + + +## getFullArg + +```php +public function getFullArg(string $prompt_msg): int|mixed|string +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| prompt_msg | string | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| int|mixed|string | | + + +## getNumArg + +```php +public function getNumArg(string $prompt_msg): int|mixed|string +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| prompt_msg | string | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| int|mixed|string | | + + +## cloneFromParent + +```php +public function cloneFromParent(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/DB/DB.md b/docs/api/ZM/DB/DB.md new file mode 100644 index 00000000..41876389 --- /dev/null +++ b/docs/api/ZM/DB/DB.md @@ -0,0 +1,88 @@ +# ZM\DB\DB + +## initTableList + +```php +public function initTableList(mixed $db_name): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| db_name | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## table + +```php +public function table(mixed $table_name): ZM\DB\Table +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| table_name | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| ZM\DB\Table | | + + +## statement + +```php +public function statement(mixed $line): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| line | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## unprepared + +```php +public function unprepared(mixed $line): bool +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| line | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| bool | | diff --git a/docs/api/ZM/DB/DeleteBody.md b/docs/api/ZM/DB/DeleteBody.md new file mode 100644 index 00000000..59efd462 --- /dev/null +++ b/docs/api/ZM/DB/DeleteBody.md @@ -0,0 +1,39 @@ +# ZM\DB\DeleteBody + +## __construct + +```php +public function __construct(ZM\DB\Table $table): mixed +``` + +### 描述 + +DeleteBody constructor. + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| table | ZM\DB\Table | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## save + +```php +public function save(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/DB/InsertBody.md b/docs/api/ZM/DB/InsertBody.md new file mode 100644 index 00000000..e44313b5 --- /dev/null +++ b/docs/api/ZM/DB/InsertBody.md @@ -0,0 +1,40 @@ +# ZM\DB\InsertBody + +## __construct + +```php +public function __construct(mixed $row, ZM\DB\Table $table): mixed +``` + +### 描述 + +InsertBody constructor. + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| row | mixed | | +| table | ZM\DB\Table | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## save + +```php +public function save(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/DB/SelectBody.md b/docs/api/ZM/DB/SelectBody.md new file mode 100644 index 00000000..986160ab --- /dev/null +++ b/docs/api/ZM/DB/SelectBody.md @@ -0,0 +1,134 @@ +# ZM\DB\SelectBody + +## get + +```php +public function get(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## count + +```php +public function count(): int +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| int | | + + +## fetchAll + +```php +public function fetchAll(int $fetch_mode): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| fetch_mode | int | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## fetchFirst + +```php +public function fetchFirst(): null|mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|mixed | | + + +## value + +```php +public function value(null $key): null|mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| key | null | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|mixed | | + + +## execute + +```php +public function execute(int $fetch_mode): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| fetch_mode | int | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## getSelectThing + +```php +public function getSelectThing(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/DB/Table.md b/docs/api/ZM/DB/Table.md new file mode 100644 index 00000000..3d0fd5bc --- /dev/null +++ b/docs/api/ZM/DB/Table.md @@ -0,0 +1,17 @@ +# ZM\DB\Table + +## getTableName + +```php +public function getTableName(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/DB/UpdateBody.md b/docs/api/ZM/DB/UpdateBody.md new file mode 100644 index 00000000..0ffd8ee9 --- /dev/null +++ b/docs/api/ZM/DB/UpdateBody.md @@ -0,0 +1,40 @@ +# ZM\DB\UpdateBody + +## __construct + +```php +public function __construct(ZM\DB\Table $table, array $set_value): mixed +``` + +### 描述 + +UpdateBody constructor. + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| table | ZM\DB\Table | | +| set_value | array | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## save + +```php +public function save(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/Entity/CQObject.md b/docs/api/ZM/Entity/CQObject.md new file mode 100644 index 00000000..0281c7e2 --- /dev/null +++ b/docs/api/ZM/Entity/CQObject.md @@ -0,0 +1 @@ +# ZM\Entity\CQObject \ No newline at end of file diff --git a/docs/api/ZM/Entity/MatchResult.md b/docs/api/ZM/Entity/MatchResult.md new file mode 100644 index 00000000..95d6cc9c --- /dev/null +++ b/docs/api/ZM/Entity/MatchResult.md @@ -0,0 +1 @@ +# ZM\Entity\MatchResult \ No newline at end of file diff --git a/docs/api/ZM/Event/EventDispatcher.md b/docs/api/ZM/Event/EventDispatcher.md new file mode 100644 index 00000000..607115ec --- /dev/null +++ b/docs/api/ZM/Event/EventDispatcher.md @@ -0,0 +1,22 @@ +# ZM\Event\EventDispatcher + +## interrupt + +```php +public function interrupt(mixed $return_var): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| return_var | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/Event/EventManager.md b/docs/api/ZM/Event/EventManager.md new file mode 100644 index 00000000..f36f19ce --- /dev/null +++ b/docs/api/ZM/Event/EventManager.md @@ -0,0 +1,39 @@ +# ZM\Event\EventManager + +## loadEventByParser + +```php +public function loadEventByParser(ZM\Annotation\AnnotationParser $parser): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| parser | ZM\Annotation\AnnotationParser | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## registerTimerTick + +```php +public function registerTimerTick(): mixed +``` + +### 描述 + +注册所有计时器给每个进程 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/Event/EventTracer.md b/docs/api/ZM/Event/EventTracer.md new file mode 100644 index 00000000..170f6e0c --- /dev/null +++ b/docs/api/ZM/Event/EventTracer.md @@ -0,0 +1,34 @@ +# ZM\Event\EventTracer + +## getCurrentEvent + +```php +public function getCurrentEvent(): null|AnnotationBase +``` + +### 描述 + +获取当前注解事件的注解类，如CQCommand对象 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|AnnotationBase | | + + +## getCurrentEventMiddlewares + +```php +public function getCurrentEventMiddlewares(): null|array|mixed +``` + +### 描述 + +获取当前注解事件的中间件列表 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|mixed | | diff --git a/docs/api/ZM/Event/SwooleEvent/OnBeforeReload.md b/docs/api/ZM/Event/SwooleEvent/OnBeforeReload.md new file mode 100644 index 00000000..bdd2eae8 --- /dev/null +++ b/docs/api/ZM/Event/SwooleEvent/OnBeforeReload.md @@ -0,0 +1 @@ +# ZM\Event\SwooleEvent\OnBeforeReload \ No newline at end of file diff --git a/docs/api/ZM/Event/SwooleEvent/OnClose.md b/docs/api/ZM/Event/SwooleEvent/OnClose.md new file mode 100644 index 00000000..791f270c --- /dev/null +++ b/docs/api/ZM/Event/SwooleEvent/OnClose.md @@ -0,0 +1 @@ +# ZM\Event\SwooleEvent\OnClose \ No newline at end of file diff --git a/docs/api/ZM/Event/SwooleEvent/OnManagerStart.md b/docs/api/ZM/Event/SwooleEvent/OnManagerStart.md new file mode 100644 index 00000000..8e8c1709 --- /dev/null +++ b/docs/api/ZM/Event/SwooleEvent/OnManagerStart.md @@ -0,0 +1 @@ +# ZM\Event\SwooleEvent\OnManagerStart \ No newline at end of file diff --git a/docs/api/ZM/Event/SwooleEvent/OnManagerStop.md b/docs/api/ZM/Event/SwooleEvent/OnManagerStop.md new file mode 100644 index 00000000..a63cd28c --- /dev/null +++ b/docs/api/ZM/Event/SwooleEvent/OnManagerStop.md @@ -0,0 +1 @@ +# ZM\Event\SwooleEvent\OnManagerStop \ No newline at end of file diff --git a/docs/api/ZM/Event/SwooleEvent/OnMessage.md b/docs/api/ZM/Event/SwooleEvent/OnMessage.md new file mode 100644 index 00000000..f61b9e69 --- /dev/null +++ b/docs/api/ZM/Event/SwooleEvent/OnMessage.md @@ -0,0 +1 @@ +# ZM\Event\SwooleEvent\OnMessage \ No newline at end of file diff --git a/docs/api/ZM/Event/SwooleEvent/OnOpen.md b/docs/api/ZM/Event/SwooleEvent/OnOpen.md new file mode 100644 index 00000000..d53fa941 --- /dev/null +++ b/docs/api/ZM/Event/SwooleEvent/OnOpen.md @@ -0,0 +1 @@ +# ZM\Event\SwooleEvent\OnOpen \ No newline at end of file diff --git a/docs/api/ZM/Event/SwooleEvent/OnPipeMessage.md b/docs/api/ZM/Event/SwooleEvent/OnPipeMessage.md new file mode 100644 index 00000000..3148b190 --- /dev/null +++ b/docs/api/ZM/Event/SwooleEvent/OnPipeMessage.md @@ -0,0 +1 @@ +# ZM\Event\SwooleEvent\OnPipeMessage \ No newline at end of file diff --git a/docs/api/ZM/Event/SwooleEvent/OnRequest.md b/docs/api/ZM/Event/SwooleEvent/OnRequest.md new file mode 100644 index 00000000..24372cee --- /dev/null +++ b/docs/api/ZM/Event/SwooleEvent/OnRequest.md @@ -0,0 +1 @@ +# ZM\Event\SwooleEvent\OnRequest \ No newline at end of file diff --git a/docs/api/ZM/Event/SwooleEvent/OnShutdown.md b/docs/api/ZM/Event/SwooleEvent/OnShutdown.md new file mode 100644 index 00000000..b41dcd23 --- /dev/null +++ b/docs/api/ZM/Event/SwooleEvent/OnShutdown.md @@ -0,0 +1 @@ +# ZM\Event\SwooleEvent\OnShutdown \ No newline at end of file diff --git a/docs/api/ZM/Event/SwooleEvent/OnStart.md b/docs/api/ZM/Event/SwooleEvent/OnStart.md new file mode 100644 index 00000000..8b1fdaea --- /dev/null +++ b/docs/api/ZM/Event/SwooleEvent/OnStart.md @@ -0,0 +1 @@ +# ZM\Event\SwooleEvent\OnStart \ No newline at end of file diff --git a/docs/api/ZM/Event/SwooleEvent/OnTask.md b/docs/api/ZM/Event/SwooleEvent/OnTask.md new file mode 100644 index 00000000..4207ecf1 --- /dev/null +++ b/docs/api/ZM/Event/SwooleEvent/OnTask.md @@ -0,0 +1,23 @@ +# ZM\Event\SwooleEvent\OnTask + +## onCall + +```php +public function onCall(Swoole\Server $server, Swoole\Server\Task $task): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| server | Swoole\Server | | +| task | Swoole\Server\Task | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/Event/SwooleEvent/OnWorkerExit.md b/docs/api/ZM/Event/SwooleEvent/OnWorkerExit.md new file mode 100644 index 00000000..11fcbb88 --- /dev/null +++ b/docs/api/ZM/Event/SwooleEvent/OnWorkerExit.md @@ -0,0 +1 @@ +# ZM\Event\SwooleEvent\OnWorkerExit \ No newline at end of file diff --git a/docs/api/ZM/Event/SwooleEvent/OnWorkerStart.md b/docs/api/ZM/Event/SwooleEvent/OnWorkerStart.md new file mode 100644 index 00000000..85a18f9a --- /dev/null +++ b/docs/api/ZM/Event/SwooleEvent/OnWorkerStart.md @@ -0,0 +1,17 @@ +# ZM\Event\SwooleEvent\OnWorkerStart + +## loadAnnotations + +```php +public function loadAnnotations(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/Event/SwooleEvent/OnWorkerStop.md b/docs/api/ZM/Event/SwooleEvent/OnWorkerStop.md new file mode 100644 index 00000000..d05cda18 --- /dev/null +++ b/docs/api/ZM/Event/SwooleEvent/OnWorkerStop.md @@ -0,0 +1 @@ +# ZM\Event\SwooleEvent\OnWorkerStop \ No newline at end of file diff --git a/docs/api/ZM/Exception/AnnotationException.md b/docs/api/ZM/Exception/AnnotationException.md new file mode 100644 index 00000000..31113429 --- /dev/null +++ b/docs/api/ZM/Exception/AnnotationException.md @@ -0,0 +1 @@ +# ZM\Exception\AnnotationException \ No newline at end of file diff --git a/docs/api/ZM/Exception/DbException.md b/docs/api/ZM/Exception/DbException.md new file mode 100644 index 00000000..4e7dcee3 --- /dev/null +++ b/docs/api/ZM/Exception/DbException.md @@ -0,0 +1 @@ +# ZM\Exception\DbException \ No newline at end of file diff --git a/docs/api/ZM/Exception/ExceptionHandler.md b/docs/api/ZM/Exception/ExceptionHandler.md new file mode 100644 index 00000000..5b51b2a8 --- /dev/null +++ b/docs/api/ZM/Exception/ExceptionHandler.md @@ -0,0 +1 @@ +# ZM\Exception\ExceptionHandler \ No newline at end of file diff --git a/docs/api/ZM/Exception/InitException.md b/docs/api/ZM/Exception/InitException.md new file mode 100644 index 00000000..56345ae6 --- /dev/null +++ b/docs/api/ZM/Exception/InitException.md @@ -0,0 +1 @@ +# ZM\Exception\InitException \ No newline at end of file diff --git a/docs/api/ZM/Exception/InterruptException.md b/docs/api/ZM/Exception/InterruptException.md new file mode 100644 index 00000000..25c3f559 --- /dev/null +++ b/docs/api/ZM/Exception/InterruptException.md @@ -0,0 +1 @@ +# ZM\Exception\InterruptException \ No newline at end of file diff --git a/docs/api/ZM/Exception/InvalidArgumentException.md b/docs/api/ZM/Exception/InvalidArgumentException.md new file mode 100644 index 00000000..7e5871af --- /dev/null +++ b/docs/api/ZM/Exception/InvalidArgumentException.md @@ -0,0 +1 @@ +# ZM\Exception\InvalidArgumentException \ No newline at end of file diff --git a/docs/api/ZM/Exception/LightCacheException.md b/docs/api/ZM/Exception/LightCacheException.md new file mode 100644 index 00000000..fa92cc43 --- /dev/null +++ b/docs/api/ZM/Exception/LightCacheException.md @@ -0,0 +1 @@ +# ZM\Exception\LightCacheException \ No newline at end of file diff --git a/docs/api/ZM/Exception/MethodNotFoundException.md b/docs/api/ZM/Exception/MethodNotFoundException.md new file mode 100644 index 00000000..d3e19448 --- /dev/null +++ b/docs/api/ZM/Exception/MethodNotFoundException.md @@ -0,0 +1 @@ +# ZM\Exception\MethodNotFoundException \ No newline at end of file diff --git a/docs/api/ZM/Exception/ModulePackException.md b/docs/api/ZM/Exception/ModulePackException.md new file mode 100644 index 00000000..3e4a4be6 --- /dev/null +++ b/docs/api/ZM/Exception/ModulePackException.md @@ -0,0 +1 @@ +# ZM\Exception\ModulePackException \ No newline at end of file diff --git a/docs/api/ZM/Exception/NotInitializedException.md b/docs/api/ZM/Exception/NotInitializedException.md new file mode 100644 index 00000000..6bb11190 --- /dev/null +++ b/docs/api/ZM/Exception/NotInitializedException.md @@ -0,0 +1 @@ +# ZM\Exception\NotInitializedException \ No newline at end of file diff --git a/docs/api/ZM/Exception/RedisException.md b/docs/api/ZM/Exception/RedisException.md new file mode 100644 index 00000000..94c5c5d7 --- /dev/null +++ b/docs/api/ZM/Exception/RedisException.md @@ -0,0 +1 @@ +# ZM\Exception\RedisException \ No newline at end of file diff --git a/docs/api/ZM/Exception/RobotNotFoundException.md b/docs/api/ZM/Exception/RobotNotFoundException.md new file mode 100644 index 00000000..4eb4d74e --- /dev/null +++ b/docs/api/ZM/Exception/RobotNotFoundException.md @@ -0,0 +1 @@ +# ZM\Exception\RobotNotFoundException \ No newline at end of file diff --git a/docs/api/ZM/Exception/WaitTimeoutException.md b/docs/api/ZM/Exception/WaitTimeoutException.md new file mode 100644 index 00000000..709132dc --- /dev/null +++ b/docs/api/ZM/Exception/WaitTimeoutException.md @@ -0,0 +1 @@ +# ZM\Exception\WaitTimeoutException \ No newline at end of file diff --git a/docs/api/ZM/Exception/ZMException.md b/docs/api/ZM/Exception/ZMException.md new file mode 100644 index 00000000..3cbdf6af --- /dev/null +++ b/docs/api/ZM/Exception/ZMException.md @@ -0,0 +1 @@ +# ZM\Exception\ZMException \ No newline at end of file diff --git a/docs/api/ZM/Exception/ZMKnownException.md b/docs/api/ZM/Exception/ZMKnownException.md new file mode 100644 index 00000000..5a66ae7b --- /dev/null +++ b/docs/api/ZM/Exception/ZMKnownException.md @@ -0,0 +1 @@ +# ZM\Exception\ZMKnownException \ No newline at end of file diff --git a/docs/api/ZM/Framework.md b/docs/api/ZM/Framework.md new file mode 100644 index 00000000..f6eddee6 --- /dev/null +++ b/docs/api/ZM/Framework.md @@ -0,0 +1,127 @@ +# ZM\Framework + +## saveProcessState + +```php +public function saveProcessState(int|string $pid, int $type, array $data): mixed +``` + +### 描述 + +将各进程的pid写入文件，以备后续崩溃及僵尸进程处理使用 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| pid | int|string | | +| type | int | | +| data | array | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## getProcessState + +```php +public function getProcessState(mixed $id_or_name, int $type): false|int|mixed +``` + +### 描述 + +用于框架内部获取多进程运行状态的函数 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| id_or_name | mixed | | +| type | int | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| false|int|mixed | | + + +## removeProcessState + +```php +public function removeProcessState(null $id_or_name, int $type): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| id_or_name | null | | +| type | int | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## loadServerEvents + +```php +public function loadServerEvents(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## registerServerEvents + +```php +public function registerServerEvents(): mixed +``` + +### 描述 + +从全局配置文件里读取注入系统事件的类 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## parseCliArgs + +```php +public function parseCliArgs(mixed $args, mixed $add_port): mixed +``` + +### 描述 + +解析命令行的 $argv 参数们 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| args | mixed | | +| add_port | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/Http/Response.md b/docs/api/ZM/Http/Response.md new file mode 100644 index 00000000..c85e1122 --- /dev/null +++ b/docs/api/ZM/Http/Response.md @@ -0,0 +1,358 @@ +# ZM\Http\Response + +## initHeader + +```php +public function initHeader(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## status + +```php +public function status(mixed $http_code, mixed $reason, mixed $params): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| http_code | mixed | | +| reason | mixed | | +| params | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## setStatusCode + +```php +public function setStatusCode(mixed $http_code, mixed $reason, mixed $params): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| http_code | mixed | | +| reason | mixed | | +| params | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## header + +```php +public function header(mixed $key, mixed $value, mixed $ucwords): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| key | mixed | | +| value | mixed | | +| ucwords | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## setHeader + +```php +public function setHeader(mixed $key, mixed $value, mixed $ucwords): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| key | mixed | | +| value | mixed | | +| ucwords | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## trailer + +```php +public function trailer(mixed $key, mixed $value): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| key | mixed | | +| value | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## ping + +```php +public function ping(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## write + +```php +public function write(mixed $content): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| content | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## end + +```php +public function end(mixed $content): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| content | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## sendfile + +```php +public function sendfile(mixed $filename, mixed $offset, mixed $length): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| filename | mixed | | +| offset | mixed | | +| length | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## redirect + +```php +public function redirect(mixed $location, mixed $http_code): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| location | mixed | | +| http_code | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## detach + +```php +public function detach(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## create + +```php +public function create(mixed $fd): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| fd | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## upgrade + +```php +public function upgrade(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## push + +```php +public function push(mixed $data, null $opcode, null $flags): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| data | mixed | | +| opcode | null | | +| flags | null | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## recv + +```php +public function recv(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## close + +```php +public function close(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/Http/RouteManager.md b/docs/api/ZM/Http/RouteManager.md new file mode 100644 index 00000000..6fef2bb3 --- /dev/null +++ b/docs/api/ZM/Http/RouteManager.md @@ -0,0 +1 @@ +# ZM\Http\RouteManager \ No newline at end of file diff --git a/docs/api/ZM/Http/StaticFileHandler.md b/docs/api/ZM/Http/StaticFileHandler.md new file mode 100644 index 00000000..37ec9a8c --- /dev/null +++ b/docs/api/ZM/Http/StaticFileHandler.md @@ -0,0 +1 @@ +# ZM\Http\StaticFileHandler \ No newline at end of file diff --git a/docs/api/ZM/Module/InstantModule.md b/docs/api/ZM/Module/InstantModule.md new file mode 100644 index 00000000..c43d6982 --- /dev/null +++ b/docs/api/ZM/Module/InstantModule.md @@ -0,0 +1 @@ +# ZM\Module\InstantModule \ No newline at end of file diff --git a/docs/api/ZM/Module/ModuleBase.md b/docs/api/ZM/Module/ModuleBase.md new file mode 100644 index 00000000..0de3fd64 --- /dev/null +++ b/docs/api/ZM/Module/ModuleBase.md @@ -0,0 +1,17 @@ +# ZM\Module\ModuleBase + +## getModuleName + +```php +public function getModuleName(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/Module/ModulePacker.md b/docs/api/ZM/Module/ModulePacker.md new file mode 100644 index 00000000..a8764a76 --- /dev/null +++ b/docs/api/ZM/Module/ModulePacker.md @@ -0,0 +1,151 @@ +# ZM\Module\ModulePacker + +## __construct + +```php +public function __construct(array $module): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| module | array | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## setOutputPath + +```php +public function setOutputPath(mixed $path): mixed +``` + +### 描述 + +设置输出文件夹 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| path | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## setOverride + +```php +public function setOverride(bool $override): mixed +``` + +### 描述 + +设置是否覆盖 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| override | bool | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## getName + +```php +public function getName(): mixed +``` + +### 描述 + +获取模块名字 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## getFileName + +```php +public function getFileName(): string +``` + +### 描述 + +获取打包的文件名绝对路径 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string | | + + +## pack + +```php +public function pack(): mixed +``` + +### 描述 + +打包模块 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## addLightCacheStore + +```php +public function addLightCacheStore(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## addZMDataFiles + +```php +public function addZMDataFiles(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/Module/ModuleUnpacker.md b/docs/api/ZM/Module/ModuleUnpacker.md new file mode 100644 index 00000000..ed05ec1a --- /dev/null +++ b/docs/api/ZM/Module/ModuleUnpacker.md @@ -0,0 +1,120 @@ +# ZM\Module\ModuleUnpacker + +## unpack + +```php +public function unpack(mixed $ignore_depends, bool $override_light_cache, bool $override_data_files, bool $override_source): array +``` + +### 描述 + +解包模块 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| ignore_depends | mixed | | +| override_light_cache | bool | | +| override_data_files | bool | | +| override_source | bool | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array | | + + +## checkConfig + +```php +public function checkConfig(): mixed +``` + +### 描述 + +检查模块配置文件是否正确地放在phar包的位置中 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## checkDepends + +```php +public function checkDepends(mixed $ignore_depends): mixed +``` + +### 描述 + +检查模块依赖关系 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| ignore_depends | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## checkLightCacheStore + +```php +public function checkLightCacheStore(): mixed +``` + +### 描述 + +检查 light-cache-store 项是否合规 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## checkZMDataStore + +```php +public function checkZMDataStore(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## copyZMDataStore + +```php +public function copyZMDataStore(mixed $override_data): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| override_data | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/Module/QQBot.md b/docs/api/ZM/Module/QQBot.md new file mode 100644 index 00000000..08a89fab --- /dev/null +++ b/docs/api/ZM/Module/QQBot.md @@ -0,0 +1,107 @@ +# ZM\Module\QQBot + +## handle + +```php +public function handle(mixed $data, int $level): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| data | mixed | | +| level | int | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## dispatchBeforeEvents + +```php +public function dispatchBeforeEvents(mixed $data, mixed $time): ZM\Event\EventDispatcher +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| data | mixed | | +| time | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| ZM\Event\EventDispatcher | | + + +## dispatchEvents + +```php +public function dispatchEvents(mixed $data): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| data | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## dispatchAPIResponse + +```php +public function dispatchAPIResponse(mixed $req): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| req | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## getInstance + +```php +public function getInstance(): self +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| self | | diff --git a/docs/api/ZM/MySQL/MySQLConnection.md b/docs/api/ZM/MySQL/MySQLConnection.md new file mode 100644 index 00000000..d97731bd --- /dev/null +++ b/docs/api/ZM/MySQL/MySQLConnection.md @@ -0,0 +1 @@ +# ZM\MySQL\MySQLConnection \ No newline at end of file diff --git a/docs/api/ZM/MySQL/MySQLDriver.md b/docs/api/ZM/MySQL/MySQLDriver.md new file mode 100644 index 00000000..087f7584 --- /dev/null +++ b/docs/api/ZM/MySQL/MySQLDriver.md @@ -0,0 +1 @@ +# ZM\MySQL\MySQLDriver \ No newline at end of file diff --git a/docs/api/ZM/MySQL/MySQLManager.md b/docs/api/ZM/MySQL/MySQLManager.md new file mode 100644 index 00000000..3d71f681 --- /dev/null +++ b/docs/api/ZM/MySQL/MySQLManager.md @@ -0,0 +1 @@ +# ZM\MySQL\MySQLManager \ No newline at end of file diff --git a/docs/api/ZM/MySQL/MySQLPool.md b/docs/api/ZM/MySQL/MySQLPool.md new file mode 100644 index 00000000..64c67141 --- /dev/null +++ b/docs/api/ZM/MySQL/MySQLPool.md @@ -0,0 +1,39 @@ +# ZM\MySQL\MySQLPool + +## getConnection + +```php +public function getConnection(): PDO|PDOProxy|void +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| PDO|PDOProxy|void | | + + +## putConnection + +```php +public function putConnection(PDO|PDOProxy $connection): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| connection | PDO|PDOProxy | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/MySQL/MySQLQueryBuilder.md b/docs/api/ZM/MySQL/MySQLQueryBuilder.md new file mode 100644 index 00000000..2aa0d294 --- /dev/null +++ b/docs/api/ZM/MySQL/MySQLQueryBuilder.md @@ -0,0 +1,17 @@ +# ZM\MySQL\MySQLQueryBuilder + +## execute + +```php +public function execute(): int|MySQLStatementWrapper +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| int|MySQLStatementWrapper | | diff --git a/docs/api/ZM/MySQL/MySQLStatement.md b/docs/api/ZM/MySQL/MySQLStatement.md new file mode 100644 index 00000000..7b972737 --- /dev/null +++ b/docs/api/ZM/MySQL/MySQLStatement.md @@ -0,0 +1 @@ +# ZM\MySQL\MySQLStatement \ No newline at end of file diff --git a/docs/api/ZM/MySQL/MySQLStatementWrapper.md b/docs/api/ZM/MySQL/MySQLStatementWrapper.md new file mode 100644 index 00000000..8762f84a --- /dev/null +++ b/docs/api/ZM/MySQL/MySQLStatementWrapper.md @@ -0,0 +1,291 @@ +# ZM\MySQL\MySQLStatementWrapper + +## getIterator + +```php +public function getIterator(): ResultStatement +``` + +### 描述 + +获取结果的迭代器 +wrapper method + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| ResultStatement | | + + +## columnCount + +```php +public function columnCount(): int +``` + +### 描述 + +获取列数 +wrapper method + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| int | | + + +## fetchNumeric + +```php +public function fetchNumeric(): array|false|mixed +``` + +### 描述 + +wrapper method + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array|false|mixed | | + + +## fetchAssociative + +```php +public function fetchAssociative(): array|false|mixed +``` + +### 描述 + +wrapper method + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array|false|mixed | | + + +## fetchOne + +```php +public function fetchOne(): false|mixed +``` + +### 描述 + +wrapper method + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| false|mixed | | + + +## fetchAllNumeric + +```php +public function fetchAllNumeric(): array +``` + +### 描述 + +wrapper method + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array | | + + +## fetchAllAssociative + +```php +public function fetchAllAssociative(): array +``` + +### 描述 + +wrapper method + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array | | + + +## fetchAllKeyValue + +```php +public function fetchAllKeyValue(): array +``` + +### 描述 + +wrapper method + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array | | + + +## fetchAllAssociativeIndexed + +```php +public function fetchAllAssociativeIndexed(): array +``` + +### 描述 + +wrapper method + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array | | + + +## fetchFirstColumn + +```php +public function fetchFirstColumn(): array +``` + +### 描述 + +wrapper method + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array | | + + +## iterateNumeric + +```php +public function iterateNumeric(): Traversable +``` + +### 描述 + +wrapper method + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| Traversable | | + + +## iterateAssociative + +```php +public function iterateAssociative(): Traversable +``` + +### 描述 + +wrapper method + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| Traversable | | + + +## iterateKeyValue + +```php +public function iterateKeyValue(): Traversable +``` + +### 描述 + +wrapper method + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| Traversable | | + + +## iterateAssociativeIndexed + +```php +public function iterateAssociativeIndexed(): Traversable +``` + +### 描述 + +wrapper method + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| Traversable | | + + +## iterateColumn + +```php +public function iterateColumn(): Traversable +``` + +### 描述 + +wrapper method + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| Traversable | | + + +## rowCount + +```php +public function rowCount(): int +``` + +### 描述 + +wrapper method + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| int | | + + +## free + +```php +public function free(): void +``` + +### 描述 + +wrapper method + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| void | | diff --git a/docs/api/ZM/MySQL/MySQLWrapper.md b/docs/api/ZM/MySQL/MySQLWrapper.md new file mode 100644 index 00000000..acba88ac --- /dev/null +++ b/docs/api/ZM/MySQL/MySQLWrapper.md @@ -0,0 +1,901 @@ +# ZM\MySQL\MySQLWrapper + +## __construct + +```php +public function __construct(): mixed +``` + +### 描述 + +MySQLWrapper constructor. + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## getDatabase + +```php +public function getDatabase(): string +``` + +### 描述 + +wrapper method + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string | | + + +## isAutoCommit + +```php +public function isAutoCommit(): bool +``` + +### 描述 + +wrapper method + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| bool | | + + +## setAutoCommit + +```php +public function setAutoCommit(mixed $autoCommit): mixed +``` + +### 描述 + +wrapper method + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| autoCommit | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## fetchAssociative + +```php +public function fetchAssociative(string $query, array $params, array $types): array|false +``` + +### 描述 + +wrapper method + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| query | string | | +| params | array | | +| types | array | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array|false | | + + +## fetchNumeric + +```php +public function fetchNumeric(string $query, array $params, array $types): array|false +``` + +### 描述 + +wrapper method + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| query | string | | +| params | array | | +| types | array | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array|false | | + + +## fetchOne + +```php +public function fetchOne(string $query, array $params, array $types): false|mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| query | string | | +| params | array | | +| types | array | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| false|mixed | | + + +## isTransactionActive + +```php +public function isTransactionActive(): bool +``` + +### 描述 + +wrapper method + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| bool | | + + +## delete + +```php +public function delete(mixed $table, array $criteria, array $types): int +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| table | mixed | | +| criteria | array | | +| types | array | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| int | | + + +## setTransactionIsolation + +```php +public function setTransactionIsolation(mixed $level): int +``` + +### 描述 + +wrapper method + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| level | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| int | | + + +## getTransactionIsolation + +```php +public function getTransactionIsolation(): int +``` + +### 描述 + +wrapper method + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| int | | + + +## update + +```php +public function update(mixed $table, array $data, array $criteria, array $types): int +``` + +### 描述 + +wrapper method + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| table | mixed | | +| data | array | | +| criteria | array | | +| types | array | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| int | | + + +## insert + +```php +public function insert(mixed $table, array $data, array $types): int +``` + +### 描述 + +wrapper method + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| table | mixed | | +| data | array | | +| types | array | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| int | | + + +## quoteIdentifier + +```php +public function quoteIdentifier(mixed $str): string +``` + +### 描述 + +wrapper method + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| str | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string | | + + +## quote + +```php +public function quote(mixed $value, int $type): mixed +``` + +### 描述 + +wrapper method + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| value | mixed | | +| type | int | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## fetchAllNumeric + +```php +public function fetchAllNumeric(string $query, array $params, array $types): array +``` + +### 描述 + +wrapper method + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| query | string | | +| params | array | | +| types | array | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array | | + + +## fetchAllAssociative + +```php +public function fetchAllAssociative(string $query, array $params, array $types): array +``` + +### 描述 + +wrapper method + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| query | string | | +| params | array | | +| types | array | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array | | + + +## fetchAllKeyValue + +```php +public function fetchAllKeyValue(string $query, array $params, array $types): array +``` + +### 描述 + +wrapper method + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| query | string | | +| params | array | | +| types | array | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array | | + + +## fetchAllAssociativeIndexed + +```php +public function fetchAllAssociativeIndexed(string $query, array $params, array $types): array +``` + +### 描述 + +wrapper method + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| query | string | | +| params | array | | +| types | array | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array | | + + +## fetchFirstColumn + +```php +public function fetchFirstColumn(string $query, array $params, array $types): array +``` + +### 描述 + +wrapper method + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| query | string | | +| params | array | | +| types | array | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array | | + + +## iterateNumeric + +```php +public function iterateNumeric(string $query, array $params, array $types): Traversable +``` + +### 描述 + +wrapper method + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| query | string | | +| params | array | | +| types | array | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| Traversable | | + + +## iterateAssociative + +```php +public function iterateAssociative(string $query, array $params, array $types): Traversable +``` + +### 描述 + +wrapper method + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| query | string | | +| params | array | | +| types | array | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| Traversable | | + + +## iterateKeyValue + +```php +public function iterateKeyValue(string $query, array $params, array $types): Traversable +``` + +### 描述 + +wrapper method + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| query | string | | +| params | array | | +| types | array | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| Traversable | | + + +## iterateAssociativeIndexed + +```php +public function iterateAssociativeIndexed(string $query, array $params, array $types): Traversable +``` + +### 描述 + +wrapper method + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| query | string | | +| params | array | | +| types | array | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| Traversable | | + + +## iterateColumn + +```php +public function iterateColumn(string $query, array $params, array $types): Traversable +``` + +### 描述 + +wrapper method + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| query | string | | +| params | array | | +| types | array | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| Traversable | | + + +## executeQuery + +```php +public function executeQuery(mixed $sql, array $types, array $params, Doctrine\DBAL\Cache\QueryCacheProfile $qcp): ZM\MySQL\MySQLStatementWrapper +``` + +### 描述 + +wrapper method + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| sql | mixed | | +| types | array | | +| params | array | | +| qcp | Doctrine\DBAL\Cache\QueryCacheProfile | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| ZM\MySQL\MySQLStatementWrapper | | + + +## executeCacheQuery + +```php +public function executeCacheQuery(mixed $sql, mixed $params, mixed $types, Doctrine\DBAL\Cache\QueryCacheProfile $qcp): ZM\MySQL\MySQLStatementWrapper +``` + +### 描述 + +wrapper method + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| sql | mixed | | +| params | mixed | | +| types | mixed | | +| qcp | Doctrine\DBAL\Cache\QueryCacheProfile | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| ZM\MySQL\MySQLStatementWrapper | | + + +## executeStatement + +```php +public function executeStatement(mixed $sql, array $params, array $types): int +``` + +### 描述 + +wrapper method + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| sql | mixed | | +| params | array | | +| types | array | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| int | | + + +## getTransactionNestingLevel + +```php +public function getTransactionNestingLevel(): int +``` + +### 描述 + +wrapper method + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| int | | + + +## lastInsertId + +```php +public function lastInsertId(null $name): string +``` + +### 描述 + +wrapper method + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| name | null | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string | | + + +## transactional + +```php +public function transactional(Closure $func): mixed +``` + +### 描述 + +overwrite method to $this->connection->transactional() + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| func | Closure | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## setNestTransactionsWithSavepoints + +```php +public function setNestTransactionsWithSavepoints(mixed $nestTransactionsWithSavepoints): mixed +``` + +### 描述 + +wrapper method + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| nestTransactionsWithSavepoints | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## getNestTransactionsWithSavepoints + +```php +public function getNestTransactionsWithSavepoints(): bool +``` + +### 描述 + +wrapper method + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| bool | | + + +## beginTransaction + +```php +public function beginTransaction(): bool +``` + +### 描述 + +wrapper method + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| bool | | + + +## commit + +```php +public function commit(): bool +``` + +### 描述 + +wrapper method + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| bool | | + + +## rollBack + +```php +public function rollBack(): bool +``` + +### 描述 + +wrapper method + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| bool | | + + +## createSavepoint + +```php +public function createSavepoint(mixed $savepoint): mixed +``` + +### 描述 + +wrapper method + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| savepoint | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## releaseSavepoint + +```php +public function releaseSavepoint(mixed $savepoint): mixed +``` + +### 描述 + +wrapper method + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| savepoint | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## rollbackSavepoint + +```php +public function rollbackSavepoint(mixed $savepoint): mixed +``` + +### 描述 + +wrapper method + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| savepoint | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## setRollbackOnly + +```php +public function setRollbackOnly(): mixed +``` + +### 描述 + +wrapper method + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## isRollbackOnly + +```php +public function isRollbackOnly(): bool +``` + +### 描述 + +wrapper method + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| bool | | + + +## createQueryBuilder + +```php +public function createQueryBuilder(): ZM\MySQL\MySQLQueryBuilder +``` + +### 描述 + +overwrite method to $this->connection->createQueryBuilder + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| ZM\MySQL\MySQLQueryBuilder | | diff --git a/docs/api/ZM/Store/LightCache.md b/docs/api/ZM/Store/LightCache.md new file mode 100644 index 00000000..43a4f1ed --- /dev/null +++ b/docs/api/ZM/Store/LightCache.md @@ -0,0 +1,174 @@ +# ZM\Store\LightCache + +## init + +```php +public function init(mixed $config): bool|mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| config | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| bool|mixed | | + + +## get + +```php +public function get(string $key): null|mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| key | string | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|mixed | | + + +## getExpire + +```php +public function getExpire(string $key): null|mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| key | string | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|mixed | | + + +## getExpireTS + +```php +public function getExpireTS(string $key): null|mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| key | string | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|mixed | | + + +## set + +```php +public function set(array|int|string $value, string $key, int $expire): bool +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| value | array|int|string | | +| key | string | | +| expire | int | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| bool | | + + +## update + +```php +public function update(mixed $value, string $key): bool +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| value | mixed | | +| key | string | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| bool | | + + +## isset + +```php +public function isset(string $key): bool +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| key | string | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| bool | | + + +## savePersistence + +```php +public function savePersistence(): mixed +``` + +### 描述 + +这个只能在唯一一个工作进程中执行 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/Store/LightCacheInside.md b/docs/api/ZM/Store/LightCacheInside.md new file mode 100644 index 00000000..240c5fdd --- /dev/null +++ b/docs/api/ZM/Store/LightCacheInside.md @@ -0,0 +1,72 @@ +# ZM\Store\LightCacheInside + +## get + +```php +public function get(string $table, string $key): null|mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| table | string | | +| key | string | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|mixed | | + + +## set + +```php +public function set(array|int|string $value, string $table, string $key): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| value | array|int|string | | +| table | string | | +| key | string | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## createTable + +```php +public function createTable(mixed $name, mixed $size, mixed $str_size, int $conflict_proportion): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| name | mixed | | +| size | mixed | | +| str_size | mixed | | +| conflict_proportion | int | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/Store/Lock/SpinLock.md b/docs/api/ZM/Store/Lock/SpinLock.md new file mode 100644 index 00000000..9e4b1250 --- /dev/null +++ b/docs/api/ZM/Store/Lock/SpinLock.md @@ -0,0 +1 @@ +# ZM\Store\Lock\SpinLock \ No newline at end of file diff --git a/docs/api/ZM/Store/MySQL/SqlPoolStorage.md b/docs/api/ZM/Store/MySQL/SqlPoolStorage.md new file mode 100644 index 00000000..c805a86d --- /dev/null +++ b/docs/api/ZM/Store/MySQL/SqlPoolStorage.md @@ -0,0 +1 @@ +# ZM\Store\MySQL\SqlPoolStorage \ No newline at end of file diff --git a/docs/api/ZM/Store/Redis/ZMRedis.md b/docs/api/ZM/Store/Redis/ZMRedis.md new file mode 100644 index 00000000..7793e22a --- /dev/null +++ b/docs/api/ZM/Store/Redis/ZMRedis.md @@ -0,0 +1,39 @@ +# ZM\Store\Redis\ZMRedis + +## __construct + +```php +public function __construct(): mixed +``` + +### 描述 + +ZMRedis constructor. + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## call + +```php +public function call(callable $callable): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| callable | callable | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/Store/Redis/ZMRedisPool.md b/docs/api/ZM/Store/Redis/ZMRedisPool.md new file mode 100644 index 00000000..a524ee52 --- /dev/null +++ b/docs/api/ZM/Store/Redis/ZMRedisPool.md @@ -0,0 +1 @@ +# ZM\Store\Redis\ZMRedisPool \ No newline at end of file diff --git a/docs/api/ZM/Store/WorkerCache.md b/docs/api/ZM/Store/WorkerCache.md new file mode 100644 index 00000000..ec78f2c8 --- /dev/null +++ b/docs/api/ZM/Store/WorkerCache.md @@ -0,0 +1 @@ +# ZM\Store\WorkerCache \ No newline at end of file diff --git a/docs/api/ZM/Store/ZMAtomic.md b/docs/api/ZM/Store/ZMAtomic.md new file mode 100644 index 00000000..66fb3c7a --- /dev/null +++ b/docs/api/ZM/Store/ZMAtomic.md @@ -0,0 +1,39 @@ +# ZM\Store\ZMAtomic + +## get + +```php +public function get(mixed $name): Swoole\Atomic +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| name | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| Swoole\Atomic | | + + +## init + +```php +public function init(): mixed +``` + +### 描述 + +初始化atomic计数器 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/Store/ZMBuf.md b/docs/api/ZM/Store/ZMBuf.md new file mode 100644 index 00000000..b3e99a98 --- /dev/null +++ b/docs/api/ZM/Store/ZMBuf.md @@ -0,0 +1 @@ +# ZM\Store\ZMBuf \ No newline at end of file diff --git a/docs/api/ZM/Utils/CoMessage.md b/docs/api/ZM/Utils/CoMessage.md new file mode 100644 index 00000000..37a2279f --- /dev/null +++ b/docs/api/ZM/Utils/CoMessage.md @@ -0,0 +1,41 @@ +# ZM\Utils\CoMessage + +## yieldByWS + +```php +public function yieldByWS(int $timeout, array $hang, array $compare): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| timeout | int | | +| hang | array | | +| compare | array | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## resumeByWS + +```php +public function resumeByWS(): bool +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| bool | | diff --git a/docs/api/ZM/Utils/CoroutinePool.md b/docs/api/ZM/Utils/CoroutinePool.md new file mode 100644 index 00000000..63d11048 --- /dev/null +++ b/docs/api/ZM/Utils/CoroutinePool.md @@ -0,0 +1 @@ +# ZM\Utils\CoroutinePool \ No newline at end of file diff --git a/docs/api/ZM/Utils/DataProvider.md b/docs/api/ZM/Utils/DataProvider.md new file mode 100644 index 00000000..72e0c1d6 --- /dev/null +++ b/docs/api/ZM/Utils/DataProvider.md @@ -0,0 +1,198 @@ +# ZM\Utils\DataProvider + +## getResourceFolder + +```php +public function getResourceFolder(): string +``` + +### 描述 + +返回资源目录 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string | | + + +## getWorkingDir + +```php +public function getWorkingDir(): false|string +``` + +### 描述 + +返回工作目录，不带最右边文件夹的斜杠（/） + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| false|string | | + + +## getFrameworkRootDir + +```php +public function getFrameworkRootDir(): false|string +``` + +### 描述 + +获取框架所在根目录 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| false|string | | + + +## getSourceRootDir + +```php +public function getSourceRootDir(): false|string +``` + +### 描述 + +获取源码根目录，除Phar模式外均与工作目录相同 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| false|string | | + + +## getFrameworkLink + +```php +public function getFrameworkLink(): null|array|false|mixed +``` + +### 描述 + +获取框架反代链接 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|false|mixed | | + + +## getDataFolder + +```php +public function getDataFolder(string $second): null|array|false|mixed|string +``` + +### 描述 + +获取zm_data数据目录，如果二级目录不为空，则自动创建目录并返回 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| second | string | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|array|false|mixed|string | | + + +## saveToJson + +```php +public function saveToJson(mixed $filename, mixed $file_array): false|int +``` + +### 描述 + +将变量保存在zm_data下的数据目录，传入数组 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| filename | mixed | | +| file_array | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| false|int | | + + +## loadFromJson + +```php +public function loadFromJson(mixed $filename): null|mixed +``` + +### 描述 + +从json加载变量到内存 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| filename | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| null|mixed | | + + +## scanDirFiles + +```php +public function scanDirFiles(mixed $dir, bool|string $relative, bool $recursive): array|false +``` + +### 描述 + +递归或非递归扫描目录，可返回相对目录的文件列表或绝对目录的文件列表 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| dir | mixed | | +| relative | bool|string | | +| recursive | bool | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array|false | | + + +## isRelativePath + +```php +public function isRelativePath(mixed $path): bool +``` + +### 描述 + +检查路径是否为相对路径（根据第一个字符是否为"/"来判断） + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| path | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| bool | | diff --git a/docs/api/ZM/Utils/HttpUtil.md b/docs/api/ZM/Utils/HttpUtil.md new file mode 100644 index 00000000..e88dd386 --- /dev/null +++ b/docs/api/ZM/Utils/HttpUtil.md @@ -0,0 +1,50 @@ +# ZM\Utils\HttpUtil + +## parseUri + +```php +public function parseUri(mixed $request, mixed $response, mixed $uri, mixed $node, mixed $params): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| request | mixed | | +| response | mixed | | +| uri | mixed | | +| node | mixed | | +| params | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## handleStaticPage + +```php +public function handleStaticPage(mixed $uri, Response|\Swoole\Http\Response $response, array $settings): bool +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| uri | mixed | | +| response | Response|\Swoole\Http\Response | | +| settings | array | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| bool | | diff --git a/docs/api/ZM/Utils/Macroable.md b/docs/api/ZM/Utils/Macroable.md new file mode 100644 index 00000000..878d4d44 --- /dev/null +++ b/docs/api/ZM/Utils/Macroable.md @@ -0,0 +1 @@ +# ZM\Utils\Macroable \ No newline at end of file diff --git a/docs/api/ZM/Utils/Manager/CronManager.md b/docs/api/ZM/Utils/Manager/CronManager.md new file mode 100644 index 00000000..e6b002bd --- /dev/null +++ b/docs/api/ZM/Utils/Manager/CronManager.md @@ -0,0 +1,42 @@ +# ZM\Utils\Manager\CronManager + +## initCronTasks + +```php +public function initCronTasks(): mixed +``` + +### 描述 + +初始化 Cron 注解 +必须在 WorkerStart 事件中调用 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## startExecute + +```php +public function startExecute(ZM\Annotation\Cron\Cron $v, ZM\Event\EventDispatcher $dispatcher, Cron\CronExpression $cron): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| v | ZM\Annotation\Cron\Cron | | +| dispatcher | ZM\Event\EventDispatcher | | +| cron | Cron\CronExpression | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/Utils/Manager/ModuleManager.md b/docs/api/ZM/Utils/Manager/ModuleManager.md new file mode 100644 index 00000000..ec8cf1ff --- /dev/null +++ b/docs/api/ZM/Utils/Manager/ModuleManager.md @@ -0,0 +1,62 @@ +# ZM\Utils\Manager\ModuleManager + +## getConfiguredModules + +```php +public function getConfiguredModules(): array +``` + +### 描述 + +扫描src目录下的所有已经被标注的模块 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array | | + + +## packModule + +```php +public function packModule(mixed $module): bool +``` + +### 描述 + +打包模块 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| module | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| bool | | + + +## unpackModule + +```php +public function unpackModule(mixed $module, array $options): array|false +``` + +### 描述 + +解包模块 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| module | mixed | | +| options | array | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array|false | | diff --git a/docs/api/ZM/Utils/Manager/ProcessManager.md b/docs/api/ZM/Utils/Manager/ProcessManager.md new file mode 100644 index 00000000..207f2853 --- /dev/null +++ b/docs/api/ZM/Utils/Manager/ProcessManager.md @@ -0,0 +1 @@ +# ZM\Utils\Manager\ProcessManager \ No newline at end of file diff --git a/docs/api/ZM/Utils/Manager/RouteManager.md b/docs/api/ZM/Utils/Manager/RouteManager.md new file mode 100644 index 00000000..b2972e7b --- /dev/null +++ b/docs/api/ZM/Utils/Manager/RouteManager.md @@ -0,0 +1 @@ +# ZM\Utils\Manager\RouteManager \ No newline at end of file diff --git a/docs/api/ZM/Utils/Manager/TaskManager.md b/docs/api/ZM/Utils/Manager/TaskManager.md new file mode 100644 index 00000000..31a277df --- /dev/null +++ b/docs/api/ZM/Utils/Manager/TaskManager.md @@ -0,0 +1 @@ +# ZM\Utils\Manager\TaskManager \ No newline at end of file diff --git a/docs/api/ZM/Utils/Manager/WorkerManager.md b/docs/api/ZM/Utils/Manager/WorkerManager.md new file mode 100644 index 00000000..05aa6d74 --- /dev/null +++ b/docs/api/ZM/Utils/Manager/WorkerManager.md @@ -0,0 +1,64 @@ +# ZM\Utils\Manager\WorkerManager + +## workerAction + +```php +public function workerAction(mixed $src_worker_id, mixed $data): mixed +``` + +### 描述 + +Worker 进程间通信触发的动作类型函数 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| src_worker_id | mixed | | +| data | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## sendActionToWorker + +```php +public function sendActionToWorker(mixed $worker_id, mixed $action, mixed $data): mixed +``` + +### 描述 + +给 Worker 进程发送动作指令（包括自身，自身将直接执行） + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| worker_id | mixed | | +| action | mixed | | +| data | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## resumeAllWorkerCoroutines + +```php +public function resumeAllWorkerCoroutines(): mixed +``` + +### 描述 + +向所有 Worker 进程发送动作指令 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/Utils/MessageUtil.md b/docs/api/ZM/Utils/MessageUtil.md new file mode 100644 index 00000000..7b493409 --- /dev/null +++ b/docs/api/ZM/Utils/MessageUtil.md @@ -0,0 +1,203 @@ +# ZM\Utils\MessageUtil + +## downloadCQImage + +```php +public function downloadCQImage(mixed $msg, null $path): array|false +``` + +### 描述 + +下载消息中 CQ 码的所有图片，通过 url + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| msg | mixed | | +| path | null | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array|false | | + + +## containsImage + +```php +public function containsImage(mixed $msg): bool +``` + +### 描述 + +检查消息中是否含有图片 CQ 码 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| msg | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| bool | | + + +## getImageCQFromLocal + +```php +public function getImageCQFromLocal(mixed $file, int $type): string +``` + +### 描述 + +通过本地地址返回图片的 CQ 码 +type == 0 : 返回图片的 base64 CQ 码 +type == 1 : 返回图片的 file://路径 CQ 码（路径必须为绝对路径） +type == 2 : 返回图片的 http://xxx CQ 码（默认为 /images/ 路径就是文件对应所在的目录） + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| file | mixed | | +| type | int | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string | | + + +## splitCommand + +```php +public function splitCommand(mixed $msg): array|string[] +``` + +### 描述 + +分割字符，将用户消息通过空格或换行分割为数组 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| msg | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array|string[] | | + + +## matchCommand + +```php +public function matchCommand(mixed $msg, mixed $obj): ZM\Entity\MatchResult +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| msg | mixed | | +| obj | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| ZM\Entity\MatchResult | | + + +## addShortCommand + +```php +public function addShortCommand(mixed $command, string $reply): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| command | mixed | | +| reply | string | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## strToArray + +```php +public function strToArray(mixed $msg, false $trim_text, bool $ignore_space): array +``` + +### 描述 + +字符串转数组 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| msg | mixed | | +| trim_text | false | | +| ignore_space | bool | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array | | + + +## arrayToStr + +```php +public function arrayToStr(array $array): string +``` + +### 描述 + +数组转字符串 +纪念一下，这段代码完全由AI生成，没有人知道它是怎么写的，这句话是我自己写的，不知道是不是有人知道的 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| array | array | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string | | + + +## generateCommandHelp + +```php +public function generateCommandHelp(): array +``` + +### 描述 + +根据注解树生成命令列表、帮助 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array | 帮助信息，每个元素对应一个命令的帮助信息，格式为：命令名（其他触发条件）：命令描述 | diff --git a/docs/api/ZM/Utils/SignalListener.md b/docs/api/ZM/Utils/SignalListener.md new file mode 100644 index 00000000..cc0dde20 --- /dev/null +++ b/docs/api/ZM/Utils/SignalListener.md @@ -0,0 +1,79 @@ +# ZM\Utils\SignalListener + +## signalMaster + +```php +public function signalMaster(Swoole\Server $server): mixed +``` + +### 描述 + +监听Master进程的Ctrl+C + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| server | Swoole\Server | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## signalManager + +```php +public function signalManager(): mixed +``` + +### 描述 + +监听Manager进程的Ctrl+C + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## signalWorker + +```php +public function signalWorker(mixed $worker_id, Swoole\Server $server): mixed +``` + +### 描述 + +监听Worker/TaskWorker进程的Ctrl+C + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| worker_id | mixed | | +| server | Swoole\Server | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## processKillerPrompt + +```php +public function processKillerPrompt(): mixed +``` + +### 描述 + +按5次Ctrl+C后强行杀死框架的处理函数 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/Utils/SingletonTrait.md b/docs/api/ZM/Utils/SingletonTrait.md new file mode 100644 index 00000000..d47f292c --- /dev/null +++ b/docs/api/ZM/Utils/SingletonTrait.md @@ -0,0 +1,17 @@ +# ZM\Utils\SingletonTrait + +## getInstance + +```php +public function getInstance(): self +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| self | | diff --git a/docs/api/ZM/Utils/Terminal.md b/docs/api/ZM/Utils/Terminal.md new file mode 100644 index 00000000..6dd66118 --- /dev/null +++ b/docs/api/ZM/Utils/Terminal.md @@ -0,0 +1,195 @@ +# ZM\Utils\Terminal + +## executeCommand + +```php +public function executeCommand(string $cmd): bool +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| cmd | string | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| bool | | + + +## help + +```php +public function help(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## status + +```php +public function status(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## testlog + +```php +public function testlog(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## call + +```php +public function call(mixed $it): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| it | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## level + +```php +public function level(mixed $it): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| it | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## bc + +```php +public function bc(mixed $it): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| it | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## echoI + +```php +public function echoI(mixed $it): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| it | mixed | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## stop + +```php +public function stop(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## reload + +```php +public function reload(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/Utils/ZMUtil.md b/docs/api/ZM/Utils/ZMUtil.md new file mode 100644 index 00000000..251a1004 --- /dev/null +++ b/docs/api/ZM/Utils/ZMUtil.md @@ -0,0 +1,76 @@ +# ZM\Utils\ZMUtil + +## stop + +```php +public function stop(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## reload + +```php +public function reload(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## getReloadableFiles + +```php +public function getReloadableFiles(): string[]|string[][] +``` + +### 描述 + +在工作进程中返回可以通过reload重新加载的php文件列表 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string[]|string[][] | | + + +## getClassesPsr4 + +```php +public function getClassesPsr4(mixed $dir, mixed $base_namespace, null|mixed $rule, bool $return_path_value): string[] +``` + +### 描述 + +使用Psr-4标准获取目录下的所有类 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| dir | mixed | | +| base_namespace | mixed | | +| rule | null|mixed | | +| return_path_value | bool | | +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string[] | | diff --git a/docs/api/ZM/ZMServer.md b/docs/api/ZM/ZMServer.md new file mode 100644 index 00000000..94427395 --- /dev/null +++ b/docs/api/ZM/ZMServer.md @@ -0,0 +1,17 @@ +# ZM\ZMServer + +## getAppName + +```php +public function getAppName(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/index.md b/docs/api/index.md new file mode 100644 index 00000000..e69de29b