Giter VIP home page Giter VIP logo

aggregationbuilderpaginationbundle's Introduction

LudoAggregationBuilderPaginationBundle

pipeline_status

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()
        );
    }
}

aggregationbuilderpaginationbundle's People

Contributors

ssv445 avatar ludo444 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.