mirror of
https://github.com/zhamao-robot/zhamao-framework.git
synced 2026-07-21 23:55:35 +08:00
add api docs (#80)
This commit is contained in:
42
docs/api/ZM/Utils/Manager/CronManager.md
Normal file
42
docs/api/ZM/Utils/Manager/CronManager.md
Normal file
@@ -0,0 +1,42 @@
|
||||
# ZM\Utils\Manager\CronManager
|
||||
|
||||
## initCronTasks
|
||||
|
||||
```php
|
||||
public function initCronTasks(): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
初始化 Cron 注解
|
||||
必须在 WorkerStart 事件中调用
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
|
||||
|
||||
## startExecute
|
||||
|
||||
```php
|
||||
public function startExecute(ZM\Annotation\Cron\Cron $v, ZM\Event\EventDispatcher $dispatcher, Cron\CronExpression $cron): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| v | ZM\Annotation\Cron\Cron | |
|
||||
| dispatcher | ZM\Event\EventDispatcher | |
|
||||
| cron | Cron\CronExpression | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
62
docs/api/ZM/Utils/Manager/ModuleManager.md
Normal file
62
docs/api/ZM/Utils/Manager/ModuleManager.md
Normal file
@@ -0,0 +1,62 @@
|
||||
# ZM\Utils\Manager\ModuleManager
|
||||
|
||||
## getConfiguredModules
|
||||
|
||||
```php
|
||||
public function getConfiguredModules(): array
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
扫描src目录下的所有已经被标注的模块
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| array | |
|
||||
|
||||
|
||||
## packModule
|
||||
|
||||
```php
|
||||
public function packModule(mixed $module): bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
打包模块
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| module | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| bool | |
|
||||
|
||||
|
||||
## unpackModule
|
||||
|
||||
```php
|
||||
public function unpackModule(mixed $module, array $options): array|false
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
解包模块
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| module | mixed | |
|
||||
| options | array | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| array|false | |
|
||||
1
docs/api/ZM/Utils/Manager/ProcessManager.md
Normal file
1
docs/api/ZM/Utils/Manager/ProcessManager.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Utils\Manager\ProcessManager
|
||||
1
docs/api/ZM/Utils/Manager/RouteManager.md
Normal file
1
docs/api/ZM/Utils/Manager/RouteManager.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Utils\Manager\RouteManager
|
||||
1
docs/api/ZM/Utils/Manager/TaskManager.md
Normal file
1
docs/api/ZM/Utils/Manager/TaskManager.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Utils\Manager\TaskManager
|
||||
64
docs/api/ZM/Utils/Manager/WorkerManager.md
Normal file
64
docs/api/ZM/Utils/Manager/WorkerManager.md
Normal file
@@ -0,0 +1,64 @@
|
||||
# ZM\Utils\Manager\WorkerManager
|
||||
|
||||
## workerAction
|
||||
|
||||
```php
|
||||
public function workerAction(mixed $src_worker_id, mixed $data): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
Worker 进程间通信触发的动作类型函数
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| src_worker_id | mixed | |
|
||||
| data | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
|
||||
|
||||
## sendActionToWorker
|
||||
|
||||
```php
|
||||
public function sendActionToWorker(mixed $worker_id, mixed $action, mixed $data): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
给 Worker 进程发送动作指令(包括自身,自身将直接执行)
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| worker_id | mixed | |
|
||||
| action | mixed | |
|
||||
| data | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
|
||||
|
||||
## resumeAllWorkerCoroutines
|
||||
|
||||
```php
|
||||
public function resumeAllWorkerCoroutines(): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
向所有 Worker 进程发送动作指令
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
Reference in New Issue
Block a user