Merge pull request #235 from dfeyer/feature-indexname-strategy

FEATURE: IndexName Strategy

Author: dfeyer

Classes/ElasticSearchClient.php

@@ -11,6 +11,7 @@
  * source code.
  */
 
+use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Service\IndexNameStrategyInterface;
 use Neos\Flow\Annotations as Flow;
 use Neos\Flow\Configuration\ConfigurationManager;
 
@@ -27,30 +28,10 @@
 class ElasticSearchClient extends \Flowpack\ElasticSearch\Domain\Model\Client
 {
     /**
-     * The index name to be used for querying (by default "neoscr")
-     *
-     * @var string
-     */
-    protected $indexName;
-
-    /**
+     * @var IndexNameStrategyInterface
      * @Flow\Inject
-     * @var ConfigurationManager
-     */
-    protected $configurationManager;
-
-    /**
-     * Called by the Flow object framework after creating the object and resolving all dependencies.
-     *
-     * @param integer $cause Creation cause
      */
-    public function initializeObject($cause)
-    {
-        if ($cause === \Neos\Flow\ObjectManagement\ObjectManagerInterface::INITIALIZATIONCAUSE_CREATED) {
-            $settings = $this->configurationManager->getConfiguration(ConfigurationManager::CONFIGURATION_TYPE_SETTINGS, 'Neos.ContentRepository.Search');
-            $this->indexName = $settings['elasticSearch']['indexName'];
-        }
-    }
+    protected $indexNameStrategy;
 
     /**
      * Get the index name to be used
@@ -59,7 +40,11 @@ public function initializeObject($cause)
      */
     public function getIndexName()
     {
-        return $this->indexName;
+        $name = trim($this->indexNameStrategy->get());
+        if ($name === '') {
+            throw new Exception('Index name can not be null');
+        }
+        return $name;
     }
 
     /**
@@ -70,6 +55,6 @@ public function getIndexName()
      */
     public function getIndex()
     {
-        return $this->findIndex($this->indexName);
+        return $this->findIndex($this->getIndexName());
     }
 }

Classes/Service/IndexNameStrategy.php

@@ -0,0 +1,38 @@
+<?php
+namespace Flowpack\ElasticSearch\ContentRepositoryAdaptor\Service;
+
+/*
+ * This file is part of the Flowpack.ElasticSearch.ContentRepositoryAdaptor package.
+ *
+ * (c) Contributors of the Neos Project - www.neos.io
+ *
+ * This package is Open Source Software. For the full copyright and license
+ * information, please view the LICENSE file which was distributed with this
+ * source code.
+ */
+
+use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception;
+use Neos\Flow\Annotations as Flow;
+
+/**
+ * Get Index Name from Settings
+ *
+ * @Flow\Scope("singleton")
+ */
+class IndexNameStrategy implements IndexNameStrategyInterface
+{
+    /**
+     * @var string
+     * @Flow\InjectConfiguration(path="elasticSearch.indexName", package="Neos.ContentRepository.Search")
+     */
+    protected $indexName;
+
+    public function get()
+    {
+        $name = $this->indexName;
+        if ($name === '') {
+            throw new Exception('Index name can not be null, check Settings at path: Neos.ContentRepository.Search.elasticSearch.indexName');
+        }
+        return $name;
+    }
+}

Classes/Service/IndexNameStrategyInterface.php

@@ -0,0 +1,21 @@
+<?php
+namespace Flowpack\ElasticSearch\ContentRepositoryAdaptor\Service;
+
+/*
+ * This file is part of the Flowpack.ElasticSearch.ContentRepositoryAdaptor package.
+ *
+ * (c) Contributors of the Neos Project - www.neos.io
+ *
+ * This package is Open Source Software. For the full copyright and license
+ * information, please view the LICENSE file which was distributed with this
+ * source code.
+ */
+
+
+/**
+ * Get Index Name
+ */
+interface IndexNameStrategyInterface
+{
+    public function get();
+}