Merge pull request #1654 from deguif/type-hint-pager-provider-signatures

Add type-hints on signatures of pager-provider methods

Author: XWB

CHANGELOG-6.0.md

@@ -14,6 +14,7 @@ in 6.0 versions.
 * Removed `FOS\ElasticaBundle\Exception\InvalidArgumentTypeException`
 * [BC break] Signature of method `FOS\ElasticaBundle\Finder\FinderInterface::find()` was changed.
 * [BC break] Signature of method `FOS\ElasticaBundle\Persister\ObjectPersisterInterface::handlesObject()` was changed.
+* [BC break] Signature of method `FOS\ElasticaBundle\Provider\PagerProviderInterface::provider()` was changed.
 * [BC break] Signature of methods `getPager`, `getOptions` and `getObjectPersister` from interface `FOS\ElasticaBundle\Persister\Event\PersistEvent` were changed.
 * [BC break] Signature of methods `getNbResults`, `getNbPages`, `getCurrentPage`, `setCurrentPage`, `getMaxPerPage` and `setMaxPerPage` from interface `FOS\ElasticaBundle\Provider\PagerInterface` were changed.
 * [BC break] Signature of methods `findPaginated`, `createPaginatorAdapter` and `createRawPaginatorAdapter` from interface `FOS\ElasticaBundle\Finder\PaginatedFinderInterface` were changed.

src/Doctrine/MongoDBPagerProvider.php

@@ -13,6 +13,7 @@
 
 use Doctrine\Persistence\ManagerRegistry;
 use FOS\ElasticaBundle\Provider\PagerfantaPager;
+use FOS\ElasticaBundle\Provider\PagerInterface;
 use FOS\ElasticaBundle\Provider\PagerProviderInterface;
 use Pagerfanta\Adapter\DoctrineODMMongoDBAdapter;
 use Pagerfanta\Pagerfanta;
@@ -53,7 +54,7 @@ public function __construct(ManagerRegistry $doctrine, RegisterListenersService
     /**
      * {@inheritdoc}
      */
-    public function provide(array $options = [])
+    public function provide(array $options = []): PagerInterface
     {
         $options = array_replace($this->baseOptions, $options);
 

src/Doctrine/ORMPagerProvider.php

@@ -15,6 +15,7 @@
 use Doctrine\ORM\QueryBuilder;
 use Doctrine\Persistence\ManagerRegistry;
 use FOS\ElasticaBundle\Provider\PagerfantaPager;
+use FOS\ElasticaBundle\Provider\PagerInterface;
 use FOS\ElasticaBundle\Provider\PagerProviderInterface;
 use Pagerfanta\Adapter\DoctrineORMAdapter;
 use Pagerfanta\Pagerfanta;
@@ -57,7 +58,7 @@ public function __construct(ManagerRegistry $doctrine, RegisterListenersService
     /**
      * {@inheritdoc}
      */
-    public function provide(array $options = [])
+    public function provide(array $options = []): PagerInterface
     {
         $options = array_replace($this->baseOptions, $options);
 

src/Doctrine/PHPCRPagerProvider.php

@@ -13,6 +13,7 @@
 
 use Doctrine\Persistence\ManagerRegistry;
 use FOS\ElasticaBundle\Provider\PagerfantaPager;
+use FOS\ElasticaBundle\Provider\PagerInterface;
 use FOS\ElasticaBundle\Provider\PagerProviderInterface;
 use Pagerfanta\Adapter\DoctrineODMPhpcrAdapter;
 use Pagerfanta\Pagerfanta;
@@ -55,7 +56,7 @@ public function __construct(ManagerRegistry $doctrine, RegisterListenersService
     /**
      * {@inheritdoc}
      */
-    public function provide(array $options = [])
+    public function provide(array $options = []): PagerInterface
     {
         $options = array_replace($this->baseOptions, $options);
 

src/Provider/PagerProviderInterface.php

@@ -13,8 +13,5 @@
 
 interface PagerProviderInterface
 {
-    /**
-     * @return PagerInterface
-     */
-    public function provide(array $options = []);
+    public function provide(array $options = []): PagerInterface;
 }

src/Provider/PagerProviderRegistry.php

@@ -45,7 +45,7 @@ public function getProviders()
      *
      * @throws \InvalidArgumentException if no provider was registered for the index and type
      */
-    public function getProvider(string $index): ?PagerProviderInterface
+    public function getProvider(string $index): PagerProviderInterface
     {
         if (!$this->providers->has($index)) {
             throw new \InvalidArgumentException(sprintf('No provider was registered for index "%s".', $index));