README

Author: Igor Pinchuk Email: i.pinchuk.work@gmail.com

Utility functions to convert offset/limit requests into page/page-size arguments.

Installation

Install the package via Composer:

composer require somework/offset-page-logic

Usage

Offset::logic() returns a DTO containing the calculated page (1-based) and page size for the given offset and limit. The method also guards against requesting more rows than are available. All inputs are strict integers; negative values are coerced to 0.

Behavior

Offset::logic() branches through several scenarios to normalize offset/limit inputs into page-based pagination:

• Zeroed inputs – if offset, limit, and nowCount are all 0, the method returns page 0 and size 0, representing a request for “everything” without pagination.
• Limit-only – with offset at 0, a positive limit sets the page size while the page is 1.
• Offset-only – with limit at 0, a positive offset yields page 2 and a size of offset + nowCount (the offset is always at least the page size).
• Limit exceeds current count – when nowCount is positive and smaller than the requested limit, the method recurses by subtracting nowCount from limit and adding it to offset, then resolves the pagination with the remaining values.
• Standard offset/limit division – when both are positive and nowCount is 0, the page and size are derived from offset divided by limit, using the largest divisor of the offset to maximize page size.
• AlreadyGetNeededCountException condition – if nowCount is positive and not less than the requested limit, the method throws AlreadyGetNeededCountException to signal that all required rows are already retrieved.

use SomeWork\OffsetPage\Logic\Offset;

$offset = 0;  // start from the first record
$limit = 10;  // request ten records
$nowCount = 0; // no rows have been processed yet

$result = Offset::logic($offset, $limit, $nowCount);

$result->getPage(); // 1 (first page)
$result->getSize(); // 10 (page size derived from limit)

If the requested limit is already satisfied by nowCount, an exception is thrown:

use SomeWork\OffsetPage\Logic\AlreadyGetNeededCountException;
use SomeWork\OffsetPage\Logic\Offset;

$offset = 0;
$limit = 5;
$nowCount = 5;

$result = Offset::logic($offset, $limit, $nowCount); // throws AlreadyGetNeededCountException

Development

Run the automated checks locally using Composer scripts:

composer install
composer test       # PHPUnit test suite
composer stan       # PHPStan static analysis
composer cs-check   # PHP CS Fixer dry-run for coding standards

License

MIT