Merge pull request #1803 from deguif/resetter-signature

Add type-hints to ResetterInterface

Author: XWB

CHANGELOG-6.0.md

@@ -6,7 +6,8 @@ in 6.0 versions.
 
 ### 6.0.0-RC1 (2021-xx-xx)
 
-* **[BC break]** Signature of `FOS\ElasticaBundle\Configuration\Source\SourceInterface::getConfiguration()` has changed.
+* **[BC break]** Changed signature of `FOS\ElasticaBundle\Configuration\Source\SourceInterface::getConfiguration()`.
+* **[BC break]** Changed signature of methods `resetAllIndexes` and `resetIndex` from interface `FOS\ElasticaBundle\Index\ResetterInterface` and its implementations.
 
 ### 6.0.0-BETA4 (2021-05-24)
 
@@ -20,9 +21,9 @@ in 6.0 versions.
 * **[BC break]** Marked the `fos_elastica.client_prototype` service as private.
 * **[BC break]** Marked the `fos_elastica.index_template_prototype` service as private.
 * **[BC break]** Marked all events final and introduced several abstract classes.
-* **[BC break]** Signature of `FantaPaginatorAdapter::getNbResults()` has changed.
-* **[BC break]** Signature of `FantaPaginatorAdapter::getSlice()` has changed.
-* **[BC break]** Signature of `PartialResultsInterface::toArray()`, `PartialResultsInterface::getTotalHits()` and `PartialResultsInterface::getAggregations()` have changed.
+* **[BC break]** Changed signature of `FantaPaginatorAdapter::getNbResults()`.
+* **[BC break]** Changed signature of `FantaPaginatorAdapter::getSlice()`.
+* **[BC break]** Changed signature of `PartialResultsInterface::toArray()`, `PartialResultsInterface::getTotalHits()` and `PartialResultsInterface::getAggregations()`.
 
 ### 6.0.0-BETA3 (2020-09-28)
 

src/Index/Resetter.php

@@ -63,7 +63,7 @@ public function __construct(
     /**
      * Deletes and recreates all indexes.
      */
-    public function resetAllIndexes(bool $populating = false, bool $force = false)
+    public function resetAllIndexes(bool $populating = false, bool $force = false): void
     {
         foreach ($this->configManager->getIndexNames() as $name) {
             $this->resetIndex($name, $populating, $force);
@@ -76,7 +76,7 @@ public function resetAllIndexes(bool $populating = false, bool $force = false)
      *
      * @throws \InvalidArgumentException if no index exists for the given name
      */
-    public function resetIndex(string $indexName, bool $populating = false, bool $force = false)
+    public function resetIndex(string $indexName, bool $populating = false, bool $force = false): void
     {
         $indexConfig = $this->configManager->getIndexConfiguration($indexName);
         $index = $this->indexManager->getIndex($indexName);
@@ -102,7 +102,7 @@ public function resetIndex(string $indexName, bool $populating = false, bool $fo
      *
      * @throws \FOS\ElasticaBundle\Exception\AliasIsIndexException
      */
-    public function switchIndexAlias(string $indexName, bool $delete = true)
+    public function switchIndexAlias(string $indexName, bool $delete = true): void
     {
         $indexConfig = $this->configManager->getIndexConfiguration($indexName);
 

src/Index/ResetterInterface.php

@@ -20,15 +20,11 @@ interface ResetterInterface
 {
     /**
      * Reset all indexes.
-     *
-     * @return void
      */
-    public function resetAllIndexes();
+    public function resetAllIndexes(): void;
 
     /**
      * Reset index.
-     *
-     * @return void
      */
-    public function resetIndex(string $indexName);
+    public function resetIndex(string $indexName): void;
 }

src/Index/TemplateResetter.php

@@ -39,8 +39,6 @@ class TemplateResetter implements ResetterInterface
     private $client;
 
     /**
-     * Index template manager.
-     *
      * @var IndexTemplateManager
      */
     private $indexTemplateManager;
@@ -57,14 +55,14 @@ public function __construct(
         $this->indexTemplateManager = $indexTemplateManager;
     }
 
-    public function resetAllIndexes($deleteIndexes = false)
+    public function resetAllIndexes(bool $deleteIndexes = false): void
     {
         foreach ($this->configManager->getIndexNames() as $name) {
             $this->resetIndex($name, $deleteIndexes);
         }
     }
 
-    public function resetIndex(string $indexName, bool $deleteIndexes = false)
+    public function resetIndex(string $indexName, bool $deleteIndexes = false): void
     {
         $indexTemplateConfig = $this->configManager->getIndexConfiguration($indexName);
         if (!$indexTemplateConfig instanceof IndexTemplateConfig) {
@@ -82,7 +80,7 @@ public function resetIndex(string $indexName, bool $deleteIndexes = false)
     /**
      * Delete all template indexes.
      */
-    public function deleteTemplateIndexes(IndexTemplateConfig $template)
+    public function deleteTemplateIndexes(IndexTemplateConfig $template): void
     {
         $this->client->request($template->getTemplate().'/', Request::DELETE);
     }