Datatables Package for Laravel 4|5 (Oracle Support)
About
This package is created to handle server-side works of DataTables jQuery Plugin by using Eloquent ORM or Fluent Query Builder.
Feature Overview
- Supporting Eloquent ORM and Fluent Query Builder
- Adding or editing content of columns and removing columns
- Templating new or current columns via Blade Template Engine
Laravel 4 Installation
Add the yajra/datatables under the require key after that run the composer update.
{
"require": {
"laravel/framework": "~4.0",
...
"yajra/laravel-datatables-oracle": "~3.0"
}
...
}Laravel 5 Installation
Add the yajra/datatables under the require key after that run the composer update.
{
"require": {
"laravel/framework": "~5.0",
...
"yajra/laravel-datatables-oracle": "~4.0"
}
...
}Composer will download the package. After package downloaded, open "app/config/app.php" and edit like below:
'providers' => array(
...
'yajra\Datatables\DatatablesServiceProvider',
),
'aliases' => array(
...
'Datatables' => 'yajra\Datatables\Datatables',
),Finally you need to publish a configuration file by running the following Artisan command.
** Laravel 4 **
$ php artisan config:publish yajra/laravel-datatables-oracle** Laravel 5 **
$ php artisan vendor:publish --provider="yajra\Datatables\DatatablesServiceProvider" --tag="config"Usage
It is very simple to use this bundle. Just create your own fluent query object or eloquent object without getting results (that means don't use get(), all() or similar methods) and give it to Datatables. You are free to use all Eloquent ORM and Fluent Query Builder features.
It is better, you know these:
- When you use select method on Eloquent or Fluent Query, you choose columns
- You can easily edit columns by using
editColumn($column, $content) - You can remove any column by using
removeColumn($column)method - You can add columns by using
addColumn($column_name, $content, $order) - You can override the default filter function by using
filter(function($query){}) - You can use Blade Template Engine in your $content values
- The name of columns is set by returned array.
- That means, for 'posts.id' it is 'id' and also for 'owner.name as ownername' it is 'ownername'
Examples
Example 1:
$posts = Post::select(array('posts.id','posts.name','posts.created_at','posts.status'));
return Datatables::of($posts)->make();Example 2:
$place = Place::leftJoin('owner','places.author_id','=','owner.id')
->select(array('places.id','places.name','places.created_at','owner.name as ownername','places.status'));
return Datatables::of($place)
->addColumn('operations','<a href="{{ URL::route( \'admin.post\', array( \'edit\',$id )) }}">edit</a>
<a href="{{ URL::route( \'admin.post\', array( \'delete\',$id )) }}">delete</a>
')
->editColumn('status','@if($status)
Active
@else
Passive
@endif')
// you can also give a function as parameter to editColumn and addColumn instead of blade string
->editColumn('ownername','Author of this post is {{ $ownername }}')
->removeColumn('id')
->make();Example 3: Overriding default filter option
$posts = Post::select(array('posts.id','posts.name','posts.created_at','posts.status'));
return Datatables::of($posts)
->filter(function($query){
if (Input::get('id')) {
$query->where('id','=',Input::get('id'));
}
})->make();Example 4: Accessing Carbon object on timestamps and/or any objects in model
Note: Only applicable if you use Eloquent object.
$posts = Post::select(array('posts.id','posts.name','posts.created_at','posts.status'));
return Datatables::of($posts)
->editColumn('created_at', function($data){ $data->created_at->toDateTimeString() })
->filter(function($query){
if (Input::get('id')) {
$query->where('id','=',Input::get('id'));
}
})->make();Example 5: Returning object data source
$posts = Post::select(array('posts.id','posts.name','posts.created_at','posts.status'));
return Datatables::of($posts)->make(true);###Example View and Controller On your view:
<table id="users" class="table table-hover table-condensed">
<thead>
<tr>
<th class="col-md-3">{{{ Lang::get('users/table.username') }}}</th>
<th class="col-md-3">{{{ Lang::get('users/table.email') }}}</th>
<th class="col-md-3">{{{ Lang::get('users/table.created_at') }}}</th>
<th class="col-md-3">{{{ Lang::get('table.actions') }}}</th>
</tr>
</thead>
</table>
<script type="text/javascript">
$(document).ready(function() {
oTable = $('#users').DataTable({
"processing": true,
"serverSide": true,
"ajax": "/users/data",
"columns": [
{data: 'username', name: 'username'},
{data: 'email', name: 'email'},
{data: 'created_at', name: 'created_at'},
{data: 'actions', name: 'actions'}
]
});
});
</script>On your controller:
public function getData()
{
$users = $this->users->select('*');
return Datatables::of($users)
->addColumn('action', 'action here')
->make(true);
}Notice: If you use double quotes while giving content of addColumn or editColumn, you should escape variables with backslash (\) else you get error. For example:
editColumn('id',"- {{ \$id }}") .License: Licensed under the MIT License