diff --git a/docs/.vuepress/api.js b/docs/.vuepress/api.js index 576cdeef..7f94f9b7 100644 --- a/docs/.vuepress/api.js +++ b/docs/.vuepress/api.js @@ -1 +1 @@ -module.exports = [{"title":"ZM","collapsable":true,"children":["ZM/ZMServer"]},{"title":"ZM/API","collapsable":true,"children":["ZM/API/GoCqhttpAPIV11","ZM/API/TuringAPI","ZM/API/OneBotV11","ZM/API/ZMRobot","ZM/API/CQ"]},{"title":"ZM/API/Proxies/Bot","collapsable":true,"children":["ZM/API/Proxies/Bot/AbstractBotProxy","ZM/API/Proxies/Bot/AllGroupsProxy","ZM/API/Proxies/Bot/AllBotsProxy"]},{"title":"ZM/Adapters","collapsable":true,"children":["ZM/Adapters/OneBot11Adapter"]},{"title":"ZM/Annotation/Swoole","collapsable":true,"children":["ZM/Annotation/Swoole/OnSwooleEventBase"]},{"title":"ZM/Command","collapsable":true,"children":["ZM/Command/CheckConfigCommand"]},{"title":"ZM/Command/Module","collapsable":true,"children":["ZM/Command/Module/ModulePackCommand","ZM/Command/Module/ModuleListCommand"]},{"title":"ZM/Command/Server","collapsable":true,"children":["ZM/Command/Server/ServerCommand","ZM/Command/Server/ServerStartCommand"]},{"title":"ZM/Config","collapsable":true,"children":["ZM/Config/ZMConfig"]},{"title":"ZM/Container","collapsable":true,"children":["ZM/Container/WorkerContainer","ZM/Container/ContainerServicesProvider","ZM/Container/Container","ZM/Container/BoundMethod"]},{"title":"ZM/DB","collapsable":true,"children":["ZM/DB/SelectBody","ZM/DB/InsertBody","ZM/DB/Table","ZM/DB/DB","ZM/DB/UpdateBody","ZM/DB/DeleteBody"]},{"title":"ZM/Event","collapsable":true,"children":["ZM/Event/EventTracer","ZM/Event/EventDispatcher","ZM/Event/EventManager"]},{"title":"ZM/Event/SwooleEvent","collapsable":true,"children":["ZM/Event/SwooleEvent/OnTask"]},{"title":"ZM/Http","collapsable":true,"children":["ZM/Http/Response"]},{"title":"ZM/Module","collapsable":true,"children":["ZM/Module/ModulePacker","ZM/Module/ModuleUnpacker","ZM/Module/ModuleBase"]},{"title":"ZM/MySQL","collapsable":true,"children":["ZM/MySQL/MySQLConnection","ZM/MySQL/MySQLStatement","ZM/MySQL/MySQLWrapper","ZM/MySQL/MySQLPool","ZM/MySQL/MySQLQueryBuilder","ZM/MySQL/MySQLStatementWrapper"]},{"title":"ZM/Store","collapsable":true,"children":["ZM/Store/ZMAtomic","ZM/Store/LightCache","ZM/Store/LightCacheInside"]},{"title":"ZM/Store/Redis","collapsable":true,"children":["ZM/Store/Redis/ZMRedis"]},{"title":"ZM/Utils","collapsable":true,"children":["ZM/Utils/SignalListener","ZM/Utils/MessageUtil","ZM/Utils/CommandInfoUtil","ZM/Utils/ReflectionUtil","ZM/Utils/Terminal","ZM/Utils/CoMessage","ZM/Utils/DataProvider","ZM/Utils/HttpUtil"]},{"title":"ZM/Utils/Manager","collapsable":true,"children":["ZM/Utils/Manager/WorkerManager","ZM/Utils/Manager/ProcessManager","ZM/Utils/Manager/CronManager","ZM/Utils/Manager/ModuleManager"]}] \ No newline at end of file +module.exports = [{"title":"ZM","collapsable":true,"children":["ZM/InstantApplication","ZM/ConsoleApplication"]},{"title":"ZM/Annotation","collapsable":true,"children":["ZM/Annotation/AnnotationBase","ZM/Annotation/AnnotationHandler","ZM/Annotation/AnnotationMap","ZM/Annotation/AnnotationParser"]},{"title":"ZM/Command","collapsable":true,"children":["ZM/Command/BuildCommand","ZM/Command/CheckConfigCommand"]},{"title":"ZM/Command/Server","collapsable":true,"children":["ZM/Command/Server/ServerCommand","ZM/Command/Server/ServerStartCommand"]},{"title":"ZM/Config","collapsable":true,"children":["ZM/Config/ZMConfig"]},{"title":"ZM/Container","collapsable":true,"children":["ZM/Container/Container","ZM/Container/BoundMethod","ZM/Container/ContainerServicesProvider","ZM/Container/WorkerContainer"]},{"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/WorkerEventListener","ZM/Event/Listener/ManagerEventListener","ZM/Event/Listener/MasterEventListener","ZM/Event/Listener/SignalListener","ZM/Event/Listener/HttpEventListener"]},{"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/Lock","collapsable":true,"children":["ZM/Store/Lock/FileLock"]},{"title":"ZM/Store/MySQL","collapsable":true,"children":["ZM/Store/MySQL/MySQLConnection","ZM/Store/MySQL/MySQLStatement","ZM/Store/MySQL/MySQLQueryBuilder","ZM/Store/MySQL/MySQLStatementWrapper","ZM/Store/MySQL/MySQLPool","ZM/Store/MySQL/MySQLWrapper"]},{"title":"ZM/Utils","collapsable":true,"children":["ZM/Utils/ReflectionUtil","ZM/Utils/HttpUtil","ZM/Utils/ZMUtil"]}] \ No newline at end of file diff --git a/docs/api/ZM/Annotation/AnnotationBase.md b/docs/api/ZM/Annotation/AnnotationBase.md index 1f51700a..c232b507 100644 --- a/docs/api/ZM/Annotation/AnnotationBase.md +++ b/docs/api/ZM/Annotation/AnnotationBase.md @@ -1 +1,23 @@ -# ZM\Annotation\AnnotationBase \ No newline at end of file +# 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 new file mode 100644 index 00000000..d08258db --- /dev/null +++ b/docs/api/ZM/Annotation/AnnotationHandler.md @@ -0,0 +1,174 @@ +# 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 new file mode 100644 index 00000000..20740566 --- /dev/null +++ b/docs/api/ZM/Annotation/AnnotationMap.md @@ -0,0 +1,23 @@ +# ZM\Annotation\AnnotationMap + +## loadAnnotationByParser + +```php +public function loadAnnotationByParser(ZM\Annotation\AnnotationParser $parser): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| parser | ZM\Annotation\AnnotationParser | | + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/Annotation/AnnotationParser.md b/docs/api/ZM/Annotation/AnnotationParser.md index 9485d01e..3639ee9d 100644 --- a/docs/api/ZM/Annotation/AnnotationParser.md +++ b/docs/api/ZM/Annotation/AnnotationParser.md @@ -3,12 +3,18 @@ ## __construct ```php -public function __construct(): mixed +public function __construct(bool $with_internal_parsers): mixed ``` ### 描述 -AnnotationParser constructor. +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| with_internal_parsers | bool | | ### 返回 @@ -17,15 +23,22 @@ AnnotationParser constructor. | mixed | | -## registerMods +## addSpecialParser ```php -public function registerMods(): mixed +public function addSpecialParser(string $class_name, callable $callback): mixed ``` ### 描述 -注册各个模块类的注解和模块level的排序 +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| class_name | string | | +| callback | callable | | ### 返回 @@ -34,6 +47,40 @@ public function registerMods(): mixed | mixed | | +## parseAll + +```php +public function parseAll(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## generateAnnotationList + +```php +public function generateAnnotationList(): array +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array | | + + ## addRegisterPath ```php @@ -48,8 +95,8 @@ public function addRegisterPath(string $path, string $indoor_name): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| path | string | 注册解析注解的路径 | -| indoor_name | string | 起始命名空间的名称 | +| path | string | | +| indoor_name | string | | ### 返回 @@ -72,9 +119,9 @@ public function sortByLevel(array $events, string $class_name, string $prefix): | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| events | array | 需要排序的 | -| class_name | string | 排序的类名 | -| prefix | string | 前缀 | +| events | array | | +| class_name | string | | +| prefix | string | | ### 返回 @@ -83,10 +130,10 @@ public function sortByLevel(array $events, string $class_name, string $prefix): | mixed | | -## verifyMiddlewares +## getUsedTime ```php -public function verifyMiddlewares(): mixed +public function getUsedTime(): float ``` ### 描述 @@ -95,6 +142,46 @@ public function verifyMiddlewares(): mixed ### 返回 +| 类型 | 描述 | +| ---- | ----------- | +| float | | + + +## getAnnotationMap + +```php +public function getAnnotationMap(): array +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array | | + + +## addRouteAnnotation + +```php +public function addRouteAnnotation(ZM\Annotation\Http\Route $vss): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| vss | ZM\Annotation\Http\Route | | + +### 返回 + | 类型 | 描述 | | ---- | ----------- | | mixed | | diff --git a/docs/api/ZM/Command/BuildCommand.md b/docs/api/ZM/Command/BuildCommand.md index 47d94c6d..f41b9687 100644 --- a/docs/api/ZM/Command/BuildCommand.md +++ b/docs/api/ZM/Command/BuildCommand.md @@ -1 +1,17 @@ -# ZM\Command\BuildCommand \ No newline at end of file +# ZM\Command\BuildCommand + +## configure + +```php +public function configure(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/Config/ZMConfig.md b/docs/api/ZM/Config/ZMConfig.md index c26cf7b7..fc17f475 100644 --- a/docs/api/ZM/Config/ZMConfig.md +++ b/docs/api/ZM/Config/ZMConfig.md @@ -20,7 +20,7 @@ public function restoreDirectory(): mixed ## get ```php -public function get(mixed $additional_key, string $name): null|array|false|mixed +public function get(string $name, mixed $additional_key): mixed ``` ### 描述 @@ -31,20 +31,44 @@ public function get(mixed $additional_key, string $name): null|array|false|mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| additional_key | mixed | | | name | string | | +| additional_key | mixed | | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| null|array|false|mixed | | +| mixed | | + + +## smartPatch + +```php +public function smartPatch(mixed $data, mixed $patch): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| data | mixed | | +| patch | mixed | | + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | ## loadConfig ```php -public function loadConfig(string $name): array|int|string +public function loadConfig(string $name): mixed ``` ### 描述 @@ -61,7 +85,7 @@ public function loadConfig(string $name): array|int|string | 类型 | 描述 | | ---- | ----------- | -| array|int|string | | +| mixed | | ## parseList @@ -72,7 +96,7 @@ public function parseList(string $name): void ### 描述 -通过名称将所有该名称的配置文件路径和信息读取到列表中 +作者很懒，什么也没有说 ### 参数 @@ -90,7 +114,7 @@ public function parseList(string $name): void ## readConfigFromFile ```php -public function readConfigFromFile(mixed $filename, mixed $ext_name): mixed +public function readConfigFromFile(mixed $filename, mixed $ext_name): array ``` ### 描述 @@ -108,4 +132,4 @@ public function readConfigFromFile(mixed $filename, mixed $ext_name): mixed | 类型 | 描述 | | ---- | ----------- | -| mixed | | +| array | | diff --git a/docs/api/ZM/ConsoleApplication.md b/docs/api/ZM/ConsoleApplication.md index 011ac0c3..4d9a7a22 100644 --- a/docs/api/ZM/ConsoleApplication.md +++ b/docs/api/ZM/ConsoleApplication.md @@ -23,10 +23,10 @@ public function __construct(string $name): mixed | mixed | | -## initEnv +## run ```php -public function initEnv(string $with_default_cmd): ZM\ConsoleApplication +public function run(Symfony\Component\Console\Input\InputInterface $input, Symfony\Component\Console\Output\OutputInterface $output): int ``` ### 描述 @@ -37,10 +37,11 @@ public function initEnv(string $with_default_cmd): ZM\ConsoleApplication | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| with_default_cmd | string | | +| input | Symfony\Component\Console\Input\InputInterface | | +| output | Symfony\Component\Console\Output\OutputInterface | | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| ZM\ConsoleApplication | | +| int | | diff --git a/docs/api/ZM/Container/BoundMethod.md b/docs/api/ZM/Container/BoundMethod.md index 65fd63ba..29657ed8 100644 --- a/docs/api/ZM/Container/BoundMethod.md +++ b/docs/api/ZM/Container/BoundMethod.md @@ -3,19 +3,19 @@ ## call ```php -public function call(Container $container, callable|string $callback, array $parameters, string $default_method): mixed +public function call(ZM\Container\ContainerInterface $container, mixed $callback, array $parameters, string $default_method): mixed ``` ### 描述 -调用指定闭包、类方法并注入依赖 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| container | Container | | -| callback | callable|string | | +| container | ZM\Container\ContainerInterface | | +| callback | mixed | | | parameters | array | | | default_method | string | | @@ -29,19 +29,19 @@ public function call(Container $container, callable|string $callback, array $par ## getMethodDependencies ```php -public function getMethodDependencies(callable|string $callback, ZM\Container\ContainerInterface $container, array $parameters): array +public function getMethodDependencies(ZM\Container\ContainerInterface $container, mixed $callback, array $parameters): array ``` ### 描述 -Get all dependencies for a given method. +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| callback | callable|string | | | container | ZM\Container\ContainerInterface | | +| callback | mixed | | | parameters | array | | ### 返回 @@ -59,7 +59,7 @@ public function addDependencyForCallParameter(ZM\Container\ContainerInterface $c ### 描述 -Get the dependency for the given call parameter. +作者很懒，什么也没有说 ### 参数 diff --git a/docs/api/ZM/Container/Container.md b/docs/api/ZM/Container/Container.md index 24c40eb9..210723b7 100644 --- a/docs/api/ZM/Container/Container.md +++ b/docs/api/ZM/Container/Container.md @@ -8,7 +8,7 @@ public function getParent(): ZM\Container\ContainerInterface ### 描述 -获取父容器 +作者很懒，什么也没有说 ### 返回 @@ -25,16 +25,13 @@ public function has(string $id): bool ### 描述 -Returns true if the container can return an entry for the given identifier. -Returns false otherwise. -`has($id)` returning true does not mean that `get($id)` will not throw an exception. -It does however mean that `get($id)` will not throw a `NotFoundExceptionInterface`. +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| id | string | identifier of the entry to look for | +| id | string | | ### 返回 @@ -46,42 +43,48 @@ It does however mean that `get($id)` will not throw a `NotFoundExceptionInterfac ## make ```php -public function make(class-string $abstract, array $parameters): Closure|mixed|T +public function make(string $abstract, array $parameters): mixed ``` ### 描述 -获取一个绑定的实例 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | class-string | 类或接口名 | -| parameters | array | 参数 | +| abstract | string | | +| parameters | array | | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| Closure|mixed|T | 实例 | +| mixed | | ## getInstance ```php -public function getInstance(): static +public function getInstance(mixed $args): object ``` ### 描述 -获取类实例 +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| args | mixed | | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| static | | +| object | | ## bound @@ -92,13 +95,13 @@ public function bound(string $abstract): bool ### 描述 -判断对应的类或接口是否已经注册 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | string | 类或接口名 | +| abstract | string | | ### 返回 @@ -115,19 +118,19 @@ public function getAlias(string $abstract): string ### 描述 -获取类别名（如存在） +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | string | 类或接口名 | +| abstract | string | | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| string | 别名，不存在时返回传入的类或接口名 | +| string | | ## alias @@ -138,14 +141,14 @@ public function alias(string $abstract, string $alias): void ### 描述 -注册一个类别名 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | string | 类或接口名 | -| alias | string | 别名 | +| abstract | string | | +| alias | string | | ### 返回 @@ -157,20 +160,20 @@ public function alias(string $abstract, string $alias): void ## bind ```php -public function bind(string $abstract, null|Closure|string $concrete, bool $shared): void +public function bind(string $abstract, mixed $concrete, bool $shared): void ``` ### 描述 -注册绑定 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | string | 类或接口名 | -| concrete | null|Closure|string | 返回类实例的闭包，或是类名 | -| shared | bool | 是否共享 | +| abstract | string | | +| concrete | mixed | | +| shared | bool | | ### 返回 @@ -182,21 +185,20 @@ public function bind(string $abstract, null|Closure|string $concrete, bool $shar ## bindIf ```php -public function bindIf(string $abstract, null|Closure|string $concrete, bool $shared): void +public function bindIf(string $abstract, mixed $concrete, bool $shared): void ``` ### 描述 -注册绑定 -在已经绑定时不会重复注册 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | string | 类或接口名 | -| concrete | null|Closure|string | 返回类实例的闭包，或是类名 | -| shared | bool | 是否共享 | +| abstract | string | | +| concrete | mixed | | +| shared | bool | | ### 返回 @@ -208,19 +210,19 @@ public function bindIf(string $abstract, null|Closure|string $concrete, bool $sh ## singleton ```php -public function singleton(string $abstract, null|Closure|string $concrete): void +public function singleton(string $abstract, mixed $concrete): void ``` ### 描述 -注册一个单例绑定 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | string | 类或接口名 | -| concrete | null|Closure|string | 返回类实例的闭包，或是类名 | +| abstract | string | | +| concrete | mixed | | ### 返回 @@ -232,20 +234,19 @@ public function singleton(string $abstract, null|Closure|string $concrete): void ## singletonIf ```php -public function singletonIf(string $abstract, null|Closure|string $concrete): void +public function singletonIf(string $abstract, mixed $concrete): void ``` ### 描述 -注册一个单例绑定 -在已经绑定时不会重复注册 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | string | 类或接口名 | -| concrete | null|Closure|string | 返回类实例的闭包，或是类名 | +| abstract | string | | +| concrete | mixed | | ### 返回 @@ -262,14 +263,14 @@ public function instance(string $abstract, mixed $instance): mixed ### 描述 -注册一个已有的实例，效果等同于单例绑定 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | string | 类或接口名 | -| instance | mixed | 实例 | +| abstract | string | | +| instance | mixed | | ### 返回 @@ -286,13 +287,13 @@ public function factory(string $abstract): Closure ### 描述 -获取一个解析对应类实例的闭包 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | string | 类或接口名 | +| abstract | string | | ### 返回 @@ -309,7 +310,7 @@ public function flush(): void ### 描述 -清除所有绑定和实例 +作者很懒，什么也没有说 ### 返回 @@ -321,42 +322,42 @@ public function flush(): void ## traitMake ```php -public function traitMake(class-string $abstract, array $parameters): Closure|mixed|T +public function traitMake(string $abstract, array $parameters): mixed ``` ### 描述 -获取一个绑定的实例 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | class-string | 类或接口名 | -| parameters | array | 参数 | +| abstract | string | | +| parameters | array | | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| Closure|mixed|T | 实例 | +| mixed | | ## build ```php -public function build(Closure|string $concrete): mixed +public function build(mixed $concrete): mixed ``` ### 描述 -实例化具体的类实例 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| concrete | Closure|string | 类名或对应的闭包 | +| concrete | mixed | | ### 返回 @@ -368,20 +369,20 @@ public function build(Closure|string $concrete): mixed ## call ```php -public function call(callable|string $callback, array $parameters, null|string $default_method): mixed +public function call(mixed $callback, array $parameters, string $default_method): mixed ``` ### 描述 -调用对应的方法，并自动注入依赖 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| callback | callable|string | 对应的方法 | -| parameters | array | 参数 | -| default_method | null|string | 默认方法 | +| callback | mixed | | +| parameters | array | | +| default_method | string | | ### 返回 @@ -398,19 +399,19 @@ public function get(string $id): mixed ### 描述 -Finds an entry of the container by its identifier and returns it. +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| id | string | identifier of the entry to look for * | +| id | string | | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| mixed | entry | +| mixed | | ## extend @@ -421,14 +422,14 @@ public function extend(string $abstract, Closure $closure): void ### 描述 -扩展一个类或接口 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | string | 类或接口名 | -| closure | Closure | 扩展闭包 | +| abstract | string | | +| closure | Closure | | ### 返回 @@ -445,7 +446,7 @@ public function getLogPrefix(): string ### 描述 -获取日志前缀 +作者很懒，什么也没有说 ### 返回 @@ -462,7 +463,7 @@ public function setLogPrefix(string $prefix): void ### 描述 -设置日志前缀 +作者很懒，什么也没有说 ### 参数 @@ -480,24 +481,24 @@ public function setLogPrefix(string $prefix): void ## getExtenders ```php -public function getExtenders(string $abstract): Closure[] +public function getExtenders(string $abstract): array ``` ### 描述 -获取对应类型的所有扩展器 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | string | 类或接口名 | +| abstract | string | | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| Closure[] | | +| array | | ## isAlias @@ -508,7 +509,7 @@ public function isAlias(string $name): bool ### 描述 -判断传入的是否为别名 +作者很懒，什么也没有说 ### 参数 @@ -531,13 +532,13 @@ public function dropStaleInstances(string $abstract): void ### 描述 -抛弃所有过时的实例和别名 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | string | 类或接口名 | +| abstract | string | | ### 返回 @@ -554,14 +555,14 @@ public function getClosure(string $abstract, string $concrete): Closure ### 描述 -获取一个解析对应类的闭包 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | string | 类或接口名 | -| concrete | string | 实际类名 | +| abstract | string | | +| concrete | string | | ### 返回 @@ -578,7 +579,7 @@ public function getLastParameterOverride(): array ### 描述 -获取最后一次的覆盖参数 +作者很懒，什么也没有说 ### 返回 @@ -595,7 +596,7 @@ public function notInstantiable(string $concrete, string $reason): void ### 描述 -抛出实例化异常 +作者很懒，什么也没有说 ### 参数 @@ -614,18 +615,18 @@ public function notInstantiable(string $concrete, string $reason): void ## resolveDependencies ```php -public function resolveDependencies(ReflectionParameter[] $dependencies): array +public function resolveDependencies(array $dependencies): array ``` ### 描述 -解析依赖 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| dependencies | ReflectionParameter[] | | +| dependencies | array | | ### 返回 @@ -642,7 +643,7 @@ public function hasParameterOverride(ReflectionParameter $parameter): bool ### 描述 -判断传入的参数是否存在覆盖参数 +作者很懒，什么也没有说 ### 参数 @@ -665,7 +666,7 @@ public function getParameterOverride(ReflectionParameter $parameter): mixed ### 描述 -获取覆盖参数 +作者很懒，什么也没有说 ### 参数 @@ -688,7 +689,7 @@ public function hasParameterTypeOverride(ReflectionParameter $parameter): bool ### 描述 -判断传入的参数是否存在临时注入的参数 +作者很懒，什么也没有说 ### 参数 @@ -711,7 +712,7 @@ public function getParameterTypeOverride(ReflectionParameter $parameter): mixed ### 描述 -获取临时注入的参数 +作者很懒，什么也没有说 ### 参数 @@ -734,7 +735,7 @@ public function resolvePrimitive(ReflectionParameter $parameter): mixed ### 描述 -解析基本类型 +作者很懒，什么也没有说 ### 参数 @@ -746,7 +747,7 @@ public function resolvePrimitive(ReflectionParameter $parameter): mixed | 类型 | 描述 | | ---- | ----------- | -| mixed | 对应类型的默认值 | +| mixed | | ## resolveClass @@ -757,7 +758,7 @@ public function resolveClass(ReflectionParameter $parameter): mixed ### 描述 -解析类 +作者很懒，什么也没有说 ### 参数 @@ -775,24 +776,24 @@ public function resolveClass(ReflectionParameter $parameter): mixed ## getConcrete ```php -public function getConcrete(string $abstract): Closure|string +public function getConcrete(string $abstract): mixed ``` ### 描述 -获取类名的实际类型 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | string | 类或接口名 | +| abstract | string | | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| Closure|string | | +| mixed | | ## isBuildable @@ -803,14 +804,14 @@ public function isBuildable(mixed $concrete, string $abstract): bool ### 描述 -判断传入的实际类型是否可以构造 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| concrete | mixed | 实际类型 | -| abstract | string | 类或接口名 | +| concrete | mixed | | +| abstract | string | | ### 返回 @@ -827,13 +828,13 @@ public function isShared(string $abstract): bool ### 描述 -判断传入的类型是否为共享实例 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | string | 类或接口名 | +| abstract | string | | ### 返回 @@ -850,7 +851,7 @@ public function shouldLog(): bool ### 描述 -判断是否输出日志 +作者很懒，什么也没有说 ### 返回 @@ -867,7 +868,7 @@ public function log(string $message): void ### 描述 -记录日志（自动附加容器日志前缀） +作者很懒，什么也没有说 ### 参数 diff --git a/docs/api/ZM/Container/ContainerServicesProvider.md b/docs/api/ZM/Container/ContainerServicesProvider.md index 65ab59c4..e1997751 100644 --- a/docs/api/ZM/Container/ContainerServicesProvider.md +++ b/docs/api/ZM/Container/ContainerServicesProvider.md @@ -3,25 +3,19 @@ ## registerServices ```php -public function registerServices(string $scope): void +public function registerServices(string $scope, mixed $params): void ``` ### 描述 -注册服务 -``` -作用域： -global: worker start -request: request -message: message -connection: open, close, message -``` +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| scope | string | 作用域 | +| scope | string | | +| params | mixed | | ### 返回 @@ -38,7 +32,7 @@ public function cleanup(): void ### 描述 -清理服务 +作者很懒，什么也没有说 ### 返回 @@ -55,7 +49,7 @@ public function registerGlobalServices(ZM\Container\ContainerInterface $containe ### 描述 -注册全局服务 +作者很懒，什么也没有说 ### 参数 @@ -73,18 +67,19 @@ public function registerGlobalServices(ZM\Container\ContainerInterface $containe ## registerRequestServices ```php -public function registerRequestServices(ZM\Container\ContainerInterface $container): void +public function registerRequestServices(ZM\Container\ContainerInterface $container, OneBot\Driver\Event\Http\HttpRequestEvent $event): void ``` ### 描述 -注册请求服务（HTTP请求） +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | container | ZM\Container\ContainerInterface | | +| event | OneBot\Driver\Event\Http\HttpRequestEvent | | ### 返回 @@ -101,7 +96,7 @@ public function registerMessageServices(ZM\Container\ContainerInterface $contain ### 描述 -注册消息服务（WS消息） +作者很懒，什么也没有说 ### 参数 @@ -124,7 +119,7 @@ public function registerConnectionServices(ZM\Container\ContainerInterface $cont ### 描述 -注册链接服务 +作者很懒，什么也没有说 ### 参数 diff --git a/docs/api/ZM/Container/WorkerContainer.md b/docs/api/ZM/Container/WorkerContainer.md index a9a91c06..b0218b1d 100644 --- a/docs/api/ZM/Container/WorkerContainer.md +++ b/docs/api/ZM/Container/WorkerContainer.md @@ -3,18 +3,24 @@ ## getInstance ```php -public function getInstance(): static +public function getInstance(mixed $args): object ``` ### 描述 -获取类实例 +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| args | mixed | | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| static | | +| object | | ## bound @@ -25,13 +31,13 @@ public function bound(string $abstract): bool ### 描述 -判断对应的类或接口是否已经注册 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | string | 类或接口名 | +| abstract | string | | ### 返回 @@ -48,19 +54,19 @@ public function getAlias(string $abstract): string ### 描述 -获取类别名（如存在） +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | string | 类或接口名 | +| abstract | string | | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| string | 别名，不存在时返回传入的类或接口名 | +| string | | ## alias @@ -71,14 +77,14 @@ public function alias(string $abstract, string $alias): void ### 描述 -注册一个类别名 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | string | 类或接口名 | -| alias | string | 别名 | +| abstract | string | | +| alias | string | | ### 返回 @@ -90,20 +96,20 @@ public function alias(string $abstract, string $alias): void ## bind ```php -public function bind(string $abstract, null|Closure|string $concrete, bool $shared): void +public function bind(string $abstract, mixed $concrete, bool $shared): void ``` ### 描述 -注册绑定 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | string | 类或接口名 | -| concrete | null|Closure|string | 返回类实例的闭包，或是类名 | -| shared | bool | 是否共享 | +| abstract | string | | +| concrete | mixed | | +| shared | bool | | ### 返回 @@ -115,21 +121,20 @@ public function bind(string $abstract, null|Closure|string $concrete, bool $shar ## bindIf ```php -public function bindIf(string $abstract, null|Closure|string $concrete, bool $shared): void +public function bindIf(string $abstract, mixed $concrete, bool $shared): void ``` ### 描述 -注册绑定 -在已经绑定时不会重复注册 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | string | 类或接口名 | -| concrete | null|Closure|string | 返回类实例的闭包，或是类名 | -| shared | bool | 是否共享 | +| abstract | string | | +| concrete | mixed | | +| shared | bool | | ### 返回 @@ -141,19 +146,19 @@ public function bindIf(string $abstract, null|Closure|string $concrete, bool $sh ## singleton ```php -public function singleton(string $abstract, null|Closure|string $concrete): void +public function singleton(string $abstract, mixed $concrete): void ``` ### 描述 -注册一个单例绑定 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | string | 类或接口名 | -| concrete | null|Closure|string | 返回类实例的闭包，或是类名 | +| abstract | string | | +| concrete | mixed | | ### 返回 @@ -165,20 +170,19 @@ public function singleton(string $abstract, null|Closure|string $concrete): void ## singletonIf ```php -public function singletonIf(string $abstract, null|Closure|string $concrete): void +public function singletonIf(string $abstract, mixed $concrete): void ``` ### 描述 -注册一个单例绑定 -在已经绑定时不会重复注册 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | string | 类或接口名 | -| concrete | null|Closure|string | 返回类实例的闭包，或是类名 | +| abstract | string | | +| concrete | mixed | | ### 返回 @@ -195,14 +199,14 @@ public function instance(string $abstract, mixed $instance): mixed ### 描述 -注册一个已有的实例，效果等同于单例绑定 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | string | 类或接口名 | -| instance | mixed | 实例 | +| abstract | string | | +| instance | mixed | | ### 返回 @@ -219,13 +223,13 @@ public function factory(string $abstract): Closure ### 描述 -获取一个解析对应类实例的闭包 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | string | 类或接口名 | +| abstract | string | | ### 返回 @@ -242,7 +246,7 @@ public function flush(): void ### 描述 -清除所有绑定和实例 +作者很懒，什么也没有说 ### 返回 @@ -254,42 +258,42 @@ public function flush(): void ## make ```php -public function make(class-string $abstract, array $parameters): Closure|mixed|T +public function make(string $abstract, array $parameters): mixed ``` ### 描述 -获取一个绑定的实例 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | class-string | 类或接口名 | -| parameters | array | 参数 | +| abstract | string | | +| parameters | array | | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| Closure|mixed|T | 实例 | +| mixed | | ## build ```php -public function build(Closure|string $concrete): mixed +public function build(mixed $concrete): mixed ``` ### 描述 -实例化具体的类实例 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| concrete | Closure|string | 类名或对应的闭包 | +| concrete | mixed | | ### 返回 @@ -301,20 +305,20 @@ public function build(Closure|string $concrete): mixed ## call ```php -public function call(callable|string $callback, array $parameters, null|string $default_method): mixed +public function call(mixed $callback, array $parameters, string $default_method): mixed ``` ### 描述 -调用对应的方法，并自动注入依赖 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| callback | callable|string | 对应的方法 | -| parameters | array | 参数 | -| default_method | null|string | 默认方法 | +| callback | mixed | | +| parameters | array | | +| default_method | string | | ### 返回 @@ -331,19 +335,19 @@ public function get(string $id): mixed ### 描述 -Finds an entry of the container by its identifier and returns it. +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| id | string | identifier of the entry to look for * | +| id | string | | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| mixed | entry | +| mixed | | ## has @@ -354,16 +358,13 @@ public function has(string $id): bool ### 描述 -Returns true if the container can return an entry for the given identifier. -Returns false otherwise. -`has($id)` returning true does not mean that `get($id)` will not throw an exception. -It does however mean that `get($id)` will not throw a `NotFoundExceptionInterface`. +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| id | string | identifier of the entry to look for | +| id | string | | ### 返回 @@ -380,14 +381,14 @@ public function extend(string $abstract, Closure $closure): void ### 描述 -扩展一个类或接口 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | string | 类或接口名 | -| closure | Closure | 扩展闭包 | +| abstract | string | | +| closure | Closure | | ### 返回 @@ -404,7 +405,7 @@ public function getLogPrefix(): string ### 描述 -获取日志前缀 +作者很懒，什么也没有说 ### 返回 @@ -421,7 +422,7 @@ public function setLogPrefix(string $prefix): void ### 描述 -设置日志前缀 +作者很懒，什么也没有说 ### 参数 @@ -439,24 +440,24 @@ public function setLogPrefix(string $prefix): void ## getExtenders ```php -public function getExtenders(string $abstract): Closure[] +public function getExtenders(string $abstract): array ``` ### 描述 -获取对应类型的所有扩展器 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | string | 类或接口名 | +| abstract | string | | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| Closure[] | | +| array | | ## isAlias @@ -467,7 +468,7 @@ public function isAlias(string $name): bool ### 描述 -判断传入的是否为别名 +作者很懒，什么也没有说 ### 参数 @@ -490,13 +491,13 @@ public function dropStaleInstances(string $abstract): void ### 描述 -抛弃所有过时的实例和别名 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | string | 类或接口名 | +| abstract | string | | ### 返回 @@ -513,14 +514,14 @@ public function getClosure(string $abstract, string $concrete): Closure ### 描述 -获取一个解析对应类的闭包 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | string | 类或接口名 | -| concrete | string | 实际类名 | +| abstract | string | | +| concrete | string | | ### 返回 @@ -537,7 +538,7 @@ public function getLastParameterOverride(): array ### 描述 -获取最后一次的覆盖参数 +作者很懒，什么也没有说 ### 返回 @@ -554,7 +555,7 @@ public function notInstantiable(string $concrete, string $reason): void ### 描述 -抛出实例化异常 +作者很懒，什么也没有说 ### 参数 @@ -573,18 +574,18 @@ public function notInstantiable(string $concrete, string $reason): void ## resolveDependencies ```php -public function resolveDependencies(ReflectionParameter[] $dependencies): array +public function resolveDependencies(array $dependencies): array ``` ### 描述 -解析依赖 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| dependencies | ReflectionParameter[] | | +| dependencies | array | | ### 返回 @@ -601,7 +602,7 @@ public function hasParameterOverride(ReflectionParameter $parameter): bool ### 描述 -判断传入的参数是否存在覆盖参数 +作者很懒，什么也没有说 ### 参数 @@ -624,7 +625,7 @@ public function getParameterOverride(ReflectionParameter $parameter): mixed ### 描述 -获取覆盖参数 +作者很懒，什么也没有说 ### 参数 @@ -647,7 +648,7 @@ public function hasParameterTypeOverride(ReflectionParameter $parameter): bool ### 描述 -判断传入的参数是否存在临时注入的参数 +作者很懒，什么也没有说 ### 参数 @@ -670,7 +671,7 @@ public function getParameterTypeOverride(ReflectionParameter $parameter): mixed ### 描述 -获取临时注入的参数 +作者很懒，什么也没有说 ### 参数 @@ -693,7 +694,7 @@ public function resolvePrimitive(ReflectionParameter $parameter): mixed ### 描述 -解析基本类型 +作者很懒，什么也没有说 ### 参数 @@ -705,7 +706,7 @@ public function resolvePrimitive(ReflectionParameter $parameter): mixed | 类型 | 描述 | | ---- | ----------- | -| mixed | 对应类型的默认值 | +| mixed | | ## resolveClass @@ -716,7 +717,7 @@ public function resolveClass(ReflectionParameter $parameter): mixed ### 描述 -解析类 +作者很懒，什么也没有说 ### 参数 @@ -734,24 +735,24 @@ public function resolveClass(ReflectionParameter $parameter): mixed ## getConcrete ```php -public function getConcrete(string $abstract): Closure|string +public function getConcrete(string $abstract): mixed ``` ### 描述 -获取类名的实际类型 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | string | 类或接口名 | +| abstract | string | | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| Closure|string | | +| mixed | | ## isBuildable @@ -762,14 +763,14 @@ public function isBuildable(mixed $concrete, string $abstract): bool ### 描述 -判断传入的实际类型是否可以构造 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| concrete | mixed | 实际类型 | -| abstract | string | 类或接口名 | +| concrete | mixed | | +| abstract | string | | ### 返回 @@ -786,13 +787,13 @@ public function isShared(string $abstract): bool ### 描述 -判断传入的类型是否为共享实例 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| abstract | string | 类或接口名 | +| abstract | string | | ### 返回 @@ -809,7 +810,7 @@ public function shouldLog(): bool ### 描述 -判断是否输出日志 +作者很懒，什么也没有说 ### 返回 @@ -826,7 +827,7 @@ public function log(string $message): void ### 描述 -记录日志（自动附加容器日志前缀） +作者很懒，什么也没有说 ### 参数 diff --git a/docs/api/ZM/Context/Context.md b/docs/api/ZM/Context/Context.md index 3715fdf9..e75fd146 100644 --- a/docs/api/ZM/Context/Context.md +++ b/docs/api/ZM/Context/Context.md @@ -1,9 +1,9 @@ # ZM\Context\Context -## getServer +## getRequest ```php -public function getServer(): Server +public function getRequest(): Psr\Http\Message\ServerRequestInterface ``` ### 描述 @@ -14,13 +14,13 @@ public function getServer(): Server | 类型 | 描述 | | ---- | ----------- | -| Server | | +| Psr\Http\Message\ServerRequestInterface | | -## getData +## getHttpRequestEvent ```php -public function getData(): mixed +public function getHttpRequestEvent(): OneBot\Driver\Event\Http\HttpRequestEvent ``` ### 描述 @@ -29,189 +29,29 @@ public function getData(): mixed ### 返回 +| 类型 | 描述 | +| ---- | ----------- | +| OneBot\Driver\Event\Http\HttpRequestEvent | | + + +## withResponse + +```php +public function withResponse(Psr\Http\Message\ResponseInterface $response): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| response | Psr\Http\Message\ResponseInterface | | + +### 返回 + | 类型 | 描述 | | ---- | ----------- | | mixed | | - - -## reply - -```php -public function reply(array|string $msg, bool|callable|Closure $yield): array|bool -``` - -### 描述 - -only can used by cq->message event function - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| msg | array|string | 要回复的消息 | -| yield | bool|callable|Closure | 是否协程挂起（true），是否绑定异步事件（Closure） | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | 返回API调用结果 | - - -## finalReply - -```php -public function finalReply(array|string $msg, bool $yield): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| msg | array|string | 要回复的消息 | -| yield | bool | 是否协程挂起（true），是否绑定异步事件（Closure） | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## waitMessage - -```php -public function waitMessage(string $prompt, int $timeout, string $timeout_prompt): string -``` - -### 描述 - -作者很懒，什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| prompt | string | | -| timeout | int | | -| timeout_prompt | string | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string | 返回用户输入的内容 | - - -## getArgs - -```php -public function getArgs(int|string $mode, string|Stringable $prompt_msg): float|int|string -``` - -### 描述 - -根据选定的模式获取消息参数 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| mode | int|string | 获取的模式 | -| prompt_msg | string|Stringable | 提示语回复 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| float|int|string | | - - -## getNextArg - -```php -public function getNextArg(string $prompt_msg): int|mixed|string -``` - -### 描述 - -获取下一个参数 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| prompt_msg | string | 提示语回复 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int|mixed|string | 返回获取的参数 | - - -## getFullArg - -```php -public function getFullArg(string $prompt_msg): int|mixed|string -``` - -### 描述 - -获取接下来所有的消息当成一个完整的参数（包含空格） - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| prompt_msg | string | 提示语回复 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int|mixed|string | 返回获取的参数 | - - -## getNumArg - -```php -public function getNumArg(string $prompt_msg): int|mixed|string -``` - -### 描述 - -获取下一个数字类型的参数 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| prompt_msg | string | 提示语回复 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int|mixed|string | 返回获取的参数 | - - -## cloneFromParent - -```php -public function cloneFromParent(): ContextInterface -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| ContextInterface | 返回上下文 | diff --git a/docs/api/ZM/Event/EventDispatcher.md b/docs/api/ZM/Event/EventDispatcher.md index 42e1057a..bfd97cfd 100644 --- a/docs/api/ZM/Event/EventDispatcher.md +++ b/docs/api/ZM/Event/EventDispatcher.md @@ -1,9 +1,9 @@ # ZM\Event\EventDispatcher -## interrupt +## getInstance ```php -public function interrupt(mixed $return_var): mixed +public function getInstance(mixed $args): object ``` ### 描述 @@ -14,10 +14,10 @@ public function interrupt(mixed $return_var): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| return_var | mixed | | +| args | mixed | | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| mixed | | +| object | | diff --git a/docs/api/ZM/Event/EventProvider.md b/docs/api/ZM/Event/EventProvider.md new file mode 100644 index 00000000..30df86f8 --- /dev/null +++ b/docs/api/ZM/Event/EventProvider.md @@ -0,0 +1,117 @@ +# 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/Listener/HttpEventListener.md b/docs/api/ZM/Event/Listener/HttpEventListener.md new file mode 100644 index 00000000..996924ae --- /dev/null +++ b/docs/api/ZM/Event/Listener/HttpEventListener.md @@ -0,0 +1,69 @@ +# 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): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| event | OneBot\Driver\Event\Http\HttpRequestEvent | | + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## 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 new file mode 100644 index 00000000..b3e725f4 --- /dev/null +++ b/docs/api/ZM/Event/Listener/ManagerEventListener.md @@ -0,0 +1,57 @@ +# 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 new file mode 100644 index 00000000..a4123e88 --- /dev/null +++ b/docs/api/ZM/Event/Listener/MasterEventListener.md @@ -0,0 +1,40 @@ +# 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 new file mode 100644 index 00000000..9402e642 --- /dev/null +++ b/docs/api/ZM/Event/Listener/SignalListener.md @@ -0,0 +1,57 @@ +# 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/WorkerEventListener.md b/docs/api/ZM/Event/Listener/WorkerEventListener.md new file mode 100644 index 00000000..591751a2 --- /dev/null +++ b/docs/api/ZM/Event/Listener/WorkerEventListener.md @@ -0,0 +1,108 @@ +# ZM\Event\Listener\WorkerEventListener + +## onWorkerStart999 + +```php +public function onWorkerStart999(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## onWorkerStop999 + +```php +public function onWorkerStop999(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## initUserPlugins + +```php +public function initUserPlugins(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## dispatchInit + +```php +public function dispatchInit(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## initConnectionPool + +```php +public function initConnectionPool(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## getInstance + +```php +public function getInstance(mixed $args): object +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| args | mixed | | + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| object | | diff --git a/docs/api/ZM/InstantApplication.md b/docs/api/ZM/InstantApplication.md new file mode 100644 index 00000000..d599ae12 --- /dev/null +++ b/docs/api/ZM/InstantApplication.md @@ -0,0 +1,40 @@ +# ZM\InstantApplication + +## __construct + +```php +public function __construct(mixed $dir): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| dir | mixed | | + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## run + +```php +public function run(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/Middleware/MiddlewareHandler.md b/docs/api/ZM/Middleware/MiddlewareHandler.md new file mode 100644 index 00000000..ef520550 --- /dev/null +++ b/docs/api/ZM/Middleware/MiddlewareHandler.md @@ -0,0 +1,112 @@ +# 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 new file mode 100644 index 00000000..a86a05b5 --- /dev/null +++ b/docs/api/ZM/Middleware/Pipeline.md @@ -0,0 +1,69 @@ +# 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/Process/ProcessStateManager.md b/docs/api/ZM/Process/ProcessStateManager.md new file mode 100644 index 00000000..53068f30 --- /dev/null +++ b/docs/api/ZM/Process/ProcessStateManager.md @@ -0,0 +1,73 @@ +# 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/FileSystem.md b/docs/api/ZM/Store/FileSystem.md new file mode 100644 index 00000000..4e459af1 --- /dev/null +++ b/docs/api/ZM/Store/FileSystem.md @@ -0,0 +1,115 @@ +# 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/Lock/FileLock.md b/docs/api/ZM/Store/Lock/FileLock.md new file mode 100644 index 00000000..273ae8d0 --- /dev/null +++ b/docs/api/ZM/Store/Lock/FileLock.md @@ -0,0 +1,46 @@ +# 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/MySQL/MySQLConnection.md b/docs/api/ZM/Store/MySQL/MySQLConnection.md new file mode 100644 index 00000000..a15960a8 --- /dev/null +++ b/docs/api/ZM/Store/MySQL/MySQLConnection.md @@ -0,0 +1,110 @@ +# 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 new file mode 100644 index 00000000..26b1656e --- /dev/null +++ b/docs/api/ZM/Store/MySQL/MySQLPool.md @@ -0,0 +1,104 @@ +# 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 new file mode 100644 index 00000000..22ab44ce --- /dev/null +++ b/docs/api/ZM/Store/MySQL/MySQLQueryBuilder.md @@ -0,0 +1,17 @@ +# 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 new file mode 100644 index 00000000..425db9c7 --- /dev/null +++ b/docs/api/ZM/Store/MySQL/MySQLStatement.md @@ -0,0 +1,17 @@ +# 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 new file mode 100644 index 00000000..d99f7e9d --- /dev/null +++ b/docs/api/ZM/Store/MySQL/MySQLStatementWrapper.md @@ -0,0 +1,289 @@ +# 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 new file mode 100644 index 00000000..d62bdbd1 --- /dev/null +++ b/docs/api/ZM/Store/MySQL/MySQLWrapper.md @@ -0,0 +1,936 @@ +# 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/Utils/HttpUtil.md b/docs/api/ZM/Utils/HttpUtil.md index b7a4802e..ecf1bb8f 100644 --- a/docs/api/ZM/Utils/HttpUtil.md +++ b/docs/api/ZM/Utils/HttpUtil.md @@ -3,7 +3,7 @@ ## parseUri ```php -public function parseUri(mixed $request, mixed $response, mixed $uri, mixed $node, mixed $params): mixed +public function parseUri(OneBot\Http\ServerRequest $request, mixed $node, mixed $params): int ``` ### 描述 @@ -14,9 +14,7 @@ public function parseUri(mixed $request, mixed $response, mixed $uri, mixed $nod | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| request | mixed | | -| response | mixed | | -| uri | mixed | | +| request | OneBot\Http\ServerRequest | | | node | mixed | | | params | mixed | | @@ -24,13 +22,13 @@ public function parseUri(mixed $request, mixed $response, mixed $uri, mixed $nod | 类型 | 描述 | | ---- | ----------- | -| mixed | | +| int | | ## handleStaticPage ```php -public function handleStaticPage(Response|\Swoole\Http\Response $response, string $uri, array $settings): bool +public function handleStaticPage(string $uri, array $settings): Psr\Http\Message\ResponseInterface ``` ### 描述 @@ -41,7 +39,6 @@ public function handleStaticPage(Response|\Swoole\Http\Response $response, strin | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| response | Response|\Swoole\Http\Response | | | uri | string | | | settings | array | | @@ -49,4 +46,52 @@ public function handleStaticPage(Response|\Swoole\Http\Response $response, strin | 类型 | 描述 | | ---- | ----------- | -| bool | | +| 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/ReflectionUtil.md b/docs/api/ZM/Utils/ReflectionUtil.md index 86a7c3bb..77d66402 100644 --- a/docs/api/ZM/Utils/ReflectionUtil.md +++ b/docs/api/ZM/Utils/ReflectionUtil.md @@ -3,24 +3,24 @@ ## getParameterClassName ```php -public function getParameterClassName(ReflectionParameter $parameter): null|string +public function getParameterClassName(ReflectionParameter $parameter): string ``` ### 描述 -获取参数的类名（如有） +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| parameter | ReflectionParameter | 参数 | +| parameter | ReflectionParameter | | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| null|string | 类名，如果参数不是类，返回 null | +| string | | ## variableToString @@ -31,7 +31,7 @@ public function variableToString(mixed $var): string ### 描述 -将传入变量转换为字符串 +作者很懒，什么也没有说 ### 参数 @@ -49,18 +49,18 @@ public function variableToString(mixed $var): string ## isNonStaticMethod ```php -public function isNonStaticMethod(callable|string $callback): bool +public function isNonStaticMethod(mixed $callback): bool ``` ### 描述 -判断传入的回调是否为任意类的非静态方法 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| callback | callable|string | 回调 | +| callback | mixed | | ### 返回 @@ -72,21 +72,18 @@ public function isNonStaticMethod(callable|string $callback): bool ## getCallReflector ```php -public function getCallReflector(callable|string $callback): ReflectionFunctionAbstract +public function getCallReflector(mixed $callback): ReflectionFunctionAbstract ``` ### 描述 -获取传入的回调的反射实例 -如果传入的是类方法，则会返回 {@link ReflectionMethod} 实例 -否则将返回 {@link ReflectionFunction} 实例 -可传入实现了 __invoke 的类 +作者很懒，什么也没有说 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| callback | callable|string | 回调 | +| callback | mixed | | ### 返回 diff --git a/docs/api/ZM/Utils/ZMUtil.md b/docs/api/ZM/Utils/ZMUtil.md index 2c7c12f3..9368ed89 100644 --- a/docs/api/ZM/Utils/ZMUtil.md +++ b/docs/api/ZM/Utils/ZMUtil.md @@ -1,9 +1,9 @@ # ZM\Utils\ZMUtil -## stop +## getComposerMetadata ```php -public function stop(mixed $error_exit): mixed +public function getComposerMetadata(string $path): array ``` ### 描述 @@ -14,70 +14,10 @@ public function stop(mixed $error_exit): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| error_exit | mixed | | +| path | string | | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| mixed | | - - -## reload - -```php -public function reload(): mixed -``` - -### 描述 - -作者很懒，什么也没有说 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## getReloadableFiles - -```php -public function getReloadableFiles(): string[]|string[][] -``` - -### 描述 - -在工作进程中返回可以通过reload重新加载的php文件列表 - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string[]|string[][] | | - - -## getClassesPsr4 - -```php -public function getClassesPsr4(string $dir, string $base_namespace, null|mixed $rule, bool|string $return_path_value): string[] -``` - -### 描述 - -使用Psr-4标准获取目录下的所有类 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| dir | string | 目录 | -| base_namespace | string | 基础命名空间 | -| rule | null|mixed | 规则 | -| return_path_value | bool|string | 是否返回文件路径，返回文件路径的话传入字符串 | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| string[] | | +| array | |