ssv445 / aggregation-builder-pagination-bundle
Paginate Doctrine MongoDB ODM AggregationBuilder with KnpPaginatorBundle
Installs: 6
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Type:symfony-bundle
Requires
- php: ^8.1
- ext-mongodb: *
- doctrine/mongodb-odm-bundle: ^4.5
- knplabs/knp-paginator-bundle: ^5.9
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.16
- phpmd/phpmd: ^2.8
- phpstan/phpstan: ^0.12.18
This package is auto-updated.
Last update: 2024-05-18 10:01:08 UTC
README
Extension bundle for Symfony's KnpPaginatorBundle that allows to paginate
DoctrineMongoDBBundle Doctrine\ODM\MongoDB\Aggregation\Builder
.
Requirements
Bundle uses MongoDB $facet
operator which is available since MongoDB 3.4.
Installation with Symfony Flex
Open a command console, enter your project directory and execute:
$ composer require ssv445/aggregation-builder-pagination-bundle
Installation without Symfony Flex
Step 1: Download the Bundle
Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:
$ composer require ssv445/aggregation-builder-pagination-bundle
Step 2: Enable the Bundle
Then, enable the bundle by adding it to the list of registered bundles
in the config/bundles.php
file of your project:
// config/bundles.php return [ // ... Ludo\Bundle\AggregationBuilderPaginationBundle\LudoAggregationBuilderPaginationBundle::class => ['all' => true], ];
Usage
Doctrine\ODM\MongoDB\Aggregation\Builder
needs to be passed into paginate()
method. Be aware that
most of the Builder
methods are returning Doctrine\ODM\MongoDB\Aggregation\Stage
. So you need to do eg.:
// src/Repository/ExampleRepository.php use Doctrine\ODM\MongoDB\Aggregation\Builder as AggregationBuilder; // ... class ExampleRepository extends Repository { public function getExamples(): AggregationBuilder { $ab = $this->createAggregationBuilder(); $ab->hydrate(Example::class) ->match() ->field('field') ->equals('value'); return $ab; } }
As ->equals('value')
would not return AggregationBuilder
, the code would throw an Exception
if you return
the result of that method directly. Now to paginate the example repository method, you can just do:
// src/Subfolder/ExamplePagination.php // ... class ExamplePagination { // ... public function __construct(DocumentManager $manager, PaginatorInterface $paginator) { $this->manager = $manager; $this->paginator = $paginator; } public function getPaginatedExamples(): PaginationInterface { return $this->paginator->paginate( $this->manager->getRepository(ExampleRepository::class)->getExamples() ); } }