From 33a14dee8b53351bc7ebd7d6737b2113b5198686 Mon Sep 17 00:00:00 2001 From: sunxyw Date: Thu, 22 Dec 2022 22:20:38 +0800 Subject: [PATCH] move api docs to doxygen --- .github/workflows/increment-build-number.yml | 14 +- bin/gendoc | 409 -------- bin/prepare-doxygen | 73 ++ docs/.vuepress/api.js | 1 - docs/.vuepress/config.js | 5 +- docs/api/ZM/API/CQ.md | 618 ----------- docs/api/ZM/API/GoCqhttpAPIV11.md | 130 --- docs/api/ZM/API/OneBotV11.md | 984 ------------------ .../ZM/API/Proxies/Bot/AbstractBotProxy.md | 117 --- docs/api/ZM/API/Proxies/Bot/AllBotsProxy.md | 24 - docs/api/ZM/API/Proxies/Bot/AllGroupsProxy.md | 24 - docs/api/ZM/API/TuringAPI.md | 48 - docs/api/ZM/API/ZMRobot.md | 46 - docs/api/ZM/Adapters/OneBot11Adapter.md | 293 ------ docs/api/ZM/Annotation/AnnotationBase.md | 23 - docs/api/ZM/Annotation/AnnotationHandler.md | 174 ---- docs/api/ZM/Annotation/AnnotationMap.md | 40 - docs/api/ZM/Annotation/AnnotationParser.md | 163 --- 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 | 23 - 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 | 17 - docs/api/ZM/Command/CheckConfigCommand.md | 24 - docs/api/ZM/Command/Command.md | 226 ---- 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 | 40 - .../ZM/Command/Module/ModuleListCommand.md | 24 - .../ZM/Command/Module/ModulePackCommand.md | 24 - .../ZM/Command/Module/ModuleUnpackCommand.md | 1 - docs/api/ZM/Command/ProxyServerCommand.md | 41 - docs/api/ZM/Command/PureHttpCommand.md | 1 - docs/api/ZM/Command/RunServerCommand.md | 1 - docs/api/ZM/Command/Server/ServerCommand.md | 24 - .../ZM/Command/Server/ServerReloadCommand.md | 1 - .../ZM/Command/Server/ServerStartCommand.md | 24 - .../ZM/Command/Server/ServerStatusCommand.md | 1 - .../ZM/Command/Server/ServerStopCommand.md | 1 - docs/api/ZM/Config/ConfigTracer.md | 73 -- docs/api/ZM/Config/ZMConfig.md | 348 ------- docs/api/ZM/ConsoleApplication.md | 24 - docs/api/ZM/Container/BoundMethod.md | 77 -- docs/api/ZM/Container/Container.md | 883 ---------------- .../ZM/Container/ContainerServicesProvider.md | 134 --- docs/api/ZM/Container/WorkerContainer.md | 842 --------------- docs/api/ZM/Context/Context.md | 57 - docs/api/ZM/DB/DB.md | 117 --- docs/api/ZM/DB/DeleteBody.md | 40 - docs/api/ZM/DB/InsertBody.md | 41 - docs/api/ZM/DB/SelectBody.md | 137 --- docs/api/ZM/DB/Table.md | 17 - docs/api/ZM/DB/UpdateBody.md | 41 - docs/api/ZM/Entity/CQObject.md | 1 - docs/api/ZM/Entity/MatchResult.md | 1 - docs/api/ZM/Event/EventDispatcher.md | 23 - docs/api/ZM/Event/EventManager.md | 40 - docs/api/ZM/Event/EventProvider.md | 117 --- docs/api/ZM/Event/EventTracer.md | 34 - .../ZM/Event/Listener/HttpEventListener.md | 69 -- .../ZM/Event/Listener/ManagerEventListener.md | 57 - .../ZM/Event/Listener/MasterEventListener.md | 40 - docs/api/ZM/Event/Listener/SignalListener.md | 57 - docs/api/ZM/Event/Listener/WSEventListener.md | 69 -- .../ZM/Event/Listener/WorkerEventListener.md | 108 -- .../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 | 24 - 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 | 24 - docs/api/ZM/Event/SwooleEvent/OnWorkerExit.md | 1 - .../api/ZM/Event/SwooleEvent/OnWorkerStart.md | 40 - 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 | 155 --- docs/api/ZM/Http/Response.md | 319 ------ docs/api/ZM/Http/RouteManager.md | 1 - docs/api/ZM/Http/StaticFileHandler.md | 1 - docs/api/ZM/InstantApplication.md | 17 - docs/api/ZM/Middleware/MiddlewareHandler.md | 112 -- docs/api/ZM/Middleware/Pipeline.md | 69 -- docs/api/ZM/Module/InstantModule.md | 1 - docs/api/ZM/Module/ModuleBase.md | 57 - docs/api/ZM/Module/ModulePacker.md | 154 --- docs/api/ZM/Module/ModuleUnpacker.md | 123 --- docs/api/ZM/Module/QQBot.md | 151 --- docs/api/ZM/MySQL/MySQLConnection.md | 93 -- docs/api/ZM/MySQL/MySQLDriver.md | 1 - docs/api/ZM/MySQL/MySQLManager.md | 1 - docs/api/ZM/MySQL/MySQLPool.md | 40 - docs/api/ZM/MySQL/MySQLQueryBuilder.md | 17 - docs/api/ZM/MySQL/MySQLStatement.md | 17 - docs/api/ZM/MySQL/MySQLStatementWrapper.md | 291 ------ docs/api/ZM/MySQL/MySQLWrapper.md | 603 ----------- docs/api/ZM/Plugin/OneBot12Adapter.md | 87 -- docs/api/ZM/Plugin/PluginManager.md | 46 - docs/api/ZM/Process/ProcessStateManager.md | 73 -- docs/api/ZM/Store/Database/DBConnection.md | 110 -- docs/api/ZM/Store/Database/DBPool.md | 104 -- docs/api/ZM/Store/Database/DBQueryBuilder.md | 17 - docs/api/ZM/Store/Database/DBStatement.md | 17 - .../ZM/Store/Database/DBStatementWrapper.md | 289 ----- docs/api/ZM/Store/Database/DBWrapper.md | 959 ----------------- docs/api/ZM/Store/FileSystem.md | 115 -- docs/api/ZM/Store/LightCache.md | 181 ---- docs/api/ZM/Store/LightCacheInside.md | 75 -- docs/api/ZM/Store/Lock/FileLock.md | 46 - docs/api/ZM/Store/Lock/SpinLock.md | 1 - docs/api/ZM/Store/MySQL/MySQLConnection.md | 110 -- docs/api/ZM/Store/MySQL/MySQLPool.md | 104 -- docs/api/ZM/Store/MySQL/MySQLQueryBuilder.md | 17 - docs/api/ZM/Store/MySQL/MySQLStatement.md | 17 - .../ZM/Store/MySQL/MySQLStatementWrapper.md | 289 ----- docs/api/ZM/Store/MySQL/MySQLWrapper.md | 936 ----------------- docs/api/ZM/Store/MySQL/SqlPoolStorage.md | 1 - docs/api/ZM/Store/Redis/ZMRedis.md | 40 - docs/api/ZM/Store/Redis/ZMRedisPool.md | 1 - docs/api/ZM/Store/WorkerCache.md | 1 - docs/api/ZM/Store/ZMAtomic.md | 17 - docs/api/ZM/Store/ZMBuf.md | 1 - docs/api/ZM/Utils/CoMessage.md | 42 - docs/api/ZM/Utils/CommandInfoUtil.md | 138 --- docs/api/ZM/Utils/ConnectionUtil.md | 71 -- docs/api/ZM/Utils/CoroutinePool.md | 1 - docs/api/ZM/Utils/DataProvider.md | 226 ---- docs/api/ZM/Utils/EasterEgg.md | 17 - docs/api/ZM/Utils/HttpUtil.md | 97 -- docs/api/ZM/Utils/Macroable.md | 1 - docs/api/ZM/Utils/Manager/CronManager.md | 43 - docs/api/ZM/Utils/Manager/ModuleManager.md | 65 -- docs/api/ZM/Utils/Manager/ProcessManager.md | 73 -- docs/api/ZM/Utils/Manager/RouteManager.md | 1 - docs/api/ZM/Utils/Manager/TaskManager.md | 1 - docs/api/ZM/Utils/Manager/WorkerManager.md | 66 -- docs/api/ZM/Utils/MessageUtil.md | 219 ---- docs/api/ZM/Utils/ReflectionUtil.md | 116 --- docs/api/ZM/Utils/SignalListener.md | 81 -- docs/api/ZM/Utils/SingletonTrait.md | 17 - docs/api/ZM/Utils/Terminal.md | 200 ---- docs/api/ZM/Utils/ZMUtil.md | 23 - docs/api/ZM/ZMApplication.md | 17 - docs/api/ZM/ZMServer.md | 63 -- docs/api/index.md | 0 197 files changed, 85 insertions(+), 14972 deletions(-) delete mode 100755 bin/gendoc create mode 100644 bin/prepare-doxygen delete mode 100644 docs/.vuepress/api.js delete mode 100644 docs/api/ZM/API/CQ.md delete mode 100644 docs/api/ZM/API/GoCqhttpAPIV11.md delete mode 100644 docs/api/ZM/API/OneBotV11.md delete mode 100644 docs/api/ZM/API/Proxies/Bot/AbstractBotProxy.md delete mode 100644 docs/api/ZM/API/Proxies/Bot/AllBotsProxy.md delete mode 100644 docs/api/ZM/API/Proxies/Bot/AllGroupsProxy.md delete mode 100644 docs/api/ZM/API/TuringAPI.md delete mode 100644 docs/api/ZM/API/ZMRobot.md delete mode 100644 docs/api/ZM/Adapters/OneBot11Adapter.md delete mode 100644 docs/api/ZM/Annotation/AnnotationBase.md delete mode 100644 docs/api/ZM/Annotation/AnnotationHandler.md delete mode 100644 docs/api/ZM/Annotation/AnnotationMap.md delete mode 100644 docs/api/ZM/Annotation/AnnotationParser.md delete mode 100644 docs/api/ZM/Annotation/CQ/CQAPIResponse.md delete mode 100644 docs/api/ZM/Annotation/CQ/CQAfter.md delete mode 100644 docs/api/ZM/Annotation/CQ/CQBefore.md delete mode 100644 docs/api/ZM/Annotation/CQ/CQCommand.md delete mode 100644 docs/api/ZM/Annotation/CQ/CQMessage.md delete mode 100644 docs/api/ZM/Annotation/CQ/CQMetaEvent.md delete mode 100644 docs/api/ZM/Annotation/CQ/CQNotice.md delete mode 100644 docs/api/ZM/Annotation/CQ/CQRequest.md delete mode 100644 docs/api/ZM/Annotation/Command/TerminalCommand.md delete mode 100644 docs/api/ZM/Annotation/Cron/Cron.md delete mode 100644 docs/api/ZM/Annotation/Http/Controller.md delete mode 100644 docs/api/ZM/Annotation/Http/HandleAfter.md delete mode 100644 docs/api/ZM/Annotation/Http/HandleBefore.md delete mode 100644 docs/api/ZM/Annotation/Http/HandleException.md delete mode 100644 docs/api/ZM/Annotation/Http/Middleware.md delete mode 100644 docs/api/ZM/Annotation/Http/MiddlewareClass.md delete mode 100644 docs/api/ZM/Annotation/Http/RequestMapping.md delete mode 100644 docs/api/ZM/Annotation/Http/RequestMethod.md delete mode 100644 docs/api/ZM/Annotation/Module/Closed.md delete mode 100644 docs/api/ZM/Annotation/Swoole/OnCloseEvent.md delete mode 100644 docs/api/ZM/Annotation/Swoole/OnManagerStartEvent.md delete mode 100644 docs/api/ZM/Annotation/Swoole/OnMessageEvent.md delete mode 100644 docs/api/ZM/Annotation/Swoole/OnOpenEvent.md delete mode 100644 docs/api/ZM/Annotation/Swoole/OnPipeMessageEvent.md delete mode 100644 docs/api/ZM/Annotation/Swoole/OnRequestEvent.md delete mode 100644 docs/api/ZM/Annotation/Swoole/OnSave.md delete mode 100644 docs/api/ZM/Annotation/Swoole/OnSetup.md delete mode 100644 docs/api/ZM/Annotation/Swoole/OnStart.md delete mode 100644 docs/api/ZM/Annotation/Swoole/OnSwooleEvent.md delete mode 100644 docs/api/ZM/Annotation/Swoole/OnSwooleEventBase.md delete mode 100644 docs/api/ZM/Annotation/Swoole/OnTask.md delete mode 100644 docs/api/ZM/Annotation/Swoole/OnTaskEvent.md delete mode 100644 docs/api/ZM/Annotation/Swoole/OnTick.md delete mode 100644 docs/api/ZM/Annotation/Swoole/SwooleHandler.md delete mode 100644 docs/api/ZM/Command/BuildCommand.md delete mode 100644 docs/api/ZM/Command/CheckConfigCommand.md delete mode 100644 docs/api/ZM/Command/Command.md delete mode 100644 docs/api/ZM/Command/Daemon/DaemonCommand.md delete mode 100644 docs/api/ZM/Command/Daemon/DaemonReloadCommand.md delete mode 100644 docs/api/ZM/Command/Daemon/DaemonStatusCommand.md delete mode 100644 docs/api/ZM/Command/Daemon/DaemonStopCommand.md delete mode 100644 docs/api/ZM/Command/Generate/APIDocsGenerateCommand.md delete mode 100644 docs/api/ZM/Command/Generate/SystemdGenerateCommand.md delete mode 100644 docs/api/ZM/Command/InitCommand.md delete mode 100644 docs/api/ZM/Command/Module/ModuleListCommand.md delete mode 100644 docs/api/ZM/Command/Module/ModulePackCommand.md delete mode 100644 docs/api/ZM/Command/Module/ModuleUnpackCommand.md delete mode 100644 docs/api/ZM/Command/ProxyServerCommand.md delete mode 100644 docs/api/ZM/Command/PureHttpCommand.md delete mode 100644 docs/api/ZM/Command/RunServerCommand.md delete mode 100644 docs/api/ZM/Command/Server/ServerCommand.md delete mode 100644 docs/api/ZM/Command/Server/ServerReloadCommand.md delete mode 100644 docs/api/ZM/Command/Server/ServerStartCommand.md delete mode 100644 docs/api/ZM/Command/Server/ServerStatusCommand.md delete mode 100644 docs/api/ZM/Command/Server/ServerStopCommand.md delete mode 100644 docs/api/ZM/Config/ConfigTracer.md delete mode 100644 docs/api/ZM/Config/ZMConfig.md delete mode 100644 docs/api/ZM/ConsoleApplication.md delete mode 100644 docs/api/ZM/Container/BoundMethod.md delete mode 100644 docs/api/ZM/Container/Container.md delete mode 100644 docs/api/ZM/Container/ContainerServicesProvider.md delete mode 100644 docs/api/ZM/Container/WorkerContainer.md delete mode 100644 docs/api/ZM/Context/Context.md delete mode 100644 docs/api/ZM/DB/DB.md delete mode 100644 docs/api/ZM/DB/DeleteBody.md delete mode 100644 docs/api/ZM/DB/InsertBody.md delete mode 100644 docs/api/ZM/DB/SelectBody.md delete mode 100644 docs/api/ZM/DB/Table.md delete mode 100644 docs/api/ZM/DB/UpdateBody.md delete mode 100644 docs/api/ZM/Entity/CQObject.md delete mode 100644 docs/api/ZM/Entity/MatchResult.md delete mode 100644 docs/api/ZM/Event/EventDispatcher.md delete mode 100644 docs/api/ZM/Event/EventManager.md delete mode 100644 docs/api/ZM/Event/EventProvider.md delete mode 100644 docs/api/ZM/Event/EventTracer.md delete mode 100644 docs/api/ZM/Event/Listener/HttpEventListener.md delete mode 100644 docs/api/ZM/Event/Listener/ManagerEventListener.md delete mode 100644 docs/api/ZM/Event/Listener/MasterEventListener.md delete mode 100644 docs/api/ZM/Event/Listener/SignalListener.md delete mode 100644 docs/api/ZM/Event/Listener/WSEventListener.md delete mode 100644 docs/api/ZM/Event/Listener/WorkerEventListener.md delete mode 100644 docs/api/ZM/Event/SwooleEvent/OnBeforeReload.md delete mode 100644 docs/api/ZM/Event/SwooleEvent/OnClose.md delete mode 100644 docs/api/ZM/Event/SwooleEvent/OnManagerStart.md delete mode 100644 docs/api/ZM/Event/SwooleEvent/OnManagerStop.md delete mode 100644 docs/api/ZM/Event/SwooleEvent/OnMessage.md delete mode 100644 docs/api/ZM/Event/SwooleEvent/OnOpen.md delete mode 100644 docs/api/ZM/Event/SwooleEvent/OnPipeMessage.md delete mode 100644 docs/api/ZM/Event/SwooleEvent/OnRequest.md delete mode 100644 docs/api/ZM/Event/SwooleEvent/OnShutdown.md delete mode 100644 docs/api/ZM/Event/SwooleEvent/OnStart.md delete mode 100644 docs/api/ZM/Event/SwooleEvent/OnTask.md delete mode 100644 docs/api/ZM/Event/SwooleEvent/OnWorkerExit.md delete mode 100644 docs/api/ZM/Event/SwooleEvent/OnWorkerStart.md delete mode 100644 docs/api/ZM/Event/SwooleEvent/OnWorkerStop.md delete mode 100644 docs/api/ZM/Exception/AnnotationException.md delete mode 100644 docs/api/ZM/Exception/DbException.md delete mode 100644 docs/api/ZM/Exception/ExceptionHandler.md delete mode 100644 docs/api/ZM/Exception/InitException.md delete mode 100644 docs/api/ZM/Exception/InterruptException.md delete mode 100644 docs/api/ZM/Exception/InvalidArgumentException.md delete mode 100644 docs/api/ZM/Exception/LightCacheException.md delete mode 100644 docs/api/ZM/Exception/MethodNotFoundException.md delete mode 100644 docs/api/ZM/Exception/ModulePackException.md delete mode 100644 docs/api/ZM/Exception/NotInitializedException.md delete mode 100644 docs/api/ZM/Exception/RedisException.md delete mode 100644 docs/api/ZM/Exception/RobotNotFoundException.md delete mode 100644 docs/api/ZM/Exception/WaitTimeoutException.md delete mode 100644 docs/api/ZM/Exception/ZMException.md delete mode 100644 docs/api/ZM/Exception/ZMKnownException.md delete mode 100644 docs/api/ZM/Framework.md delete mode 100644 docs/api/ZM/Http/Response.md delete mode 100644 docs/api/ZM/Http/RouteManager.md delete mode 100644 docs/api/ZM/Http/StaticFileHandler.md delete mode 100644 docs/api/ZM/InstantApplication.md delete mode 100644 docs/api/ZM/Middleware/MiddlewareHandler.md delete mode 100644 docs/api/ZM/Middleware/Pipeline.md delete mode 100644 docs/api/ZM/Module/InstantModule.md delete mode 100644 docs/api/ZM/Module/ModuleBase.md delete mode 100644 docs/api/ZM/Module/ModulePacker.md delete mode 100644 docs/api/ZM/Module/ModuleUnpacker.md delete mode 100644 docs/api/ZM/Module/QQBot.md delete mode 100644 docs/api/ZM/MySQL/MySQLConnection.md delete mode 100644 docs/api/ZM/MySQL/MySQLDriver.md delete mode 100644 docs/api/ZM/MySQL/MySQLManager.md delete mode 100644 docs/api/ZM/MySQL/MySQLPool.md delete mode 100644 docs/api/ZM/MySQL/MySQLQueryBuilder.md delete mode 100644 docs/api/ZM/MySQL/MySQLStatement.md delete mode 100644 docs/api/ZM/MySQL/MySQLStatementWrapper.md delete mode 100644 docs/api/ZM/MySQL/MySQLWrapper.md delete mode 100644 docs/api/ZM/Plugin/OneBot12Adapter.md delete mode 100644 docs/api/ZM/Plugin/PluginManager.md delete mode 100644 docs/api/ZM/Process/ProcessStateManager.md delete mode 100644 docs/api/ZM/Store/Database/DBConnection.md delete mode 100644 docs/api/ZM/Store/Database/DBPool.md delete mode 100644 docs/api/ZM/Store/Database/DBQueryBuilder.md delete mode 100644 docs/api/ZM/Store/Database/DBStatement.md delete mode 100644 docs/api/ZM/Store/Database/DBStatementWrapper.md delete mode 100644 docs/api/ZM/Store/Database/DBWrapper.md delete mode 100644 docs/api/ZM/Store/FileSystem.md delete mode 100644 docs/api/ZM/Store/LightCache.md delete mode 100644 docs/api/ZM/Store/LightCacheInside.md delete mode 100644 docs/api/ZM/Store/Lock/FileLock.md delete mode 100644 docs/api/ZM/Store/Lock/SpinLock.md delete mode 100644 docs/api/ZM/Store/MySQL/MySQLConnection.md delete mode 100644 docs/api/ZM/Store/MySQL/MySQLPool.md delete mode 100644 docs/api/ZM/Store/MySQL/MySQLQueryBuilder.md delete mode 100644 docs/api/ZM/Store/MySQL/MySQLStatement.md delete mode 100644 docs/api/ZM/Store/MySQL/MySQLStatementWrapper.md delete mode 100644 docs/api/ZM/Store/MySQL/MySQLWrapper.md delete mode 100644 docs/api/ZM/Store/MySQL/SqlPoolStorage.md delete mode 100644 docs/api/ZM/Store/Redis/ZMRedis.md delete mode 100644 docs/api/ZM/Store/Redis/ZMRedisPool.md delete mode 100644 docs/api/ZM/Store/WorkerCache.md delete mode 100644 docs/api/ZM/Store/ZMAtomic.md delete mode 100644 docs/api/ZM/Store/ZMBuf.md delete mode 100644 docs/api/ZM/Utils/CoMessage.md delete mode 100644 docs/api/ZM/Utils/CommandInfoUtil.md delete mode 100644 docs/api/ZM/Utils/ConnectionUtil.md delete mode 100644 docs/api/ZM/Utils/CoroutinePool.md delete mode 100644 docs/api/ZM/Utils/DataProvider.md delete mode 100644 docs/api/ZM/Utils/EasterEgg.md delete mode 100644 docs/api/ZM/Utils/HttpUtil.md delete mode 100644 docs/api/ZM/Utils/Macroable.md delete mode 100644 docs/api/ZM/Utils/Manager/CronManager.md delete mode 100644 docs/api/ZM/Utils/Manager/ModuleManager.md delete mode 100644 docs/api/ZM/Utils/Manager/ProcessManager.md delete mode 100644 docs/api/ZM/Utils/Manager/RouteManager.md delete mode 100644 docs/api/ZM/Utils/Manager/TaskManager.md delete mode 100644 docs/api/ZM/Utils/Manager/WorkerManager.md delete mode 100644 docs/api/ZM/Utils/MessageUtil.md delete mode 100644 docs/api/ZM/Utils/ReflectionUtil.md delete mode 100644 docs/api/ZM/Utils/SignalListener.md delete mode 100644 docs/api/ZM/Utils/SingletonTrait.md delete mode 100644 docs/api/ZM/Utils/Terminal.md delete mode 100644 docs/api/ZM/Utils/ZMUtil.md delete mode 100644 docs/api/ZM/ZMApplication.md delete mode 100644 docs/api/ZM/ZMServer.md delete mode 100644 docs/api/index.md diff --git a/.github/workflows/increment-build-number.yml b/.github/workflows/increment-build-number.yml index c482a307..461044cf 100644 --- a/.github/workflows/increment-build-number.yml +++ b/.github/workflows/increment-build-number.yml @@ -29,10 +29,18 @@ jobs: operating-system: ubuntu-latest use-cache: true - - name: Generate API Docs - id: generate-api-docs + - name: Prepare Doxygen + id: prepare-doxygen continue-on-error: true - run: bin/gendoc + run: bin/prepare-doxygen before + + - name: Generate Doxygen + if: steps.prepare-doxygen.outcome == 'success' + use: mattnotmitt/doxygen-action@v1.9.5 + + - name: Finishing Doxygen + if: steps.prepare-doxygen.outcome == 'success' + run: bin/prepare-doxygen after - name: Commit API Docs uses: stefanzweifel/git-auto-commit-action@v4 diff --git a/bin/gendoc b/bin/gendoc deleted file mode 100755 index a4ee3368..00000000 --- a/bin/gendoc +++ /dev/null @@ -1,409 +0,0 @@ -#!/usr/bin/env php -getDocComment()) && strpos($doc, '@Annotation') !== false) { - return true; - } - if (str_ends_with($class->getName(), 'Exception')) { - return true; - } - if (str_contains($class->getName(), '_')) { - return true; - } - return false; -} - -if (PHP_VERSION_ID < 70400) { - echo 'PHP 版本必须为 7.4 或以上'; - exit(1); -} - -function check_composer_executable(string $composer): bool -{ - passthru($composer . ' --version 2>/dev/null', $exit_code); - return $exit_code === 0; -} - -function find_valid_root(string $current_dir, int $max_loop): string -{ - if ($max_loop <= 0) { - return ''; - } - if (!file_exists($current_dir . '/composer.json')) { - return find_valid_root(dirname($current_dir), $max_loop - 1); - } - return $current_dir; -} - -$root = find_valid_root(getcwd(), 3); -if (empty($root)) { - echo '找不到有效的根目录'; - exit(1); -} -echo '根目录: ' . $root . PHP_EOL; - -chdir($root); - -if (!is_dir($root . '/src/ZM')) { - echo '源码目录不存在'; - exit(1); -} - -$phpdoc_package_temp_installed = false; -if (file_exists($root . '/vendor/jasny/phpdoc-parser/composer.json')) { - echo '正在使用现有的 PHPDoc 解析库' . PHP_EOL; -} else { - echo 'PHPDoc 解析库不存在，正在尝试安装...' . PHP_EOL; - echo '本次生成完成后将会自动移除' . PHP_EOL; - $composers = [ - 'runtime/composer', 'composer', 'php composer.phar', - ]; - foreach ($composers as $composer) { - if (check_composer_executable($composer)) { - echo '正在使用 ' . $composer . ' 安装 PHPDoc 解析库，请稍候...' . PHP_EOL; - passthru("{$composer} require --quiet jasny/phpdoc-parser", $exit_code); - if ($exit_code === 0) { - $phpdoc_package_temp_installed = true; - break; - } - } - } - if (!$phpdoc_package_temp_installed) { - echo '安装失败，请手动安装：composer require jasny/phpdoc-parser' . PHP_EOL; - exit(1); - } -} - -function remove_temp_phpdoc_package() -{ - if ($GLOBALS['phpdoc_package_temp_installed']) { - echo '正在移除 PHPDoc 解析库，请稍候...' . PHP_EOL; - passthru('composer remove --quiet jasny/phpdoc-parser', $exit_code); - if ($exit_code !== 0) { - echo '移除失败，请手动移除：composer remove jasny/phpdoc-parser' . PHP_EOL; - } - echo '移除完成'; - } -} - -register_shutdown_function('remove_temp_phpdoc_package'); - -// 从这里开始是主要生成逻辑 - -require_once $root . '/vendor/autoload.php'; - -use Jasny\PhpdocParser\PhpdocParser; -use Jasny\PhpdocParser\Set\PhpDocumentor; -use Jasny\PhpdocParser\Tag\Summery; -use ZM\Logger\ConsoleLogger; - -$opts = getopt('', ['show-warnings', 'show-debug']); - -if (array_key_exists('show-warnings', $opts)) { - $show_warnings = true; -} else { - $show_warnings = false; -} - -ob_logger_register(new ConsoleLogger(array_key_exists('show-debug', $opts) ? 'debug' : 'info')); - -$errors = []; -$warnings = []; - -// 获取源码目录的文件遍历器 -$fs = new \RecursiveDirectoryIterator($root . '/src/ZM', FilesystemIterator::SKIP_DOTS); - -// 初始化文档解析器 -$parser = new PhpdocParser(PhpDocumentor::tags()->with([ - new Summery(), -])); - -$metas = []; -$class_count = 0; -$method_count = 0; - -function error(string $message) -{ - global $errors; - $errors[] = $message; - logger()->error($message); -} - -function warning(string $message) -{ - global $warnings, $show_warnings; - $warnings[] = $message; - if ($show_warnings) { - logger()->warning($message); - } -} - -/** - * 获取类的元数据 - * - * 包括类的注释、方法的注释、参数、返回值等 - */ -function get_class_metas(string $class_name, PhpdocParser $parser): array -{ - // 尝试获取反射类 - try { - $class = new \ReflectionClass($class_name); - } catch (\ReflectionException $e) { - error('无法获取类 ' . $class_name . ' 的反射类'); - return []; - } - - // 判断是否略过该类 - if (should_ignore_class($class)) { - return []; - } - - $metas = []; - - // 遍历类方法 - foreach ($class->getMethods() as $method) { - if ($method->getDeclaringClass()->getName() !== $class_name) { - continue; - } - - logger()->debug('正在解析方法：' . $class_name . '::' . $method->getName()); - - // 获取方法的注释并解析 - $doc = $method->getDocComment(); - if (!$doc) { - warning('找不到文档：' . $class_name . '::' . $method->getName()); - continue; - } - try { - // 解析器对于多余空格的解析似乎有问题，这里去除一下多余的空格 - $doc = preg_replace('/\s(?=\s)/', '\\1', $doc); - $meta = $parser->parse($doc); - } catch (\Exception $e) { - error('解析失败：' . $class_name . '::' . $method->getName() . '，' . $e->getMessage()); - continue; - } - // 少数情况解析后会带有 */，需要去除 - array_walk_recursive($meta, static function (&$item) { - if (is_string($item)) { - $item = trim(str_replace('*/', '', $item)); - } - }); - - // 对比反射方法获取的参数和注释声明的参数 - $parameters = $method->getParameters(); - $params_in_doc = $meta['params'] ?? []; - - foreach ($parameters as $parameter) { - $parameter_name = $parameter->getName(); - // 不存在则添加进参数列表中 - if (!isset($params_in_doc[$parameter_name])) { - $params_in_doc[$parameter_name] = [ - 'type' => $parameter->getType()?->getName(), - 'description' => '', - ]; - } - } - // 确保所有参数都有对应的类型和描述 - foreach ($params_in_doc as &$param) { - if (!isset($param['type'])) { - $param['type'] = 'mixed'; - } - if (!isset($param['description'])) { - $param['description'] = ''; - } - } - // 清除引用 - unset($param); - $meta['params'] = $params_in_doc; - - // 设定方法默认返回值 - if (!isset($meta['return'])) { - $meta['return'] = [ - 'type' => $method->getReturnType()?->getName() ?: 'mixed', - 'description' => '', - ]; - } - - // 设定默认描述 - if (!isset($meta['return']['description'])) { - $meta['return']['description'] = ''; - } - - $metas[$method->getName()] = $meta; - } - - return $metas; -} - -/** - * 将方法的元数据转换为 Markdown 格式 - * - * @param string $method 方法名 - * @param array $meta 元数据 - */ -function convert_meta_to_markdown(string $method, array $meta): string -{ - // 方法名作为标题 - $markdown = '## ' . $method . "\n\n"; - - // 构造方法代码块 - $markdown .= '```php' . "\n"; - // TODO: 适配 private 等修饰符 - $markdown .= 'public function ' . $method . '('; - $params = []; - // 添加参数 - foreach ($meta['params'] as $param_name => $param_meta) { - $params[] = sprintf('%s $%s', $param_meta['type'] ?? 'mixed', $param_name); - } - $markdown .= implode(', ', $params) . ')'; - // 添加返回值 - $markdown .= ': ' . $meta['return']['type']; - $markdown .= "\n```\n\n"; - - // 方法描述 - $markdown .= '### 描述' . "\n\n"; - $markdown .= ($meta['description'] ?? '作者很懒，什么也没有说') . "\n\n"; - - // 参数 - if (count($meta['params'])) { - $markdown .= '### 参数' . "\n\n"; - $markdown .= '| 名称 | 类型 | 描述 |' . "\n"; - $markdown .= '| -------- | ---- | ----------- |' . "\n"; - foreach ($meta['params'] as $param_name => $param_meta) { - $markdown .= '| ' . $param_name . ' | ' . $param_meta['type'] . ' | ' . $param_meta['description'] . ' |' . "\n"; - } - $markdown .= "\n"; - } - - // 返回值 - $markdown .= '### 返回' . "\n\n"; - $markdown .= '| 类型 | 描述 |' . "\n"; - $markdown .= '| ---- | ----------- |' . "\n"; - $markdown .= '| ' . $meta['return']['type'] . ' | ' . $meta['return']['description'] . ' |' . "\n"; - - return $markdown; -} - -function generate_sidebar_config(string $title, array $items): array -{ - return [ - 'title' => $title, - 'collapsable' => true, - 'children' => $items, - ]; -} - -logger()->info('开始生成！'); - -// 遍历类并将元数据添加至数组中 -foreach (new \RecursiveIteratorIterator($fs) as $file) { - if (!$file->isFile()) { - continue; - } - $path = $file->getPathname(); - - // 过滤不包含类的文件 - $tokens = token_get_all(file_get_contents($path)); - $found = false; - foreach ($tokens as $k => $token) { - if (!is_array($token)) { - continue; - } - if ($token[0] === T_CLASS && $tokens[$k - 2][0] !== T_NEW) { - $found = true; - break; - } - if ($k >= 100) { - break; - } - } - if (!$found) { - continue; - } - - // 获取完整类名 - $path = str_replace($root . '/', '', $path); - $class = str_replace(['.php', 'src/', '/'], ['', '', '\\'], $path); - logger()->debug('正在解析类：' . $class); - $meta = get_class_metas($class, $parser); - // 忽略不包含任何方法的类 - if (empty($meta)) { - continue; - } - $metas[$class] = $meta; - ++$class_count; - $method_count += count($meta); -} - -// 将元数据转换为 Markdown -$markdown = []; -foreach ($metas as $class => $class_metas) { - $markdown[$class] = []; - // 将类名作为页面大标题 - $markdown[$class]['class'] = '# ' . $class; - foreach ($class_metas as $method => $meta) { - $markdown[$class][$method] = convert_meta_to_markdown($method, $meta); - } -} - -// 生成文档 -$docs = $root . '/docs/api/'; -foreach ($markdown as $class => $methods) { - $file = $docs . str_replace('\\', '/', $class) . '.md'; - // 确保目录存在 - if (!file_exists(dirname($file)) && !mkdir($concurrent_directory = dirname($file), 0777, true) && !is_dir($concurrent_directory)) { - throw new \RuntimeException(sprintf('无法建立目录 %s', $concurrent_directory)); - } - logger()->debug('正在生成文档：' . $file); - $text = implode("\n\n", $methods); - file_put_contents($file, $text); -} - -// 生成文档目录 -$children = array_keys($markdown); -$children = str_replace('\\', '/', $children); -$class_tree = []; -foreach ($children as $child) { - $parent = dirname($child); - $class_tree[$parent][] = $child; -} -ksort($class_tree); -$config = 'module.exports = ['; -foreach ($class_tree as $parent => $children) { - $encode = json_encode(generate_sidebar_config($parent, $children)); - $encode = str_replace('\/', '/', $encode); - $config .= $encode . ','; -} -$config = rtrim($config, ','); -$config .= ']'; - -$file = $root . '/docs/.vuepress/api.js'; -file_put_contents($file, $config); - -if (count($warnings)) { - logger()->warning('生成过程中发现 ' . count($warnings) . ' 次警告'); - if (!$show_warnings) { - logger()->info('生成器默认忽略了警告，你可以通过 gendoc --show-warnings 来查看警告'); - } -} -if (count($errors)) { - logger()->error('生成过程中发现错误：'); - foreach ($errors as $error) { - logger()->error($error); - } -} - -logger()->notice('API 文档生成完毕'); -logger()->notice(sprintf('共生成 %d 个类，共 %d 个方法', $class_count, $method_count)); - -// 完成生成，进行善后 - -exit(0); diff --git a/bin/prepare-doxygen b/bin/prepare-doxygen new file mode 100644 index 00000000..c9f51542 --- /dev/null +++ b/bin/prepare-doxygen @@ -0,0 +1,73 @@ +#!/usr/bin/env php +info('正在获取 Doxyfile 内容'); + $doxyfile = file_get_contents('https://pastebin.com/raw/N8tJ9kWE'); + $doxyfile = str_replace('', \ZM\Framework::VERSION, $doxyfile); + file_put_contents('Doxyfile', $doxyfile); + + // 应用 Awesome 样式 + // 来源：https://github.com/jothepro/doxygen-awesome-css.git + // 优先使用本地文件 + logger()->info('正在应用 Awesome 样式'); + \ZM\Store\FileSystem::createDir('doxy/css'); + if ( + file_exists('doxy/css/doxygen-awesome.css') && + (md5_file('doxy/css/doxygen-awesome.css') === '326a1447f9693d1b3876f59de837a7c0') + ) { + logger()->info('本地 Awesome 样式文件已存在，跳过下载'); + } else { + logger()->info('正在下载 Awesome 样式文件'); + $cmd = [ + 'git clone https://github.com/jothepro/doxygen-awesome-css.git doxy/css', + 'cd doxy/css', + 'git checkout v2.1.0', + 'cd ../..', + ]; + $cmd = implode(' && ', $cmd); + exec($cmd); + } +} elseif ($param === 'after') { + // 删除临时文件 + unlink('Doxyfile'); + + // 清除旧文档 + exec('rm -rf docs/.vuepress/public/doxy'); + + // 移动新文档到 docs 目录 + exec('mv doxy/html docs/.vuepress/public/doxy'); + + logger()->info('文档生成完成'); +} else { + logger()->error('参数错误'); + exit(1); +} diff --git a/docs/.vuepress/api.js b/docs/.vuepress/api.js deleted file mode 100644 index b0f3c853..00000000 --- a/docs/.vuepress/api.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"title":"ZM","collapsable":true,"children":["ZM/ZMApplication","ZM/ConsoleApplication"]},{"title":"ZM/Annotation","collapsable":true,"children":["ZM/Annotation/AnnotationHandler","ZM/Annotation/AnnotationMap","ZM/Annotation/AnnotationParser","ZM/Annotation/AnnotationBase"]},{"title":"ZM/Command","collapsable":true,"children":["ZM/Command/InitCommand","ZM/Command/Command","ZM/Command/ProxyServerCommand","ZM/Command/BuildCommand"]},{"title":"ZM/Command/Server","collapsable":true,"children":["ZM/Command/Server/ServerStartCommand","ZM/Command/Server/ServerCommand"]},{"title":"ZM/Config","collapsable":true,"children":["ZM/Config/ZMConfig","ZM/Config/ConfigTracer"]},{"title":"ZM/Container","collapsable":true,"children":["ZM/Container/ContainerServicesProvider","ZM/Container/BoundMethod","ZM/Container/WorkerContainer","ZM/Container/Container"]},{"title":"ZM/Context","collapsable":true,"children":["ZM/Context/Context"]},{"title":"ZM/Event","collapsable":true,"children":["ZM/Event/EventProvider","ZM/Event/EventDispatcher"]},{"title":"ZM/Event/Listener","collapsable":true,"children":["ZM/Event/Listener/MasterEventListener","ZM/Event/Listener/ManagerEventListener","ZM/Event/Listener/HttpEventListener","ZM/Event/Listener/WorkerEventListener","ZM/Event/Listener/SignalListener","ZM/Event/Listener/WSEventListener"]},{"title":"ZM/Middleware","collapsable":true,"children":["ZM/Middleware/MiddlewareHandler","ZM/Middleware/Pipeline"]},{"title":"ZM/Plugin","collapsable":true,"children":["ZM/Plugin/PluginManager","ZM/Plugin/OneBot12Adapter"]},{"title":"ZM/Process","collapsable":true,"children":["ZM/Process/ProcessStateManager"]},{"title":"ZM/Store","collapsable":true,"children":["ZM/Store/FileSystem"]},{"title":"ZM/Store/Database","collapsable":true,"children":["ZM/Store/Database/DBWrapper","ZM/Store/Database/DBStatement","ZM/Store/Database/DBPool","ZM/Store/Database/DBStatementWrapper","ZM/Store/Database/DBConnection","ZM/Store/Database/DBQueryBuilder"]},{"title":"ZM/Store/Lock","collapsable":true,"children":["ZM/Store/Lock/FileLock"]},{"title":"ZM/Utils","collapsable":true,"children":["ZM/Utils/EasterEgg","ZM/Utils/ConnectionUtil","ZM/Utils/ReflectionUtil","ZM/Utils/ZMUtil","ZM/Utils/HttpUtil"]}] \ No newline at end of file diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 4359bf56..211bf522 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -1,5 +1,3 @@ -const apiConfig = require('./api') - module.exports = { title: '炸毛框架', description: '一个高性能聊天机器人 + Web 框架', @@ -31,7 +29,7 @@ module.exports = { { text: '事件和注解', link: '/event/' }, { text: '组件', link: '/component/' }, { text: '进阶', link: '/advanced/' }, - { text: 'API', link: '/api/' }, + { text: 'API', link: '/doxy/' }, { text: 'FAQ', link: '/faq/' }, { text: '更新日志', link: '/update/v2/' }, { text: '炸毛框架 v1', link: 'https://docs-v1.zhamao.xin/' } @@ -164,7 +162,6 @@ module.exports = { ] }, ], - '/api/': apiConfig, '/faq/': [ '', 'to-v2', diff --git a/docs/api/ZM/API/CQ.md b/docs/api/ZM/API/CQ.md deleted file mode 100644 index 1b9798f3..00000000 --- a/docs/api/ZM/API/CQ.md +++ /dev/null @@ -1,618 +0,0 @@ -# ZM\API\CQ - -## at - -```php -public function at(int|string $qq): string -``` - -### 描述 - -at一下QQ用户（仅在QQ群支持at全体） - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| qq | int|string | 用户QQ号/ID号 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | CQ码 | - - -## face - -```php -public function face(int|string $id): string -``` - -### 描述 - -发送QQ原生表情 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| id | int|string | 表情ID | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | CQ码 | - - -## image - -```php -public function image(string $file, bool $cache, bool $flash, bool $proxy, int $timeout): string -``` - -### 描述 - -发送图片 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| file | string | 文件的路径、URL或者base64编码的图片数据 | -| cache | bool | 是否缓存（默认为true） | -| flash | bool | 是否闪照（默认为false） | -| proxy | bool | 是否使用代理（默认为true） | -| timeout | int | 超时时间（默认不超时） | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | CQ码 | - - -## record - -```php -public function record(string $file, bool $magic, bool $cache, bool $proxy, int $timeout): string -``` - -### 描述 - -发送语音 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| file | string | 文件的路径、URL或者base64编码的语音数据 | -| magic | bool | 是否加特技（默认为false） | -| cache | bool | 是否缓存（默认为true） | -| proxy | bool | 是否使用代理（默认为true） | -| timeout | int | 超时时间（默认不超时） | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | CQ码 | - - -## video - -```php -public function video(string $file, bool $cache, bool $proxy, int $timeout): string -``` - -### 描述 - -发送短视频 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| file | string | 文件的路径、URL或者base64编码的短视频数据 | -| cache | bool | 是否缓存（默认为true） | -| proxy | bool | 是否使用代理（默认为true） | -| timeout | int | 超时时间（默认不超时） | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | CQ码 | - - -## rps - -```php -public function rps(): string -``` - -### 描述 - -发送投掷骰子（只能在单条回复中单独使用） - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | CQ码 | - - -## dice - -```php -public function dice(): string -``` - -### 描述 - -发送掷骰子表情（只能在单条回复中单独使用） - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | CQ码 | - - -## shake - -```php -public function shake(): string -``` - -### 描述 - -戳一戳（原窗口抖动，仅支持好友消息使用） - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | CQ码 | - - -## poke - -```php -public function poke(int|string $type, int|string $id, string $name): string -``` - -### 描述 - -发送新的戳一戳 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| type | int|string | 焯一戳类型 | -| id | int|string | 戳一戳ID号 | -| name | string | 戳一戳名称（可选） | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | CQ码 | - - -## anonymous - -```php -public function anonymous(int $ignore): string -``` - -### 描述 - -发送匿名消息 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| ignore | int | 是否忽略错误（默认为1，0表示不忽略错误） | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | CQ码 | - - -## share - -```php -public function share(string $url, string $title, null|string $content, null|string $image): string -``` - -### 描述 - -发送链接分享（只能在单条回复中单独使用） - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| url | string | 分享地址 | -| title | string | 标题 | -| content | null|string | 卡片内容（可选） | -| image | null|string | 卡片图片（可选） | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | CQ码 | - - -## contact - -```php -public function contact(int|string $type, int|string $id): string -``` - -### 描述 - -发送好友或群推荐名片 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| type | int|string | 名片类型 | -| id | int|string | 好友或群ID | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | CQ码 | - - -## location - -```php -public function location(float|string $lat, float|string $lon, string $title, string $content): string -``` - -### 描述 - -发送位置 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| lat | float|string | 纬度 | -| lon | float|string | 经度 | -| title | string | 标题（可选） | -| content | string | 卡片内容（可选） | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | CQ码 | - - -## music - -```php -public function music(string $type, int|string $id_or_url, null|string $audio, null|string $title, null|string $content, null|string $image): string -``` - -### 描述 - -发送音乐分享（只能在单条回复中单独使用） -qq、163、xiami为内置分享，需要先通过搜索功能获取id后使用 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| type | string | 分享类型（仅限 `qq`、`163`、`xiami` 或 `custom`） | -| id_or_url | int|string | 当分享类型不是 `custom` 时，表示的是分享音乐的ID（需要先通过搜索功能获取id后使用），反之表示的是音乐卡片点入的链接 | -| audio | null|string | 当分享类型是 `custom` 时，表示为音乐（如mp3文件）的HTTP链接地址（不可为空） | -| title | null|string | 当分享类型是 `custom` 时，表示为音乐卡片的标题，建议12字以内（不可为空） | -| content | null|string | 当分享类型是 `custom` 时，表示为音乐卡片的简介（可忽略） | -| image | null|string | 当分享类型是 `custom` 时，表示为音乐卡片的图片链接地址（可忽略） | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | CQ码 | - - -## forward - -```php -public function forward(int|string $id): string -``` - -### 描述 - -合并转发消息 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| id | int|string | 合并转发ID, 需要通过 `/get_forward_msg` API获取转发的具体内容 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | CQ码 | - - -## node - -```php -public function node(int|string $user_id, string $nickname, string $content): string -``` - -### 描述 - -合并转发消息节点 -特殊说明: 需要使用单独的API /send_group_forward_msg 发送, 并且由于消息段较为复杂, 仅支持Array形式入参。 -如果引用消息和自定义消息同时出现, 实际查看顺序将取消息段顺序。 -另外按 CQHTTP 文档说明, data 应全为字符串, 但由于需要接收message 类型的消息, 所以 仅限此Type的content字段 支持Array套娃 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| user_id | int|string | 转发消息id | -| nickname | string | 发送者显示名字 | -| content | string | 具体消息 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | CQ码 | - - -## xml - -```php -public function xml(string $data): string -``` - -### 描述 - -XML消息 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| data | string | xml内容, xml中的value部分 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | CQ码 | - - -## json - -```php -public function json(string $data, int $resid): string -``` - -### 描述 - -JSON消息 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| data | string | json内容 | -| resid | int | 0为走小程序通道，其他值为富文本通道（默认为0） | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | CQ码 | - - -## _custom - -```php -public function _custom(string $type_name, array $params): string -``` - -### 描述 - -返回一个自定义扩展的CQ码（支持自定义类型和参数） - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| type_name | string | CQ码类型名称 | -| params | array | 参数 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | CQ码 | - - -## decode - -```php -public function decode(int|string|Stringable $msg, bool $is_content): string -``` - -### 描述 - -反转义字符串中的CQ码敏感符号 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| msg | int|string|Stringable | 字符串 | -| is_content | bool | 如果是解码CQ码本体内容，则为false（默认），如果是参数内的字符串，则为true | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | 转义后的CQ码 | - - -## replace - -```php -public function replace(int|string|Stringable $str): string -``` - -### 描述 - -简单反转义替换CQ码的方括号 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| str | int|string|Stringable | 字符串 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | 字符串 | - - -## escape - -```php -public function escape(int|string|Stringable $msg, bool $is_content): string -``` - -### 描述 - -转义CQ码的特殊字符，同encode - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| msg | int|string|Stringable | 字符串 | -| is_content | bool | 如果是转义CQ码本体内容，则为false（默认），如果是参数内的字符串，则为true | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | 转义后的CQ码 | - - -## encode - -```php -public function encode(int|string|Stringable $msg, bool $is_content): string -``` - -### 描述 - -转义CQ码的特殊字符 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| msg | int|string|Stringable | 字符串 | -| is_content | bool | 如果是转义CQ码本体内容，则为false（默认），如果是参数内的字符串，则为true | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | 转义后的CQ码 | - - -## removeCQ - -```php -public function removeCQ(string $msg): string -``` - -### 描述 - -移除消息中所有的CQ码并返回移除CQ码后的消息 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| msg | string | 消息 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | 消息内容 | - - -## getCQ - -```php -public function getCQ(string $msg, bool $is_object): null|array|CQObject -``` - -### 描述 - -获取消息中第一个CQ码 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| msg | string | 消息内容 | -| is_object | bool | 是否以对象形式返回，如果为False的话，返回数组形式（默认为false） | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| null|array|CQObject | 返回的CQ码（数组或对象） | - - -## getAllCQ - -```php -public function getAllCQ(string $msg, bool $is_object): array|CQObject[] -``` - -### 描述 - -获取消息中所有的CQ码 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| msg | string | 消息内容 | -| is_object | bool | 是否以对象形式返回，如果为False的话，返回数组形式（默认为false） | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|CQObject[] | 返回的CQ码们（数组或对象） | diff --git a/docs/api/ZM/API/GoCqhttpAPIV11.md b/docs/api/ZM/API/GoCqhttpAPIV11.md deleted file mode 100644 index 326652e6..00000000 --- a/docs/api/ZM/API/GoCqhttpAPIV11.md +++ /dev/null @@ -1,130 +0,0 @@ -# ZM\API\GoCqhttpAPIV11 - -## getGuildServiceProfile - -```php -public function getGuildServiceProfile(): array|bool -``` - -### 描述 - -获取频道系统内BOT的资料 -响应字段：nickname, tiny_id, avatar_url - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## getGuildList - -```php -public function getGuildList(): array|bool -``` - -### 描述 - -获取频道列表 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## getGuildMetaByGuest - -```php -public function getGuildMetaByGuest(int|string $guild_id): array|bool -``` - -### 描述 - -通过访客获取频道元数据 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| guild_id | int|string | 频道ID | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## getGuildChannelList - -```php -public function getGuildChannelList(int|string $guild_id, false $no_cache): array|bool -``` - -### 描述 - -获取子频道列表 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| guild_id | int|string | 频道ID | -| no_cache | false | 禁用缓存（默认为false） | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## getGuildMembers - -```php -public function getGuildMembers(int|string $guild_id): array|bool -``` - -### 描述 - -获取频道成员列表 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| guild_id | int|string | 频道ID | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## sendGuildChannelMsg - -```php -public function sendGuildChannelMsg(int|string $guild_id, int|string $channel_id, string $message): array|bool -``` - -### 描述 - -发送信息到子频道 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| guild_id | int|string | 频道ID | -| channel_id | int|string | 子频道ID | -| message | string | 信息内容 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | diff --git a/docs/api/ZM/API/OneBotV11.md b/docs/api/ZM/API/OneBotV11.md deleted file mode 100644 index 6bd09e03..00000000 --- a/docs/api/ZM/API/OneBotV11.md +++ /dev/null @@ -1,984 +0,0 @@ -# ZM\API\OneBotV11 - -## get - -```php -public function get(int|string $robot_id): ZMRobot -``` - -### 描述 - -获取机器人Action/API实例 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| robot_id | int|string | 机器人ID | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| ZMRobot | 机器人实例 | - - -## getRandom - -```php -public function getRandom(): ZMRobot -``` - -### 描述 - -随机获取一个连接到框架的机器人实例 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| ZMRobot | 机器人实例 | - - -## getAllRobot - -```php -public function getAllRobot(): ZMRobot[] -``` - -### 描述 - -获取所有机器人实例 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| ZMRobot[] | 机器人实例们 | - - -## setCallback - -```php -public function setCallback(bool|Closure $callback): OneBotV11 -``` - -### 描述 - -设置回调或启用协程等待API回包 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| callback | bool|Closure | 是否开启协程或设置异步回调函数，如果为true，则协程等待结果，如果为false，则异步执行并不等待结果，如果为回调函数，则异步执行且调用回调 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| OneBotV11 | 返回本身 | - - -## setPrefix - -```php -public function setPrefix(int $prefix): OneBotV11 -``` - -### 描述 - -设置API调用类型后缀 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| prefix | int | 设置后缀类型，API_NORMAL为不加后缀，API_ASYNC为异步调用，API_RATE_LIMITED为加后缀并且限制调用频率 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| OneBotV11 | 返回本身 | - - -## sendPrivateMsg - -```php -public function sendPrivateMsg(int|string $user_id, string $message, bool $auto_escape): array|bool -``` - -### 描述 - -发送私聊消息 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| user_id | int|string | 用户ID | -| message | string | 消息内容 | -| auto_escape | bool | 是否自动转义（默认为false） | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## sendGroupMsg - -```php -public function sendGroupMsg(int|string $group_id, string $message, bool $auto_escape): array|bool -``` - -### 描述 - -发送群消息 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| group_id | int|string | 群组ID | -| message | string | 消息内容 | -| auto_escape | bool | 是否自动转义（默认为false） | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## sendMsg - -```php -public function sendMsg(string $message_type, int|string $target_id, string $message, bool $auto_escape): array|bool -``` - -### 描述 - -发送消息 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| message_type | string | 消息类型 | -| target_id | int|string | 目标ID | -| message | string | 消息内容 | -| auto_escape | bool | 是否自动转义（默认为false） | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## deleteMsg - -```php -public function deleteMsg(int|string $message_id): array|bool -``` - -### 描述 - -撤回消息 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| message_id | int|string | 消息ID | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## getMsg - -```php -public function getMsg(int|string $message_id): array|bool -``` - -### 描述 - -获取消息 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| message_id | int|string | 消息ID | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## getForwardMsg - -```php -public function getForwardMsg(int|string $id): array|bool -``` - -### 描述 - -获取合并转发消息 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| id | int|string | ID | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## sendLike - -```php -public function sendLike(int|string $user_id, int $times): array|bool -``` - -### 描述 - -发送好友赞 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| user_id | int|string | 用户ID | -| times | int | 时间 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## setGroupKick - -```php -public function setGroupKick(int|string $group_id, int|string $user_id, bool $reject_add_request): array|bool -``` - -### 描述 - -群组踢人 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| group_id | int|string | 群ID | -| user_id | int|string | 用户ID | -| reject_add_request | bool | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## setGroupBan - -```php -public function setGroupBan(int|string $group_id, int|string $user_id, int $duration): array|bool -``` - -### 描述 - -群组单人禁言 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| group_id | int|string | 群ID | -| user_id | int|string | 用户ID | -| duration | int | 禁言时长 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## setGroupAnonymousBan - -```php -public function setGroupAnonymousBan(int|string $group_id, array|int|string $anonymous_or_flag, int $duration): array|bool -``` - -### 描述 - -群组匿名用户禁言 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| group_id | int|string | 群ID | -| anonymous_or_flag | array|int|string | 匿名禁言Flag或匿名用户对象 | -| duration | int | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## setGroupWholeBan - -```php -public function setGroupWholeBan(int|string $group_id, bool $enable): array|bool -``` - -### 描述 - -群组全员禁言 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| group_id | int|string | 群ID | -| enable | bool | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## setGroupAdmin - -```php -public function setGroupAdmin(int|string $group_id, int|string $user_id, bool $enable): array|bool -``` - -### 描述 - -群组设置管理员 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| group_id | int|string | 群ID | -| user_id | int|string | 用户ID | -| enable | bool | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## setGroupAnonymous - -```php -public function setGroupAnonymous(int|string $group_id, bool $enable): array|bool -``` - -### 描述 - -群组匿名 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| group_id | int|string | 群ID | -| enable | bool | 是否启用（默认为true） | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## setGroupCard - -```php -public function setGroupCard(int|string $group_id, int|string $user_id, string $card): array|bool -``` - -### 描述 - -设置群名片（群备注） - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| group_id | int|string | 群ID | -| user_id | int|string | 用户ID | -| card | string | 名片内容（默认为空） | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## setGroupName - -```php -public function setGroupName(int|string $group_id, string $group_name): array|bool -``` - -### 描述 - -设置群名 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| group_id | int|string | 群ID | -| group_name | string | 群名 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## setGroupLeave - -```php -public function setGroupLeave(int|string $group_id, bool $is_dismiss): array|bool -``` - -### 描述 - -退出群组 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| group_id | int|string | 群ID | -| is_dismiss | bool | 是否解散（默认为false） | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## setGroupSpecialTitle - -```php -public function setGroupSpecialTitle(int|string $group_id, int|string $user_id, string $special_title, int $duration): array|bool -``` - -### 描述 - -设置群组专属头衔 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| group_id | int|string | 群ID | -| user_id | int|string | 用户ID | -| special_title | string | 专属头衔内容 | -| duration | int | 持续时间（默认为-1，永久） | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## setFriendAddRequest - -```php -public function setFriendAddRequest(array|int|string $flag, bool $approve, string $remark): array|bool -``` - -### 描述 - -处理加好友请求 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| flag | array|int|string | 处理加好友请求的flag | -| approve | bool | 是否同意（默认为true） | -| remark | string | 设置昵称（默认不设置） | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## setGroupAddRequest - -```php -public function setGroupAddRequest(array|int|string $flag, string $sub_type, bool $approve, string $reason): array|bool -``` - -### 描述 - -处理加群请求／邀请 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| flag | array|int|string | 处理加群请求的flag | -| sub_type | string | 处理请求类型（包含add和invite） | -| approve | bool | 是否同意（默认为true） | -| reason | string | 拒绝理由（仅在拒绝时有效，默认为空） | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## getLoginInfo - -```php -public function getLoginInfo(): array|bool -``` - -### 描述 - -获取登录号信息 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## getStrangerInfo - -```php -public function getStrangerInfo(int|string $user_id, bool $no_cache): array|bool -``` - -### 描述 - -获取陌生人信息 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| user_id | int|string | 用户ID | -| no_cache | bool | 是否不使用缓存（默认为false） | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## getFriendList - -```php -public function getFriendList(): array|bool -``` - -### 描述 - -获取好友列表 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## getGroupInfo - -```php -public function getGroupInfo(int|string $group_id, bool $no_cache): array|bool -``` - -### 描述 - -获取群信息 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| group_id | int|string | 群ID | -| no_cache | bool | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## getGroupList - -```php -public function getGroupList(): array|bool -``` - -### 描述 - -获取群列表 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## getGroupMemberInfo - -```php -public function getGroupMemberInfo(int|string $group_id, int|string $user_id, bool $no_cache): array|bool -``` - -### 描述 - -获取群成员信息 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| group_id | int|string | 群ID | -| user_id | int|string | 用户ID | -| no_cache | bool | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## getGroupMemberList - -```php -public function getGroupMemberList(int|string $group_id): array|bool -``` - -### 描述 - -获取群成员列表 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| group_id | int|string | 群ID | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## getGroupHonorInfo - -```php -public function getGroupHonorInfo(int|string $group_id, string $type): array|bool -``` - -### 描述 - -获取群荣誉信息 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| group_id | int|string | 群ID | -| type | string | 荣誉类型 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## getCsrfToken - -```php -public function getCsrfToken(): array|bool -``` - -### 描述 - -获取 CSRF Token - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## getCredentials - -```php -public function getCredentials(string $domain): array|bool -``` - -### 描述 - -获取 QQ 相关接口凭证 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| domain | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## getRecord - -```php -public function getRecord(string $file, string $out_format): array|bool -``` - -### 描述 - -获取语音 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| file | string | 文件 | -| out_format | string | 输出格式 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## getImage - -```php -public function getImage(string $file): array|bool -``` - -### 描述 - -获取图片 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| file | string | 文件 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## canSendImage - -```php -public function canSendImage(): array|bool -``` - -### 描述 - -检查是否可以发送图片 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## canSendRecord - -```php -public function canSendRecord(): array|bool -``` - -### 描述 - -检查是否可以发送语音 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## getStatus - -```php -public function getStatus(): array|bool -``` - -### 描述 - -获取运行状态 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## getVersionInfo - -```php -public function getVersionInfo(): array|bool -``` - -### 描述 - -获取版本信息 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## setRestart - -```php -public function setRestart(int $delay): array|bool -``` - -### 描述 - -重启 OneBot 实现 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| delay | int | 延迟时间（毫秒，默认为0） | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## cleanCache - -```php -public function cleanCache(): array|bool -``` - -### 描述 - -清理缓存 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | - - -## getExtendedAPI - -```php -public function getExtendedAPI(string $package_name): mixed -``` - -### 描述 - -获取内置支持的扩展API对象 -现支持 go-cqhttp 的扩展API - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| package_name | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | 返回包的操作对象 | - - -## callExtendedAPI - -```php -public function callExtendedAPI(string $action, array $params): array|bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| action | string | 动作（API）名称 | -| params | array | 参数 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果（数组）或异步API调用状态（bool） | diff --git a/docs/api/ZM/API/Proxies/Bot/AbstractBotProxy.md b/docs/api/ZM/API/Proxies/Bot/AbstractBotProxy.md deleted file mode 100644 index a4147b2f..00000000 --- a/docs/api/ZM/API/Proxies/Bot/AbstractBotProxy.md +++ /dev/null @@ -1,117 +0,0 @@ -# ZM\API\Proxies\Bot\AbstractBotProxy - -## __construct - -```php -public function __construct(AbstractBotProxy|ZMRobot $bot): mixed -``` - -### 描述 - -构造函数 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| bot | AbstractBotProxy|ZMRobot | 调用此代理的机器人实例 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## __call - -```php -public function __call(string $name, array $arguments): mixed -``` - -### 描述 - -在传入的机器人实例上调用方法 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| name | string | 方法名 | -| arguments | array | 参数 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## __get - -```php -public function __get(string $name): mixed -``` - -### 描述 - -获取传入的机器人实例的属性 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| name | string | 属性名 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## __set - -```php -public function __set(string $name, mixed $value): mixed -``` - -### 描述 - -设置传入的机器人实例的属性 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| name | string | 属性名 | -| value | mixed | 属性值 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## __isset - -```php -public function __isset(string $name): bool -``` - -### 描述 - -判断传入的机器人实例的属性是否存在 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| name | string | 属性名 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | diff --git a/docs/api/ZM/API/Proxies/Bot/AllBotsProxy.md b/docs/api/ZM/API/Proxies/Bot/AllBotsProxy.md deleted file mode 100644 index 70a53db9..00000000 --- a/docs/api/ZM/API/Proxies/Bot/AllBotsProxy.md +++ /dev/null @@ -1,24 +0,0 @@ -# ZM\API\Proxies\Bot\AllBotsProxy - -## __call - -```php -public function __call(string $name, array $arguments): array -``` - -### 描述 - -在所有机器人实例上调用方法 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| name | string | 方法名 | -| arguments | array | 参数 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | 返回一个包含所有执行结果的数组，键名为机器人ID | diff --git a/docs/api/ZM/API/Proxies/Bot/AllGroupsProxy.md b/docs/api/ZM/API/Proxies/Bot/AllGroupsProxy.md deleted file mode 100644 index 21d7c563..00000000 --- a/docs/api/ZM/API/Proxies/Bot/AllGroupsProxy.md +++ /dev/null @@ -1,24 +0,0 @@ -# ZM\API\Proxies\Bot\AllGroupsProxy - -## __call - -```php -public function __call(string $name, array $arguments): array -``` - -### 描述 - -在传入的机器人实例上调用方法 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| name | string | 方法名 | -| arguments | array | 参数 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | 返回一个包含所有执行结果的数组，键名为群号 | diff --git a/docs/api/ZM/API/TuringAPI.md b/docs/api/ZM/API/TuringAPI.md deleted file mode 100644 index 2ed8ab30..00000000 --- a/docs/api/ZM/API/TuringAPI.md +++ /dev/null @@ -1,48 +0,0 @@ -# ZM\API\TuringAPI - -## getTuringMsg - -```php -public function getTuringMsg(string $msg, int|string $user_id, string $api): string -``` - -### 描述 - -请求图灵API，返回图灵的消息 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| msg | string | 消息 | -| user_id | int|string | 用户ID | -| api | string | API Key | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | 图灵的回复 | - - -## getResultStatus - -```php -public function getResultStatus(array $r): bool|string -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| r | array | 数据API回包 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool|string | 错误消息或成功鸥鸟 | diff --git a/docs/api/ZM/API/ZMRobot.md b/docs/api/ZM/API/ZMRobot.md deleted file mode 100644 index 0d5f7b1d..00000000 --- a/docs/api/ZM/API/ZMRobot.md +++ /dev/null @@ -1,46 +0,0 @@ -# ZM\API\ZMRobot - -## all - -```php -public function all(ZM\API\Proxies\Bot\AbstractBotProxy $proxy): ZM\API\Proxies\Bot\AllBotsProxy -``` - -### 描述 - -获取一个会在所有机器人实例上执行的代理 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| proxy | ZM\API\Proxies\Bot\AbstractBotProxy | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| ZM\API\Proxies\Bot\AllBotsProxy | | - - -## allGroups - -```php -public function allGroups(ZM\API\Proxies\Bot\AbstractBotProxy $proxy): ZM\API\Proxies\Bot\AllGroupsProxy -``` - -### 描述 - -获取一个会在所有群上执行的代理 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| proxy | ZM\API\Proxies\Bot\AbstractBotProxy | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| ZM\API\Proxies\Bot\AllGroupsProxy | | diff --git a/docs/api/ZM/Adapters/OneBot11Adapter.md b/docs/api/ZM/Adapters/OneBot11Adapter.md deleted file mode 100644 index fc340254..00000000 --- a/docs/api/ZM/Adapters/OneBot11Adapter.md +++ /dev/null @@ -1,293 +0,0 @@ -# ZM\Adapters\OneBot11Adapter - -## getName - -```php -public function getName(): string -``` - -### 描述 - -{@inheritDoc} - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | | - - -## getVersion - -```php -public function getVersion(): string -``` - -### 描述 - -{@inheritDoc} - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | | - - -## handleIncomingRequest - -```php -public function handleIncomingRequest(ZM\Context\ContextInterface $context): void -``` - -### 描述 - -{@inheritDoc} - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| context | ZM\Context\ContextInterface | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## handleAPIResponse - -```php -public function handleAPIResponse(array $data, ContextInterface $context): void -``` - -### 描述 - -处理 API 响应 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| data | array | 数据 | -| context | ContextInterface | 上下文 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## handleMessageEvent - -```php -public function handleMessageEvent(array $data, ContextInterface $context): void -``` - -### 描述 - -处理消息事件 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| data | array | 消息数据 | -| context | ContextInterface | 上下文 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## handleMetaEvent - -```php -public function handleMetaEvent(array $data, ContextInterface $context): void -``` - -### 描述 - -处理元事件 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| data | array | 消息数据 | -| context | ContextInterface | 上下文 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## handleNoticeEvent - -```php -public function handleNoticeEvent(array $data, ContextInterface $context): void -``` - -### 描述 - -处理通知事件 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| data | array | 消息数据 | -| context | ContextInterface | 上下文 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## handleRequestEvent - -```php -public function handleRequestEvent(array $data, ContextInterface $context): void -``` - -### 描述 - -处理请求事件 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| data | array | 消息数据 | -| context | ContextInterface | 上下文 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## handleBeforeEvent - -```php -public function handleBeforeEvent(array $data, string $time): ZM\Event\EventDispatcher -``` - -### 描述 - -处理前置事件 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| data | array | 消息数据 | -| time | string | 执行时机 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| ZM\Event\EventDispatcher | | - - -## handleAfterEvent - -```php -public function handleAfterEvent(array $data): ZM\Event\EventDispatcher -``` - -### 描述 - -处理后置事件 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| data | array | 消息数据 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| ZM\Event\EventDispatcher | | - - -## isAPIResponse - -```php -public function isAPIResponse(array $data): bool -``` - -### 描述 - -判断是否为 API 回调 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| data | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## isEvent - -```php -public function isEvent(array $data): bool -``` - -### 描述 - -判断是否为事件 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| data | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## isMetaEvent - -```php -public function isMetaEvent(array $data): bool -``` - -### 描述 - -判断是否为元事件 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| data | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | diff --git a/docs/api/ZM/Annotation/AnnotationBase.md b/docs/api/ZM/Annotation/AnnotationBase.md deleted file mode 100644 index c232b507..00000000 --- a/docs/api/ZM/Annotation/AnnotationBase.md +++ /dev/null @@ -1,23 +0,0 @@ -# ZM\Annotation\AnnotationBase - -## on - -```php -public function on(mixed $method): ZM\Annotation\AnnotationBase -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| method | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| ZM\Annotation\AnnotationBase | | diff --git a/docs/api/ZM/Annotation/AnnotationHandler.md b/docs/api/ZM/Annotation/AnnotationHandler.md deleted file mode 100644 index d08258db..00000000 --- a/docs/api/ZM/Annotation/AnnotationHandler.md +++ /dev/null @@ -1,174 +0,0 @@ -# ZM\Annotation\AnnotationHandler - -## __construct - -```php -public function __construct(string $annotation_class): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| annotation_class | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## interrupt - -```php -public function interrupt(mixed $return_var): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| return_var | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## setRuleCallback - -```php -public function setRuleCallback(callable $rule): ZM\Annotation\AnnotationHandler -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| rule | callable | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| ZM\Annotation\AnnotationHandler | | - - -## setReturnCallback - -```php -public function setReturnCallback(callable $return): ZM\Annotation\AnnotationHandler -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| return | callable | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| ZM\Annotation\AnnotationHandler | | - - -## handleAll - -```php -public function handleAll(mixed $params): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| params | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## handle - -```php -public function handle(ZM\Annotation\AnnotationBase $v, callable $rule_callback, mixed $args): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| v | ZM\Annotation\AnnotationBase | | -| rule_callback | callable | | -| args | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## getStatus - -```php -public function getStatus(): int -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int | | - - -## getReturnVal - -```php -public function getReturnVal(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | diff --git a/docs/api/ZM/Annotation/AnnotationMap.md b/docs/api/ZM/Annotation/AnnotationMap.md deleted file mode 100644 index 94846f81..00000000 --- a/docs/api/ZM/Annotation/AnnotationMap.md +++ /dev/null @@ -1,40 +0,0 @@ -# ZM\Annotation\AnnotationMap - -## loadAnnotationByParser - -```php -public function loadAnnotationByParser(ZM\Annotation\AnnotationParser $parser): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| parser | ZM\Annotation\AnnotationParser | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## sortAnnotationList - -```php -public function sortAnnotationList(): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | diff --git a/docs/api/ZM/Annotation/AnnotationParser.md b/docs/api/ZM/Annotation/AnnotationParser.md deleted file mode 100644 index d51396c7..00000000 --- a/docs/api/ZM/Annotation/AnnotationParser.md +++ /dev/null @@ -1,163 +0,0 @@ -# ZM\Annotation\AnnotationParser - -## __construct - -```php -public function __construct(bool $with_internal_parsers): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| with_internal_parsers | bool | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## addSpecialParser - -```php -public function addSpecialParser(string $class_name, callable $callback): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| class_name | string | | -| callback | callable | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## parseAll - -```php -public function parseAll(): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## generateAnnotationList - -```php -public function generateAnnotationList(): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## addRegisterPath - -```php -public function addRegisterPath(string $path, string $indoor_name): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| path | string | | -| indoor_name | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## getUsedTime - -```php -public function getUsedTime(): float -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| float | | - - -## getAnnotationMap - -```php -public function getAnnotationMap(): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## addRouteAnnotation - -```php -public function addRouteAnnotation(ZM\Annotation\Http\Route $vss, array $same_method_annotations): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| vss | ZM\Annotation\Http\Route | | -| same_method_annotations | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | diff --git a/docs/api/ZM/Annotation/CQ/CQAPIResponse.md b/docs/api/ZM/Annotation/CQ/CQAPIResponse.md deleted file mode 100644 index 54bf0fa7..00000000 --- a/docs/api/ZM/Annotation/CQ/CQAPIResponse.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index e18500bb..00000000 --- a/docs/api/ZM/Annotation/CQ/CQAfter.md +++ /dev/null @@ -1,39 +0,0 @@ -# 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 deleted file mode 100644 index 9fc6d48a..00000000 --- a/docs/api/ZM/Annotation/CQ/CQBefore.md +++ /dev/null @@ -1,39 +0,0 @@ -# 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 deleted file mode 100644 index 69616fc9..00000000 --- a/docs/api/ZM/Annotation/CQ/CQCommand.md +++ /dev/null @@ -1,22 +0,0 @@ -# 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 deleted file mode 100644 index 4d9529e5..00000000 --- a/docs/api/ZM/Annotation/CQ/CQMessage.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index bba036b4..00000000 --- a/docs/api/ZM/Annotation/CQ/CQMetaEvent.md +++ /dev/null @@ -1,39 +0,0 @@ -# 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 deleted file mode 100644 index 152494a7..00000000 --- a/docs/api/ZM/Annotation/CQ/CQNotice.md +++ /dev/null @@ -1,22 +0,0 @@ -# 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 deleted file mode 100644 index daa64f52..00000000 --- a/docs/api/ZM/Annotation/CQ/CQRequest.md +++ /dev/null @@ -1,22 +0,0 @@ -# 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 deleted file mode 100644 index 7172677f..00000000 --- a/docs/api/ZM/Annotation/Command/TerminalCommand.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 95535f8c..00000000 --- a/docs/api/ZM/Annotation/Cron/Cron.md +++ /dev/null @@ -1,61 +0,0 @@ -# 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 deleted file mode 100644 index b1c2b707..00000000 --- a/docs/api/ZM/Annotation/Http/Controller.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 81036d8b..00000000 --- a/docs/api/ZM/Annotation/Http/HandleAfter.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 8d88feb6..00000000 --- a/docs/api/ZM/Annotation/Http/HandleBefore.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index af8e0057..00000000 --- a/docs/api/ZM/Annotation/Http/HandleException.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index ba3e2c8f..00000000 --- a/docs/api/ZM/Annotation/Http/Middleware.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index ac53f6a0..00000000 --- a/docs/api/ZM/Annotation/Http/MiddlewareClass.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index d193124b..00000000 --- a/docs/api/ZM/Annotation/Http/RequestMapping.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 6917eae5..00000000 --- a/docs/api/ZM/Annotation/Http/RequestMethod.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 422ccfca..00000000 --- a/docs/api/ZM/Annotation/Module/Closed.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index f88f8443..00000000 --- a/docs/api/ZM/Annotation/Swoole/OnCloseEvent.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 05cc1b94..00000000 --- a/docs/api/ZM/Annotation/Swoole/OnManagerStartEvent.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 95f59e25..00000000 --- a/docs/api/ZM/Annotation/Swoole/OnMessageEvent.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 20c0dd39..00000000 --- a/docs/api/ZM/Annotation/Swoole/OnOpenEvent.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 478ce4e3..00000000 --- a/docs/api/ZM/Annotation/Swoole/OnPipeMessageEvent.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index bf94dde7..00000000 --- a/docs/api/ZM/Annotation/Swoole/OnRequestEvent.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 69b22d3e..00000000 --- a/docs/api/ZM/Annotation/Swoole/OnSave.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index e1c94920..00000000 --- a/docs/api/ZM/Annotation/Swoole/OnSetup.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 8f548c2c..00000000 --- a/docs/api/ZM/Annotation/Swoole/OnStart.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 512d4d03..00000000 --- a/docs/api/ZM/Annotation/Swoole/OnSwooleEvent.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 75f8777b..00000000 --- a/docs/api/ZM/Annotation/Swoole/OnSwooleEventBase.md +++ /dev/null @@ -1,23 +0,0 @@ -# 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 deleted file mode 100644 index f08fabe2..00000000 --- a/docs/api/ZM/Annotation/Swoole/OnTask.md +++ /dev/null @@ -1,17 +0,0 @@ -# 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 deleted file mode 100644 index 13a800ef..00000000 --- a/docs/api/ZM/Annotation/Swoole/OnTaskEvent.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 63348022..00000000 --- a/docs/api/ZM/Annotation/Swoole/OnTick.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index a0a400f3..00000000 --- a/docs/api/ZM/Annotation/Swoole/SwooleHandler.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index f41b9687..00000000 --- a/docs/api/ZM/Command/BuildCommand.md +++ /dev/null @@ -1,17 +0,0 @@ -# ZM\Command\BuildCommand - -## configure - -```php -public function configure(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | diff --git a/docs/api/ZM/Command/CheckConfigCommand.md b/docs/api/ZM/Command/CheckConfigCommand.md deleted file mode 100644 index 546ab53e..00000000 --- a/docs/api/ZM/Command/CheckConfigCommand.md +++ /dev/null @@ -1,24 +0,0 @@ -# ZM\Command\CheckConfigCommand - -## check - -```php -public function check(mixed $remote, mixed $local): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| remote | mixed | | -| local | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | diff --git a/docs/api/ZM/Command/Command.md b/docs/api/ZM/Command/Command.md deleted file mode 100644 index 9da5af5c..00000000 --- a/docs/api/ZM/Command/Command.md +++ /dev/null @@ -1,226 +0,0 @@ -# ZM\Command\Command - -## execute - -```php -public function execute(Symfony\Component\Console\Input\InputInterface $input, Symfony\Component\Console\Output\OutputInterface $output): int -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| input | Symfony\Component\Console\Input\InputInterface | | -| output | Symfony\Component\Console\Output\OutputInterface | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int | | - - -## shouldExecute - -```php -public function shouldExecute(): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## handle - -```php -public function handle(): int -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int | | - - -## write - -```php -public function write(string $message, bool $newline): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| message | string | | -| newline | bool | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## info - -```php -public function info(string $message, bool $newline): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| message | string | | -| newline | bool | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## error - -```php -public function error(string $message, bool $newline): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| message | string | | -| newline | bool | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## comment - -```php -public function comment(string $message, bool $newline): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| message | string | | -| newline | bool | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## question - -```php -public function question(string $message, bool $newline): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| message | string | | -| newline | bool | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## detail - -```php -public function detail(string $message, bool $newline): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| message | string | | -| newline | bool | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## section - -```php -public function section(string $message, callable $callback): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| message | string | | -| callback | callable | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | diff --git a/docs/api/ZM/Command/Daemon/DaemonCommand.md b/docs/api/ZM/Command/Daemon/DaemonCommand.md deleted file mode 100644 index 751f0241..00000000 --- a/docs/api/ZM/Command/Daemon/DaemonCommand.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index d3f57d45..00000000 --- a/docs/api/ZM/Command/Daemon/DaemonReloadCommand.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 2d7cf795..00000000 --- a/docs/api/ZM/Command/Daemon/DaemonStatusCommand.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index bcdb4040..00000000 --- a/docs/api/ZM/Command/Daemon/DaemonStopCommand.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index aa0daafd..00000000 --- a/docs/api/ZM/Command/Generate/APIDocsGenerateCommand.md +++ /dev/null @@ -1,91 +0,0 @@ -# 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 deleted file mode 100644 index ca5d40b4..00000000 --- a/docs/api/ZM/Command/Generate/SystemdGenerateCommand.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 6072ac63..00000000 --- a/docs/api/ZM/Command/InitCommand.md +++ /dev/null @@ -1,40 +0,0 @@ -# ZM\Command\InitCommand - -## setBasePath - -```php -public function setBasePath(): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## extractFile - -```php -public function extractFile(string $file): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| file | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | diff --git a/docs/api/ZM/Command/Module/ModuleListCommand.md b/docs/api/ZM/Command/Module/ModuleListCommand.md deleted file mode 100644 index b7e82986..00000000 --- a/docs/api/ZM/Command/Module/ModuleListCommand.md +++ /dev/null @@ -1,24 +0,0 @@ -# ZM\Command\Module\ModuleListCommand - -## execute - -```php -public function execute(Symfony\Component\Console\Input\InputInterface $input, Symfony\Component\Console\Output\OutputInterface $output): int -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| input | Symfony\Component\Console\Input\InputInterface | | -| output | Symfony\Component\Console\Output\OutputInterface | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int | | diff --git a/docs/api/ZM/Command/Module/ModulePackCommand.md b/docs/api/ZM/Command/Module/ModulePackCommand.md deleted file mode 100644 index 5d2427aa..00000000 --- a/docs/api/ZM/Command/Module/ModulePackCommand.md +++ /dev/null @@ -1,24 +0,0 @@ -# ZM\Command\Module\ModulePackCommand - -## execute - -```php -public function execute(Symfony\Component\Console\Input\InputInterface $input, Symfony\Component\Console\Output\OutputInterface $output): int -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| input | Symfony\Component\Console\Input\InputInterface | | -| output | Symfony\Component\Console\Output\OutputInterface | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int | | diff --git a/docs/api/ZM/Command/Module/ModuleUnpackCommand.md b/docs/api/ZM/Command/Module/ModuleUnpackCommand.md deleted file mode 100644 index 31c7d466..00000000 --- a/docs/api/ZM/Command/Module/ModuleUnpackCommand.md +++ /dev/null @@ -1 +0,0 @@ -# ZM\Command\Module\ModuleUnpackCommand \ No newline at end of file diff --git a/docs/api/ZM/Command/ProxyServerCommand.md b/docs/api/ZM/Command/ProxyServerCommand.md deleted file mode 100644 index a9662b73..00000000 --- a/docs/api/ZM/Command/ProxyServerCommand.md +++ /dev/null @@ -1,41 +0,0 @@ -# ZM\Command\ProxyServerCommand - -## configure - -```php -public function configure(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## startSocksProxy - -```php -public function startSocksProxy(string $address, mixed $port): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| address | string | | -| port | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | diff --git a/docs/api/ZM/Command/PureHttpCommand.md b/docs/api/ZM/Command/PureHttpCommand.md deleted file mode 100644 index 4ebe259c..00000000 --- a/docs/api/ZM/Command/PureHttpCommand.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 71e5e134..00000000 --- a/docs/api/ZM/Command/RunServerCommand.md +++ /dev/null @@ -1 +0,0 @@ -# ZM\Command\RunServerCommand \ No newline at end of file diff --git a/docs/api/ZM/Command/Server/ServerCommand.md b/docs/api/ZM/Command/Server/ServerCommand.md deleted file mode 100644 index 52915833..00000000 --- a/docs/api/ZM/Command/Server/ServerCommand.md +++ /dev/null @@ -1,24 +0,0 @@ -# ZM\Command\Server\ServerCommand - -## execute - -```php -public function execute(Symfony\Component\Console\Input\InputInterface $input, Symfony\Component\Console\Output\OutputInterface $output): int -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| input | Symfony\Component\Console\Input\InputInterface | | -| output | Symfony\Component\Console\Output\OutputInterface | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int | | diff --git a/docs/api/ZM/Command/Server/ServerReloadCommand.md b/docs/api/ZM/Command/Server/ServerReloadCommand.md deleted file mode 100644 index a6d031cc..00000000 --- a/docs/api/ZM/Command/Server/ServerReloadCommand.md +++ /dev/null @@ -1 +0,0 @@ -# ZM\Command\Server\ServerReloadCommand \ No newline at end of file diff --git a/docs/api/ZM/Command/Server/ServerStartCommand.md b/docs/api/ZM/Command/Server/ServerStartCommand.md deleted file mode 100644 index 51befafe..00000000 --- a/docs/api/ZM/Command/Server/ServerStartCommand.md +++ /dev/null @@ -1,24 +0,0 @@ -# ZM\Command\Server\ServerStartCommand - -## execute - -```php -public function execute(Symfony\Component\Console\Input\InputInterface $input, Symfony\Component\Console\Output\OutputInterface $output): int -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| input | Symfony\Component\Console\Input\InputInterface | | -| output | Symfony\Component\Console\Output\OutputInterface | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int | | diff --git a/docs/api/ZM/Command/Server/ServerStatusCommand.md b/docs/api/ZM/Command/Server/ServerStatusCommand.md deleted file mode 100644 index 8b6de08f..00000000 --- a/docs/api/ZM/Command/Server/ServerStatusCommand.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 717aea6d..00000000 --- a/docs/api/ZM/Command/Server/ServerStopCommand.md +++ /dev/null @@ -1 +0,0 @@ -# ZM\Command\Server\ServerStopCommand \ No newline at end of file diff --git a/docs/api/ZM/Config/ConfigTracer.md b/docs/api/ZM/Config/ConfigTracer.md deleted file mode 100644 index 1ce48364..00000000 --- a/docs/api/ZM/Config/ConfigTracer.md +++ /dev/null @@ -1,73 +0,0 @@ -# ZM\Config\ConfigTracer - -## addTracesOf - -```php -public function addTracesOf(string $group, array $traces, string $source): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| group | string | | -| traces | array | | -| source | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## getTraceOf - -```php -public function getTraceOf(string $key): string -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| key | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | | - - -## flatten - -```php -public function flatten(string $prefix, array $array, string $source): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| prefix | string | | -| array | array | | -| source | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | diff --git a/docs/api/ZM/Config/ZMConfig.md b/docs/api/ZM/Config/ZMConfig.md deleted file mode 100644 index 154e1fbf..00000000 --- a/docs/api/ZM/Config/ZMConfig.md +++ /dev/null @@ -1,348 +0,0 @@ -# ZM\Config\ZMConfig - -## __construct - -```php -public function __construct(array $config_paths, string $environment): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| config_paths | array | | -| environment | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## loadFiles - -```php -public function loadFiles(): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## merge - -```php -public function merge(string $key, array $config): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| key | string | | -| config | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## get - -```php -public function get(string $key, mixed $default): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| key | string | | -| default | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## set - -```php -public function set(mixed $key, mixed $value): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| key | mixed | | -| value | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## addConfigPath - -```php -public function addConfigPath(string $path): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| path | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## getEnvironment - -```php -public function getEnvironment(): string -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | | - - -## setEnvironment - -```php -public function setEnvironment(string $environment): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| environment | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## reload - -```php -public function reload(): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## getHolder - -```php -public function getHolder(): OneBot\Config\Config -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| OneBot\Config\Config | | - - -## getTrace - -```php -public function getTrace(string $key): string -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| key | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | | - - -## getFileMeta - -```php -public function getFileMeta(string $name): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| name | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## getFileLoadType - -```php -public function getFileLoadType(string $name): string -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| name | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | | - - -## shouldLoadFile - -```php -public function shouldLoadFile(string $path): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| path | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## loadConfigFromPath - -```php -public function loadConfigFromPath(string $path): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| path | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## getInstance - -```php -public function getInstance(mixed $args): object -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| args | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| object | | diff --git a/docs/api/ZM/ConsoleApplication.md b/docs/api/ZM/ConsoleApplication.md deleted file mode 100644 index 2fd9fddf..00000000 --- a/docs/api/ZM/ConsoleApplication.md +++ /dev/null @@ -1,24 +0,0 @@ -# ZM\ConsoleApplication - -## run - -```php -public function run(Symfony\Component\Console\Input\InputInterface $input, Symfony\Component\Console\Output\OutputInterface $output): int -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| input | Symfony\Component\Console\Input\InputInterface | | -| output | Symfony\Component\Console\Output\OutputInterface | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int | | diff --git a/docs/api/ZM/Container/BoundMethod.md b/docs/api/ZM/Container/BoundMethod.md deleted file mode 100644 index 29657ed8..00000000 --- a/docs/api/ZM/Container/BoundMethod.md +++ /dev/null @@ -1,77 +0,0 @@ -# ZM\Container\BoundMethod - -## call - -```php -public function call(ZM\Container\ContainerInterface $container, mixed $callback, array $parameters, string $default_method): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| container | ZM\Container\ContainerInterface | | -| callback | mixed | | -| parameters | array | | -| default_method | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## getMethodDependencies - -```php -public function getMethodDependencies(ZM\Container\ContainerInterface $container, mixed $callback, array $parameters): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| container | ZM\Container\ContainerInterface | | -| callback | mixed | | -| parameters | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## addDependencyForCallParameter - -```php -public function addDependencyForCallParameter(ZM\Container\ContainerInterface $container, ReflectionParameter $parameter, array $parameters, array $dependencies): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| container | ZM\Container\ContainerInterface | | -| parameter | ReflectionParameter | | -| parameters | array | | -| dependencies | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | diff --git a/docs/api/ZM/Container/Container.md b/docs/api/ZM/Container/Container.md deleted file mode 100644 index 210723b7..00000000 --- a/docs/api/ZM/Container/Container.md +++ /dev/null @@ -1,883 +0,0 @@ -# ZM\Container\Container - -## getParent - -```php -public function getParent(): ZM\Container\ContainerInterface -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| ZM\Container\ContainerInterface | | - - -## has - -```php -public function has(string $id): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| id | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## make - -```php -public function make(string $abstract, array $parameters): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | -| parameters | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## getInstance - -```php -public function getInstance(mixed $args): object -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| args | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| object | | - - -## bound - -```php -public function bound(string $abstract): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## getAlias - -```php -public function getAlias(string $abstract): string -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | | - - -## alias - -```php -public function alias(string $abstract, string $alias): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | -| alias | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## bind - -```php -public function bind(string $abstract, mixed $concrete, bool $shared): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | -| concrete | mixed | | -| shared | bool | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## bindIf - -```php -public function bindIf(string $abstract, mixed $concrete, bool $shared): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | -| concrete | mixed | | -| shared | bool | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## singleton - -```php -public function singleton(string $abstract, mixed $concrete): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | -| concrete | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## singletonIf - -```php -public function singletonIf(string $abstract, mixed $concrete): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | -| concrete | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## instance - -```php -public function instance(string $abstract, mixed $instance): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | -| instance | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## factory - -```php -public function factory(string $abstract): Closure -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Closure | | - - -## flush - -```php -public function flush(): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## traitMake - -```php -public function traitMake(string $abstract, array $parameters): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | -| parameters | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## build - -```php -public function build(mixed $concrete): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| concrete | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## call - -```php -public function call(mixed $callback, array $parameters, string $default_method): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| callback | mixed | | -| parameters | array | | -| default_method | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## get - -```php -public function get(string $id): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| id | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## extend - -```php -public function extend(string $abstract, Closure $closure): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | -| closure | Closure | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## getLogPrefix - -```php -public function getLogPrefix(): string -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | | - - -## setLogPrefix - -```php -public function setLogPrefix(string $prefix): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| prefix | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## getExtenders - -```php -public function getExtenders(string $abstract): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## isAlias - -```php -public function isAlias(string $name): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| name | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## dropStaleInstances - -```php -public function dropStaleInstances(string $abstract): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## getClosure - -```php -public function getClosure(string $abstract, string $concrete): Closure -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | -| concrete | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Closure | | - - -## getLastParameterOverride - -```php -public function getLastParameterOverride(): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## notInstantiable - -```php -public function notInstantiable(string $concrete, string $reason): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| concrete | string | | -| reason | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## resolveDependencies - -```php -public function resolveDependencies(array $dependencies): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| dependencies | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## hasParameterOverride - -```php -public function hasParameterOverride(ReflectionParameter $parameter): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| parameter | ReflectionParameter | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## getParameterOverride - -```php -public function getParameterOverride(ReflectionParameter $parameter): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| parameter | ReflectionParameter | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## hasParameterTypeOverride - -```php -public function hasParameterTypeOverride(ReflectionParameter $parameter): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| parameter | ReflectionParameter | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## getParameterTypeOverride - -```php -public function getParameterTypeOverride(ReflectionParameter $parameter): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| parameter | ReflectionParameter | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## resolvePrimitive - -```php -public function resolvePrimitive(ReflectionParameter $parameter): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| parameter | ReflectionParameter | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## resolveClass - -```php -public function resolveClass(ReflectionParameter $parameter): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| parameter | ReflectionParameter | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## getConcrete - -```php -public function getConcrete(string $abstract): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## isBuildable - -```php -public function isBuildable(mixed $concrete, string $abstract): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| concrete | mixed | | -| abstract | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## isShared - -```php -public function isShared(string $abstract): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## shouldLog - -```php -public function shouldLog(): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## log - -```php -public function log(string $message): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| message | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | diff --git a/docs/api/ZM/Container/ContainerServicesProvider.md b/docs/api/ZM/Container/ContainerServicesProvider.md deleted file mode 100644 index e1997751..00000000 --- a/docs/api/ZM/Container/ContainerServicesProvider.md +++ /dev/null @@ -1,134 +0,0 @@ -# ZM\Container\ContainerServicesProvider - -## registerServices - -```php -public function registerServices(string $scope, mixed $params): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| scope | string | | -| params | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## cleanup - -```php -public function cleanup(): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## registerGlobalServices - -```php -public function registerGlobalServices(ZM\Container\ContainerInterface $container): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| container | ZM\Container\ContainerInterface | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## registerRequestServices - -```php -public function registerRequestServices(ZM\Container\ContainerInterface $container, OneBot\Driver\Event\Http\HttpRequestEvent $event): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| container | ZM\Container\ContainerInterface | | -| event | OneBot\Driver\Event\Http\HttpRequestEvent | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## registerMessageServices - -```php -public function registerMessageServices(ZM\Container\ContainerInterface $container): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| container | ZM\Container\ContainerInterface | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## registerConnectionServices - -```php -public function registerConnectionServices(ZM\Container\ContainerInterface $container): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| container | ZM\Container\ContainerInterface | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | diff --git a/docs/api/ZM/Container/WorkerContainer.md b/docs/api/ZM/Container/WorkerContainer.md deleted file mode 100644 index b0218b1d..00000000 --- a/docs/api/ZM/Container/WorkerContainer.md +++ /dev/null @@ -1,842 +0,0 @@ -# ZM\Container\WorkerContainer - -## getInstance - -```php -public function getInstance(mixed $args): object -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| args | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| object | | - - -## bound - -```php -public function bound(string $abstract): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## getAlias - -```php -public function getAlias(string $abstract): string -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | | - - -## alias - -```php -public function alias(string $abstract, string $alias): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | -| alias | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## bind - -```php -public function bind(string $abstract, mixed $concrete, bool $shared): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | -| concrete | mixed | | -| shared | bool | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## bindIf - -```php -public function bindIf(string $abstract, mixed $concrete, bool $shared): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | -| concrete | mixed | | -| shared | bool | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## singleton - -```php -public function singleton(string $abstract, mixed $concrete): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | -| concrete | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## singletonIf - -```php -public function singletonIf(string $abstract, mixed $concrete): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | -| concrete | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## instance - -```php -public function instance(string $abstract, mixed $instance): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | -| instance | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## factory - -```php -public function factory(string $abstract): Closure -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Closure | | - - -## flush - -```php -public function flush(): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## make - -```php -public function make(string $abstract, array $parameters): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | -| parameters | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## build - -```php -public function build(mixed $concrete): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| concrete | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## call - -```php -public function call(mixed $callback, array $parameters, string $default_method): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| callback | mixed | | -| parameters | array | | -| default_method | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## get - -```php -public function get(string $id): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| id | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## has - -```php -public function has(string $id): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| id | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## extend - -```php -public function extend(string $abstract, Closure $closure): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | -| closure | Closure | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## getLogPrefix - -```php -public function getLogPrefix(): string -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | | - - -## setLogPrefix - -```php -public function setLogPrefix(string $prefix): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| prefix | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## getExtenders - -```php -public function getExtenders(string $abstract): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## isAlias - -```php -public function isAlias(string $name): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| name | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## dropStaleInstances - -```php -public function dropStaleInstances(string $abstract): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## getClosure - -```php -public function getClosure(string $abstract, string $concrete): Closure -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | -| concrete | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Closure | | - - -## getLastParameterOverride - -```php -public function getLastParameterOverride(): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## notInstantiable - -```php -public function notInstantiable(string $concrete, string $reason): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| concrete | string | | -| reason | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## resolveDependencies - -```php -public function resolveDependencies(array $dependencies): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| dependencies | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## hasParameterOverride - -```php -public function hasParameterOverride(ReflectionParameter $parameter): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| parameter | ReflectionParameter | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## getParameterOverride - -```php -public function getParameterOverride(ReflectionParameter $parameter): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| parameter | ReflectionParameter | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## hasParameterTypeOverride - -```php -public function hasParameterTypeOverride(ReflectionParameter $parameter): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| parameter | ReflectionParameter | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## getParameterTypeOverride - -```php -public function getParameterTypeOverride(ReflectionParameter $parameter): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| parameter | ReflectionParameter | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## resolvePrimitive - -```php -public function resolvePrimitive(ReflectionParameter $parameter): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| parameter | ReflectionParameter | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## resolveClass - -```php -public function resolveClass(ReflectionParameter $parameter): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| parameter | ReflectionParameter | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## getConcrete - -```php -public function getConcrete(string $abstract): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## isBuildable - -```php -public function isBuildable(mixed $concrete, string $abstract): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| concrete | mixed | | -| abstract | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## isShared - -```php -public function isShared(string $abstract): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| abstract | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## shouldLog - -```php -public function shouldLog(): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## log - -```php -public function log(string $message): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| message | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | diff --git a/docs/api/ZM/Context/Context.md b/docs/api/ZM/Context/Context.md deleted file mode 100644 index e75fd146..00000000 --- a/docs/api/ZM/Context/Context.md +++ /dev/null @@ -1,57 +0,0 @@ -# ZM\Context\Context - -## getRequest - -```php -public function getRequest(): Psr\Http\Message\ServerRequestInterface -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Psr\Http\Message\ServerRequestInterface | | - - -## getHttpRequestEvent - -```php -public function getHttpRequestEvent(): OneBot\Driver\Event\Http\HttpRequestEvent -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| OneBot\Driver\Event\Http\HttpRequestEvent | | - - -## withResponse - -```php -public function withResponse(Psr\Http\Message\ResponseInterface $response): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| response | Psr\Http\Message\ResponseInterface | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | diff --git a/docs/api/ZM/DB/DB.md b/docs/api/ZM/DB/DB.md deleted file mode 100644 index 1bfaf55e..00000000 --- a/docs/api/ZM/DB/DB.md +++ /dev/null @@ -1,117 +0,0 @@ -# ZM\DB\DB - -## initTableList - -```php -public function initTableList(string $db_name): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| db_name | string | 数据库名称 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## table - -```php -public function table(string $table_name): Table -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| table_name | string | 表名 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Table | 返回表对象 | - - -## statement - -```php -public function statement(string $line): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| line | string | SQL语句 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## unprepared - -```php -public function unprepared(string $line): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| line | string | SQL语句 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | 返回查询是否成功的结果 | - - -## rawQuery - -```php -public function rawQuery(string $line, array $params, int $fetch_mode): array|false -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| line | string | SQL语句 | -| params | array | 查询参数 | -| fetch_mode | int | fetch规则 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|false | 返回结果集或false | diff --git a/docs/api/ZM/DB/DeleteBody.md b/docs/api/ZM/DB/DeleteBody.md deleted file mode 100644 index 09702791..00000000 --- a/docs/api/ZM/DB/DeleteBody.md +++ /dev/null @@ -1,40 +0,0 @@ -# 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 deleted file mode 100644 index eb8838a2..00000000 --- a/docs/api/ZM/DB/InsertBody.md +++ /dev/null @@ -1,41 +0,0 @@ -# ZM\DB\InsertBody - -## __construct - -```php -public function __construct(Table $table, array|string $row): mixed -``` - -### 描述 - -InsertBody constructor. - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| table | Table | 表对象 | -| row | array|string | 行数据 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## save - -```php -public function save(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | diff --git a/docs/api/ZM/DB/SelectBody.md b/docs/api/ZM/DB/SelectBody.md deleted file mode 100644 index f21c67dc..00000000 --- a/docs/api/ZM/DB/SelectBody.md +++ /dev/null @@ -1,137 +0,0 @@ -# ZM\DB\SelectBody - -## get - -```php -public function get(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## count - -```php -public function count(): int -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int | | - - -## fetchAll - -```php -public function fetchAll(mixed $fetch_mode): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| fetch_mode | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## fetchFirst - -```php -public function fetchFirst(): null|mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| null|mixed | | - - -## value - -```php -public function value(null|mixed $key): null|mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| key | null|mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| 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 deleted file mode 100644 index 3d0fd5bc..00000000 --- a/docs/api/ZM/DB/Table.md +++ /dev/null @@ -1,17 +0,0 @@ -# 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 deleted file mode 100644 index cb892276..00000000 --- a/docs/api/ZM/DB/UpdateBody.md +++ /dev/null @@ -1,41 +0,0 @@ -# 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 deleted file mode 100644 index 0281c7e2..00000000 --- a/docs/api/ZM/Entity/CQObject.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 95d6cc9c..00000000 --- a/docs/api/ZM/Entity/MatchResult.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index bfd97cfd..00000000 --- a/docs/api/ZM/Event/EventDispatcher.md +++ /dev/null @@ -1,23 +0,0 @@ -# ZM\Event\EventDispatcher - -## getInstance - -```php -public function getInstance(mixed $args): object -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| args | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| object | | diff --git a/docs/api/ZM/Event/EventManager.md b/docs/api/ZM/Event/EventManager.md deleted file mode 100644 index 2e5a812d..00000000 --- a/docs/api/ZM/Event/EventManager.md +++ /dev/null @@ -1,40 +0,0 @@ -# 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/EventProvider.md b/docs/api/ZM/Event/EventProvider.md deleted file mode 100644 index 30df86f8..00000000 --- a/docs/api/ZM/Event/EventProvider.md +++ /dev/null @@ -1,117 +0,0 @@ -# ZM\Event\EventProvider - -## addEventListener - -```php -public function addEventListener(mixed $event, callable $callback, int $level): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| event | mixed | | -| callback | callable | | -| level | int | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## getEventListeners - -```php -public function getEventListeners(string $event_name): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| event_name | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## getListenersForEvent - -```php -public function getListenersForEvent(object $event): iterable -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| event | object | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| iterable | | - - -## sortEvents - -```php -public function sortEvents(mixed $name): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| name | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## getInstance - -```php -public function getInstance(mixed $args): object -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| args | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| object | | diff --git a/docs/api/ZM/Event/EventTracer.md b/docs/api/ZM/Event/EventTracer.md deleted file mode 100644 index 170f6e0c..00000000 --- a/docs/api/ZM/Event/EventTracer.md +++ /dev/null @@ -1,34 +0,0 @@ -# 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/Listener/HttpEventListener.md b/docs/api/ZM/Event/Listener/HttpEventListener.md deleted file mode 100644 index f93dfb37..00000000 --- a/docs/api/ZM/Event/Listener/HttpEventListener.md +++ /dev/null @@ -1,69 +0,0 @@ -# ZM\Event\Listener\HttpEventListener - -## onRequest999 - -```php -public function onRequest999(OneBot\Driver\Event\Http\HttpRequestEvent $event): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| event | OneBot\Driver\Event\Http\HttpRequestEvent | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## onRequest1 - -```php -public function onRequest1(OneBot\Driver\Event\Http\HttpRequestEvent $event): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| event | OneBot\Driver\Event\Http\HttpRequestEvent | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## getInstance - -```php -public function getInstance(mixed $args): object -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| args | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| object | | diff --git a/docs/api/ZM/Event/Listener/ManagerEventListener.md b/docs/api/ZM/Event/Listener/ManagerEventListener.md deleted file mode 100644 index b3e725f4..00000000 --- a/docs/api/ZM/Event/Listener/ManagerEventListener.md +++ /dev/null @@ -1,57 +0,0 @@ -# ZM\Event\Listener\ManagerEventListener - -## onManagerStart - -```php -public function onManagerStart(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## onManagerStop - -```php -public function onManagerStop(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## getInstance - -```php -public function getInstance(mixed $args): object -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| args | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| object | | diff --git a/docs/api/ZM/Event/Listener/MasterEventListener.md b/docs/api/ZM/Event/Listener/MasterEventListener.md deleted file mode 100644 index a4123e88..00000000 --- a/docs/api/ZM/Event/Listener/MasterEventListener.md +++ /dev/null @@ -1,40 +0,0 @@ -# ZM\Event\Listener\MasterEventListener - -## onMasterStop - -```php -public function onMasterStop(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## getInstance - -```php -public function getInstance(mixed $args): object -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| args | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| object | | diff --git a/docs/api/ZM/Event/Listener/SignalListener.md b/docs/api/ZM/Event/Listener/SignalListener.md deleted file mode 100644 index 9402e642..00000000 --- a/docs/api/ZM/Event/Listener/SignalListener.md +++ /dev/null @@ -1,57 +0,0 @@ -# ZM\Event\Listener\SignalListener - -## signalWorker - -```php -public function signalWorker(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## processKillerPrompt - -```php -public function processKillerPrompt(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## getInstance - -```php -public function getInstance(mixed $args): object -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| args | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| object | | diff --git a/docs/api/ZM/Event/Listener/WSEventListener.md b/docs/api/ZM/Event/Listener/WSEventListener.md deleted file mode 100644 index 3d4a0625..00000000 --- a/docs/api/ZM/Event/Listener/WSEventListener.md +++ /dev/null @@ -1,69 +0,0 @@ -# ZM\Event\Listener\WSEventListener - -## onWebSocketOpen - -```php -public function onWebSocketOpen(OneBot\Driver\Event\WebSocket\WebSocketOpenEvent $event): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| event | OneBot\Driver\Event\WebSocket\WebSocketOpenEvent | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## onWebSocketClose - -```php -public function onWebSocketClose(OneBot\Driver\Event\WebSocket\WebSocketCloseEvent $event): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| event | OneBot\Driver\Event\WebSocket\WebSocketCloseEvent | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## getInstance - -```php -public function getInstance(mixed $args): object -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| args | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| object | | diff --git a/docs/api/ZM/Event/Listener/WorkerEventListener.md b/docs/api/ZM/Event/Listener/WorkerEventListener.md deleted file mode 100644 index c907b2d9..00000000 --- a/docs/api/ZM/Event/Listener/WorkerEventListener.md +++ /dev/null @@ -1,108 +0,0 @@ -# ZM\Event\Listener\WorkerEventListener - -## onWorkerStart999 - -```php -public function onWorkerStart999(): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## onWorkerStop999 - -```php -public function onWorkerStop999(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## initUserPlugins - -```php -public function initUserPlugins(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## dispatchInit - -```php -public function dispatchInit(): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## initConnectionPool - -```php -public function initConnectionPool(): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## getInstance - -```php -public function getInstance(mixed $args): object -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| args | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| object | | diff --git a/docs/api/ZM/Event/SwooleEvent/OnBeforeReload.md b/docs/api/ZM/Event/SwooleEvent/OnBeforeReload.md deleted file mode 100644 index bdd2eae8..00000000 --- a/docs/api/ZM/Event/SwooleEvent/OnBeforeReload.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 791f270c..00000000 --- a/docs/api/ZM/Event/SwooleEvent/OnClose.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 8e8c1709..00000000 --- a/docs/api/ZM/Event/SwooleEvent/OnManagerStart.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index a63cd28c..00000000 --- a/docs/api/ZM/Event/SwooleEvent/OnManagerStop.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index b8f63bb4..00000000 --- a/docs/api/ZM/Event/SwooleEvent/OnMessage.md +++ /dev/null @@ -1,24 +0,0 @@ -# ZM\Event\SwooleEvent\OnMessage - -## registerRequestContainerBindings - -```php -public function registerRequestContainerBindings(Swoole\WebSocket\Frame $frame, ZM\ConnectionManager\ConnectionObject $conn): void -``` - -### 描述 - -注册请求容器绑定 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| frame | Swoole\WebSocket\Frame | | -| conn | ZM\ConnectionManager\ConnectionObject | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | diff --git a/docs/api/ZM/Event/SwooleEvent/OnOpen.md b/docs/api/ZM/Event/SwooleEvent/OnOpen.md deleted file mode 100644 index d53fa941..00000000 --- a/docs/api/ZM/Event/SwooleEvent/OnOpen.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 3148b190..00000000 --- a/docs/api/ZM/Event/SwooleEvent/OnPipeMessage.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 24372cee..00000000 --- a/docs/api/ZM/Event/SwooleEvent/OnRequest.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index b41dcd23..00000000 --- a/docs/api/ZM/Event/SwooleEvent/OnShutdown.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 8b1fdaea..00000000 --- a/docs/api/ZM/Event/SwooleEvent/OnStart.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 46f3efe0..00000000 --- a/docs/api/ZM/Event/SwooleEvent/OnTask.md +++ /dev/null @@ -1,24 +0,0 @@ -# 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 deleted file mode 100644 index 11fcbb88..00000000 --- a/docs/api/ZM/Event/SwooleEvent/OnWorkerExit.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 0187f583..00000000 --- a/docs/api/ZM/Event/SwooleEvent/OnWorkerStart.md +++ /dev/null @@ -1,40 +0,0 @@ -# ZM\Event\SwooleEvent\OnWorkerStart - -## loadAnnotations - -```php -public function loadAnnotations(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## registerWorkerContainerBindings - -```php -public function registerWorkerContainerBindings(Swoole\WebSocket\Server $server): void -``` - -### 描述 - -注册进程容器绑定 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| server | Swoole\WebSocket\Server | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | diff --git a/docs/api/ZM/Event/SwooleEvent/OnWorkerStop.md b/docs/api/ZM/Event/SwooleEvent/OnWorkerStop.md deleted file mode 100644 index d05cda18..00000000 --- a/docs/api/ZM/Event/SwooleEvent/OnWorkerStop.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 31113429..00000000 --- a/docs/api/ZM/Exception/AnnotationException.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 4e7dcee3..00000000 --- a/docs/api/ZM/Exception/DbException.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 5b51b2a8..00000000 --- a/docs/api/ZM/Exception/ExceptionHandler.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 56345ae6..00000000 --- a/docs/api/ZM/Exception/InitException.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 25c3f559..00000000 --- a/docs/api/ZM/Exception/InterruptException.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 7e5871af..00000000 --- a/docs/api/ZM/Exception/InvalidArgumentException.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index fa92cc43..00000000 --- a/docs/api/ZM/Exception/LightCacheException.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index d3e19448..00000000 --- a/docs/api/ZM/Exception/MethodNotFoundException.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 3e4a4be6..00000000 --- a/docs/api/ZM/Exception/ModulePackException.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 6bb11190..00000000 --- a/docs/api/ZM/Exception/NotInitializedException.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 94c5c5d7..00000000 --- a/docs/api/ZM/Exception/RedisException.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 4eb4d74e..00000000 --- a/docs/api/ZM/Exception/RobotNotFoundException.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 709132dc..00000000 --- a/docs/api/ZM/Exception/WaitTimeoutException.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 3cbdf6af..00000000 --- a/docs/api/ZM/Exception/ZMException.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 5a66ae7b..00000000 --- a/docs/api/ZM/Exception/ZMKnownException.md +++ /dev/null @@ -1 +0,0 @@ -# ZM\Exception\ZMKnownException \ No newline at end of file diff --git a/docs/api/ZM/Framework.md b/docs/api/ZM/Framework.md deleted file mode 100644 index 519646a1..00000000 --- a/docs/api/ZM/Framework.md +++ /dev/null @@ -1,155 +0,0 @@ -# ZM\Framework - -## __construct - -```php -public function __construct(array $args, bool $instant_mode): mixed -``` - -### 描述 - -创建一个新的框架实例 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| args | array | 运行参数 | -| instant_mode | bool | 是否为单文件模式 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## 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|int|string $id_or_name, int $type): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| id_or_name | null|int|string | | -| type | int | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## loadServerEvents - -```php -public function loadServerEvents(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## registerServerEvents - -```php -public function registerServerEvents(): mixed -``` - -### 描述 - -从全局配置文件里读取注入系统事件的类 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## parseCliArgs - -```php -public function parseCliArgs(array $args, bool|string $add_port): mixed -``` - -### 描述 - -解析命令行的 $argv 参数们 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| args | array | 命令行参数 | -| add_port | bool|string | 是否添加端口号 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | diff --git a/docs/api/ZM/Http/Response.md b/docs/api/ZM/Http/Response.md deleted file mode 100644 index f1f71ad4..00000000 --- a/docs/api/ZM/Http/Response.md +++ /dev/null @@ -1,319 +0,0 @@ -# ZM\Http\Response - -## initHeader - -```php -public function initHeader(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## header - -```php -public function header(array|string $value, null|array|string $ucwords, string $key): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| value | array|string | | -| ucwords | null|array|string | | -| key | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## setHeader - -```php -public function setHeader(array|string $value, null|array|string $ucwords, string $key): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| value | array|string | | -| ucwords | null|array|string | | -| key | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## trailer - -```php -public function trailer(array|string $value, string $key): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| value | array|string | | -| key | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## ping - -```php -public function ping(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## write - -```php -public function write(string|Stringable $content): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| content | string|Stringable | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## end - -```php -public function end(null|string|Stringable $content): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| content | null|string|Stringable | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## sendfile - -```php -public function sendfile(null|int|string $offset, null|int|string $length, string $filename): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| offset | null|int|string | | -| length | null|int|string | | -| filename | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## redirect - -```php -public function redirect(string $location, int $http_code): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| location | string | | -| http_code | int | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| 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, mixed $opcode, mixed $flags): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| data | mixed | | -| opcode | mixed | | -| flags | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| 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 deleted file mode 100644 index 6fef2bb3..00000000 --- a/docs/api/ZM/Http/RouteManager.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 37ec9a8c..00000000 --- a/docs/api/ZM/Http/StaticFileHandler.md +++ /dev/null @@ -1 +0,0 @@ -# ZM\Http\StaticFileHandler \ No newline at end of file diff --git a/docs/api/ZM/InstantApplication.md b/docs/api/ZM/InstantApplication.md deleted file mode 100644 index c1af0b01..00000000 --- a/docs/api/ZM/InstantApplication.md +++ /dev/null @@ -1,17 +0,0 @@ -# ZM\InstantApplication - -## run - -```php -public function run(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | diff --git a/docs/api/ZM/Middleware/MiddlewareHandler.md b/docs/api/ZM/Middleware/MiddlewareHandler.md deleted file mode 100644 index ef520550..00000000 --- a/docs/api/ZM/Middleware/MiddlewareHandler.md +++ /dev/null @@ -1,112 +0,0 @@ -# ZM\Middleware\MiddlewareHandler - -## bindMiddleware - -```php -public function bindMiddleware(callable $callback, string $name, array $params): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| callback | callable | | -| name | string | | -| params | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## process - -```php -public function process(callable $callback, mixed $args): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| callback | callable | | -| args | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## getCurrentCallable - -```php -public function getCurrentCallable(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## getStackId - -```php -public function getStackId(callable $callback): string -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| callback | callable | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | | - - -## getInstance - -```php -public function getInstance(mixed $args): object -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| args | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| object | | diff --git a/docs/api/ZM/Middleware/Pipeline.md b/docs/api/ZM/Middleware/Pipeline.md deleted file mode 100644 index a86a05b5..00000000 --- a/docs/api/ZM/Middleware/Pipeline.md +++ /dev/null @@ -1,69 +0,0 @@ -# ZM\Middleware\Pipeline - -## send - -```php -public function send(mixed $value): ZM\Middleware\Pipeline -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| value | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| ZM\Middleware\Pipeline | | - - -## through - -```php -public function through(array $middlewares): ZM\Middleware\Pipeline -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| middlewares | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| ZM\Middleware\Pipeline | | - - -## then - -```php -public function then(callable $callback): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| callback | callable | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | diff --git a/docs/api/ZM/Module/InstantModule.md b/docs/api/ZM/Module/InstantModule.md deleted file mode 100644 index c43d6982..00000000 --- a/docs/api/ZM/Module/InstantModule.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 2e04c047..00000000 --- a/docs/api/ZM/Module/ModuleBase.md +++ /dev/null @@ -1,57 +0,0 @@ -# ZM\Module\ModuleBase - -## __construct - -```php -public function __construct(string $module_name): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| module_name | string | 模块名称 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## getModuleName - -```php -public function getModuleName(): string -``` - -### 描述 - -获取模块名称 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | | - - -## getEvents - -```php -public function getEvents(): array -``` - -### 描述 - -获取事件列表 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | diff --git a/docs/api/ZM/Module/ModulePacker.md b/docs/api/ZM/Module/ModulePacker.md deleted file mode 100644 index 62af1292..00000000 --- a/docs/api/ZM/Module/ModulePacker.md +++ /dev/null @@ -1,154 +0,0 @@ -# ZM\Module\ModulePacker - -## __construct - -```php -public function __construct(array $module): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| module | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## setOutputPath - -```php -public function setOutputPath(string $path): mixed -``` - -### 描述 - -设置输出文件夹 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| path | string | 输出路径 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| 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 deleted file mode 100644 index 929a59da..00000000 --- a/docs/api/ZM/Module/ModuleUnpacker.md +++ /dev/null @@ -1,123 +0,0 @@ -# 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 deleted file mode 100644 index 0ef0901e..00000000 --- a/docs/api/ZM/Module/QQBot.md +++ /dev/null @@ -1,151 +0,0 @@ -# ZM\Module\QQBot - -## handleByEvent - -```php -public function handleByEvent(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## handle - -```php -public function handle(array|Iterator $data, int $level): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| data | array|Iterator | 数据包 | -| level | int | 递归等级 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## dispatchBeforeEvents - -```php -public function dispatchBeforeEvents(array|Iterator $data, string $time): ZM\Event\EventDispatcher -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| data | array|Iterator | 数据包 | -| time | string | 类型（pre或post） | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| ZM\Event\EventDispatcher | | - - -## dispatchEvents - -```php -public function dispatchEvents(array|Iterator $data): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| data | array|Iterator | 数据包 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## dispatchAfterEvents - -```php -public function dispatchAfterEvents(mixed $data): ZM\Event\EventDispatcher -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| data | mixed | 分发事件数据包 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| ZM\Event\EventDispatcher | | - - -## dispatchAPIResponse - -```php -public function dispatchAPIResponse(mixed $req): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| req | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## getInstance - -```php -public function getInstance(): static -``` - -### 描述 - -获取类实例 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| static | | diff --git a/docs/api/ZM/MySQL/MySQLConnection.md b/docs/api/ZM/MySQL/MySQLConnection.md deleted file mode 100644 index 5c155058..00000000 --- a/docs/api/ZM/MySQL/MySQLConnection.md +++ /dev/null @@ -1,93 +0,0 @@ -# ZM\MySQL\MySQLConnection - -## prepare - -```php -public function prepare(mixed $sql, mixed $options): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| sql | mixed | | -| options | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## query - -```php -public function query(mixed $args): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| args | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## exec - -```php -public function exec(mixed $sql): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| sql | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## lastInsertId - -```php -public function lastInsertId(null|mixed $name): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| name | null|mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | diff --git a/docs/api/ZM/MySQL/MySQLDriver.md b/docs/api/ZM/MySQL/MySQLDriver.md deleted file mode 100644 index 087f7584..00000000 --- a/docs/api/ZM/MySQL/MySQLDriver.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 3d71f681..00000000 --- a/docs/api/ZM/MySQL/MySQLManager.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 5f57a7d3..00000000 --- a/docs/api/ZM/MySQL/MySQLPool.md +++ /dev/null @@ -1,40 +0,0 @@ -# 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 deleted file mode 100644 index 2aa0d294..00000000 --- a/docs/api/ZM/MySQL/MySQLQueryBuilder.md +++ /dev/null @@ -1,17 +0,0 @@ -# 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 deleted file mode 100644 index 2ed5de8e..00000000 --- a/docs/api/ZM/MySQL/MySQLStatement.md +++ /dev/null @@ -1,17 +0,0 @@ -# ZM\MySQL\MySQLStatement - -## current - -```php -public function current(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | diff --git a/docs/api/ZM/MySQL/MySQLStatementWrapper.md b/docs/api/ZM/MySQL/MySQLStatementWrapper.md deleted file mode 100644 index 8762f84a..00000000 --- a/docs/api/ZM/MySQL/MySQLStatementWrapper.md +++ /dev/null @@ -1,291 +0,0 @@ -# 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 deleted file mode 100644 index c6f346c5..00000000 --- a/docs/api/ZM/MySQL/MySQLWrapper.md +++ /dev/null @@ -1,603 +0,0 @@ -# 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(bool $auto_commit): mixed -``` - -### 描述 - -wrapper method - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| auto_commit | bool | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| 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(string $table, array $criteria, array $types): int -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| table | string | 表 | -| criteria | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int | | - - -## setTransactionIsolation - -```php -public function setTransactionIsolation(int $level): int -``` - -### 描述 - -wrapper method - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| level | int | Sets the transaction isolation level | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int | | - - -## getTransactionIsolation - -```php -public function getTransactionIsolation(): int -``` - -### 描述 - -wrapper method - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int | | - - -## update - -```php -public function update(string $table, array $data, array $criteria, array $types): int -``` - -### 描述 - -wrapper method - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| table | string | 表名 | -| data | array | | -| criteria | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int | | - - -## insert - -```php -public function insert(string $table, array $data, array $types): int -``` - -### 描述 - -wrapper method - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| table | string | 表名 | -| data | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int | | - - -## quoteIdentifier - -```php -public function quoteIdentifier(string $str): string -``` - -### 描述 - -wrapper method - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| str | string | The name to be quoted | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | | - - -## quote - -```php -public function quote(mixed $value, null|int|string|Type $type): mixed -``` - -### 描述 - -wrapper method - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| value | mixed | | -| type | null|int|string|Type | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## getTransactionNestingLevel - -```php -public function getTransactionNestingLevel(): int -``` - -### 描述 - -wrapper method - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int | | - - -## lastInsertId - -```php -public function lastInsertId(null|string $name): false|int|string -``` - -### 描述 - -wrapper method - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| name | null|string | name of the sequence object from which the ID should be returned | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| false|int|string | a string representation of the last inserted ID | - - -## transactional - -```php -public function transactional(Closure $func): mixed -``` - -### 描述 - -overwrite method to $this->connection->transactional() - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| func | Closure | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## setNestTransactionsWithSavepoints - -```php -public function setNestTransactionsWithSavepoints(bool $nest_transactions_with_savepoints): mixed -``` - -### 描述 - -wrapper method - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| nest_transactions_with_savepoints | bool | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| 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(string $savepoint): mixed -``` - -### 描述 - -wrapper method - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| savepoint | string | the name of the savepoint to create | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## releaseSavepoint - -```php -public function releaseSavepoint(string $savepoint): mixed -``` - -### 描述 - -wrapper method - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| savepoint | string | the name of the savepoint to release | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## rollbackSavepoint - -```php -public function rollbackSavepoint(string $savepoint): mixed -``` - -### 描述 - -wrapper method - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| savepoint | string | the name of the savepoint to rollback to | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| 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/Plugin/OneBot12Adapter.md b/docs/api/ZM/Plugin/OneBot12Adapter.md deleted file mode 100644 index 98ff2131..00000000 --- a/docs/api/ZM/Plugin/OneBot12Adapter.md +++ /dev/null @@ -1,87 +0,0 @@ -# ZM\Plugin\OneBot12Adapter - -## parseBotCommand - -```php -public function parseBotCommand(ZM\Annotation\OneBot\BotCommand $command, array $same_method_annotations): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| command | ZM\Annotation\OneBot\BotCommand | | -| same_method_annotations | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## parseCommandArgument - -```php -public function parseCommandArgument(): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## handleUnknownWSReverseInput - -```php -public function handleUnknownWSReverseInput(OneBot\Driver\Event\WebSocket\WebSocketOpenEvent $event): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| event | OneBot\Driver\Event\WebSocket\WebSocketOpenEvent | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## handleWSReverseInput - -```php -public function handleWSReverseInput(OneBot\Driver\Event\WebSocket\WebSocketOpenEvent $event): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| event | OneBot\Driver\Event\WebSocket\WebSocketOpenEvent | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | diff --git a/docs/api/ZM/Plugin/PluginManager.md b/docs/api/ZM/Plugin/PluginManager.md deleted file mode 100644 index 91524109..00000000 --- a/docs/api/ZM/Plugin/PluginManager.md +++ /dev/null @@ -1,46 +0,0 @@ -# ZM\Plugin\PluginManager - -## addPluginsFromDir - -```php -public function addPluginsFromDir(string $dir): int -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| dir | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int | | - - -## addPlugin - -```php -public function addPlugin(array $meta): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| meta | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | diff --git a/docs/api/ZM/Process/ProcessStateManager.md b/docs/api/ZM/Process/ProcessStateManager.md deleted file mode 100644 index 53068f30..00000000 --- a/docs/api/ZM/Process/ProcessStateManager.md +++ /dev/null @@ -1,73 +0,0 @@ -# ZM\Process\ProcessStateManager - -## removeProcessState - -```php -public function removeProcessState(int $type, mixed $id_or_name): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| type | int | | -| id_or_name | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## getProcessState - -```php -public function getProcessState(int $type, mixed $id_or_name): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| type | int | | -| id_or_name | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## saveProcessState - -```php -public function saveProcessState(int $type, mixed $pid, array $data): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| type | int | | -| pid | mixed | | -| data | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | diff --git a/docs/api/ZM/Store/Database/DBConnection.md b/docs/api/ZM/Store/Database/DBConnection.md deleted file mode 100644 index 52b9d7db..00000000 --- a/docs/api/ZM/Store/Database/DBConnection.md +++ /dev/null @@ -1,110 +0,0 @@ -# ZM\Store\Database\DBConnection - -## prepare - -```php -public function prepare(mixed $sql, mixed $options): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| sql | mixed | | -| options | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## query - -```php -public function query(mixed $args): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| args | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## exec - -```php -public function exec(mixed $sql): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| sql | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## lastInsertId - -```php -public function lastInsertId(mixed $name): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| name | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## getPoolName - -```php -public function getPoolName(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | diff --git a/docs/api/ZM/Store/Database/DBPool.md b/docs/api/ZM/Store/Database/DBPool.md deleted file mode 100644 index e28f2d4d..00000000 --- a/docs/api/ZM/Store/Database/DBPool.md +++ /dev/null @@ -1,104 +0,0 @@ -# ZM\Store\Database\DBPool - -## create - -```php -public function create(string $name, array $config): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| name | string | | -| config | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## pool - -```php -public function pool(string $name): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| name | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## getAllPools - -```php -public function getAllPools(): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## destroyPool - -```php -public function destroyPool(string $name): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| name | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## checkMysqlExtension - -```php -public function checkMysqlExtension(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | diff --git a/docs/api/ZM/Store/Database/DBQueryBuilder.md b/docs/api/ZM/Store/Database/DBQueryBuilder.md deleted file mode 100644 index b96c669c..00000000 --- a/docs/api/ZM/Store/Database/DBQueryBuilder.md +++ /dev/null @@ -1,17 +0,0 @@ -# ZM\Store\Database\DBQueryBuilder - -## execute - -```php -public function execute(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | diff --git a/docs/api/ZM/Store/Database/DBStatement.md b/docs/api/ZM/Store/Database/DBStatement.md deleted file mode 100644 index 62cf40c0..00000000 --- a/docs/api/ZM/Store/Database/DBStatement.md +++ /dev/null @@ -1,17 +0,0 @@ -# ZM\Store\Database\DBStatement - -## current - -```php -public function current(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | diff --git a/docs/api/ZM/Store/Database/DBStatementWrapper.md b/docs/api/ZM/Store/Database/DBStatementWrapper.md deleted file mode 100644 index 76e6ebcf..00000000 --- a/docs/api/ZM/Store/Database/DBStatementWrapper.md +++ /dev/null @@ -1,289 +0,0 @@ -# ZM\Store\Database\DBStatementWrapper - -## getIterator - -```php -public function getIterator(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## columnCount - -```php -public function columnCount(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## fetchNumeric - -```php -public function fetchNumeric(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## fetchAssociative - -```php -public function fetchAssociative(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## fetchOne - -```php -public function fetchOne(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## fetchAllNumeric - -```php -public function fetchAllNumeric(): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## fetchAllAssociative - -```php -public function fetchAllAssociative(): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## fetchAllKeyValue - -```php -public function fetchAllKeyValue(): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## fetchAllAssociativeIndexed - -```php -public function fetchAllAssociativeIndexed(): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## fetchFirstColumn - -```php -public function fetchFirstColumn(): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## iterateNumeric - -```php -public function iterateNumeric(): Traversable -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Traversable | | - - -## iterateAssociative - -```php -public function iterateAssociative(): Traversable -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Traversable | | - - -## iterateKeyValue - -```php -public function iterateKeyValue(): Traversable -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Traversable | | - - -## iterateAssociativeIndexed - -```php -public function iterateAssociativeIndexed(): Traversable -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Traversable | | - - -## iterateColumn - -```php -public function iterateColumn(): Traversable -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Traversable | | - - -## rowCount - -```php -public function rowCount(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## free - -```php -public function free(): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | diff --git a/docs/api/ZM/Store/Database/DBWrapper.md b/docs/api/ZM/Store/Database/DBWrapper.md deleted file mode 100644 index 4d9bea22..00000000 --- a/docs/api/ZM/Store/Database/DBWrapper.md +++ /dev/null @@ -1,959 +0,0 @@ -# ZM\Store\Database\DBWrapper - -## __construct - -```php -public function __construct(string $name): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| name | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## getDatabase - -```php -public function getDatabase(): string -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | | - - -## isAutoCommit - -```php -public function isAutoCommit(): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## setAutoCommit - -```php -public function setAutoCommit(bool $auto_commit): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| auto_commit | bool | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## fetchAssociative - -```php -public function fetchAssociative(string $query, array $params, array $types): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## fetchNumeric - -```php -public function fetchNumeric(string $query, array $params, array $types): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## fetchOne - -```php -public function fetchOne(string $query, array $params, array $types): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## isTransactionActive - -```php -public function isTransactionActive(): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## delete - -```php -public function delete(string $table, array $criteria, array $types): int -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| table | string | | -| criteria | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int | | - - -## setTransactionIsolation - -```php -public function setTransactionIsolation(int $level): int -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| level | int | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int | | - - -## getTransactionIsolation - -```php -public function getTransactionIsolation(): int -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int | | - - -## update - -```php -public function update(string $table, array $data, array $criteria, array $types): int -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| table | string | | -| data | array | | -| criteria | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int | | - - -## insert - -```php -public function insert(string $table, array $data, array $types): int -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| table | string | | -| data | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int | | - - -## quoteIdentifier - -```php -public function quoteIdentifier(string $str): string -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| str | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | | - - -## quote - -```php -public function quote(mixed $value, mixed $type): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| value | mixed | | -| type | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## fetchAllNumeric - -```php -public function fetchAllNumeric(string $query, array $params, array $types): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## fetchAllAssociative - -```php -public function fetchAllAssociative(string $query, array $params, array $types): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## fetchAllKeyValue - -```php -public function fetchAllKeyValue(string $query, array $params, array $types): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## fetchAllAssociativeIndexed - -```php -public function fetchAllAssociativeIndexed(string $query, array $params, array $types): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## fetchFirstColumn - -```php -public function fetchFirstColumn(string $query, array $params, array $types): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## iterateNumeric - -```php -public function iterateNumeric(string $query, array $params, array $types): Traversable -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Traversable | | - - -## iterateAssociative - -```php -public function iterateAssociative(string $query, array $params, array $types): Traversable -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Traversable | | - - -## iterateKeyValue - -```php -public function iterateKeyValue(string $query, array $params, array $types): Traversable -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Traversable | | - - -## iterateAssociativeIndexed - -```php -public function iterateAssociativeIndexed(string $query, array $params, array $types): Traversable -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Traversable | | - - -## iterateColumn - -```php -public function iterateColumn(string $query, array $params, array $types): Traversable -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Traversable | | - - -## executeQuery - -```php -public function executeQuery(string $sql, array $params, array $types, Doctrine\DBAL\Cache\QueryCacheProfile $qcp): ZM\Store\Database\DBStatementWrapper -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| sql | string | | -| params | array | | -| types | array | | -| qcp | Doctrine\DBAL\Cache\QueryCacheProfile | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| ZM\Store\Database\DBStatementWrapper | | - - -## executeCacheQuery - -```php -public function executeCacheQuery(string $sql, array $params, array $types, Doctrine\DBAL\Cache\QueryCacheProfile $qcp): ZM\Store\Database\DBStatementWrapper -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| sql | string | | -| params | array | | -| types | array | | -| qcp | Doctrine\DBAL\Cache\QueryCacheProfile | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| ZM\Store\Database\DBStatementWrapper | | - - -## executeStatement - -```php -public function executeStatement(string $sql, array $params, array $types): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| sql | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## getTransactionNestingLevel - -```php -public function getTransactionNestingLevel(): int -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int | | - - -## lastInsertId - -```php -public function lastInsertId(string $name): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| name | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## transactional - -```php -public function transactional(Closure $func): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| func | Closure | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## setNestTransactionsWithSavepoints - -```php -public function setNestTransactionsWithSavepoints(bool $nest_transactions_with_savepoints): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| nest_transactions_with_savepoints | bool | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## getNestTransactionsWithSavepoints - -```php -public function getNestTransactionsWithSavepoints(): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## beginTransaction - -```php -public function beginTransaction(): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## commit - -```php -public function commit(): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## rollBack - -```php -public function rollBack(): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## createSavepoint - -```php -public function createSavepoint(string $savepoint): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| savepoint | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## releaseSavepoint - -```php -public function releaseSavepoint(string $savepoint): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| savepoint | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## rollbackSavepoint - -```php -public function rollbackSavepoint(string $savepoint): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| savepoint | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## setRollbackOnly - -```php -public function setRollbackOnly(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## isRollbackOnly - -```php -public function isRollbackOnly(): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## createQueryBuilder - -```php -public function createQueryBuilder(): ZM\Store\Database\DBQueryBuilder -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| ZM\Store\Database\DBQueryBuilder | | - - -## getConnectionClass - -```php -public function getConnectionClass(string $type): string -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| type | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | | diff --git a/docs/api/ZM/Store/FileSystem.md b/docs/api/ZM/Store/FileSystem.md deleted file mode 100644 index 4e459af1..00000000 --- a/docs/api/ZM/Store/FileSystem.md +++ /dev/null @@ -1,115 +0,0 @@ -# ZM\Store\FileSystem - -## scanDirFiles - -```php -public function scanDirFiles(string $dir, bool $recursive, mixed $relative, bool $include_dir): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| dir | string | | -| recursive | bool | | -| relative | mixed | | -| include_dir | bool | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## isRelativePath - -```php -public function isRelativePath(string $path): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| path | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## createDir - -```php -public function createDir(string $path): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| path | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## getReloadableFiles - -```php -public function getReloadableFiles(): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## getClassesPsr4 - -```php -public function getClassesPsr4(string $dir, string $base_namespace, mixed $rule, mixed $return_path_value): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| dir | string | | -| base_namespace | string | | -| rule | mixed | | -| return_path_value | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | diff --git a/docs/api/ZM/Store/LightCache.md b/docs/api/ZM/Store/LightCache.md deleted file mode 100644 index 5f4f6587..00000000 --- a/docs/api/ZM/Store/LightCache.md +++ /dev/null @@ -1,181 +0,0 @@ -# ZM\Store\LightCache - -## init - -```php -public function init(array $config): bool|mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| config | array | 配置 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool|mixed | 返回失败（false）或创建SwooleTable成功结果 | - - -## 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 deleted file mode 100644 index 8529418c..00000000 --- a/docs/api/ZM/Store/LightCacheInside.md +++ /dev/null @@ -1,75 +0,0 @@ -# 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): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| value | array|int|string | | -| table | string | | -| key | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## createTable - -```php -public function createTable(float|int $conflict_proportion, string $name, int $size, int $str_size): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| conflict_proportion | float|int | | -| name | string | | -| size | int | | -| str_size | int | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | diff --git a/docs/api/ZM/Store/Lock/FileLock.md b/docs/api/ZM/Store/Lock/FileLock.md deleted file mode 100644 index 273ae8d0..00000000 --- a/docs/api/ZM/Store/Lock/FileLock.md +++ /dev/null @@ -1,46 +0,0 @@ -# ZM\Store\Lock\FileLock - -## lock - -```php -public function lock(string $name): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| name | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## unlock - -```php -public function unlock(string $name): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| name | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | diff --git a/docs/api/ZM/Store/Lock/SpinLock.md b/docs/api/ZM/Store/Lock/SpinLock.md deleted file mode 100644 index 9e4b1250..00000000 --- a/docs/api/ZM/Store/Lock/SpinLock.md +++ /dev/null @@ -1 +0,0 @@ -# ZM\Store\Lock\SpinLock \ No newline at end of file diff --git a/docs/api/ZM/Store/MySQL/MySQLConnection.md b/docs/api/ZM/Store/MySQL/MySQLConnection.md deleted file mode 100644 index a15960a8..00000000 --- a/docs/api/ZM/Store/MySQL/MySQLConnection.md +++ /dev/null @@ -1,110 +0,0 @@ -# ZM\Store\MySQL\MySQLConnection - -## prepare - -```php -public function prepare(mixed $sql, mixed $options): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| sql | mixed | | -| options | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## query - -```php -public function query(mixed $args): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| args | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## exec - -```php -public function exec(mixed $sql): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| sql | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## lastInsertId - -```php -public function lastInsertId(mixed $name): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| name | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## getPoolName - -```php -public function getPoolName(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | diff --git a/docs/api/ZM/Store/MySQL/MySQLPool.md b/docs/api/ZM/Store/MySQL/MySQLPool.md deleted file mode 100644 index 26b1656e..00000000 --- a/docs/api/ZM/Store/MySQL/MySQLPool.md +++ /dev/null @@ -1,104 +0,0 @@ -# ZM\Store\MySQL\MySQLPool - -## create - -```php -public function create(string $name, array $config): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| name | string | | -| config | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## pool - -```php -public function pool(string $name): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| name | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## getAllPools - -```php -public function getAllPools(): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## destroyPool - -```php -public function destroyPool(string $name): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| name | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## checkExtension - -```php -public function checkExtension(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | diff --git a/docs/api/ZM/Store/MySQL/MySQLQueryBuilder.md b/docs/api/ZM/Store/MySQL/MySQLQueryBuilder.md deleted file mode 100644 index 22ab44ce..00000000 --- a/docs/api/ZM/Store/MySQL/MySQLQueryBuilder.md +++ /dev/null @@ -1,17 +0,0 @@ -# ZM\Store\MySQL\MySQLQueryBuilder - -## execute - -```php -public function execute(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | diff --git a/docs/api/ZM/Store/MySQL/MySQLStatement.md b/docs/api/ZM/Store/MySQL/MySQLStatement.md deleted file mode 100644 index 425db9c7..00000000 --- a/docs/api/ZM/Store/MySQL/MySQLStatement.md +++ /dev/null @@ -1,17 +0,0 @@ -# ZM\Store\MySQL\MySQLStatement - -## current - -```php -public function current(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | diff --git a/docs/api/ZM/Store/MySQL/MySQLStatementWrapper.md b/docs/api/ZM/Store/MySQL/MySQLStatementWrapper.md deleted file mode 100644 index d99f7e9d..00000000 --- a/docs/api/ZM/Store/MySQL/MySQLStatementWrapper.md +++ /dev/null @@ -1,289 +0,0 @@ -# ZM\Store\MySQL\MySQLStatementWrapper - -## getIterator - -```php -public function getIterator(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## columnCount - -```php -public function columnCount(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## fetchNumeric - -```php -public function fetchNumeric(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## fetchAssociative - -```php -public function fetchAssociative(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## fetchOne - -```php -public function fetchOne(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## fetchAllNumeric - -```php -public function fetchAllNumeric(): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## fetchAllAssociative - -```php -public function fetchAllAssociative(): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## fetchAllKeyValue - -```php -public function fetchAllKeyValue(): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## fetchAllAssociativeIndexed - -```php -public function fetchAllAssociativeIndexed(): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## fetchFirstColumn - -```php -public function fetchFirstColumn(): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## iterateNumeric - -```php -public function iterateNumeric(): Traversable -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Traversable | | - - -## iterateAssociative - -```php -public function iterateAssociative(): Traversable -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Traversable | | - - -## iterateKeyValue - -```php -public function iterateKeyValue(): Traversable -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Traversable | | - - -## iterateAssociativeIndexed - -```php -public function iterateAssociativeIndexed(): Traversable -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Traversable | | - - -## iterateColumn - -```php -public function iterateColumn(): Traversable -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Traversable | | - - -## rowCount - -```php -public function rowCount(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## free - -```php -public function free(): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | diff --git a/docs/api/ZM/Store/MySQL/MySQLWrapper.md b/docs/api/ZM/Store/MySQL/MySQLWrapper.md deleted file mode 100644 index d62bdbd1..00000000 --- a/docs/api/ZM/Store/MySQL/MySQLWrapper.md +++ /dev/null @@ -1,936 +0,0 @@ -# ZM\Store\MySQL\MySQLWrapper - -## __construct - -```php -public function __construct(string $name): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| name | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## getDatabase - -```php -public function getDatabase(): string -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | | - - -## isAutoCommit - -```php -public function isAutoCommit(): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## setAutoCommit - -```php -public function setAutoCommit(bool $auto_commit): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| auto_commit | bool | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## fetchAssociative - -```php -public function fetchAssociative(string $query, array $params, array $types): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## fetchNumeric - -```php -public function fetchNumeric(string $query, array $params, array $types): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## fetchOne - -```php -public function fetchOne(string $query, array $params, array $types): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## isTransactionActive - -```php -public function isTransactionActive(): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## delete - -```php -public function delete(string $table, array $criteria, array $types): int -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| table | string | | -| criteria | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int | | - - -## setTransactionIsolation - -```php -public function setTransactionIsolation(int $level): int -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| level | int | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int | | - - -## getTransactionIsolation - -```php -public function getTransactionIsolation(): int -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int | | - - -## update - -```php -public function update(string $table, array $data, array $criteria, array $types): int -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| table | string | | -| data | array | | -| criteria | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int | | - - -## insert - -```php -public function insert(string $table, array $data, array $types): int -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| table | string | | -| data | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int | | - - -## quoteIdentifier - -```php -public function quoteIdentifier(string $str): string -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| str | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | | - - -## quote - -```php -public function quote(mixed $value, mixed $type): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| value | mixed | | -| type | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## fetchAllNumeric - -```php -public function fetchAllNumeric(string $query, array $params, array $types): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## fetchAllAssociative - -```php -public function fetchAllAssociative(string $query, array $params, array $types): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## fetchAllKeyValue - -```php -public function fetchAllKeyValue(string $query, array $params, array $types): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## fetchAllAssociativeIndexed - -```php -public function fetchAllAssociativeIndexed(string $query, array $params, array $types): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## fetchFirstColumn - -```php -public function fetchFirstColumn(string $query, array $params, array $types): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## iterateNumeric - -```php -public function iterateNumeric(string $query, array $params, array $types): Traversable -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Traversable | | - - -## iterateAssociative - -```php -public function iterateAssociative(string $query, array $params, array $types): Traversable -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Traversable | | - - -## iterateKeyValue - -```php -public function iterateKeyValue(string $query, array $params, array $types): Traversable -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Traversable | | - - -## iterateAssociativeIndexed - -```php -public function iterateAssociativeIndexed(string $query, array $params, array $types): Traversable -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Traversable | | - - -## iterateColumn - -```php -public function iterateColumn(string $query, array $params, array $types): Traversable -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Traversable | | - - -## executeQuery - -```php -public function executeQuery(string $sql, array $params, array $types, Doctrine\DBAL\Cache\QueryCacheProfile $qcp): ZM\Store\MySQL\MySQLStatementWrapper -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| sql | string | | -| params | array | | -| types | array | | -| qcp | Doctrine\DBAL\Cache\QueryCacheProfile | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| ZM\Store\MySQL\MySQLStatementWrapper | | - - -## executeCacheQuery - -```php -public function executeCacheQuery(string $sql, array $params, array $types, Doctrine\DBAL\Cache\QueryCacheProfile $qcp): ZM\Store\MySQL\MySQLStatementWrapper -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| sql | string | | -| params | array | | -| types | array | | -| qcp | Doctrine\DBAL\Cache\QueryCacheProfile | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| ZM\Store\MySQL\MySQLStatementWrapper | | - - -## executeStatement - -```php -public function executeStatement(string $sql, array $params, array $types): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| sql | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## getTransactionNestingLevel - -```php -public function getTransactionNestingLevel(): int -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int | | - - -## lastInsertId - -```php -public function lastInsertId(string $name): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| name | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## transactional - -```php -public function transactional(Closure $func): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| func | Closure | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## setNestTransactionsWithSavepoints - -```php -public function setNestTransactionsWithSavepoints(bool $nest_transactions_with_savepoints): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| nest_transactions_with_savepoints | bool | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## getNestTransactionsWithSavepoints - -```php -public function getNestTransactionsWithSavepoints(): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## beginTransaction - -```php -public function beginTransaction(): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## commit - -```php -public function commit(): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## rollBack - -```php -public function rollBack(): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## createSavepoint - -```php -public function createSavepoint(string $savepoint): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| savepoint | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## releaseSavepoint - -```php -public function releaseSavepoint(string $savepoint): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| savepoint | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## rollbackSavepoint - -```php -public function rollbackSavepoint(string $savepoint): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| savepoint | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## setRollbackOnly - -```php -public function setRollbackOnly(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## isRollbackOnly - -```php -public function isRollbackOnly(): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## createQueryBuilder - -```php -public function createQueryBuilder(): ZM\Store\MySQL\MySQLQueryBuilder -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| ZM\Store\MySQL\MySQLQueryBuilder | | diff --git a/docs/api/ZM/Store/MySQL/SqlPoolStorage.md b/docs/api/ZM/Store/MySQL/SqlPoolStorage.md deleted file mode 100644 index c805a86d..00000000 --- a/docs/api/ZM/Store/MySQL/SqlPoolStorage.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index efee0423..00000000 --- a/docs/api/ZM/Store/Redis/ZMRedis.md +++ /dev/null @@ -1,40 +0,0 @@ -# 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 deleted file mode 100644 index a524ee52..00000000 --- a/docs/api/ZM/Store/Redis/ZMRedisPool.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index ec78f2c8..00000000 --- a/docs/api/ZM/Store/WorkerCache.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 70b1c874..00000000 --- a/docs/api/ZM/Store/ZMAtomic.md +++ /dev/null @@ -1,17 +0,0 @@ -# ZM\Store\ZMAtomic - -## init - -```php -public function init(): mixed -``` - -### 描述 - -初始化atomic计数器 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | diff --git a/docs/api/ZM/Store/ZMBuf.md b/docs/api/ZM/Store/ZMBuf.md deleted file mode 100644 index b3e99a98..00000000 --- a/docs/api/ZM/Store/ZMBuf.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index bd14746f..00000000 --- a/docs/api/ZM/Utils/CoMessage.md +++ /dev/null @@ -1,42 +0,0 @@ -# ZM\Utils\CoMessage - -## yieldByWS - -```php -public function yieldByWS(array $hang, array $compare, int $timeout): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| hang | array | | -| compare | array | | -| timeout | int | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## resumeByWS - -```php -public function resumeByWS(): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | diff --git a/docs/api/ZM/Utils/CommandInfoUtil.md b/docs/api/ZM/Utils/CommandInfoUtil.md deleted file mode 100644 index 98bc6605..00000000 --- a/docs/api/ZM/Utils/CommandInfoUtil.md +++ /dev/null @@ -1,138 +0,0 @@ -# ZM\Utils\CommandInfoUtil - -## exists - -```php -public function exists(): bool -``` - -### 描述 - -判断命令信息是否已生成并缓存 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## get - -```php -public function get(): array -``` - -### 描述 - -获取命令信息 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## regenerate - -```php -public function regenerate(): void -``` - -### 描述 - -重新生成命令信息 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## getHelp - -```php -public function getHelp(string $command_id, bool $simple): string -``` - -### 描述 - -获取命令帮助 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| command_id | string | 命令ID，为 `class@method` 格式 | -| simple | bool | 是否仅输出简易信息（只有命令触发条件和描述） | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | | - - -## save - -```php -public function save(array $helps): void -``` - -### 描述 - -缓存命令信息 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| helps | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## generateCommandList - -```php -public function generateCommandList(): array -``` - -### 描述 - -根据注解树生成命令信息（内部） - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## generateCommandArgumentList - -```php -public function generateCommandArgumentList(string $id): array -``` - -### 描述 - -生成指定命令的参数列表 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| id | string | 命令 ID | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | diff --git a/docs/api/ZM/Utils/ConnectionUtil.md b/docs/api/ZM/Utils/ConnectionUtil.md deleted file mode 100644 index 76e11cb4..00000000 --- a/docs/api/ZM/Utils/ConnectionUtil.md +++ /dev/null @@ -1,71 +0,0 @@ -# ZM\Utils\ConnectionUtil - -## addConnection - -```php -public function addConnection(int $fd, array $handle): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| fd | int | | -| handle | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## setConnection - -```php -public function setConnection(int $fd, array $handle): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| fd | int | | -| handle | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | - - -## removeConnection - -```php -public function removeConnection(int $fd): void -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| fd | int | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | diff --git a/docs/api/ZM/Utils/CoroutinePool.md b/docs/api/ZM/Utils/CoroutinePool.md deleted file mode 100644 index 63d11048..00000000 --- a/docs/api/ZM/Utils/CoroutinePool.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 3e911322..00000000 --- a/docs/api/ZM/Utils/DataProvider.md +++ /dev/null @@ -1,226 +0,0 @@ -# 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(string $filename, array|int|Iterator|JsonSerializable|string|Traversable $file_array): false|int -``` - -### 描述 - -将变量保存在zm_data下的数据目录，传入数组 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| filename | string | 文件名 | -| file_array | array|int|Iterator|JsonSerializable|string|Traversable | 文件内容数组 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| false|int | 返回文件大小或false | - - -## loadFromJson - -```php -public function loadFromJson(string $filename): null|mixed -``` - -### 描述 - -从json加载变量到内存 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| filename | string | 文件名 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| null|mixed | 返回文件内容数据或null | - - -## scanDirFiles - -```php -public function scanDirFiles(string $dir, bool $recursive, bool|string $relative): array|false -``` - -### 描述 - -递归或非递归扫描目录，可返回相对目录的文件列表或绝对目录的文件列表 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| dir | string | 目录 | -| recursive | bool | 是否递归扫描子目录 | -| relative | bool|string | 是否返回相对目录，如果为true则返回相对目录，如果为false则返回绝对目录 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|false | | - - -## isRelativePath - -```php -public function isRelativePath(string $path): bool -``` - -### 描述 - -检查路径是否为相对路径（根据第一个字符是否为"/"来判断） - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| path | string | 路径 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | 返回结果 | - - -## createIfNotExists - -```php -public function createIfNotExists(string $path): void -``` - -### 描述 - -创建目录（如果不存在） - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| path | string | 目录路径 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| void | | diff --git a/docs/api/ZM/Utils/EasterEgg.md b/docs/api/ZM/Utils/EasterEgg.md deleted file mode 100644 index edf460bf..00000000 --- a/docs/api/ZM/Utils/EasterEgg.md +++ /dev/null @@ -1,17 +0,0 @@ -# ZM\Utils\EasterEgg - -## checkFrameworkPermissionCall - -```php -public function checkFrameworkPermissionCall(): string -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | | diff --git a/docs/api/ZM/Utils/HttpUtil.md b/docs/api/ZM/Utils/HttpUtil.md deleted file mode 100644 index d08eb946..00000000 --- a/docs/api/ZM/Utils/HttpUtil.md +++ /dev/null @@ -1,97 +0,0 @@ -# ZM\Utils\HttpUtil - -## parseUri - -```php -public function parseUri(Psr\Http\Message\RequestInterface $request, mixed $node, mixed $params): int -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| request | Psr\Http\Message\RequestInterface | | -| node | mixed | | -| params | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int | | - - -## handleStaticPage - -```php -public function handleStaticPage(string $uri, array $settings): Psr\Http\Message\ResponseInterface -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| uri | string | | -| settings | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Psr\Http\Message\ResponseInterface | | - - -## handleHttpCodePage - -```php -public function handleHttpCodePage(int $code): Psr\Http\Message\ResponseInterface -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| code | int | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Psr\Http\Message\ResponseInterface | | - - -## createJsonResponse - -```php -public function createJsonResponse(array $data, int $http_code, int $json_flag): Psr\Http\Message\ResponseInterface -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| data | array | | -| http_code | int | | -| json_flag | int | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Psr\Http\Message\ResponseInterface | | diff --git a/docs/api/ZM/Utils/Macroable.md b/docs/api/ZM/Utils/Macroable.md deleted file mode 100644 index 878d4d44..00000000 --- a/docs/api/ZM/Utils/Macroable.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index f6c0e7d5..00000000 --- a/docs/api/ZM/Utils/Manager/CronManager.md +++ /dev/null @@ -1,43 +0,0 @@ -# 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 deleted file mode 100644 index 924ecd06..00000000 --- a/docs/api/ZM/Utils/Manager/ModuleManager.md +++ /dev/null @@ -1,65 +0,0 @@ -# ZM\Utils\Manager\ModuleManager - -## getConfiguredModules - -```php -public function getConfiguredModules(): array -``` - -### 描述 - -扫描src目录下的所有已经被标注的模块 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## packModule - -```php -public function packModule(array $module, string $target): bool -``` - -### 描述 - -打包模块 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| module | array | 模块信息 | -| target | string | 目标路径 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## unpackModule - -```php -public function unpackModule(array|Iterator $module, array $options): array|false -``` - -### 描述 - -解包模块 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| module | array|Iterator | 模块信息 | -| options | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|false | 返回解包的信息或false | diff --git a/docs/api/ZM/Utils/Manager/ProcessManager.md b/docs/api/ZM/Utils/Manager/ProcessManager.md deleted file mode 100644 index bc1a74d4..00000000 --- a/docs/api/ZM/Utils/Manager/ProcessManager.md +++ /dev/null @@ -1,73 +0,0 @@ -# ZM\Utils\Manager\ProcessManager - -## removeProcessState - -```php -public function removeProcessState(null|int|string $id_or_name, int $type): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| id_or_name | null|int|string | | -| type | int | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## getProcessState - -```php -public function getProcessState(mixed $id_or_name, int $type): false|int|mixed -``` - -### 描述 - -用于框架内部获取多进程运行状态的函数 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| id_or_name | mixed | | -| type | int | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| false|int|mixed | | - - -## saveProcessState - -```php -public function saveProcessState(int|string $pid, int $type, array $data): mixed -``` - -### 描述 - -将各进程的pid写入文件，以备后续崩溃及僵尸进程处理使用 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| pid | int|string | | -| type | int | | -| data | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | diff --git a/docs/api/ZM/Utils/Manager/RouteManager.md b/docs/api/ZM/Utils/Manager/RouteManager.md deleted file mode 100644 index b2972e7b..00000000 --- a/docs/api/ZM/Utils/Manager/RouteManager.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 31a277df..00000000 --- a/docs/api/ZM/Utils/Manager/TaskManager.md +++ /dev/null @@ -1 +0,0 @@ -# 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 deleted file mode 100644 index 34a38c33..00000000 --- a/docs/api/ZM/Utils/Manager/WorkerManager.md +++ /dev/null @@ -1,66 +0,0 @@ -# ZM\Utils\Manager\WorkerManager - -## workerAction - -```php -public function workerAction(int $src_worker_id, array $data): mixed -``` - -### 描述 - -Worker 进程间通信触发的动作类型函数 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| src_worker_id | int | 源 Worker 进程 ID | -| data | array | 数据 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## sendActionToWorker - -```php -public function sendActionToWorker(int $worker_id, string $action, mixed $data): mixed -``` - -### 描述 - -给 Worker 进程发送动作指令（包括自身，自身将直接执行） - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| worker_id | int | 进程ID | -| action | string | 动作 | -| 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 deleted file mode 100644 index 631fd4d3..00000000 --- a/docs/api/ZM/Utils/MessageUtil.md +++ /dev/null @@ -1,219 +0,0 @@ -# ZM\Utils\MessageUtil - -## downloadCQImage - -```php -public function downloadCQImage(array|string $msg, null|string $path): array|false -``` - -### 描述 - -下载消息中 CQ 码的所有图片，通过 url - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| msg | array|string | 消息或消息数组 | -| path | null|string | 保存路径 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|false | 返回图片信息或失败返回false | - - -## containsImage - -```php -public function containsImage(array|string $msg): bool -``` - -### 描述 - -检查消息中是否含有图片 CQ 码 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| msg | array|string | 消息或消息数组 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## getImageCQFromLocal - -```php -public function getImageCQFromLocal(string $file, int $type): string -``` - -### 描述 - -通过本地地址返回图片的 CQ 码 -type == 0 : 返回图片的 base64 CQ 码 -type == 1 : 返回图片的 file://路径 CQ 码（路径必须为绝对路径） -type == 2 : 返回图片的 http://xxx CQ 码（默认为 /images/ 路径就是文件对应所在的目录） - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| file | string | 文件数据 | -| type | int | 文件类型（0，1，2可选，默认为0） | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | | - - -## splitCommand - -```php -public function splitCommand(string $msg): array|string[] -``` - -### 描述 - -分割字符，将用户消息通过空格或换行分割为数组 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| msg | string | 消息内容 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|string[] | | - - -## matchCommand - -```php -public function matchCommand(array|string $msg, array|Iterator $obj): ZM\Entity\MatchResult -``` - -### 描述 - -根据CQCommand的规则匹配消息，获取是否匹配到对应的注解事件 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| msg | array|string | 消息内容 | -| obj | array|Iterator | 数据对象 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| ZM\Entity\MatchResult | | - - -## addShortCommand - -```php -public function addShortCommand(string $command, string $reply): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| command | string | 命令内容 | -| reply | string | 回复内容 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## strToArray - -```php -public function strToArray(string $msg, bool $ignore_space, bool $trim_text): array -``` - -### 描述 - -字符串转数组 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| msg | string | 消息内容 | -| ignore_space | bool | 是否忽略空行 | -| trim_text | bool | 是否去除空格 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | 返回数组 | - - -## arrayToStr - -```php -public function arrayToStr(array $array): string -``` - -### 描述 - -数组转字符串 -纪念一下，这段代码完全由AI生成，没有人知道它是怎么写的，这句话是我自己写的，不知道是不是有人知道的 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| array | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | | - - -## checkArguments - -```php -public function checkArguments(string $class, string $method, array $match): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| class | string | | -| method | string | | -| match | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | diff --git a/docs/api/ZM/Utils/ReflectionUtil.md b/docs/api/ZM/Utils/ReflectionUtil.md deleted file mode 100644 index 5f246139..00000000 --- a/docs/api/ZM/Utils/ReflectionUtil.md +++ /dev/null @@ -1,116 +0,0 @@ -# ZM\Utils\ReflectionUtil - -## getParameterClassName - -```php -public function getParameterClassName(ReflectionParameter $parameter): string -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| parameter | ReflectionParameter | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | | - - -## variableToString - -```php -public function variableToString(mixed $var): string -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| var | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | | - - -## isNonStaticMethod - -```php -public function isNonStaticMethod(mixed $callback): bool -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| callback | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | - - -## getCallReflector - -```php -public function getCallReflector(mixed $callback): ReflectionFunctionAbstract -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| callback | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| ReflectionFunctionAbstract | | - - -## getMethod - -```php -public function getMethod(string $class, string $method): ReflectionMethod -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| class | string | | -| method | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| ReflectionMethod | | diff --git a/docs/api/ZM/Utils/SignalListener.md b/docs/api/ZM/Utils/SignalListener.md deleted file mode 100644 index eba3013e..00000000 --- a/docs/api/ZM/Utils/SignalListener.md +++ /dev/null @@ -1,81 +0,0 @@ -# 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(int $worker_id, Swoole\Server $server): mixed -``` - -### 描述 - -监听Worker/TaskWorker进程的Ctrl+C - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| worker_id | int | 当前进程的ID | -| 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 deleted file mode 100644 index d47f292c..00000000 --- a/docs/api/ZM/Utils/SingletonTrait.md +++ /dev/null @@ -1,17 +0,0 @@ -# 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 deleted file mode 100644 index 3c0cedd7..00000000 --- a/docs/api/ZM/Utils/Terminal.md +++ /dev/null @@ -1,200 +0,0 @@ -# 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(array $it): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| it | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## level - -```php -public function level(array $it): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| it | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## bc - -```php -public function bc(array $it): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| it | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## echoI - -```php -public function echoI(array $it): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| it | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| 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 deleted file mode 100644 index 9368ed89..00000000 --- a/docs/api/ZM/Utils/ZMUtil.md +++ /dev/null @@ -1,23 +0,0 @@ -# ZM\Utils\ZMUtil - -## getComposerMetadata - -```php -public function getComposerMetadata(string $path): array -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| path | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | diff --git a/docs/api/ZM/ZMApplication.md b/docs/api/ZM/ZMApplication.md deleted file mode 100644 index 57acd4bb..00000000 --- a/docs/api/ZM/ZMApplication.md +++ /dev/null @@ -1,17 +0,0 @@ -# ZM\ZMApplication - -## run - -```php -public function run(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | diff --git a/docs/api/ZM/ZMServer.md b/docs/api/ZM/ZMServer.md deleted file mode 100644 index 14b0169b..00000000 --- a/docs/api/ZM/ZMServer.md +++ /dev/null @@ -1,63 +0,0 @@ -# ZM\ZMServer - -## __construct - -```php -public function __construct(string $app_name): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| app_name | string | App名称 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## addModule - -```php -public function addModule(mixed $module_class): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| module_class | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## run - -```php -public function run(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | diff --git a/docs/api/index.md b/docs/api/index.md deleted file mode 100644 index e69de29b..00000000