README

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

Laravel 5.5-7的列排序

用于处理Laravel 5.5-7版本列排序的包。对于Laravel更早版本，请查看L5.1-3分支。此包是从废弃的kyslik/column-sortable fork而来，以添加自定义排序URL。

设置

Composer

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

{
    "require": {
        "Healyhatman/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...
     */
    Healyhatman\ColumnSortable\ColumnSortableServiceProvider::class,
],

发布配置

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

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

请查看配置文件(config/columnsortable.php)并进行您希望进行的调整。

使用

在您的Eloquent模型(s)内部使用Sortable特质。定义$sortable数组（见下例代码）。

注意：Scheme::hasColumn()仅在未定义$sortable时运行 - 请求时减少数据库访问。

use Healyhatman\ColumnSortable\Sortable;

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

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

您已经设置好了。

Sortable特质为模型添加了排序作用域，因此您可以使用它与paginate一起使用。

Blade 扩展

有一个Blade扩展供您使用@sortablelink()。

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

列（第一个）参数是数据库中的列，标题（第二个）参数在锚标签内显示，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')])

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

注意：您可以设置应用于 标题（第二个参数）的默认格式化函数，默认设置为 ucfirst。

简要配置

Sortablelink 视图扩展区分 类型（数字、金额 和 字母），并为每种类型应用不同的类。

请看以下示例

'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 以视觉化 喜悦。在 速查表 中搜索 "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 模型中，我们定义了 hasOne 关系到 UserDetail 模型（其中包含电话号码和地址详细信息）。

定义 $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关系功能，基本上你可以自己编写join（连接）/查询，并手动应用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()对结果进行排序时，别名非常有用，请参阅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。