https://github.com/yajra/laravel-datatables-scout

Laravel DataTables plugin to support Laravel Scout.
https://github.com/yajra/laravel-datatables-scout

datatables laravel plugin scout

Last synced: 7 months ago
JSON representation

Laravel DataTables plugin to support Laravel Scout.

• Host: GitHub
• URL: https://github.com/yajra/laravel-datatables-scout
• Owner: yajra
• License: mit
• Created: 2017-07-19T12:15:53.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-07-20T01:35:55.000Z (about 8 years ago)
• Last Synced: 2025-02-28T21:07:06.339Z (7 months ago)
• Topics: datatables, laravel, plugin, scout
• Language: PHP
• Size: 9.77 KB
• Stars: 12
• Watchers: 2
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# Laravel DataTables Scout Plugin

[![Laravel 5.4|5.5](https://img.shields.io/badge/Laravel-5.4|5.5-orange.svg)](http://laravel.com)

[![Latest Stable Version](https://img.shields.io/packagist/v/yajra/laravel-datatables-scout.svg)](https://packagist.org/packages/yajra/laravel-datatables-scout)

[![Build Status](https://travis-ci.org/yajra/laravel-datatables-scout.svg?branch=master)](https://travis-ci.org/yajra/laravel-datatables-scout)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/yajra/laravel-datatables-scout/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/yajra/laravel-datatables-scout/?branch=master)

[![Total Downloads](https://img.shields.io/packagist/dt/yajra/laravel-datatables-scout.svg)](https://packagist.org/packages/yajra/laravel-datatables-scout)

[![License](https://img.shields.io/github/license/mashape/apistatus.svg)](https://packagist.org/packages/yajra/laravel-datatables-scout)

This package is a plugin of [Laravel DataTables](https://github.com/yajra/laravel-datatables) to support searching using [Laravel Scout](https://github.com/laravel/scout).

## Requirements

- [PHP >=7.0](http://php.net/)

- [Laravel 5.4|5.5](https://github.com/laravel/framework)

- [Laravel Scout](https://github.com/laravel/scout)

- [Laravel DataTables](https://github.com/yajra/laravel-datatables)

- [jQuery DataTables v1.10.x](http://datatables.net/)

## Documentations

- [Laravel DataTables Documentation](http://yajrabox.com/docs/laravel-datatables)

## Installation

`composer require yajra/laravel-datatables-scout:^1.0`

## Usage

### Use the dataTable class directly.

```php

use Yajra\DataTables\ScoutDataTable;

$model = new App\User;

return (new ScoutDataTable($model))->toJson()

```

### Use via trait.

1. You need to use `ScoutDataTable` trait on your model.

```php

use Yajra\DataTables\Traits\ScoutDataTable;

class User extends Model

{

	use ScoutDataTable;

}

```

2. Process dataTable directly from your model.

```php

Route::get('users/data', function() {

	return User::dataTable()->toJson();

});

```

## Contributing

Please see [CONTRIBUTING](https://github.com/yajra/laravel-datatables-scout/blob/master/.github/CONTRIBUTING.md) for details.

## Security

If you discover any security related issues, please email [aqangeles@gmail.com](mailto:aqangeles@gmail.com) instead of using the issue tracker.

## Credits

- [Arjay Angeles](https://github.com/yajra)

- [All Contributors](https://github.com/yajra/laravel-datatables-scout/graphs/contributors)

## License

The MIT License (MIT). Please see [License File](https://github.com/yajra/laravel-datatables-scout/blob/master/LICENSE.md) for more information.

## Buy me a beer