zhamao-robot/zhamao-framework
1
0
Fork 0
mirror of https://github.com/zhamao-robot/zhamao-framework.git synced 2026-07-21 15:45:36 +08:00
Code Issues Packages Projects Releases Wiki Activity

update api docs

Browse Source
This commit is contained in:
crazywhalecc
2022-08-22 07:39:44 +00:00
committed by github-actions[bot]
parent 53c1c0103c
commit e83a169fd6
35 changed files with 3069 additions and 527 deletions
Download Patch File Download Diff File Expand all files Collapse all files

205
docs/api/ZM/Container/Container.md
View File

@@ -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<T> $abstract, array $parameters): Closure|mixed|T
public function make(string $abstract, array $parameters): mixed
```
### 描述
获取一个绑定的实例
作者很懒，什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| abstract | class-string<T> | 类或接口名 |
| 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<T> $abstract, array $parameters): Closure|mixed|T
public function traitMake(string $abstract, array $parameters): mixed
```
### 描述
获取一个绑定的实例
作者很懒，什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| abstract | class-string<T> | 类或接口名 |
| 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
### 描述
记录日志（自动附加容器日志前缀）
作者很懒，什么也没有说
### 参数