Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ryanwinchester/laravel-paginates
Laravel controller trait for paginating models
https://github.com/ryanwinchester/laravel-paginates
laravel laravel-package laravel-pagination laravel-paginator php
Last synced: about 2 months ago
JSON representation
Laravel controller trait for paginating models
- Host: GitHub
- URL: https://github.com/ryanwinchester/laravel-paginates
- Owner: ryanwinchester
- License: other
- Created: 2016-10-04T16:44:55.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-07T03:33:34.000Z (about 7 years ago)
- Last Synced: 2024-04-05T03:02:35.080Z (9 months ago)
- Topics: laravel, laravel-package, laravel-pagination, laravel-paginator, php
- Language: PHP
- Size: 20.5 KB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# PaginatesModels
[](https://packagist.org/packages/ryanwinchester/laravel-paginates)
[](https://packagist.org/packages/ryanwinchester/laravel-paginates)
This trait adds a super duper handy method that will give you behaviour from requests slightly similar to what something like `league/fractal` gives you without all the setup and needing to create transformers.
Between this trait, and Eloquent Models' `$casts` and `$hidden` properties, starting a basic API with about as much control as some more *heavyweight* packages give you, will be really quick.
## Install
```
composer require ryanwinchester/laravel-paginates
```
## Usage
Add it to your controller (or base controller, as shown):
```php
// ...
use RyanWinchester\Paginates\PaginatesModels;
class Controller extends BaseController
{
use AuthorizesRequests, DispatchesJobs, ValidatesRequests, PaginatesModels;
}
```
Then use it in your controller methods like so:
```php
class ProductsController extends Controller
{
public function index()
{
$products = $this->paginate(Product::class);
return response()->json($products);
}
}
```
Sometimes because of security or privacy, you may want to limit `include` relationships and/or `columns`.
If that is the case, then be sure to include the parameters you want, making sure to exclude any user-supplied include parameters.
```php
$products = $this->paginate(
Product::class,
$request->except(['include', 'columns'])
);
```
Or, say you want to define some included relationships yourself:
```php
$products = $this->paginate(
Product::with('variations'),
$request->except(['include', 'columns'])
);
```
Or, even limit to specific columns:
```php
$products = $this->paginate(
Product::select(['id', 'price', 'in_stock']),
$request->except('columns')
);
```
You can pass in any builder instance or a model class name.
### Parameters:
- **page** : `page=3` the page number
- **perPage** : `perPage=10` amount to show per page
- **columns** : `columns=title,body,author` limit to certain columns
- **include** : `include=categories,tags` load relations
- **orderBy** : `orderBy=published|desc` order the items by a column and direction
## In action
Then you can go to your route and add some of these optional parameters to page and filter:
# Please try it out and give feedback.
[Taylor thinks it's a good idea](https://github.com/laravel/framework/pull/15741), so I mean what other reason do you need?