eastown/laravel-pagination

Pagination for laravel

dev-master 2024-05-16 11:20 UTC

Requires

• php: >=7.0.0
• illuminate/database: ^5|^6|^7|^8|^9|^10|^11
• illuminate/http: ^5|^6|^7|^8|^9|^10|^11
• illuminate/support: ^5|^6|^7|^8|^9|^10|^11

MIT

• Eastown

README

Pagination for laravel

Installation

composer require eastown/laravel-pagination

Example Models

\App\User

• id
• name
• score
• group_id (group belongsTo \App\UserGroup)

\App\UserGroup

• id
• name

Usage

$pagination = (new Eastown\Pagination\Pagination(new \App\User()))
       ->setCurrentPage(1)
       ->setPageSize(20)
       ->conditions([
          new Condition('id', \Eastown\Pagination\Operator::GTE, 100),
          new Condition('id', \Eastown\Pagination\Operator::LTE, 10000),
      ])
      // Simple way
      // ->conditions([
      //          ['id', 'GTE', 100],
      //          ['id', 'LTE', 100],
      // ])
       ->selects([
           new \Eastown\Pagination\Select('SUM(score)', 'total_score'),
           new \Eastown\Pagination\Select('id'),
           new \Eastown\Pagination\Select('name'),
       ])
       // Simple way
       // ->selects([
       //   ['SUM(score)', 'total_score'],
       //   ['id'], // or just use string 'id',
       //   ['name']
       // ])
       ->groups([
           new \Eastown\Pagination\Group('id')
       ])
       // Simple way
       // ->groups([
       //   'id'
       // ])
       ->sorts([
            new \Eastown\Pagination\Sort('id', \Eastown\Pagination\Sort::SORT_DESC)
       ])
       // Simple way
      // ->sorts([
      //   ['id', 'desc']
      // ])
       ;
       

$total = $pagination->total();
$sum = $pagination->sum(['score']);
$data = $pagination->query();

// with page info
$info = $pagination->paginate();

// Output exp
// [
//    'data': [...],
//    'total': 100,
//    'page_size': 20,
//    'current_page': 1 
// ]


// Map results
$info = $pagination->paginate(function($user){
    $user->token = uniqid();
    return $user;
});

Condition

(new Eastown\Pagination\Pagination(new \App\User()))
       ->setCurrentPage(1)
       ->setPageSize(20)
       ->conditions([
          new Condition('id', \Eastown\Pagination\Operator::GTE, 100),
          new Condition('id', \Eastown\Pagination\Operator::LTE, 10000),
          new Condition('id', \Eastown\Pagination\Operator::IN, [100, 101, 102]),
          new Condition('id', \Eastown\Pagination\Operator::NOT_IN, [201, 202, 203]),
          new Condition('name', \Eastown\Pagination\Operator::LIKE, '%aaa%'),
          new Condition('name', \Eastown\Pagination\Operator::NOT_LIKE, '%bbb%'),
          new Condition('score', \Eastown\Pagination\Operator::BETWEEN, [1, 100]),
          new Condition('score', \Eastown\Pagination\Operator::NOT_BETWEEN, [500, 1000]),
          new Condition('name', \Eastown\Pagination\Operator::REGEXP, '*'),
          new Condition('group', \Eastown\Pagination\Operator::HAS, 
            [
                new Condition('name', \Eastown\Pagination\Operator::EQ, 'test_group')
            ]
          ),
          new Condition('group', \Eastown\Pagination\Operator::DOES_NOT_HAVE, 
            [
              new Condition('name', \Eastown\Pagination\Operator::EQ, 'test_group2')
            ]
          )
      ])
      ->paginate();

Simple way

(new Eastown\Pagination\Pagination(new \App\User()))
       ->setCurrentPage(1)
       ->setPageSize(20)
       ->conditions([
            ['id', 'GTE', 100],
            ['id', 'LTE', 10000],
            ['id', 'IN', [100, 101, 102]],
            ['id', 'NOT_IN', [201, 202, 203]],
            ['name', 'LIKE', '%aaa%'],
            ['name', 'NOT_LIKE', '%bbb%'],
            ['score', 'BETWEEN', [1, 100]],
            ['score', 'NOT_BETWEEN', [500, 1000]],
            ['name', 'REGEXP', '*'],
            ['group', 'HAS', 
                [
                    ['name', 'EQ', 'test_group']
                ]
            ],
            ['group', 'DOES_NOT_HAVE', 
                [
                    ['name', 'EQ', 'test_group2']
                ]
            ],
      ])
      ->paginate();

Total

(new Eastown\Pagination\Pagination(new \App\User()))->conditions(...)->total();

// Output exp
// 100

Sum

(new Eastown\Pagination\Pagination(new \App\User()))->conditions(...)->sum(['field1', 'field2']);

// Output exp
// [
//     'field1': 100,
//     'field2': 200
// ]

Work with Request

(new \Eastown\Pagination\RequestPagination(new \App\User()))->request($request)->paginate();

params can be passed by request

• current_page
• page_size
• conditions
• sorts
• selects
• groups
• sum_fields

http://example.com/?sorts[0][0]=id&sorts[0][1]=desc&sum_fields[0]=id&current_page=1&page_size=2&conditions[0][0]=name&conditions[0][1]=LIKE&conditions[0][2]=%3%

http://example.com/?sorts=[{"id":"desc"}]&sum_fields=["id"]&current_page=1&page_size=2&conditions=[["name","LIKE","%3%"]]

http://example.com/?sorts=[{"id":"desc"}]&sum_fields=["id"]&current_page=1&page_size=2&conditions={"name__like__":"%3%"}

relationship usage:

conditions={"group.name__like__":"%test%"}

{
"data": [
        {
            "id": 3,
            "name": "123"
        },
        {
            "id": 2,
            "name": "223"
        }
    ],
    "total": 3,
    "page_size": 2,
    "current_page": 1,
    "request": {
        "conditions": [
            [
              "name", "LIKE", "%3%"
            ]
        ],
        "sorts": [
            [
              "id", "desc"
            ]
        ],
        "sum_fields": [
          "id"
        ],
        "page_size": "2",
        "current_page": "1"
    },
    "sum": {
      "id": 6
    }
}

You can extend Pagination to make your own RequestPagination to handle request by the way you like