README

• 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()
• 需要捕获的异常

Laravel 5.5-8的列排序

用于处理Laravel 5.5-8中列排序的包。对于更早版本的Laravel，请检查L5.1-3分支。

设置

Composer

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

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

发布配置

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

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

查看配置文件（config/columnsortable.php）并按需进行调整。

使用方法

在您的Eloquent模型中内部使用Sortable特质。定义$sortable数组（请参阅以下示例代码）。

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

use Bogddan\ColumnSortable\Sortable;

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

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

您已准备就绪。

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

Blade扩展

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

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

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

您可以选择省略第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

将配置文件中的后缀类名从-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 (\Bogddan\ColumnSortable\Exceptions\ColumnSortableException $e) {
    dd($e);
}

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