README

这个Laravel Nova扩展包允许您通过拖拽的方式在Nova资源索引视图中重新排列模型。

内部使用Spatie的eloquent-sortable。

要求

• php: >=8.0
• laravel/nova: ^4.24.0

特性

• 拖拽排序（在索引视图或HasMany视图中）
• BelongsTo/MorphsTo排序支持，包含连接表
• 移动到开始和结束箭头（使项目成为第一个/最后一个）
• 包括eloquent-sortable的所有功能
• 本地化

屏幕截图

安装

通过Composer在Laravel Nova项目中安装此包

# Install package
composer require outl1ne/nova-sortable

用法

创建迁移

使用Laravel迁移在模型中添加一个排序字段

// Add order column to the model
Schema::table('some_model', function (Blueprint $table) {
  $table->integer('sort_order');
});

// Set default sort order (just copy ID to sort order)
DB::statement('UPDATE some_model SET sort_order = id');

实现eloquent-sortable

实现Spatie的eloquent-sortable接口并应用特性

use Spatie\EloquentSortable\Sortable;
use Spatie\EloquentSortable\SortableTrait;

class SomeModel extends Eloquent implements Sortable
{
  use SortableTrait;

  public $sortable = [
    'order_column_name' => 'sort_order',
    'sort_when_creating' => true,
  ];

  ...
}

当模型没有排序配置时，将使用默认的eloquent-sortable配置。

将HasSortableRows应用于Nova资源

在资源上应用此包中的HasSortableRows特性

use Outl1ne\NovaSortable\Traits\HasSortableRows;

class MyResource extends Resource
{
  use HasSortableRows;

  ...
}

注意！这会覆盖indexQuery()方法。

按请求/资源禁用排序

您可以通过覆盖资源方法中的canSort()来按请求或资源禁用排序，如下所示

public static function canSort(NovaRequest $request, $resource)
{
  // Do whatever here, ie:
  // return user()->isAdmin();
  // return $resource->id !== 5;
  return true;
}

注意！这要求您禁用缓存（见下文）。

禁用缓存

如果您想禁用缓存（由于使用canSort或运行测试），可以在具有HasSortableRows特性的资源上设置sortableCacheEnabled为false。以下是一个示例

class Artist extends Resource
{
    use HasSortableRows;

    public static $sortableCacheEnabled = false;
}

或者，如果您想暂时禁用可排序缓存（用于测试），可以在资源上调用Resource::disableSortabilityCache()。

自定义可排序选项

Nova排序顺序

要按不同的顺序在Nova中对资源进行排序，可以将nova_order_by标志设置为DESC（默认为ASC）在$sortable数组中。

class SomeModel extends Eloquent implements Sortable
{
  use SortableTrait;

  public $sortable = [
    'order_column_name' => 'sort_order',
    'sort_when_creating' => true,
    'nova_order_by' => 'DESC',
  ];

  ...
}

忽略策略

如果您有一个资源，其authorizedToUpdate为false，但您仍然希望用户能够对其进行排序，可以使用ignore_policies标志，如下所示

class SomeModel extends Eloquent implements Sortable
{
  use SortableTrait;

  public $sortable = [
    'order_column_name' => 'sort_order',
    'sort_when_creating' => true,
    'ignore_policies' => true,
  ];

  ...
}

在HasMany关系上进行排序

注意！资源只能对索引视图或HasMany列表视图中的其中一个进行排序，但不能同时排序两个！

HasMany排序简单。将'sort_on_has_many' => true添加到模型上的$sortable数组。如下所示

public $sortable = [
  'order_column_name' => 'sort_order',
  'sort_when_creating' => true,
  'sort_on_has_many' => true,
];

HasMany排序配置可以在每个模型的基础上应用，也可以添加到eloquent-sortable的配置中，适用于所有模型。

return [

    // Spatie sortable configuration

    /**
     * Add sort on has many in all the models.
     **/
    'sort_on_has_many' => true,
];

在ManyToMany关系上进行排序

在BelongsToMany和MorphToMany关系上进行排序是可用的，但需要特殊步骤。

请参阅以下文档：排序ManyToMany关系（使用连接表）。

本地化

可以使用以下发布命令发布翻译文件

php artisan vendor:publish --provider="Outl1ne\NovaSortable\ToolServiceProvider" --tag="translations"

您可以通过创建一个新翻译文件（例如et.json）并将现有en.json中的JSON复制进去，将您的翻译添加到resources/lang/vendor/nova-sortable/中。

其他用例

使用indexQuery

此包会覆盖资源的 indexQuery，如果您仍然想使用它，可以按照以下方式操作

use HasSortableRows {
    indexQuery as indexSortableQuery;
}

public static function indexQuery(NovaRequest $request, $query)
{
  // Do whatever with the query
  // ie $query->withCount(['children', 'descendants', 'modules']);
  return parent::indexQuery($request, static::indexSortableQuery($request, $query));
}

致谢

• Tarvo Reinpalu

许可证

Nova Sortable 是开源软件，遵循 MIT 许可证。