kirchbaum-development/nova-inline-relationship

一个用于在行内显示关系属性的 Laravel Nova 字段。

2.1.1 2024-01-17 11:39 UTC

README

请注意,这是一个实验性项目,并且我们的团队并没有积极维护和支持。如果您有兴趣帮助维护/扩展此项目,请与我们联系。

背景:我们最初于2019年开始这个项目,旨在为Laravel Nova添加行内关系功能。由于遇到了一些重大的复杂性,我们无法有效推进,Laravel Nova随后添加了功能,覆盖了我们试图实现的大部分内容,但并非全部。我们建议在此阶段使用这些核心的Laravel Nova功能,而不是这个包。

Banner

Nova Inline Relationship

Latest Version on Packagist Total Downloads Actions Status

Nova Inline Relationship 允许您直接从父对象的创建/编辑界面管理(添加/编辑/更新/删除/重新排序)对象的关联。通过将关系作为行内属性呈现,您可以提供内容编辑者一个流畅且高效的流程来管理复杂的数据。

要求

此包需要 Laravel Nova 4.0。

安装

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

composer require kirschbaum-development/nova-inline-relationship

用法

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

假设一个 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
  • MorphOne
  • MorphMany

支持的字段

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

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

变更日志

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

贡献

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

安全

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

赞助

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

许可

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