codicastudio/flexible-content

一个随机的 Codica Studio 包。

1.0.0 2020-09-25 01:53 UTC

This package is not auto-updated.

Last update: 2024-09-21 21:27:03 UTC


README

一个简单且完整的 Laravel Nova 可灵活字段,非常适合重复和灵活的字段组。

Laravel Nova Flexible Content in action

快速开始

以下是一个快速入门指南,让您尽快开始。查看完整文档,请访问 https://whitecube.github.io/nova-flexible-content

安装

composer require whitecube/nova-flexible-content

使用方法

灵活字段允许轻松管理可重复和可排序的字段组。与 Laravel Nova 的现有少数解决方案相比,此方案对这些组内允许使用哪些字段没有限制。这意味着您可以使用所有 Laravel Nova 字段类型,以及任何社区制作的字段。

添加布局

布局代表可以在灵活字段内重复的一组字段。您可以添加任意数量的布局。如果只定义了一个布局,字段将表现得像一个简单的重复器;通过添加更多布局,您将获得灵活内容。这两个概念与 Wordpress ACF 插件中的同类功能类似。

您可以使用以下方法在灵活字段中添加布局

 addLayout(string $title, string $name, array $fields)

$name 参数用于在字段的值中存储选择的布局。请谨慎选择,您可能需要用它来识别应用程序中的布局。

use Whitecube\NovaFlexibleContent\Flexible;

/**
 * Get the fields displayed by the resource.
 *
 * @param  \Illuminate\Http\Request  $request
 * @return array
 */
public function fields(Request $request)
{
    return [
        // ...

        Flexible::make('Content')
            ->addLayout('Simple content section', 'wysiwyg', [
                Text::make('Title'),
                Markdown::make('Content')
            ])
            ->addLayout('Video section', 'video', [
                Text::make('Title'),
                Image::make('Video Thumbnail', 'thumbnail'),
                Text::make('Video ID (YouTube)', 'video'),
                Text::make('Video Caption', 'caption')
            ])
    ];
}

Example of Flexible layouts

自定义按钮标签

您可以更改默认的“添加布局”按钮的文本如下

Flexible::make('Content')
    ->button('Add something amazing!');

Add something amazing

在视图中使用灵活值

如果您正在使用 Laravel 6 及以下版本,或者不想使用类型转换,请 在模型上使用带有 HasFlexible 特性的访问器

Laravel 7 带来了自定义类型转换,灵活内容字段是它们的完美用例。字段将值存储为单个 JSON 字符串,这意味着在您的应用程序中使用之前需要解析此字符串。这可以通过使用本包中的 FlexibleCast 类轻松完成

namespace App;

use Illuminate\Database\Eloquent\Model;
use Whitecube\NovaFlexibleContent\Value\FlexibleCast;

class MyModel extends Model
{
    protected $casts = [
        'flexible-content' => FlexibleCast::class
    ];
}

默认情况下,FlexibleCast 类将收集基本的 Layout 实例。如果您想将布局映射到 自定义布局实例,也是可能的。首先,通过运行 php artisan flexible:cast MyFlexibleCast 创建一个自定义灵活类型转换。这将创建位于 App\Casts 目录中的文件。

然后轻松地将自定义布局类映射到正确的键

namespace App\Casts;

class MyFlexibleCast extends FlexibleCast
{
    protected $layouts = [
        'wysiwyg' => \App\Nova\Flexible\Layouts\WysiwygLayout::class,
        'video' => \App\Nova\Flexible\Layouts\VideoLayout::class,
    ]
}

如果您需要更多控制,可以 覆盖 getLayoutMappings 方法

布局集合

FlexibleCast 类型转换和 HasFlexible 特性返回的集合扩展了原始的 Illuminate\Support\Collection。这些自定义布局集合公开了一个 find(string $name) 方法,它返回第一个具有给定布局 $name 的布局。

布局实例

布局是一些类型的虚拟模型。它们使用Laravel的HasAttributes特性,这意味着您可以为布局的属性定义访问器和修改器。此外,还可以使用以下方法访问Layout的属性:

name()

返回布局的名称。

title()

返回布局的标题(如Nova所示)。

key()

返回布局的唯一键(布局的唯一标识符)。

更进一步

当使用灵活内容字段时,您很快会遇到一些基本描述不足以应对的场景。这就是我们以可扩展的方式开发此包的原因,使其能够轻松地为字段及其输出添加自定义行为和能力。

自定义布局类

有时,addLayout定义可能相当长,或者您可能希望它们与其他Flexible字段共享。解决这个问题的方法是提取您的布局到它自己的类中。有关更多信息,请参阅文档

预定义预设类

除了可重用的布局类,您还可以进一步创建用于灵活字段的Preset类。这些类允许您在任何地方重用整个灵活字段。它们还使灵活字段更具动态性,例如,如果您想有条件地添加布局。最重要的是,如果您的灵活字段有许多addLayout定义,它们还有助于清理您的Nova资源类。有关更多信息,请参阅文档

自定义解析器类

默认情况下,该字段利用模型表上的JSON列。在某些情况下,您可能真的想使用该字段,但出于某种原因,JSON属性并不是最佳选择。例如,您可能想将值存储在另一个表中(这意味着您将使用灵活内容字段而不是传统的BelongsToMany或HasMany字段)。不用担心,我们已经为您解决了这个问题!

通过创建自己的解析器类来告诉字段如何存储和检索其内容,该类基本上只包含两个简单的方法:getset有关更多信息,请参阅文档

与nova-page一起使用

您可能听说过我们的另一个包,nova-page,这是一个Nova工具,允许您编辑静态页面,如"关于"页面(或类似页面)而无需为它单独声明模型。通常,灵活内容字段非常有用。别担心,这两个包可以很好地一起工作!首先创建一个nova页面模板,并将灵活内容添加到模板的字段中。

如文档中所述,您可以使用{{ Page::get('attribute') }}在blade视图中访问nova-page的静态内容。当以这种方式请求灵活内容时,它返回一个描述灵活内容的原始JSON字符串,这当然不是非常有用。相反,您可以在页面模板上实现Whitecube\NovaFlexibleContent\Concerns\HasFlexible特性,这将暴露Page::flexible('attribute')门面方法,并处理灵活内容的转换。

namespace App\Nova\Templates;

// ...
use App\Nova\Templates\Concerns\HasFlexible;

class Home extends Template
{
    use HasFlexible;

    // ...
}