Merge pull request #1656 from deguif/type-hint-repository-signatures

Add type-hints on signatures of repository methods

Author: XWB

CHANGELOG-6.0.md

@@ -15,12 +15,13 @@ in 6.0 versions.
 * [BC break] Signature of method `FOS\ElasticaBundle\HybridResult::getResult()` was changed.
 * [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 method `FOS\ElasticaBundle\Provider\PagerProviderInterface::provide()` 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.
 * [BC break] Signature of methods `request`, `getIndex`, `getIndexTemplate` and `setStopwatch` from class `FOS\ElasticaBundle\Elastica\Client` were changed.
 * [BC break] Signature of methods `logQuery`, `getNbQueries` and `getQueries` from class `FOS\ElasticaBundle\Logger\ElasticaLogger` were changed.
+* [BC break] Signature of methods `find`, `findHybrid`, `findPaginated` and `createPaginatorAdapter` from class `FOS\ElasticaBundle\Repository` were changed.
 * [BC break] Removed `Elastica\Type`.
 * [BC break] Removed `_parent`.
 * [BC Break] Removed `FOS\ElasticaBundle\Persister\Event\Events` class, use class events instead.

src/Repository.php

@@ -31,46 +31,40 @@ public function __construct(PaginatedFinderInterface $finder)
 
     /**
      * @param mixed $query
-     * @param int   $limit
-     * @param array $options
      *
      * @return array
      */
-    public function find($query, $limit = null, $options = [])
+    public function find($query, ?int $limit = null, array $options = [])
     {
         return $this->finder->find($query, $limit, $options);
     }
 
     /**
      * @param mixed $query
-     * @param int   $limit
-     * @param array $options
      *
      * @return mixed
      */
-    public function findHybrid($query, $limit = null, $options = [])
+    public function findHybrid($query, ?int $limit = null, array $options = [])
     {
         return $this->finder->findHybrid($query, $limit, $options);
     }
 
     /**
      * @param mixed $query
-     * @param array $options
      *
      * @return \Pagerfanta\Pagerfanta
      */
-    public function findPaginated($query, $options = [])
+    public function findPaginated($query, array $options = [])
     {
         return $this->finder->findPaginated($query, $options);
     }
 
     /**
      * @param mixed $query
-     * @param array $options
      *
      * @return Paginator\PaginatorAdapterInterface
      */
-    public function createPaginatorAdapter($query, $options = [])
+    public function createPaginatorAdapter($query, array $options = [])
     {
         return $this->finder->createPaginatorAdapter($query, $options);
     }