[PHP知识库]Laravel 8 ORM 分页功能简化

laravel 8 的分页方法在模板开发中挺好用，但是在开发API的时候就有点不太适合

在网上找到一些方法，然后根据自己的需要进行了修改。

我想要的就是以下JSON格式

{
    "data": [
        {
            "id": 3,
            "name": "王五",
            "user_type": 1
        },
        {
            "id": 4,
            "name": "赵六",
            "user_type": 1
        }
    ],
    "total": 7,
    "currentPage": 2
}

那么要达成目的，就首先看文档

在laravel 文档里提到一句手动创建分页。

地址在这里?https://learnku.com/docs/laravel/8.x/pagination/9402#manually-creating-a-paginator

然后加上网上老哥的帮助

大概做法是这样的

首先写一个service，当然写其他层也可以，继承LengthAwarePaginator

<?php


namespace App\Service;


class LengthAwarePaginatorService extends \Illuminate\Pagination\LengthAwarePaginator
{
    public function toArray()
    {
        return [
            'data' => $this->items->toArray(),
            'total' => $this->total(),
            'currentPage'=>$this->currentPage(),
        ];
    }
}

紧接着在AppServiceProvider里面注册

以下是部分代码，主要是register方法里面的

<?php

namespace App\Providers;

use App\Service\LengthAwarePaginatorService;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    /**
     * Register any application services.
     *
     * @return void
     */
    public function register()
    {
        $this->app->bind('Illuminate\Pagination\LengthAwarePaginator',function ($app,$options){
            return new LengthAwarePaginatorService($options['items'], $options['total'], $options['perPage'], $options['currentPage'] , $options['options']);
        });

    }
}

但是现在有个问题是使用paginate链式方法，如果我url的查询参数里面传的是page和limit，查出来的数据会有点问题。

但是我又想使用paginate这么方便的方法。

查看了一下源码，paginate方法是可以传入4个参数的，分别是$perPage, $columns,?$pageName, $page

四个参数分别代表每一页要多少条数据，查询的列名（通常是*，代表查询所有的列），然后是查询的page的名字，最后是查询的第几页。

如果我要查询第一页，每一页显示30条数据那么最终写出来的效果 User::paginate(30,'*','page',1)；

这样也太不laravel了！

这个顺序和我习惯的参数顺序不太一样，并且中间两个参数在大部分情况下写起来比较麻烦

这里我还是选择再一次封装了一下paginate方法

使用了Builder添加了一个paging的链式方法

注意这段代码也要在AppServiceProvider的register方法里注册

Builder::macro("paging",function ($page,$limit,$column="*",$pageName="page"){
            if(is_null($page))$page = 1;
            if(is_null($limit))$limit = 50;
            return $this->paginate($limit,$column,$pageName,$page);
        });

最终可以这样调用系统的链式方法那样，直接调用我们自己写好的方法

User::paging($request->page,$request->limit);

这样子就方便很多了！