README

FyreEngine 是一个免费的、开源的 PHP 引擎库。

安装

使用 Composer

composer require fyre/engine

在 PHP 中

use Fyre\Engine\Engine;

方法

引导

引导应用程序。

Engine::bootstrap();

中间件

构建应用程序中间件。

$queue 是一个 MiddlewareQueue。

Engine::middleware($queue);

路由

构建应用程序路由。

Engine::routes();

函数

获取语言值。

$key 是一个表示要查找的键的字符串。
$data 是一个包含要插入到语言字符串中的数据的数组。

$lang = __($key, $data);

中止

抛出一个异常。

$code 是一个表示状态码的数字，默认为 500。
$message 是一个表示错误信息的字符串，默认为 ""。

abort($code, $message);

资产

为资产路径生成 URL。

$path 是一个表示资产路径的字符串。
$options 是一个包含路由选项的数组。
- fullBase 是一个布尔值，表示是否使用完整的基 URI，默认为 false。

$url = asset($path);

缓存

加载一个共享的 Cacher 实例。

$key 是一个表示 Cacher 键的字符串，默认为 Cache::DEFAULT。

$cacher = cache($key);

配置

使用 "点" 表示法从配置中检索值。

$key 是一个表示要查找的键的字符串。
$default 是要返回的默认值，默认为 null。

$value = config($key, $default);

数据库

加载一个共享的连接实例。

$key 是一个表示连接键的字符串，默认为 ConnectionManager::DEFAULT。

$connection = db($key);

导出并终止。

dd(...$data);

导出

导出数据。

dump(...$data);

电子邮件

创建一个 电子邮件。

$key 是一个表示 邮件发送者 键的字符串，默认为 Mail::DEFAULT。

$email = email($key);

加密

加载一个共享的 加密器 实例。

$key 是一个表示 加密器 键的字符串，默认为 Encryption::DEFAULT。

$encrypter = encryption($key);

转义

将字符串中的字符转义，以便在 HTML 中使用。

$string 是要转义的字符串。

$escaped = escape($string);

JSON

使用 JSON 数据创建一个新的 客户端响应。

$data 是要发送的数据。

$response = json($data);

日志消息

记录一条消息。

$type 是一个表示日志级别的字符串。
$message 是一个表示日志消息的字符串。
$data 是一个包含要插入到消息字符串中的数据的数组。

log_message($type, $message, $data);

$type 必须是支持的日志级别之一。

模型

加载一个共享的模型实例。

$alias 是一个表示模型别名的字符串。

$model = model($alias);

现在

创建一个新的 DateTime 设置为当前时间。

$now = now();

队列

将一个任务推送到一个队列。

$className 是一个表示作业类的字符串。
$arguments 是一个包含将被传递到作业的参数的数组。
$options 是一个包含消息选项的数组。
- config 是一个表示配置键的字符串，默认为 "default"。
- queue 是一个表示队列名称的字符串，默认为 "default"。
- method 是一个表示类方法的字符串，默认为 "run"。
- delay 是一个表示在作业应运行之前的秒数的数字，默认为 0。
- expires 是一个表示在作业过期之前的秒数的数字，默认为 0。

queue($className, $arguments, $options);

重定向

创建一个新的 RedirectResponse。

$uri 是一个 Uri 或表示要重定向到的 URI 的字符串。
$code 是一个表示头状态码的数字，默认为 302。
$options 是一个包含配置选项的数组。

$response = redirect($uri, $code, $options);

请求

加载一个共享的 ServerRequest 实例。

$request = request();

您还可以通过传递参数到这个函数来从 $_POST 数组中检索值。

$key 是一个表示使用 "点" 表示法的数组键的字符串。
$filter 是一个表示要应用的过滤器的数字，默认为 FILTER_DEFAULT。
$options 是一个表示在过滤时要使用的标志的数字或数组，默认为 0。

$value = request($key, $filter, $options);

响应

创建一个新的 ClientResponse。

$response = response();

路由

为命名的 Route 生成 URL。

$name 是一个表示路由别名的字符串。
$arguments 是一个包含路由参数的数组。
- ? 是一个包含路由查询参数的数组。
- # 是一个表示 URI 的片段组件的字符串。
$options 是一个包含路由选项的数组。
- fullBase 是一个布尔值，表示是否使用完整的基 URI，默认为 false。

$route = route($name, $arguments, $options);

会话

从会话中检索一个值。

$key 是一个表示会话键的字符串。

$value = session($key);

您还可以通过包含第二个参数来设置会话值。

session($key, $value);

类型

获取值类型的映射类型类。

$type 是一个表示值类型的字符串。

$typeClass = type($type);

视图

渲染 View 模板。

$template 是一个表示模板文件的字符串。
$data 是一个包含传递给模板的数据的数组。
$layout 是一个表示布局文件的字符串，默认为 null。

$view = view($template, $data, $layout);

如果将 $layout 设置为 null，它将使用来自 Config 的 App.defaultLayout 选项。

fyre / engine

维护者

详情

README

目录

安装

方法

函数