Eloquent compatible DataTable plugin for server side ajax call handling.
If you are familiar with eloquent and would like to use it in combination with datatables this is what you are looking for.
composer require livecontrol/eloquent-datatable
For more information check out the datatables manual.
var table = $('#example').DataTable({
"processing": true,
"serverSide": true,
"ajax": {
"url": "<url to datatable route>",
"type": "POST"
}
});
$users = new Models\User();
$dataTable = new LiveControl\EloquentDataTable\DataTable($users, ['email', 'firstname', 'lastname']);
echo json_encode($dataTable->make());
Just initialize the DataTable object as you would normally and call the setVersionTransformer function as in the following example (for version 1.09 of DataTables):
$dataTable->setVersionTransformer(new LiveControl\EloquentDataTable\VersionTransformers\Version109Transformer());
By default the plugin will be loading the transformer which is compatible with DataTables version 1.10.
use LiveControl\EloquentDataTable\DataTable;
class UserController {
...
public function datatable()
{
$users = new User();
$dataTable = new DataTable(
$users->where('city', '=', 'London'),
['email', 'firstname', 'lastname']
);
return response()->json($dataTable->make());
}
}
In this case we are making a datatable response with all users who live in London.
If you want to combine the firstname and lastname into one column, you can wrap them into an array.
use LiveControl\EloquentDataTable\DataTable;
class UserController {
...
public function datatable()
{
$users = new User();
$dataTable = new DataTable(
$users,
['email', ['firstname', 'lastname'], 'city']
);
return response()->json($dataTable->make());
}
}
Sometimes you want to use custom sql statements on a column to get specific results,
this can be achieved using the ExpressionWithName
class.
use LiveControl\EloquentDataTable\DataTable;
use LiveControl\EloquentDataTable\ExpressionWithName;
class UserController {
...
public function datatable()
{
$users = new User();
$dataTable = new DataTable(
$users,
[
'email',
new ExpressionWithName('`id` + 1000', 'idPlus1000'),
'city'
]
);
return response()->json($dataTable->make());
}
}
If you would like to return a custom row format you can do this by adding an anonymous function as an extra argument to the make method.
use LiveControl\EloquentDataTable\DataTable;
use LiveControl\EloquentDataTable\ExpressionWithName;
class UserController {
...
public function datatable()
{
$users = new User();
$dataTable = new DataTable($users, ['email', ['firstname', 'lastname'], 'city']);
$dataTable->setFormatRowFunction(function ($user) {
return [
$user->id,
'<a href="/users/' . $user->id . '">' . $user->firstnameLastname . '</a>',
'<a href="mailto:' . $user->email . '">' . $user->email . '</a>',
$user->city,
'<a href="/users/delete/' . $user->id . '">×</a>'
];
});
return response()->json($dataTable->make());
}
}