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

Add type-hints on signatures of repository-manager methods

Author: XWB

CHANGELOG-6.0.md

@@ -21,6 +21,7 @@ in 6.0 versions.
 * [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 `addIndex`, `getRepository` and `getRepositoryName` from class `FOS\ElasticaBundle\Manager\RepositoryManager` 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`.

src/Manager/RepositoryManager.php

@@ -13,7 +13,6 @@
 
 use FOS\ElasticaBundle\Finder\FinderInterface;
 use FOS\ElasticaBundle\Repository;
-use RuntimeException;
 
 /**
  * @author Richard Miller <[email protected]>
@@ -26,20 +25,14 @@ class RepositoryManager implements RepositoryManagerInterface
     /**
      * @var array
      */
-    private $indexes;
+    private $indexes = [];
 
     /**
      * @var array
      */
-    private $repositories;
+    private $repositories = [];
 
-    public function __construct()
-    {
-        $this->indexes = [];
-        $this->repositories = [];
-    }
-
-    public function addIndex(string $indexName, FinderInterface $finder, string $repositoryName = null): void
+    public function addIndex(string $indexName, FinderInterface $finder, ?string $repositoryName = null): void
     {
         $this->indexes[$indexName] = [
             'finder' => $finder,
@@ -60,7 +53,7 @@ public function getRepository(string $indexName): Repository
         }
 
         if (!$this->hasRepository($indexName)) {
-            throw new RuntimeException(sprintf('No search finder configured for %s', $indexName));
+            throw new \RuntimeException(sprintf('No repository configured for %s', $indexName));
         }
 
         $repository = $this->createRepository($indexName);
@@ -74,12 +67,7 @@ public function hasRepository(string $indexName): bool
         return isset($this->indexes[$indexName]);
     }
 
-    /**
-     * @param $indexName
-     *
-     * @return string
-     */
-    protected function getRepositoryName($indexName)
+    protected function getRepositoryName(string $indexName): string
     {
         if (isset($this->indexes[$indexName]['repositoryName'])) {
             return $this->indexes[$indexName]['repositoryName'];
@@ -89,14 +77,12 @@ protected function getRepositoryName($indexName)
     }
 
     /**
-     * @param $indexName
-     *
      * @return mixed
      */
-    private function createRepository($indexName)
+    private function createRepository(string $indexName)
     {
         if (!class_exists($repositoryName = $this->getRepositoryName($indexName))) {
-            throw new RuntimeException(sprintf('%s repository for %s does not exist', $repositoryName, $indexName));
+            throw new \RuntimeException(sprintf('%s repository for %s does not exist', $repositoryName, $indexName));
         }
 
         return new $repositoryName($this->indexes[$indexName]['finder']);