部门/nova-dependency-container

A Laravel Nova 字段容器,允许依赖其他字段的值

1.3.3 2021-05-13 16:30 UTC

README

Latest Version on Packagist Total Downloads License


描述

一个用于分组依赖其他字段值的字段容器。依赖可以设置在任何字段类型或值上。


演示

Demo


版本

  • 为 Laravel v5.8 或 v6.x 和 Nova 2.x 安装 v1.2.x
  • 为 Laravel v5.7 和 Nova v1.x 安装 v1.1.2

安装

可以通过 Composer 安装此包。

composer require epartment/nova-dependency-container

用法

  1. Epartment\NovaDependencyContainer\HasDependencies 特性添加到您的 Nova 资源。
  2. Epartment\NovaDependencyContainer\NovaDependencyContainer 添加到您的 Nova 资源 fields 方法。
  3. Epartment\NovaDependencyContainer\ActionHasDependencies 特性添加到您希望使用依赖的 Nova 操作。
class Page extends Resource
{
    use HasDependencies;

    public function fields(Request $request)
    {
        return [
            
            Select::make('Name format', 'name_format')->options([
                0 => 'First Name',
                1 => 'First Name / Last Name',
                2 => 'Full Name'
            ])->displayUsingLabels(),

            NovaDependencyContainer::make([
                Text::make('First Name', 'first_name')
            ])->dependsOn('name_format', 0),

        ];
    }
}

依赖

该包支持四种类型的依赖

  1. ->dependsOn('field', 'value')
  2. ->dependsOnNot('field', 'value')
  3. ->dependsOnEmpty('field')
  4. ->dependsOnNotEmpty('field')
  5. ->dependsOnNullOrZero('field')

这些依赖可以通过链式调用 NovaDependencyContainer 上的方法进行组合

NovaDependencyContainer::make([
  // dependency fields
])
->dependsOn('field1', 'value1')
->dependsOnNotEmpty('field2')
->dependsOn('field3', 'value3')

用作依赖的字段可以是任何 Laravel Nova 字段类型。目前仅支持两种关系字段类型,BelongsToMorphTo

以下是一个使用复选框的示例

Demo


BelongsTo 依赖

如果我们遵循 Novas 文档中 Post 模型属于 User 模型 的示例,来自 Novas 文档 BelongsTo,依赖设置的结构如下。

我们使用 belongsTo 资源的单数形式,小写形式,在这个例子中,Post 变成了 post。然后我们定义点符号,我们想依赖的资源属性。在这个例子中,我们只使用 id 属性,即 post.id

BelongsTo::make('Post'),

NovaDependencyContainer::make([
    Boolean::make('Visible')
])
->dependsOn('post.id', 2)

当选择 Post 资源 id 为 2 时,将显示一个 Boolean 字段。


BelongsToMany 依赖

一个 BelongsToMany 设置类似于 BelongsTo

dependsOn 方法应指向中间表名称。如果它被命名为 role_user,则设置如下

BelongsToMany::make('Roles')
	->fields(function() {
		return [
			NovaDependencyContainer::make([
			    // pivot field rules_all
			    Boolean::make('Rules All', 'rules_all')
			])
			->dependsOn('role_user', 1)
		]
	}),

如果枢轴字段名称出现多次,请考虑使用 自定义中间表模型 并在适当的模型关系方法中定义它。我发现唯一的可靠解决方案是使用用于多次使用的字段的多态变换器。尽管这可能看起来很丑陋,但使用观察者时,在中间模型实例上触发的事件在 Nova 的每个新版本中都会不可靠地工作。

如果 Nova 能够可靠地在中间表上触发 Eloquent 事件,我将更新此示例,使用事件而不是使用更优雅的方法。

以下是一个使用名为 type 的枢轴字段的中间表的(丑陋)get/set 多态变换器设置示例。

// model User
class User ... { 
   
   public function roles() {
   		return $this->belongsToMany->using(RoleUser::class)->withPivot('rules_all');
   }
   
}

// model Role
class Role ... { 
   
   public function users() {
   		return $this->belongsToMany->using(RoleUser::class)->withPivot('rules_all');
   }
   
}

// intermediate table
use Illuminate\Database\Eloquent\Relations\Pivot;
class RoleUser extends Pivot {  

	protected $table 'role_user';

	public function getType1Attribute() {
	    return $this->type;
	}

	public function setType1Attribute($value) {
		$this->attributes['type'] = $value;
	}

	// ... repeat for as many types as needed
}

现在让我们来看看依赖容器。

->fields(function() {
	return [
		NovaDependencyContainer::make([
		    // pivot field rules_all
		    Select::make('Type', 'type_1')
		    	->options([ 
		    		/* some options */ 
	    		])
		    	->displayUsingLabels()
		])
		->dependsOn('role_user', 1)
		,
	
		NovaDependencyContainer::make([
		    // pivot field rules_all
		    Select::make('Type', 'type_2')
		    	->options([ 
		    		/* different options */ 
	    		])
		    	->displayUsingLabels()
		])
		->dependsOn('role_user', 2)
		,
		
		// .. and so on
	]
}),

MorphTo 依赖

从 Novas 文档中取出的一个类似示例,用于 MorphTo 被称为 commentable。它使用 3 个模型;CommentVideoPost。在这里,Comment 有可变字段 commentable_idcommentable_type

对于 MorphTo 依赖,需要以下构造。

Commentable 转换为小写 commentable,依赖的值是资源的单数形式。在本例中,只有当选择 Post 资源时,依赖容器才会添加两个额外字段,即 附加文本可见

MorphTo::make('Commentable')->types([
    Post::class,
    Video::class,
]),

NovaDependencyContainer::make([
    Text::make('Additional Text', 'additional'),
    Boolean::make('Visible', 'visible')
])
->dependsOn('commentable', 'Post') 

许可证

MIT 许可证 (MIT)。更多信息请参阅 许可证文件