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:
174
docs/api/ZM/Store/LightCache.md
Normal file
174
docs/api/ZM/Store/LightCache.md
Normal file
@@ -0,0 +1,174 @@
|
||||
# ZM\Store\LightCache
|
||||
|
||||
## init
|
||||
|
||||
```php
|
||||
public function init(mixed $config): bool|mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| config | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| bool|mixed | |
|
||||
|
||||
|
||||
## get
|
||||
|
||||
```php
|
||||
public function get(string $key): null|mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| key | string | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|mixed | |
|
||||
|
||||
|
||||
## getExpire
|
||||
|
||||
```php
|
||||
public function getExpire(string $key): null|mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| key | string | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|mixed | |
|
||||
|
||||
|
||||
## getExpireTS
|
||||
|
||||
```php
|
||||
public function getExpireTS(string $key): null|mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| key | string | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|mixed | |
|
||||
|
||||
|
||||
## set
|
||||
|
||||
```php
|
||||
public function set(array|int|string $value, string $key, int $expire): bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| value | array|int|string | |
|
||||
| key | string | |
|
||||
| expire | int | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| bool | |
|
||||
|
||||
|
||||
## update
|
||||
|
||||
```php
|
||||
public function update(mixed $value, string $key): bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| value | mixed | |
|
||||
| key | string | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| bool | |
|
||||
|
||||
|
||||
## isset
|
||||
|
||||
```php
|
||||
public function isset(string $key): bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| key | string | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| bool | |
|
||||
|
||||
|
||||
## savePersistence
|
||||
|
||||
```php
|
||||
public function savePersistence(): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
这个只能在唯一一个工作进程中执行
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
72
docs/api/ZM/Store/LightCacheInside.md
Normal file
72
docs/api/ZM/Store/LightCacheInside.md
Normal file
@@ -0,0 +1,72 @@
|
||||
# ZM\Store\LightCacheInside
|
||||
|
||||
## get
|
||||
|
||||
```php
|
||||
public function get(string $table, string $key): null|mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| table | string | |
|
||||
| key | string | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|mixed | |
|
||||
|
||||
|
||||
## set
|
||||
|
||||
```php
|
||||
public function set(array|int|string $value, string $table, string $key): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| value | array|int|string | |
|
||||
| table | string | |
|
||||
| key | string | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
|
||||
|
||||
## createTable
|
||||
|
||||
```php
|
||||
public function createTable(mixed $name, mixed $size, mixed $str_size, int $conflict_proportion): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| name | mixed | |
|
||||
| size | mixed | |
|
||||
| str_size | mixed | |
|
||||
| conflict_proportion | int | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
1
docs/api/ZM/Store/Lock/SpinLock.md
Normal file
1
docs/api/ZM/Store/Lock/SpinLock.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Store\Lock\SpinLock
|
||||
1
docs/api/ZM/Store/MySQL/SqlPoolStorage.md
Normal file
1
docs/api/ZM/Store/MySQL/SqlPoolStorage.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Store\MySQL\SqlPoolStorage
|
||||
39
docs/api/ZM/Store/Redis/ZMRedis.md
Normal file
39
docs/api/ZM/Store/Redis/ZMRedis.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# ZM\Store\Redis\ZMRedis
|
||||
|
||||
## __construct
|
||||
|
||||
```php
|
||||
public function __construct(): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
ZMRedis constructor.
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
|
||||
|
||||
## call
|
||||
|
||||
```php
|
||||
public function call(callable $callable): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| callable | callable | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
1
docs/api/ZM/Store/Redis/ZMRedisPool.md
Normal file
1
docs/api/ZM/Store/Redis/ZMRedisPool.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Store\Redis\ZMRedisPool
|
||||
1
docs/api/ZM/Store/WorkerCache.md
Normal file
1
docs/api/ZM/Store/WorkerCache.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Store\WorkerCache
|
||||
39
docs/api/ZM/Store/ZMAtomic.md
Normal file
39
docs/api/ZM/Store/ZMAtomic.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# ZM\Store\ZMAtomic
|
||||
|
||||
## get
|
||||
|
||||
```php
|
||||
public function get(mixed $name): Swoole\Atomic
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| name | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| Swoole\Atomic | |
|
||||
|
||||
|
||||
## init
|
||||
|
||||
```php
|
||||
public function init(): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
初始化atomic计数器
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
1
docs/api/ZM/Store/ZMBuf.md
Normal file
1
docs/api/ZM/Store/ZMBuf.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Store\ZMBuf
|
||||
Reference in New Issue
Block a user