README

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

• Laravel 5.5-10 的列排序
• 设置
  • Composer
    • Laravel >=5.5 自动发现
    • 手动安装（5.5 之前）
  • 发布配置
• 使用方法
  • Blade 扩展
  • 简要说明
  • Font Awesome（默认字体类）
    • Font Awesome 5
  • 完整示例
    • 路由
    • 控制器的 index() 方法
    • 视图（包含分页）
• HasOne / BelongsTo 关系排序
  • 定义 hasOne 关系
  • 定义 belongsTo 关系
  • 定义 $sortable 数组
  • Blade 和关系排序
• ColumnSortable 覆盖（高级）
• 别名
  • 使用 withCount()
• 异常捕获

设置

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 数组。

'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 扩展

您可以使用 @sortablelink() blade 扩展。

@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 覆盖（高级）

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

请见示例

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表示通过排序参数提供的关联不是hasOne的实例。

如何捕获示例

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

注意

我强烈建议捕获ColumnSortableException，因为存在用户输入（GET参数），任何用户都可以以这种方式修改它，使得包抛出带有代码0的ColumnSortableException。