README

Laravel DataTable is a wrapper class for Yajra DataTable, this class is intended to separate query and configuration on yajra datatable and call blade view and serve as json responders when called with ajax to make clean code.

Installation

To install the package, simply follow the steps below.

Install the package using Composer:

$ composer require octopyid/laravel-datatable

Usage

$ artisan make:datatable UserDataTable

Or with the --model option to apply the model to the datatable automatically

$ artisan make:datatable UserDataTable --model=User

UserDataTable.php

<?php

namespace App\DataTables;

use App\Models\User;
use Octopy\DataTable\DataTable;
use Yajra\DataTables\DataTableAbstract;

class UserDataTable extends DataTable
{
    /**
     * @return mixed
     */
    public function query()
    {
        return User::query();
    }

    /**
     * @param  DataTableAbstract $table
     */
    public function option(DataTableAbstract $table) : void
    {
        //
    }
}

UserController.php

<?php

namespace App\Http\Controllers;

use App\DataTables\UserDataTable;

class UserController extends Controller 
{
    /**
     * @param UserDataTable $table
     * @return mixed
     */
    public function index(UserDataTable $table)
    {
        return $table->render('user.datatable', [
            'foo' => 'Bar Baz'
        ]);    
    }
}

Debug

Sometimes we need to see the response in JSON form to debug, just add the query debug=true in the url and ENV_DEBUG=true, then the response will be in json.

https://foobar.example/panel/users?debug=true

Explanation

query

In the query method, it is used only to relate to the database or from other data, and may only return data instances of Collection, Eloquent or Query Builder.

You are free to pass other classes to this method, it will be injected automatically.

option

And in the option method, you are free to modify the results, like column editing, row editing or etc, see Yajra DataTable Doc.

Security

If you discover any security related issues, please email supianidz@gmail.com or supianidz@octopy.id instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

octopyid / laravel-datatable

Maintainers

Details