From ca61e6a23892bb716ce072db84c13251123b9b37 Mon Sep 17 00:00:00 2001 From: sunxyw Date: Sat, 17 Dec 2022 11:43:41 +0000 Subject: [PATCH] update api docs --- docs/.vuepress/api.js | 2 +- docs/api/ZM/Command/Command.md | 209 +++++++++++++++++++++++++++++ docs/api/ZM/Command/InitCommand.md | 41 +++++- docs/api/ZM/ConsoleApplication.md | 23 ---- docs/api/ZM/InstantApplication.md | 23 ---- 5 files changed, 250 insertions(+), 48 deletions(-) create mode 100644 docs/api/ZM/Command/Command.md diff --git a/docs/.vuepress/api.js b/docs/.vuepress/api.js index 07fb7180..c9b1c359 100644 --- a/docs/.vuepress/api.js +++ b/docs/.vuepress/api.js @@ -1 +1 @@ -module.exports = [{"title":"ZM","collapsable":true,"children":["ZM/InstantApplication","ZM/ConsoleApplication"]},{"title":"ZM/Annotation","collapsable":true,"children":["ZM/Annotation/AnnotationBase","ZM/Annotation/AnnotationParser","ZM/Annotation/AnnotationMap","ZM/Annotation/AnnotationHandler"]},{"title":"ZM/Command","collapsable":true,"children":["ZM/Command/ProxyServerCommand","ZM/Command/BuildCommand","ZM/Command/CheckConfigCommand"]},{"title":"ZM/Command/Server","collapsable":true,"children":["ZM/Command/Server/ServerStartCommand","ZM/Command/Server/ServerCommand"]},{"title":"ZM/Config","collapsable":true,"children":["ZM/Config/ConfigTracer","ZM/Config/ZMConfig"]},{"title":"ZM/Container","collapsable":true,"children":["ZM/Container/Container","ZM/Container/BoundMethod","ZM/Container/WorkerContainer","ZM/Container/ContainerServicesProvider"]},{"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/ManagerEventListener","ZM/Event/Listener/WorkerEventListener","ZM/Event/Listener/MasterEventListener","ZM/Event/Listener/HttpEventListener","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/DBPool","ZM/Store/Database/DBQueryBuilder","ZM/Store/Database/DBStatement","ZM/Store/Database/DBStatementWrapper","ZM/Store/Database/DBConnection"]},{"title":"ZM/Store/Lock","collapsable":true,"children":["ZM/Store/Lock/FileLock"]},{"title":"ZM/Utils","collapsable":true,"children":["ZM/Utils/ZMUtil","ZM/Utils/HttpUtil","ZM/Utils/ReflectionUtil"]}] \ No newline at end of file +module.exports = [{"title":"ZM","collapsable":true,"children":["ZM/ConsoleApplication","ZM/InstantApplication"]},{"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/ReflectionUtil","ZM/Utils/ZMUtil","ZM/Utils/HttpUtil"]}] \ No newline at end of file diff --git a/docs/api/ZM/Command/Command.md b/docs/api/ZM/Command/Command.md new file mode 100644 index 00000000..e0e6bf35 --- /dev/null +++ b/docs/api/ZM/Command/Command.md @@ -0,0 +1,209 @@ +# 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 | | + + +## 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/InitCommand.md b/docs/api/ZM/Command/InitCommand.md index 2363e5c1..6072ac63 100644 --- a/docs/api/ZM/Command/InitCommand.md +++ b/docs/api/ZM/Command/InitCommand.md @@ -1 +1,40 @@ -# ZM\Command\InitCommand \ No newline at end of file +# 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/ConsoleApplication.md b/docs/api/ZM/ConsoleApplication.md index 4d9a7a22..2fd9fddf 100644 --- a/docs/api/ZM/ConsoleApplication.md +++ b/docs/api/ZM/ConsoleApplication.md @@ -1,28 +1,5 @@ # ZM\ConsoleApplication -## __construct - -```php -public function __construct(string $name): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| name | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - ## run ```php diff --git a/docs/api/ZM/InstantApplication.md b/docs/api/ZM/InstantApplication.md index d599ae12..c1af0b01 100644 --- a/docs/api/ZM/InstantApplication.md +++ b/docs/api/ZM/InstantApplication.md @@ -1,28 +1,5 @@ # ZM\InstantApplication -## __construct - -```php -public function __construct(mixed $dir): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| dir | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - ## run ```php