laralabs/datatablejson

Easily generate DataTable JSON from an eloquent collection and bind it to the view

DataTableJson for Laravel

This package aims to simplify the process of creating JSON data for DataTable components., _(*1)

Recently I started using a Vue DataTable component and found that I needed a simple way of formatting and passing the data into the view to keep everything tidy., _(*2)

Installation

Install the package via composer, _(*3)

{
    "require": {
      "laralabs/datatablejson": "~1.0.1"     
    }
}

Once you have updated composer, add the Service Provider to your providers array within config/app.php, _(*4)

'providers' => [
    Laralabs\DataTableJson\DataTableJsonServiceProvider::class
];

Now you can publish the config file to config/datatablejson.php, _(*5)

php artisan vendor:publish --tag=config

Edit the published configuration file to suit your application., _(*6)

It is recommended that you change the namespace from the default 'window', _(*7)

Usage

Add the trait to the top of your Eloquent Model, _(*8)

use DataTableJsonTrait;

Add public $columns = [] to your model, this defines the columns that will be used in the table., _(*9)

Here is an example of a populated $columns array:, _(*10)

    public $columns = [
        [
            "label" => "ID",
            "field" => "id",
            "searchable" => true,
            "orderable" => true
        ],
        [
            "label" => "First Name",
            "field" => "first_name",
            "searchable" => true,
            "orderable" => true
        ],
        [
            "label" => "Actions",
            "field" => "actions",
            "searchable" => false,
            "orderable" => false,
            "html" => true,
            "content" => '<a class="btn waves-light waves-effect" href="/admin/users/edit/{id}">
                            <i class="fa fa-pencil"></i>
                        </a>'
        ]
    ];

The Actions column in the example shows how you create columns that can include HTML snippets, pull in data from other fields by using {field_name}, _(*11)

Once the columns have been defined you can then create a collection and apply the conversion function., _(*12)

$users = Users::all();
$users->toDataTableJson();

This will build up the data and prepend it to the view that you specified in the configuration file., _(*13)

Got a special case and need a different set of fields? You can pass a $columns array to this function which will override the columns specified in the model., _(*14)

$columns = [
    [
      "....." => "...."
    ]
]
$users = Users::all();
$users->toDataTableJson($columns);

This package is designed to work well with MicroDroid/vue-materialize-datatable, _(*15)

Credits

Thanks to Jeffrey Way over at Laracasts for his awesome Laracasts/PHP-Vars-To-Js-Transformer package which allowed me to include the view binding functionality., _(*16)

Support

Please raise an issue on Github if there is a problem., _(*17)

License

This is open-sourced software licensed under the MIT license., _(*18)