README

• Laravel 5.5-7 的列排序
• 设置
  • Composer
    • Laravel >=5.5 自动发现
    • 手动安装（5.5 之前）
  • 发布配置
• 使用
  • Blade 扩展
  • 简短配置说明
  • Font Awesome（默认字体类）
    • Font Awesome 5

Laravel 5.5-7 的列排序

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

设置

Composer

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

{
    "require": {
        "victorbondaruk/column-sortable": "^6.0"
    }
}

composer update

Laravel >=5.5 自动发现

简单安装包，让 Laravel 进行其魔法操作。

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

手动安装（5.5 之前）

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

'providers' => [

    App\Providers\RouteServiceProvider::class,

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

发布配置

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

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

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

使用

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

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

use VictorBondaruk\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'])

列（第 1 个）参数是数据库中的列，标题（第 2 个）参数在锚标签内显示，array() 参数（第 3 个）是默认（GET）查询字符串参数，array() 参数（第 4 个）是用于附加锚标签属性的。

您可以省略第 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'])

如果您不填写 标题（第 2 个参数），则使用列名代替。

注意：您可以设置应用于 标题（第 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 以获得视觉效果。在 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"（方法）的关系 "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 表示通过排序参数提供的关联不是 hasOne 的实例。

如何捕获的示例

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

注意：我强烈建议捕获 ColumnSortableException 异常，因为存在一个用户输入的问题（GET 参数），任何用户都可以修改它，从而使程序抛出带有代码 0 的 ColumnSortableException 异常。