ePages 7.48.0 - DE_EPAGES/WebService/API/ResourcePager.pm

Package DE_EPAGES::WebService::API::ResourcePager

implements a pager for REST collections.

Functions

new

new

Creates a pager object and verifies the parameters "Page" and "PageSize". Throws a BadRequest error if one of these parameters is invalid or out of range.

Syntax
$Pager = DE_EPAGES::Product::API::Resource::ResourcePager->new(%Options);
Example
my $Pager = DE_EPAGES::Product::API::Resource::ResourcePager->new({
    Page => $hForm->{'page'},
    PageSize => $hForm->{'resultsPerPage'},
    DefaultPageSize => 10,
    MaxPageSize => 100,
});
Input
%Options (hash)
pager options
  • Page (optional, default=1) - 1-based page number - int
  • PageSize (optional, default=$Options{DefaultPageSize}) - number of items per page - int
  • DefaultPageSize (optional, default=10) - number of items per page id $Options{PageSize} is not specified - int
  • MaxPageSize (optional, default=100) - maximum value of $Options{PageSize} - int
Return
$Pager (DE_EPAGES::Product::API::Resource::ResourcePager)
pager object