FORGEBOX Enterprise 🚀 - Take your ColdFusion (CFML) Development to Modern Times! Learn More...

The ColdBox Paginator

v2.6.2 Public

Welcome to the Pagination Module

This module builds the pagination struct for API responses and custom data tables.

LICENSE

Apache License, Version 2.0.

SYSTEM REQUIREMENTS

  • Adobe ColdFusion 2016+
  • Lucee 4.5 or later

Instructions

Just drop into your modules folder or use the box cli to install

box install cbpaginator

Usage

First you will need to inject the paginator into your service/handler:

property name="cbpaginator" inject="[email protected]";

This module provides two functions to build your pagination struct:

generate

public struct function generate(
    numeric totalRecords = 0,
    numeric page = 1,
    numeric maxRows = 25
)

Returns the pagination struct according to the total records.

If page and maxRows parameters are not passed in, it will use the default values.

The response will look like the following:

{
    "totalPages": 0,
    "maxRows": 25,
    "offset": 0,
    "page": 1,
    "totalRecords": 0
}

generateWithResults

public struct function generateWithResults(
    numeric totalRecords = 0,
    array results = [],
    numeric page = 1,
    numeric maxRows = settings.defaults.maxRows,
    boolean asResultsMap = false,
    string keyName = "id",
    string resultsKeyName = "results"
)

This function returns the same pagination struct as the above along with the results

You can convert your results to be a resultsMap by setting asResultsMap to true

In addition you can set a name for your results key by passing in the resultsKeyName value as a parameter. By default this key is called results

{
    "pagination": {
        "totalPages": 0,
        "maxRows": 25,
        "offset": 0,
        "page": 1,
        "totalRecords": 0
    },
    "results": [],
    // optional
    "resultsMap": {}
}

generateSimple

public struct function generateSimple(
        required boolean hasMore,
        numeric page = 1,
        numeric maxRows = 25
    )

Generates a simple pagination struct with the following struct

{ "hasMore" : boolean, "maxRows" : numeric, "offset" : numeric, "page" : numeric }

generateSimpleWithResults

public struct function generateSimpleWithResults(
        array results = [],
        numeric page = 1,
        numeric maxRows = 25,
        boolean asResultsMap = false,
        string keyName = "id",
        string resultsKeyName = "results"
    )

Generates a simple pagination struct with along with the results following struct

reduceAndGenerate

public struct function reduceAndGenerate( 
        required array results, 
        numeric page = 0, 
        maxRows = 25 
    )

Reduce and paginate an array to bring back only the records requested in the page. Very useful when we want to sort all the results first and then paginate them

Helper Method

getPageOffset

Since we have to calculate the offset before we filter our data we can use the getPageOffset() function to calculate that number for us

	public function getPageOffset( 
        page = 1,
        maxRows = 25 
    )

This function receives two arguments. The page number and the maxRows to retrieve. If no params are passed in, the defaults will be used.

Dependencies (0)


Dev Dependencies (1)


readme.md

 

$ box install cbpaginator

   
  • {{ getFullDate("Dec 10 2020 09:12 PM GMT") }}
  • {{ getFullDate("Dec 10 2020 09:12 PM GMT") }}
  • 940
  • 0
  • 42,298