silarhi/cursor-pagination

A doctrine ORM cursor based pagination library for faster batch operations.

1.1.0 2024-03-13 17:27 UTC

Requires

• php: >=8.0
• doctrine/orm: ^2.5|^3.0

Requires (Dev)

• doctrine/data-fixtures: ^1.7
• friendsofphp/php-cs-fixer: ^3.51
• phpstan/phpstan: ^1.10.60
• phpunit/phpunit: ^9.6.15
• rector/rector: ^1.0
• symfony/cache: ^6.0|^7.0
• vimeo/psalm: ^5.23

MIT

• SILARHI

• orm
• pagination
• doctrine
• cursor
• cursor-pagination

README

Installation

composer require silarhi/cursor-pagination

Usage

use Silarhi\CursorPagination\Pagination\CursorPagination;

$queryBuilder = $entityManager
    ->createQueryBuilder('u')
    ->from(User::class, 'u')
    ->where('u.foo = true');

$configurations = new OrderConfigurations(
    new OrderConfiguration('u.createdAt', fn (User $user) => $user->getCreatedAt()),
    new OrderConfiguration('u.id', fn (User $user) => $user->getId()),
);

/** @var CursorPagination<User> $pagination */
$pagination = new CursorPagination($queryBuilder, $configurations, 100);

// Method 1: get results as chunk (recommended)
foreach($pagination->getChunkResults() as $results) {
    foreach($results as $user) {
        // do something with user
    }
    
    $entityManager->flush();
    $entityManager->clear();
}

// Method 2: get single result as iterator
foreach($pagination->getResults() as $user) {
    // do something with user
}

``