【Laravel】 Sortable을 사용하여 쉽게 정렬 기능을 구현

소개

데이터 일람 화면에서 소트 기능을 붙이고 싶다.
좋아, JavaScript를 사용해 소고 그리고~...라고 엄청 귀찮아! !
라는 것이 있었으므로, 정렬 기능이 간단하게 구현할 수 있는 패키지를 소개합니다.

개발 환경

OS Windows10
PHP 7.4.7
Laravel 8.45.1

사전 준비

먼저 composer에서 이번에 사용할 kyslik/column-sortable 패키지를 추가합니다.$ composer require kyslik/column-sortable

개발

거친 흐름으로,
①Model에 Sortable을 선언
②Controller로 DB로부터 데이터를 취득
③View로 표시
됩니다.

①Model에 Sortable을 선언

대상 모델에 Sortable을 use 선언합니다.

Models/Post.php

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Kyslik\ColumnSortable\Sortable; // 追加

class Post extends Model
{
    use Sortable;  // 追加
}

②Controller로 DB로부터 데이터 취득

Controller에 Sortable 쿼리 빌더를 추가합니다.

Controllers/PostsController.php

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use App\Models\Post;

class PostsController extends Controller
{

    public function index()
    {
        $posts = Post::sortable()->get(); //sortable() を先に宣言
        return view('posts.index')->with('posts', $posts);
    }
    .
    .
    .
}

③View로 표시

테이블 구조의 열에 해당하는 부분에 Srotable link를 부여합니다.
기법은 다음과 같습니다.@sortablelink('*column_name*', '*カラム名称*')
posts/index.blade.php

<div>
    <table class="table table-bordered">
        <thead>
        <tr>
            <th scope="col">@sortablelink('id', 'ID')</th>
            <th scope="col">@sortablelink('title', 'タイトル')</th>
            <th scope="col">@sortablelink('text', '本文')</th>
            <th scope="col">@sortablelink('created_at', '作成日時')</th>
            <th scope="col">@sortablelink('updated_at', '更新日時')</th>
        </tr>
        </thead>
        <tbody>
        @foreach($posts as $post)
        <tr>
            <th scope="row">{{ $post->id }}</th>
            <td>{{ $post->title }}</td>
            <td>{{ $post->text }}</td>
            <td>{{ $post->created_at }}</td>
            <td>{{ $post->updated_at }}</td>
        </tr>
        @endforeach 
        </tbody>
    </table>
    </div>
</div>

데모

끝에

뭔가 기능을 추가하고 싶습니다! 라고 하는 경우는 대체로 패키지로서 떨어지고 있으므로, 실장하기 전에 찾아 보면 좋다고 생각합니다.
이번의 정렬 기능은 페이지 네이션과도 함께 사용할 수 있으므로, 추천입니다!

Github 참조