README

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

Laravel 5.5-8的列排序

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

设置

Composer

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

{
    "require": {
        "sportdude/column-sortable": "^6.3.1"
    }
}

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...
     */
    Kyslik\ColumnSortable\ColumnSortableServiceProvider::class,
],

发布配置

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

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

查看配置文件(config/columnsortable.php)，并根据需要进行调整。

用法

在您的Eloquent模型中（s）使用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 扩展

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

@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扩展区分类型（数值、金额和字母）并为每个类型应用不同的类。

请参阅以下片段

'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()关系。

/**
* Get the user_detail record associated with the user.
*/
public function detail()
{
    return $this->hasOne(App\UserDetail::class);
}

定义所属关系

注意：如果存在自引用模型（如评论、分类等），则父表将以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 (\Kyslik\ColumnSortable\Exceptions\ColumnSortableException $e) {
    dd($e);
}

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