updated-packages

vendor/yajra/laravel-datatables-oracle/README.md

@@ -1,70 +1,107 @@
-# jQuery DataTables API for Laravel 4|5
+# jQuery DataTables API for Laravel 4|5|6
 
 [![Join the chat at https://gitter.im/yajra/laravel-datatables](https://badges.gitter.im/yajra/laravel-datatables.svg)](https://gitter.im/yajra/laravel-datatables?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![Donate](https://img.shields.io/badge/donate-paypal-blue.svg)](https://www.paypal.me/yajra)
+[![Donate](https://img.shields.io/badge/donate-patreon-blue.svg)](https://www.patreon.com/bePatron?u=4521203)
 
-[![Laravel 4.2|5.0|5.1|5.2](https://img.shields.io/badge/Laravel-4.2|5.0|5.1|5.2-orange.svg)](http://laravel.com)
-[![Latest Stable Version](https://poser.pugx.org/yajra/laravel-datatables-oracle/v/stable)](https://packagist.org/packages/yajra/laravel-datatables-oracle)
+[![Laravel 4.2|5.x|6.x](https://img.shields.io/badge/Laravel-4.2|5.x-orange.svg)](http://laravel.com)
+[![Latest Stable Version](https://img.shields.io/packagist/v/yajra/laravel-datatables-oracle.svg)](https://packagist.org/packages/yajra/laravel-datatables-oracle)
+[![Latest Unstable Version](https://poser.pugx.org/yajra/laravel-datatables-oracle/v/unstable.svg)](https://packagist.org/packages/yajra/laravel-datatables-oracle)
 [![Build Status](https://travis-ci.org/yajra/laravel-datatables.svg?branch=master)](https://travis-ci.org/yajra/laravel-datatables)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/yajra/laravel-datatables/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/yajra/laravel-datatables/?branch=master)
-[![Total Downloads](https://poser.pugx.org/yajra/laravel-datatables-oracle/downloads)](https://packagist.org/packages/yajra/laravel-datatables-oracle)
-[![License](https://poser.pugx.org/yajra/laravel-datatables-oracle/license)](https://packagist.org/packages/yajra/laravel-datatables-oracle)
+[![Total Downloads](https://poser.pugx.org/yajra/laravel-datatables-oracle/downloads.png)](https://packagist.org/packages/yajra/laravel-datatables-oracle)
+[![License](https://img.shields.io/github/license/mashape/apistatus.svg)](https://packagist.org/packages/yajra/laravel-datatables-oracle)
 
 This package is created to handle [server-side](https://www.datatables.net/manual/server-side) works of [DataTables](http://datatables.net) jQuery Plugin via [AJAX option](https://datatables.net/reference/option/ajax) by using Eloquent ORM, Fluent Query Builder or Collection.
 
 ```php
-use Yajra\Datatables\Facades\Datatables;
+return datatables()->of(User::query())->toJson();
+return datatables()->of(DB::table('users'))->toJson();
+return datatables()->of(User::all())->toJson();
 
-// Using Eloquent
-return Datatables::eloquent(User::query())->make(true);
+return datatables()->eloquent(User::query())->toJson();
+return datatables()->query(DB::table('users'))->toJson();
+return datatables()->collection(User::all())->toJson();
 
-// Using Query Builder
-return Datatables::queryBuilder(DB::table('users'))->make(true);
-
-// Using Collection
-return Datatables::collection(User::all())->make(true);
-
-// Using the Engine Factory
-return Datatables::of(User::query())->make(true);
-return Datatables::of(DB::table('users'))->make(true);
-return Datatables::of(User::all())->make(true);
+return datatables(User::query())->toJson();
+return datatables(DB::table('users'))->toJson();
+return datatables(User::all())->toJson();
 ```
 
 ## Requirements
-- [PHP 5.5.9 or later](http://php.net/)
-- [Laravel 5.0 or later](https://github.com/laravel/framework)
-- [DataTables jQuery Plugin](http://datatables.net/) **Version 1.10.xx**
+- [PHP >= 7.0](http://php.net/)
+- [Laravel 5.x|6.x](https://github.com/laravel/framework)
+- [jQuery DataTables v1.10.x](http://datatables.net/)
 
 ## Documentations
-- You will find user friendly and updated documentation in the wiki here: [Laravel Datatables Wiki](https://github.com/yajra/laravel-datatables/wiki)
-- You will find the API Documentation here: [Laravel Datatables API](http://yajra.github.io/laravel-datatables/api/)
-- [Demo Application](http://datatables.yajrabox.com) is available for artisan's reference.
+
+- [Github Docs](https://github.com/yajra/laravel-datatables-docs)
+- [Laravel DataTables Quick Starter](https://yajrabox.com/docs/laravel-datatables/master/quick-starter)
+- [Laravel DataTables Documentation](https://yajrabox.com/docs/laravel-datatables)
+- [Laravel 5.0 - 5.3 Demo Application](https://datatables.yajrabox.com)
+
+**NOTE: Documentation links below are currently offline.**
+
+- [Laravel 5.4 Demo Application](http://dt54.yajrabox.com)
+
+## 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.x    | 9.x
+ 7.x.x    | 9.x
+
+## DataTables 8.x Upgrade Guide
+There are breaking changes since DataTables v8.x.
+If you are upgrading from v7.x to v8.x, please see [upgrade guide](https://yajrabox.com/docs/laravel-datatables/master/upgrade).
 
 ## Quick Installation
-`composer require yajra/laravel-datatables-oracle:~6.0`
+```bash
+$ composer require yajra/laravel-datatables-oracle:"~9.0"
+```
 
-#### Service Provider
-`Yajra\Datatables\DatatablesServiceProvider::class`
+#### Service Provider & Facade (Optional on Laravel 5.5)
+Register provider and facade on your `config/app.php` file.
+```php
+'providers' => [
+    ...,
+    Yajra\DataTables\DataTablesServiceProvider::class,
+]
 
-#### Facade
-`Datatables` facade is automatically registered as an alias for `Yajra\Datatables\Facades\Datatables` class. 
+'aliases' => [
+    ...,
+    'DataTables' => Yajra\DataTables\Facades\DataTables::class,
+]
+```
 
-#### Configuration and Assets
-`$ php artisan vendor:publish --tag=datatables`
+#### Configuration (Optional)
+```bash
+$ php artisan vendor:publish --provider="Yajra\DataTables\DataTablesServiceProvider"
+```
 
 And that's it! Start building out some awesome DataTables!
 
-## Upgrading from v5.x to v6.x
-  - Change all occurrences of `yajra\Datatables` to `Yajra\Datatables`. (Use Sublime's find and replace all for faster update). 
-  - Remove `Datatables` facade registration.
-  - Temporarily comment out `Yajra\Datatables\DatatablesServiceProvider`.
-  - Update package version on your composer.json and use `yajra/laravel-datatables-oracle: ~6.0`
-  - Uncomment the provider `Yajra\Datatables\DatatablesServiceProvider`. 
-
 ## 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 make sure that APP_DEBUG is set to false when your app is on production.
 
+## PHP ARTISAN SERVE BUG
+Please avoid using `php artisan serve` when developing with 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](https://laravel.com/docs/5.4/homestead) or [Valet](https://laravel.com/docs/5.4/valet) when working with the package.
+
 ## Contributing
 
 Please see [CONTRIBUTING](https://github.com/yajra/laravel-datatables/blob/master/.github/CONTRIBUTING.md) for details.
@@ -82,6 +119,3 @@ If you discover any security related issues, please email [aqangeles@gmail.com](
 ## License
 
 The MIT License (MIT). Please see [License File](https://github.com/yajra/laravel-datatables/blob/master/LICENSE.md) for more information.
-
-## Buy me a beer
-<a href='https://pledgie.com/campaigns/29515'><img alt='Click here to lend your support to: Laravel Datatables and make a donation at pledgie.com !' src='https://pledgie.com/campaigns/29515.png?skin_name=chrome' border='0' ></a>