added support for Symfony 5 (#1592)

Co-authored-by: Karel <[email protected]>

Author: kuraobi

.travis.yml

@@ -29,6 +29,8 @@ matrix:
       env: DEPENDENCIES="symfony/flex" SYMFONY_VERSION="^3.4"
     - php: 7.4
       env: DEPENDENCIES="symfony/flex" SYMFONY_VERSION="^4.4"
+    - php: 7.4
+      env: DEPENDENCIES="symfony/flex" SYMFONY_VERSION="^5.0"
 
 before_install:
   - if [[ $COVERAGE != true ]]; then phpenv config-rm xdebug.ini || true; fi

composer.json

@@ -13,30 +13,30 @@
     ],
     "require": {
         "php": "^7.1",
-        "symfony/framework-bundle": "^3.4|^4.3",
-        "symfony/console": "^3.4|^4.3",
-        "symfony/dependency-injection": "^3.4|^4.3",
-        "symfony/property-access": "^3.4|^4.3",
+        "symfony/framework-bundle": "^3.4|^4.3|^5",
+        "symfony/console": "^3.4|^4.3|^5",
+        "symfony/dependency-injection": "^3.4|^4.3|^5",
+        "symfony/property-access": "^3.4|^4.3|^5",
         "pagerfanta/pagerfanta": "^1.0.5|^2.0",
         "psr/log": "^1.0",
         "ruflin/elastica": "^5.3.5|^6.1.1"
     },
     "require-dev": {
         "doctrine/orm": "^2.5",
-        "doctrine/doctrine-bundle": "^1.6",
+        "doctrine/doctrine-bundle": "^1.6|^2",
         "doctrine/persistence": "^1.3.4",
         "doctrine/phpcr-bundle": "^1.3|^2.0",
         "doctrine/phpcr-odm": "^1.4",
         "jackalope/jackalope-doctrine-dbal": "^1.2",
-        "jms/serializer-bundle": "^2.2",
-        "phpunit/phpunit": "^5.7.11|^6.5",
-        "knplabs/knp-components": "^1.2",
-        "symfony/expression-language" : "^3.4|^4.3",
-        "symfony/twig-bundle": "^3.4|^4.3",
-        "symfony/serializer": "^3.4|^4.3",
-        "symfony/yaml": "^3.4|^4.3",
+        "jms/serializer-bundle": "^2.4|^3.5",
+        "phpunit/phpunit": "^6.5.14",
+        "knplabs/knp-components": "^1.2|^2.3",
+        "symfony/expression-language" : "^3.4|^4.3|^5",
+        "symfony/twig-bundle": "^3.4|^4.3|^5",
+        "symfony/serializer": "^3.4|^4.3|^5",
+        "symfony/yaml": "^3.4|^4.3|^5",
         "friendsofphp/php-cs-fixer": "^2.2",
-        "symfony/web-profiler-bundle": "^3.4|^4.3"
+        "symfony/web-profiler-bundle": "^3.4|^4.3|^5"
     },
     "suggest": {
         "enqueue/elastica-bundle": "The bundle adds extra features to FOSElasticaBundle bundle. Aimed to improve performance."

src/Command/CreateCommand.php

@@ -55,7 +55,7 @@ protected function configure()
         ;
     }
 
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $indexName = $input->getOption('index');
         $indexes = null === $indexName ? array_keys($this->indexManager->getAllIndexes()) : [$indexName];
@@ -71,5 +71,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             $mapping = $this->mappingBuilder->buildIndexMapping($indexConfig);
             $index->create($mapping, false);
         }
+
+        return 0;
     }
 }

src/Command/PopulateCommand.php

@@ -31,8 +31,9 @@
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Question\Question;
-use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface as LegacyEventDispatcherInterface;
 use Symfony\Component\EventDispatcher\LegacyEventDispatcherProxy;
+use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
 /**
  * Populate the search index.
@@ -42,12 +43,12 @@ class PopulateCommand extends Command
     protected static $defaultName = 'fos:elastica:populate';
 
     /**
-     * @var EventDispatcherInterface 
+     * @var EventDispatcherInterface|LegacyEventDispatcherInterface
      */
     private $dispatcher;
 
     /**
-     * @var IndexManager 
+     * @var IndexManager
      */
     private $indexManager;
 
@@ -72,7 +73,7 @@ class PopulateCommand extends Command
     private $resetter;
 
     public function __construct(
-        EventDispatcherInterface $dispatcher,
+        $dispatcher,
         IndexManager $indexManager,
         PagerProviderRegistry $pagerProviderRegistry,
         PagerPersisterRegistry $pagerPersisterRegistry,
@@ -125,7 +126,7 @@ protected function initialize(InputInterface $input, OutputInterface $output)
         }
     }
 
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $index = $input->getOption('index');
         $type = $input->getOption('type');
@@ -149,7 +150,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             /** @var QuestionHelper $dialog */
             $dialog = $this->getHelperSet()->get('question');
             if (!$dialog->ask($input, $output, new Question('<question>You chose to reset the index and start indexing with an offset. Do you really want to do that?</question>'))) {
-                return;
+                return 0;
             }
         }
 
@@ -170,6 +171,8 @@ protected function execute(InputInterface $input, OutputInterface $output)
                 $this->populateIndex($output, $index, $reset, $options);
             }
         }
+
+        return 0;
     }
 
     /**
@@ -183,7 +186,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
     private function populateIndex(OutputInterface $output, $index, $reset, $options)
     {
         $event = new IndexPopulateEvent($index, $reset, $options);
-        $this->dispatcher->dispatch(IndexPopulateEvent::PRE_INDEX_POPULATE, $event);
+        $this->dispatch($event, IndexPopulateEvent::PRE_INDEX_POPULATE);
 
         if ($event->isReset()) {
             $output->writeln(sprintf('<info>Resetting</info> <comment>%s</comment>', $index));
@@ -195,7 +198,7 @@ private function populateIndex(OutputInterface $output, $index, $reset, $options
             $this->populateIndexType($output, $index, $type, false, $event->getOptions());
         }
 
-        $this->dispatcher->dispatch(IndexPopulateEvent::POST_INDEX_POPULATE, $event);
+        $this->dispatch($event, IndexPopulateEvent::POST_INDEX_POPULATE);
 
         $this->refreshIndex($output, $index);
     }
@@ -212,7 +215,7 @@ private function populateIndex(OutputInterface $output, $index, $reset, $options
     private function populateIndexType(OutputInterface $output, $index, $type, $reset, $options)
     {
         $event = new TypePopulateEvent($index, $type, $reset, $options);
-        $this->dispatcher->dispatch(TypePopulateEvent::PRE_TYPE_POPULATE, $event);
+        $this->dispatch($event, TypePopulateEvent::PRE_TYPE_POPULATE);
 
         if ($event->isReset()) {
             $output->writeln(sprintf('<info>Resetting</info> <comment>%s/%s</comment>', $index, $type));
@@ -264,7 +267,7 @@ function(PostAsyncInsertObjectsEvent $event) use ($loggerClosure) {
 
         $this->pagerPersister->insert($pager, $options);
 
-        $this->dispatcher->dispatch(TypePopulateEvent::POST_TYPE_POPULATE, $event);
+        $this->dispatch($event, TypePopulateEvent::POST_TYPE_POPULATE);
 
         $this->refreshIndex($output, $index);
     }
@@ -281,4 +284,15 @@ private function refreshIndex(OutputInterface $output, $index)
         $this->indexManager->getIndex($index)->refresh();
         $output->writeln("");
     }
+
+    private function dispatch($event, $eventName): void
+    {
+        if ($this->dispatcher instanceof EventDispatcherInterface) {
+            // Symfony >= 4.3
+            $this->dispatcher->dispatch($event, $eventName);
+        } else {
+            // Symfony 3.4
+            $this->dispatcher->dispatch($eventName, $event);
+        }
+    }
 }

src/Command/ResetCommand.php

@@ -49,7 +49,7 @@ protected function configure()
         ;
     }
 
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $index = $input->getOption('index');
         $type = $input->getOption('type');
@@ -73,5 +73,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
                 $this->resetter->resetIndex($index, false, $force);
             }
         }
+
+        return 0;
     }
 }

src/Command/ResetTemplatesCommand.php

@@ -63,7 +63,7 @@ protected function configure()
     /**
      * {@inheritdoc}
      */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $indexTemplate = $input->getOption('index');
         $deleteByPattern = $input->getOption('force-delete');

src/Command/SearchCommand.php

@@ -52,7 +52,7 @@ protected function configure()
         ;
     }
 
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $indexName = $input->getOption('index');
         $index = $this->indexManager->getIndex($indexName ? $indexName : null);
@@ -69,6 +69,8 @@ protected function execute(InputInterface $input, OutputInterface $output)
         foreach ($resultSet->getResults() as $result) {
             $output->writeLn($this->formatResult($result, $input->getOption('show-field'), $input->getOption('show-source'), $input->getOption('show-id'), $input->getOption('explain')));
         }
+
+        return 0;
     }
 
     /**