搜索qlick / column-sortable
Laravel 6.x 处理列排序的包
Requires
- php: ^8.1
Requires (Dev)
- orchestra/testbench: ^5.0|^7.0
- phpunit/phpunit: ^9.5
This package is auto-updated.
Last update: 2024-09-16 18:28:16 UTC
README
Laravel 5.5-8 的列排序
处理 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 模型（s）内部使用 Sortable 特性。定义 $sortable 数组（请参阅下面的示例代码）。
注意：仅当
$sortable未定义时才运行Scheme::hasColumn()- 每个请求的数据库访问次数更少。
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 （第一个）参数是数据库中的列，Title （第二个）参数显示在锚标签内，array() 参数（第三个）是默认（GET）查询字符串参数，array() 参数（第四个）是用于附加到锚标签的额外属性。您可以在第四个参数中使用自定义 URL 作为 'href' 属性，并将查询字符串附加到它。
您可以省略第二个、第三个和第四个参数。
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 （第二个参数），则使用列名代替。
注意：您可以设置应用于 Title （第二个参数）的默认格式化函数，默认情况下，这设置为
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
在配置文件中将后缀类从-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')
别名
您可能声明一个$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表示通过排序参数提供的关联不是hasOne的实例。
示例如何捕获
... try { $users = $user->with('detail')->sortable(['detail.phone_number'])->paginate(5); } catch (\Kyslik\ColumnSortable\Exceptions\ColumnSortableException $e) { dd($e); }
注意：我强烈建议捕获
ColumnSortableException，因为涉及用户输入（GET参数），任何用户都可以将其修改为使包抛出带有代码0的ColumnSortableException。