nelkasovic/column-sortable

Laravel 6.x 处理列排序的包

维护者

详细信息

github.com/nelkasovic/column-sortable

源代码

安装: 380

依赖者: 0

建议者: 0

安全: 0

星星: 0

关注者: 0

分支: 105

类型:package

v1.0.2 2023-02-16 15:18 UTC

Requires

  • php: ^8.1

Requires (Dev)

MIT a877650dbf19e6f48ce8ff0ab8eabd7ff412c7ba

  • Martin Kiesel <martin.kiesel.woop@gmail.com>

sortablesortlaravelsortingcolumn

This package is not auto-updated.

Last update: 2024-09-27 21:23:41 UTC

README

Laravel 5.5-8 的列排序

Latest Version Software License Total Downloads run-tests

处理 Laravel 5.[5-8] 列排序的包。对于 Laravel 早期版本，请查看分支 L5.1-3

设置

Composer

通过 Composer 引入此包（开发/最新版本 dev-master）

{
    "require": {
        "kyslik/column-sortable": "^6.0"
    }
}
composer update

Laravel >=5.5 自动发现

简单地安装包，让 Laravel 做它的工作。

注意（Laravel 6.0 之前）：主版本和次要版本应与 Laravel 的版本匹配，例如，如果您使用 Laravel 5.4，column-sortable 版本应为 5.4.*。

手动安装（5.5 之前）

将服务提供者添加到 config/app.php 中的提供者数组中

'providers' => [

    App\Providers\RouteServiceProvider::class,

    /*
     * Third Party Service Providers...
     */
    Kyslik\ColumnSortable\ColumnSortableServiceProvider::class,
],

发布配置

发布包配置文件到您的应用程序

php artisan vendor:publish --provider="Kyslik\ColumnSortable\ColumnSortableServiceProvider" --tag="config"

查看配置文件 （config/columnsortable.php） 并根据需要调整

使用方法

在您的 Eloquent 模型中使用 Sortable 特性。定义 $sortable 数组（见下面的示例代码）。

注意：Scheme::hasColumn() 仅在未定义 $sortable 时运行 - 每个请求的数据库击中次数较少。

use Kyslik\ColumnSortable\Sortable;

class User extends Model implements AuthenticatableContract, CanResetPasswordContract
{
    use Authenticatable, CanResetPassword, Sortable;
    ...

    public $sortable = ['id',
                        'name',
                        'email',
                        'created_at',
                        'updated_at'];
    ...
}

您已准备就绪。

Sortable 特性为模型添加了 Sortable 范围，因此您可以与 paginate 一起使用它。

Blade 扩展

为您提供了可使用的 blade 扩展 @sortablelink()

@sortablelink('column', 'Title', ['parameter' => 'smile'],  ['rel' => 'nofollow'])

Column（第 1 个）参数是数据库中的列，Title（第 2 个）参数在锚标签内显示，array() 参数（第 3 个）是默认（GET）查询字符串参数，array() 参数（第 4 个）用于额外的锚标签属性。您可以在第 4 个参数中使用自定义 URL 作为 'href' 属性，并将查询字符串附加到它。

您可以省略第 2、3 和 4 个参数。

Blade 扩展的可能示例和用法

@sortablelink('name')
@sortablelink('name', 'Username')
@sortablelink('address', trans('fields.address'), ['filter' => 'active, visible'])
@sortablelink('address', trans('fields.address'), ['filter' => 'active, visible'], ['class' => 'btn btn-block', 'rel' => 'nofollow', 'href' => route('my.custom.route')])

如果您未填写 Title（第 2 个参数），则将使用列名。

注意：您可以为 Title（第 2 个参数）设置默认格式化函数，默认情况下设置为 ucfirst。

简述配置

Sortablelink blade 扩展区分 类型（numeric、amount 和 alpha）并应用不同的类。

请参阅以下片段

'columns' => [
    'numeric'  => [
        'rows' => ['created_at', 'updated_at', 'level', 'id'],
        'class' => 'fa fa-sort-numeric'
    ],
    'amount'   => [
        'rows' => ['price'],
        'class' => 'fa fa-sort-amount'
    ],
    'alpha'    => [
        'rows' => ['name', 'description', 'email', 'slug'],
        'class' => 'fa fa-sort-alpha',
    ],
],

其余的 配置文件 应该非常清晰，我建议您快速浏览。

Font Awesome（默认字体类）

安装Font-Awesome以支持视觉Joy。在cheatsheet中搜索“sort”，自己查看使用过的图标（12个）。

Font Awesome 5

将配置文件config.php中的后缀类从-asc/-desc（FA 4）更改为分别对应的-up/-down（FA 5）。

/* this is FA 5 compatible.
suffix class that is appended when ascending direction is applied */
'asc_suffix'                    => '-up',

/* suffix class that is appended when descending direction is applied */
'desc_suffix'                   => '-down',

注意：如果您还没有发布配置，请按照上面的说明操作。

完整示例

您可能对工作示例仓库感兴趣，其中演示了包的使用。

路由

Route::get('users', ['as' => 'users.index', 'uses' => 'HomeController@index']);

控制器 index() 方法

public function index(User $user)
{
    $users = $user->sortable()->paginate(10);

    return view('user.index')->withUsers($users);
}

您可以为空URL设置默认排序参数。

例如：页面首次加载时，默认方向是可配置的（升序）

$users = $user->sortable('name')->paginate(10);
// produces ->orderBy('users.name', 'asc')

$users = $user->sortable(['name'])->paginate(10); 
// produces ->orderBy('users.name', 'asc')

$users = $user->sortable(['name' => 'desc'])->paginate(10);
// produces ->orderBy('users.name', 'desc')

视图（包含分页）

@sortablelink('id', 'Id')
@sortablelink('name')

@foreach ($users as $user)
    {{ $user->name }}
@endforeach
{!! $users->appends(\Request::except('page'))->render() !!}

注意：Blade指令的识别能力取决于指令本身前是否有空格<tr> @sortablelink('Name')

HasOne / BelongsTo 关系排序

定义 hasOne 关系

为了使关系排序生效，您必须在模型中定义hasOne()关系。

/**
* Get the user_detail record associated with the user.
*/
public function detail()
{
    return $this->hasOne(App\UserDetail::class);
}

定义 belongsTo 关系

注意：如果有自引用模型（如评论、类别等），父表将以parent_字符串别名，更多详细信息请参阅问题#60。

/**
 * Get the user that owns the phone.
 */
public function user()
{
    return $this->belongsTo(App\User::class);
}

在User模型中，我们定义了与UserDetail模型（包含电话号码和地址详情）的hasOne关系。

定义 $sortable 数组

在两个模型中定义$sortable数组（否则，包将使用Scheme::hasColumn()，这将产生额外的数据库查询）。

对User

public $sortable = ['id', 'name', 'email', 'created_at', 'updated_at'];

对UserDetail

public $sortable = ['address', 'phone_number'];

Blade 和关系排序

为了告诉包使用关系排序

@sortablelink('detail.phone_number', 'phone')
@sortablelink('user.name', 'name')

注意：包使用模型中定义的“name”方法（而不是表名）的关系。

警告：不要同时使用两个不同的关系，否则您将收到关系未定义的错误。

在配置文件中，您可以设置自己的分隔符，如果.（点）不是您想要的。

'uri_relation_column_separator' => '.'

ColumnSortable 覆盖（高级）

您可以覆盖ColumnSortable的关系功能，基本可以自己编写连接（查询）并手动应用orderBy()。

查看示例

class User extends Model
{
    use Sortable;

    public $sortable = ['name'];
    ...

    public function addressSortable($query, $direction)
    {
        return $query->join('user_details', 'users.id', '=', 'user_details.user_id')
                    ->orderBy('address', $direction)
                    ->select('users.*');
    }
    ...

控制器与以下相同$users = $user->sortable()->paginate(10);

在视图中，只需使用@sortablelink('address')

非常感谢@neutralrockets及其对#8的评论。有关如何使用覆盖的另一个示例，请参阅问题#41。

别名

您可以声明$sortableAs数组，并使用它来别名（绕过列存在检查），并忽略表前缀。

在模型中

...
$sortableAs = ['nick_name'];
...

在控制器中

$users = $user->select(['name as nick_name'])->sortable(['nick_name'])->paginate(10);

在视图中

@sortablelink('nick_name', 'nick')

有关更多别名信息，请参阅#44。

使用 withCount()

别名在您想要使用withCount()排序结果时很有用，有关更多信息，请参阅问题#49。

异常捕获

包会抛出自定义异常ColumnSortableException，包含三个代码（0、1、2）。

代码 0 表示 explode() 无法将 URI 参数 "sort" 分解为两个值。例如：sort=detail..phone_number - 产生一个长度为 3 的数组，导致包抛出代码为 0 的异常。

代码 1 表示 $query->getRelation() 方法失败，这意味着当关系名无效（不存在，未在模型中声明）时。

代码 2 表示通过 sort 参数提供的关联不是 hasOne 实例。

如何捕获示例

...
try {
    $users = $user->with('detail')->sortable(['detail.phone_number'])->paginate(5);
} catch (\Kyslik\ColumnSortable\Exceptions\ColumnSortableException $e) {
    dd($e);
}

注意：我强烈建议捕获 ColumnSortableException，因为问题中有用户输入（GET 参数），任何用户都可以修改它，使得包抛出代码为 0 的 ColumnSortableException。