Merge pull request #1111 from XWB/hybrid

Pagination of hybrid results

Author: XWB

CHANGELOG-3.2.md

@@ -17,3 +17,4 @@ CHANGELOG for 3.2.x
  * Add Elastica compression option
  * Add support for `defaultSortFieldName` and `defaultSortDirection` pagination options
  * Removed `immediate` option on type persistence configuration
+ * Enable pagination of hybrid results

Finder/PaginatedFinderInterface.php

@@ -27,4 +27,13 @@ public function findPaginated($query, $options = array());
      * @return PaginatorAdapterInterface
      */
     public function createPaginatorAdapter($query, $options = array());
+
+    /**
+     * Creates a hybrid paginator adapter for this query.
+     *
+     * @param mixed $query
+     *
+     * @return PaginatorAdapterInterface
+     */
+    public function createHybridPaginatorAdapter($query);
 }

Finder/TransformedFinder.php

@@ -3,6 +3,7 @@
 namespace FOS\ElasticaBundle\Finder;
 
 use Elastica\Document;
+use FOS\ElasticaBundle\Paginator\HybridPaginatorAdapter;
 use FOS\ElasticaBundle\Transformer\ElasticaToModelTransformerInterface;
 use FOS\ElasticaBundle\Paginator\TransformedPaginatorAdapter;
 use FOS\ElasticaBundle\Paginator\FantaPaginatorAdapter;
@@ -100,4 +101,14 @@ public function createPaginatorAdapter($query, $options = array())
 
         return new TransformedPaginatorAdapter($this->searchable, $query, $options, $this->transformer);
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function createHybridPaginatorAdapter($query)
+    {
+        $query = Query::create($query);
+
+        return new HybridPaginatorAdapter($this->searchable, $query, $this->transformer);
+    }
 }

Paginator/HybridPaginatorAdapter.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace FOS\ElasticaBundle\Paginator;
+
+use FOS\ElasticaBundle\Transformer\ElasticaToModelTransformerInterface;
+use Elastica\SearchableInterface;
+use Elastica\Query;
+
+/**
+ * Allows pagination of \Elastica\Query
+ */
+class HybridPaginatorAdapter extends RawPaginatorAdapter
+{
+    private $transformer;
+
+    /**
+     * @param SearchableInterface $searchable the object to search in
+     * @param Query $query the query to search
+     * @param ElasticaToModelTransformerInterface $transformer the transformer for fetching the results
+     */
+    public function __construct(SearchableInterface $searchable, Query $query, ElasticaToModelTransformerInterface $transformer)
+    {
+        parent::__construct($searchable, $query);
+
+        $this->transformer = $transformer;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getResults($offset, $length)
+    {
+        return new HybridPartialResults($this->getElasticaResults($offset, $length), $this->transformer);
+    }
+}

Paginator/HybridPartialResults.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace FOS\ElasticaBundle\Paginator;
+
+use FOS\ElasticaBundle\Transformer\ElasticaToModelTransformerInterface;
+use Elastica\ResultSet;
+
+/**
+ * Partial transformed result set
+ */
+class HybridPartialResults extends RawPartialResults
+{
+    /**
+     * @var ElasticaToModelTransformerInterface
+     */
+    protected $transformer;
+
+    /**
+     * @param ResultSet                           $resultSet
+     * @param ElasticaToModelTransformerInterface $transformer
+     */
+    public function __construct(ResultSet $resultSet, ElasticaToModelTransformerInterface $transformer)
+    {
+        parent::__construct($resultSet);
+
+        $this->transformer = $transformer;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function toArray()
+    {
+        return $this->transformer->hybridTransform($this->resultSet->getResults());
+    }
+}

Repository.php

@@ -68,4 +68,14 @@ public function createPaginatorAdapter($query, $options = array())
     {
         return $this->finder->createPaginatorAdapter($query, $options);
     }
+
+    /**
+     * @param mixed $query
+     *
+     * @return Paginator\HybridPaginatorAdapter
+     */
+    public function createHybridPaginatorAdapter($query)
+    {
+        return $this->finder->createHybridPaginatorAdapter($query);
+    }
 }

Tests/Finder/TransformedFinderTest.php

@@ -126,4 +126,24 @@ public function testFindPaginatedReturnsAConfiguredPagerfantaObject()
 
         $this->assertInstanceOf('Pagerfanta\Pagerfanta', $pagerfanta);
     }
+
+    public function testCreatePaginatorAdapter()
+    {
+        $searchable = $this->getMock('Elastica\SearchableInterface');
+        $transformer = $this->getMock('FOS\ElasticaBundle\Transformer\ElasticaToModelTransformerInterface');
+
+        $finder = new TransformedFinder($searchable, $transformer);
+
+        $this->assertInstanceOf('FOS\ElasticaBundle\Paginator\TransformedPaginatorAdapter', $finder->createPaginatorAdapter(''));
+    }
+
+    public function testCreateHybridPaginatorAdapter()
+    {
+        $searchable = $this->getMock('Elastica\SearchableInterface');
+        $transformer = $this->getMock('FOS\ElasticaBundle\Transformer\ElasticaToModelTransformerInterface');
+
+        $finder = new TransformedFinder($searchable, $transformer);
+
+        $this->assertInstanceOf('FOS\ElasticaBundle\Paginator\HybridPaginatorAdapter', $finder->createHybridPaginatorAdapter(''));
+    }
 }