zhamao-framework/docs/api/ZM/Framework.md
Github Build Bot 6d23e489aa update api docs
2022-04-15 15:08:34 +00:00

156 lines
2.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# ZM\Framework
## __construct
```php
public function __construct(array $args, bool $instant_mode): mixed
```
### 描述
创建一个新的框架实例
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| args | array | 运行参数 |
| instant_mode | bool | 是否为单文件模式 |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## saveProcessState
```php
public function saveProcessState(int|string $pid, int $type, array $data): mixed
```
### 描述
将各进程的pid写入文件以备后续崩溃及僵尸进程处理使用
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| pid | int|string | |
| type | int | |
| data | array | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## getProcessState
```php
public function getProcessState(mixed $id_or_name, int $type): false|int|mixed
```
### 描述
用于框架内部获取多进程运行状态的函数
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| id_or_name | mixed | |
| type | int | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| false|int|mixed | |
## removeProcessState
```php
public function removeProcessState(null|int|string $id_or_name, int $type): mixed
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| id_or_name | null|int|string | |
| type | int | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## loadServerEvents
```php
public function loadServerEvents(): mixed
```
### 描述
作者很懒,什么也没有说
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## registerServerEvents
```php
public function registerServerEvents(): mixed
```
### 描述
从全局配置文件里读取注入系统事件的类
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## parseCliArgs
```php
public function parseCliArgs(array $args, bool|string $add_port): mixed
```
### 描述
解析命令行的 $argv 参数们
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| args | array | 命令行参数 |
| add_port | bool|string | 是否添加端口号 |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |