update api docs

This commit is contained in:
crazywhalecc 2022-12-18 12:14:51 +00:00 committed by github-actions[bot]
parent 2633e91d4d
commit ede5f456a8
7 changed files with 145 additions and 5 deletions

View File

@ -1 +1 @@
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/CheckConfigCommand","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/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/ReflectionUtil","ZM/Utils/ZMUtil","ZM/Utils/HttpUtil"]}]
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"]}]

View File

@ -26,7 +26,7 @@ public function onRequest999(OneBot\Driver\Event\Http\HttpRequestEvent $event):
## onRequest1
```php
public function onRequest1(OneBot\Driver\Event\Http\HttpRequestEvent $event): mixed
public function onRequest1(OneBot\Driver\Event\Http\HttpRequestEvent $event): void
```
### 描述
@ -43,7 +43,7 @@ public function onRequest1(OneBot\Driver\Event\Http\HttpRequestEvent $event): mi
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
| void | |
## getInstance

View File

@ -1,5 +1,28 @@
# ZM\Event\Listener\WSEventListener
## onWebSocketOpen
```php
public function onWebSocketOpen(OneBot\Driver\Event\WebSocket\WebSocketOpenEvent $event): void
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| event | OneBot\Driver\Event\WebSocket\WebSocketOpenEvent | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| void | |
## getInstance
```php

View File

@ -0,0 +1,23 @@
# ZM\Plugin\OneBot12Adapter
## handleWSReverseInput
```php
public function handleWSReverseInput(OneBot\Driver\Event\WebSocket\WebSocketOpenEvent $event): void
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| event | OneBot\Driver\Event\WebSocket\WebSocketOpenEvent | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| void | |

View File

@ -0,0 +1,23 @@
# ZM\Plugin\PluginManager
## addPlugin
```php
public function addPlugin(array $meta): void
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| meta | array | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| void | |

View File

@ -0,0 +1,71 @@
# 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 | |

View File

@ -3,7 +3,7 @@
## parseUri
```php
public function parseUri(OneBot\Http\ServerRequest $request, mixed $node, mixed $params): int
public function parseUri(Psr\Http\Message\RequestInterface $request, mixed $node, mixed $params): int
```
### 描述
@ -14,7 +14,7 @@ public function parseUri(OneBot\Http\ServerRequest $request, mixed $node, mixed
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| request | OneBot\Http\ServerRequest | |
| request | Psr\Http\Message\RequestInterface | |
| node | mixed | |
| params | mixed | |