Skip to content

Latest commit

 

History

History
157 lines (116 loc) · 6.3 KB

README.md

File metadata and controls

157 lines (116 loc) · 6.3 KB
Raw

jQuery DataTables API for Laravel

Join the chat at https://gitter.im/yajra/laravel-datatables Donate Donate

Laravel 4.2|5.x|6|7|8|9|10|11 Latest Stable Version Continuous Integration Static Analysis

Total Downloads License

Laravel package for handling server-side works of DataTables jQuery Plugin via AJAX option by using Eloquent ORM, Fluent Query Builder or Collection.

use Yajra\DataTables\Facades\DataTables;

return DataTables::eloquent(User::query())->toJson();
return DataTables::query(DB::table('users'))->toJson();
return DataTables::collection(User::all())->toJson();

return DataTables::make(User::query())->toJson();
return DataTables::make(DB::table('users'))->toJson();
return DataTables::make(User::all())->toJson();

Sponsors

DataTables Logo A big thank you to DataTables for supporting this project with a free DataTables Editor license.
JetBrains Logo A big thank you to JetBrains for supporting this project with free open-source licenses of their IDEs.
Blackfire.io Logo A big thank you to Blackfire.io for supporting this project with a free open-source license.

Requirements

Documentations

Laravel Version Compatibility

Laravel Package
4.2.x 3.x
5.0.x 6.x
5.1.x 6.x
5.2.x 6.x
5.3.x 6.x
5.4.x 7.x, 8.x
5.5.x 8.x
5.6.x 8.x
5.7.x 8.x
5.8.x 9.x
6.x 9.x
7.x 9.x
8.x 9.x
9.x 10.x
10.x 10.x
11.x 11.x

Quick Installation

Option 1: Install all DataTables libraries

composer require yajra/laravel-datatables:"^11"

Option 2: Install only this library

composer require yajra/laravel-datatables-oracle:"^11"

Service Provider & Facade (Optional on Laravel 5.5+)

Register the provider and facade on your config/app.php file.

'providers' => [
    ...,
    Yajra\DataTables\DataTablesServiceProvider::class,
]

'aliases' => [
    ...,
    'DataTables' => Yajra\DataTables\Facades\DataTables::class,
]

Configuration (Optional)

php artisan vendor:publish --provider="Yajra\DataTables\DataTablesServiceProvider"

And that's it! Start building out some awesome DataTables!

Debugging Mode

To enable debugging mode, just set APP_DEBUG=true and the package will include the queries and inputs used when processing the table.

Important

Please ensure that the APP_DEBUG config is set to false when your app is in production.

PHP ARTISAN SERVE BUG

Please avoid using php artisan serve when developing the package. There are known bugs when using this where Laravel randomly returns a redirect and 401 (Unauthorized) if the route requires authentication and a 404 NotFoundHttpException on valid routes.

It is advised to use Homestead or Valet when working with the package.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security-related issues, please email [email protected] instead of using the issue tracker.

Credits

License

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