egorogl/laravel-db-blade

从 Eloquent 模型字段渲染 Blade 模板

v1.0.5 2020-11-11 06:48 UTC

This package is auto-updated.

Last update: 2024-08-29 05:22:41 UTC


README

Build Status Scrutinizer Code Quality

从 Eloquent 模型字段渲染 Blade 模板

此包允许您从数据库模型而不是文件中渲染 Blade 模板。它基于 Flynsarmylaravel-db-blade-compiler

安装

您可以通过 composer 安装此包

composer require kiroushi/laravel-db-blade

使用 artisan 发布资源

php artisan vendor:publish

然后,在 config/db-blade.php 配置文件中设置您的 DbView 模型。包中包含一个默认模型(Kiroushi\DbBlade\Models\DbView

return [

    'model_name' => 'Kiroushi\DbBlade\Models\DbView',
    'table_name' => 'db_views',

    /**
     * The default name field used to look up for the model.
     * e.g. DbView::make($viewName) or dbview($viewName)
     */
    'name_field' => 'name',

    /**
     * The default model field to be compiled when not explicitly specified
     * with DbView::field($fieldName) or DbView::model($modelName, $fieldName)
     */
    'content_field' => 'content',

    /**
     * This property will be added to models being compiled with DbView
     * to keep track of which field in the model is being compiled
     */
    'model_property' => '__db_blade_compiler_content_field',

    'cache' => false,
    'cache_path' => 'app/db-blade/cache/views'

];

配置完成后,确保迁移已被发布,然后可以通过运行迁移来创建数据库视图表

php artisan migrate

使用方法

此包提供了一个与 View 完全相同的语法和功能的 DbView 面板

return DbView::make('home')->with(['foo' => 'bar']);

您还可以使用与 Laravel 基础 view() 辅助功能匹配的 dbview() 辅助函数。如果没有提供参数,则返回工厂

return dbview()->make('home')->with(['foo' => 'bar']);

如果提供了一个字符串,则会查找并渲染具有该名称的视图

return dbview('home')->with(['foo' => 'bar']);

运行时覆盖设置

您可以通过关联方法使用关联方法覆盖模型、名称字段和内容字段的单个设置

return DbView::make('home')->model('App\Template');

return DbView::make('home')->field('template_name');

// You can also pass the model and name field as a shorthand:
return DbView::make('home')->model('App\Template', 'template_name');

// Override content field
return DbView::make('home')->contentField('template_content');

// ... or a combination of these
return DbView::make('home')->model('App\Template', 'template_name')->contentField('template_content');

缓存

默认情况下,在配置文件中禁用缓存。如果您启用此设置,则视图的编译版本将存储在所需路径。如果模型被更新,则将检查 updated_at 字段与文件修改日期是否匹配,并将视图重新渲染并缓存。

变更日志

有关最近更改的更多信息,请参阅 CHANGELOG

待办事项

  • 公开视图查找回调
  • 将标准视图构建器与 dbview 构建器分开。
  • 单元测试

许可

laravel-db-blade 是开源软件,许可协议为 MIT 许可证 (MIT)。有关更多信息,请参阅 许可文件