Skip to content

Latest commit

 

History

History
99 lines (57 loc) · 4.07 KB

3-2-helpers.md

File metadata and controls

99 lines (57 loc) · 4.07 KB

辅助函数

辅助函数目前暂时没有提供自定的模板,可以通过 composer.json 中的 autoload 进行自定义扩展。

PSR规范官网

预设函数

框架内置提供数个辅助函数,能够提高效率快速开发。

app(): Application

函数返回应用核心,应用核心继承自容器,因此应用本身就是一个容器。

version()

获取框架应用版本号。

route($prefix = null, callable $callback = null): \FastD\Routing\RouteCollection

路由函数,当 $prefix$callback 都为空的时候,直接返回路由集合。

当需要设置路由组的时候,则需要 $prefix$callback 配合设置, 如:

route("/", function () {
    route()->get("/hello/{name}", "IndexController@sayHello");
});

config(): \FastD\Config\Config

返回配置对象,具体操作可以查看: 配置

request(): \Psr\Http\Message\ServerRequestInterface

返回 PSR7 ServerRequestInterface 对象, 具体操作可以查看: HTTP

json(array $content = [], $statusCode = Response::HTTP_OK): \FastD\Http\JsonResponse

框架中返回均需要返回 Psr\Http\Message\ResponseInterface 接口,在函数中,JsonResponse 继承 Response 并实现相关接口,因此返回响应必须要返回实现 Psr\Http\Message\ResponseInterface 实现类。

binary(array $content = [], $statusCode = Response::HTTP_OK, array $headers = []): \FastD\Http\Response

框架中返回均需要返回 Psr\Http\Message\ResponseInterface 接口,在函数中,JsonResponse 继承 Response 并实现相关接口,因此返回响应必须要返回实现 Psr\Http\Message\ResponseInterface 实现类。

abort($statusCode, $message = null)

终端执行,抛出异常。异常输出控制请参考: 应用配置

logger(): \Monolog\Logger

返回 monolog 对象,框架默认提供两种日志,一个是信息日志,一个是错误日志,分别在 配置 中设置,如果需要操作日志并且创建更多日志,请使用该函数获取 Logger 对象,然后进行操作。

更多 monolog 操作请看: Monolog

cache($connection = 'default'): \Symfony\Component\Cache\Adapter\AbstractAdapter

缓存提供器依赖于 Symfony/cache ,缓存函数返回一个 AbstractAdapter 对象,具体操作可以查看文档。如果无法满足业务需求,可以自定义服务提供器,对其进行代替.

database($connection = 'default'): \Medoo

框架默认的 DatabaseServiceProvider 是提供 medoo 操作,不提供具体的 ORM 等关系操作,如果需要自定义数据库操作,可以通过实现自己的 ServiceProvider 进行扩展。

具体的操作和使用方式请查看: 服务提供器

server(): \FastD\Swoole\Server

返回 Server 对象,能够通过对象获取部分服务器和客户端信息。

swoole(): \swoole_server

server 函数返回 swoole 对象,在 swoole 启动的时候会自动赋值,可在控制器中使用 server 对象进行操作。

自定义辅助函数

很多情况下,部分的辅助函数可能不足以满足业务需求,我们可以扩展出属于自己的扩展函数。

如果你能够足够熟悉 composer,那么其实可以撇开框架,去进行自己的扩展。

添加辅助函数文件: helpers.php

修改 composer.json

{
    // some code
    "autoload": {
        "files": [
            "helpers.php"
        ]
    }
    // some code
}

然后重新生成 autoload。composer dump-autoload

下一节: 服务提供器