README

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

快速入门

以下是一个非常简化的指南，以帮助您尽快开始。请参阅完整的文档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')
            ])
    ];
}

自定义按钮标签

您可以通过以下方式更改默认的“添加布局”按钮的文本

Flexible::make('Content')
    ->button('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特质，这意味着您可以定义布局属性的访问器和修改器。此外，还可以使用以下方法访问布局的属性

name()

返回布局的名称。

title()

返回布局的标题（如Nova所示）。

key()

返回布局的唯一键（布局的唯一标识符）。

进一步探索

当使用灵活内容字段时，你很快会遇到一些情况，其中上面描述的基本内容是不够的。这就是我们以可扩展的方式开发这个包的原因，使其能够轻松地添加自定义行为和/或功能到字段及其输出。

自定义布局类

有时，addLayout 定义可能会相当长，或者你可能希望它们与其他 Flexible 字段共享。这个问题的解决方案是将你的布局提取成自己的类。有关更多信息，请参见文档。

预定义预设类

除了可重用的布局类之外，你还可以为你的灵活字段创建 Preset 类。这些允许你在任何需要的地方重用整个灵活字段。它们还使你的灵活字段更加动态，例如，如果你想有条件地添加布局。最重要的是，如果您的灵活字段有很多 addLayout 定义，它们还可以帮助你清理 Nova 资源类。有关更多信息，请参见文档。

自定义解析器类

默认情况下，字段利用了模型表的 JSON 列。在某些情况下，你真的很想使用这个字段，但由于某种原因，JSON 属性根本不是可行的选择。例如，你可能想将值存储在另一个表中（这意味着你将使用灵活内容字段而不是传统的 BelongsToMany 或 HasMany 字段）。不用担心，我们已经为你准备好了！

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

与 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 Whitecube\NovaFlexibleContent\Concerns\HasFlexible;

class Home extends Template
{
    use HasFlexible;

    // ...
}

💖 赞助

如果你的生产应用程序依赖于此包，请考虑 赞助我们！这是帮助我们继续做我们热爱的事情的最好方式：制作优秀的开源软件。

贡献

请随时提出更改建议、请求新功能或自行修复错误。我们确信还有很多改进的空间，我们非常乐意合并有用的拉取请求。

谢谢！

单元测试

当添加新功能或修复错误时，请添加相应的单元测试。当前的测试集有限，但添加的每个单元测试都将提高软件包的质量。

通过调用composer test来运行PHPUnit。

用❤️为开源制作

在Whitecube，我们每天工作中使用大量开源软件。因此，当我们有机会回馈时，我们非常激动！

我们希望您会喜欢我们的小贡献，如果您在项目中发现它有用，我们非常愿意收到您的反馈。在Twitter上关注我们，获取更多更新！