igrik/nova-inline-relationship

A Laravel Nova 字段,用于显示关系属性的内联。

dev-master 2023-10-23 10:47 UTC

This package is auto-updated.

Last update: 2024-09-23 12:51:23 UTC


README

Banner

Nova Inline Relationship

Latest Version on Packagist Total Downloads Actions Status

这是从 kirschbaum-development/nova-inline-relationship GitHub 分支出来的

Nova Inline Relationship 允许您直接从父对象的创建/编辑屏幕管理对象的(添加/编辑/更新/删除/重新排序)关系。通过将关系作为内联属性呈现,您可以提供内容编辑器以高效地管理复杂数据的简化工作流程。

要求

此包需要 Laravel Nova 4.0。

安装

您可以通过 composer 在使用 Nova 的 Laravel 应用中安装此包

composer require igrik/nova-inline-relationship

用法

要在您的 Model 的资源中使用 NovaInlineRelationship,您只需向相关 Model 的资源字段的常规语法中添加一个内联方法。

假设一个 BlogPost 模型与 Image 模型有一个一对多关系,您的 BlogPost 资源将如下所示

namespace App\Nova;

use Laravel\Nova\Fields\Image;

class BlogPost extends Resource
{
    //...
    public function fields(Request $request)
    {
        return [
            //...

            HasMany::make('Images', 'images', Image::class)->inline(),
        ];
    }
}

注意: 您需要为 Image 添加一个 Nova 资源 - 所有字段和规则都将从指定的资源中检索。您必须将资源指定为关系字段的第三个参数,如上所示。

添加相关模型

Create View

设置完成后,您可以在创建新基础模型时直接添加新相关模型。您可以使用 添加新 Image 按钮将新 Image 添加到 BlogPost

Create Related Model

查看相关模型

相关模型现在也将以内联形式显示

Detail View

更新相关模型

您还可以更新、重新排列(对于一对多关系)和删除相关模型

Rearrange Models

您可以使用 sortUsing() 方法添加拖放功能来更新相关模型的顺序。在以下代码示例中,我们使用名为 order 的字段来存储 Images 模型的排序顺序

HasMany::make('Images')->inline()->sortUsing('order'),

必需的关系

有时您可能在创建模型时需要强制要求子关系。为此,只需使用 requireChild() 方法。例如,您可能想要创建一个新用户并强制创建用户的配置文件。

HasOne::make('Profile', 'profile', Profile::class)->inline()->requireChild(),

第三方包支持

我们提供了一种简单的方法来处理第三方包偶尔与 Nova Inline Relationships 不兼容的问题。这些包偶尔以不同的方式处理它们返回的字段子集。我们有方法轻松集成这些包的功能。这可能不会全面适用,但应该允许大多数第三方包。

您必须使用以下命令发布此包的配置

php artisan vendor:publish

这将发布一个配置文件 config/nova-inline-relationships.php。在 third-party 数组中添加您自定义的命名空间路径。例如

'third-party' => [
    'App\Nova\ThirdPartyIntegrations',
    'KirschbaumDevelopment\NovaInlineRelationship\Integrations',
]

在命名空间内创建一个新类,如下所示

<?php

namespace App\Nova\ThirdPartyIntegrations;

use KirschbaumDevelopment\NovaInlineRelationship\Integrations\ThirdParty;
use KirschbaumDevelopment\NovaInlineRelationship\Integrations\Contracts\ThirdPartyContract;

class SomeThirdPartyField extends ThirdParty implements ThirdPartyContract
{
    /**
     * Fields array from object.
     *
     * @return array
     */
    public function fields(): array
    {
        // The following is just an example and should be updated to meet your needs.
        return $this->field->customFieldArray;
    }
}

类的名称非常重要。它应该是 Nova 资源中使用的字段的名称。如果字段类是 CustomField,则第三方集成类也应称为 CustomField

fields() 方法应返回一个包含所有自定义字段或包的字段数组的数组。

如果您认为您创建的第三方集成应包含在此包中,请创建一个 pull request,我们将审查它!

支持的关系

以下 eloquent 关系目前得到支持

  • BelongsTo
  • HasOne
  • HasMany
  • 形态一
  • 形态多

支持的字段

以下原生Nova 2.0字段已确认可以使用。

  • 布尔值
  • 代码
  • 国家
  • 货币
  • 日期
  • 日期时间
  • Markdown
  • 数字
  • 密码
  • 地点
  • 选择
  • 文本
  • 文本区域
  • 时区
  • Trix
  • 头像
  • 图片
  • 文件

更新日志

有关最近更改的更多信息,请参阅更新日志

贡献

有关详细信息,请参阅贡献指南

安全性

如果您发现任何安全相关的问题,请通过电子邮件navneet@kirschbaumdevelopment.comnathan@kirschbaumdevelopment.com联系,而不是使用问题跟踪器。

赞助

此包的开发由Kirschbaum Development Group赞助,该公司是一家以解决问题、团队建设和社区为重点的驱动型开发公司。了解更多关于我们加入我们

许可协议

MIT许可协议(MIT)。有关更多信息,请参阅许可文件