Merge pull request #30 from dachcom-digital/coding-standard/refactor-…

…master

[CS] Refactor

src/Builder/ClientBuilder.php

@@ -1,5 +1,16 @@
 <?php
 
+/*
+ * This source file is available under two different licenses:
+ *   - GNU General Public License version 3 (GPLv3)
+ *   - DACHCOM Commercial License (DCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ * @copyright  Copyright (c) DACHCOM.DIGITAL AG (https://www.dachcom-digital.com)
+ * @license    GPLv3 and DCL
+ */
+
 namespace DsElasticSearchBundle\Builder;
 
 use DynamicSearchBundle\Logger\LoggerInterface;

src/Builder/ClientBuilderInterface.php

@@ -1,10 +1,21 @@
 <?php
 
+/*
+ * This source file is available under two different licenses:
+ *   - GNU General Public License version 3 (GPLv3)
+ *   - DACHCOM Commercial License (DCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ * @copyright  Copyright (c) DACHCOM.DIGITAL AG (https://www.dachcom-digital.com)
+ * @license    GPLv3 and DCL
+ */
+
 namespace DsElasticSearchBundle\Builder;
 
 use Elasticsearch\Client;
 
 interface ClientBuilderInterface
 {
     public function build(array $indexOptions): Client;
-}
+}

src/Command/RebuildIndexCommand.php

@@ -1,5 +1,16 @@
 <?php
 
+/*
+ * This source file is available under two different licenses:
+ *   - GNU General Public License version 3 (GPLv3)
+ *   - DACHCOM Commercial License (DCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ * @copyright  Copyright (c) DACHCOM.DIGITAL AG (https://www.dachcom-digital.com)
+ * @license    GPLv3 and DCL
+ */
+
 namespace DsElasticSearchBundle\Command;
 
 use DsElasticSearchBundle\Builder\ClientBuilderInterface;
@@ -40,13 +51,15 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         if (empty($contextName)) {
             $output->writeln('<error>no context definition name given</error>');
+
             return 0;
         }
 
         $contextDefinition = $this->contextDefinitionBuilder->buildContextDefinition($contextName, ContextDefinitionInterface::CONTEXT_DISPATCH_TYPE_INDEX);
 
         if (!$contextDefinition instanceof ContextDefinitionInterface) {
             $output->writeln(sprintf('<error>no context definition with name "%s" found</error>', $contextName));
+
             return 0;
         }
 
@@ -56,7 +69,8 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $output->writeln(
                 sprintf(
                     '%s. (The current context index provider also requires pre-configured indices. Please make sure your document definition implements the "%s" interface)',
-                    $e->getMessage(), PreConfiguredIndexProviderInterface::class
+                    $e->getMessage(),
+                    PreConfiguredIndexProviderInterface::class
                 )
             );
 
@@ -80,7 +94,6 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $indexService = new IndexPersistenceService($client, $options);
 
         if ($indexService->indexExists()) {
-
             /** @var QuestionHelper $helper */
             $helper = $this->getHelper('question');
 
@@ -96,6 +109,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 $indexService->dropIndex();
             } catch (\Throwable $e) {
                 $output->writeln(sprintf('Error while dropping index: %s', $e->getMessage()));
+
                 return 0;
             }
         }
@@ -104,6 +118,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $indexService->createIndex($indexDocument);
         } catch (\Throwable $e) {
             $output->writeln(sprintf('Error while creating index: %s', $e->getMessage()));
+
             return 0;
         }
 

src/DependencyInjection/Configuration.php

@@ -1,5 +1,16 @@
 <?php
 
+/*
+ * This source file is available under two different licenses:
+ *   - GNU General Public License version 3 (GPLv3)
+ *   - DACHCOM Commercial License (DCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ * @copyright  Copyright (c) DACHCOM.DIGITAL AG (https://www.dachcom-digital.com)
+ * @license    GPLv3 and DCL
+ */
+
 namespace DsElasticSearchBundle\DependencyInjection;
 
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
@@ -11,4 +22,4 @@ public function getConfigTreeBuilder(): TreeBuilder
     {
         return new TreeBuilder('ds_elasticsearch');
     }
-}
+}

src/DependencyInjection/DsElasticSearchExtension.php

@@ -1,11 +1,22 @@
 <?php
 
+/*
+ * This source file is available under two different licenses:
+ *   - GNU General Public License version 3 (GPLv3)
+ *   - DACHCOM Commercial License (DCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ * @copyright  Copyright (c) DACHCOM.DIGITAL AG (https://www.dachcom-digital.com)
+ * @license    GPLv3 and DCL
+ */
+
 namespace DsElasticSearchBundle\DependencyInjection;
 
+use Symfony\Component\Config\FileLocator;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
-use Symfony\Component\DependencyInjection\ContainerBuilder;
-use Symfony\Component\Config\FileLocator;
 
 class DsElasticSearchExtension extends Extension
 {
@@ -17,4 +28,4 @@ public function load(array $configs, ContainerBuilder $container): void
         $loader = new YamlFileLoader($container, new FileLocator([__DIR__ . '/../../config']));
         $loader->load('services.yaml');
     }
-}
+}

src/DsElasticSearchBundle.php

@@ -1,5 +1,16 @@
 <?php
 
+/*
+ * This source file is available under two different licenses:
+ *   - GNU General Public License version 3 (GPLv3)
+ *   - DACHCOM Commercial License (DCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ * @copyright  Copyright (c) DACHCOM.DIGITAL AG (https://www.dachcom-digital.com)
+ * @license    GPLv3 and DCL
+ */
+
 namespace DsElasticSearchBundle;
 
 use DynamicSearchBundle\Provider\Extension\ProviderBundleInterface;

src/DsElasticSearchEvents.php

@@ -1,21 +1,32 @@
 <?php
 
+/*
+ * This source file is available under two different licenses:
+ *   - GNU General Public License version 3 (GPLv3)
+ *   - DACHCOM Commercial License (DCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ * @copyright  Copyright (c) DACHCOM.DIGITAL AG (https://www.dachcom-digital.com)
+ * @license    GPLv3 and DCL
+ */
+
 namespace DsElasticSearchBundle;
 
 final class DsElasticSearchEvents
 {
     /**
-     * The BULK event occurs before during the processing of bulk method
+     * The BULK event occurs before during the processing of bulk method.
      */
     public const BULK = 'ds_elasticsearch.bulk';
 
     /**
-     * The PRE_COMMIT event occurs before committing queries to ES
+     * The PRE_COMMIT event occurs before committing queries to ES.
      */
     public const PRE_COMMIT = 'ds_elasticsearch.pre_commit';
 
     /**
-     * The POST_COMMIT event occurs after committing queries to ES
+     * The POST_COMMIT event occurs after committing queries to ES.
      */
     public const POST_COMMIT = 'ds_elasticsearch.post_commit';
 

src/Exception/ClientException.php

@@ -1,5 +1,16 @@
 <?php
 
+/*
+ * This source file is available under two different licenses:
+ *   - GNU General Public License version 3 (GPLv3)
+ *   - DACHCOM Commercial License (DCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ * @copyright  Copyright (c) DACHCOM.DIGITAL AG (https://www.dachcom-digital.com)
+ * @license    GPLv3 and DCL
+ */
+
 namespace DsElasticSearchBundle\Exception;
 
 final class ClientException extends \Exception

src/Index/Field/AbstractType.php

@@ -1,5 +1,16 @@
 <?php
 
+/*
+ * This source file is available under two different licenses:
+ *   - GNU General Public License version 3 (GPLv3)
+ *   - DACHCOM Commercial License (DCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ * @copyright  Copyright (c) DACHCOM.DIGITAL AG (https://www.dachcom-digital.com)
+ * @license    GPLv3 and DCL
+ */
+
 namespace DsElasticSearchBundle\Index\Field;
 
 use DynamicSearchBundle\Index\IndexFieldInterface;

src/Index/Field/DynamicField.php

@@ -1,5 +1,16 @@
 <?php
 
+/*
+ * This source file is available under two different licenses:
+ *   - GNU General Public License version 3 (GPLv3)
+ *   - DACHCOM Commercial License (DCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ * @copyright  Copyright (c) DACHCOM.DIGITAL AG (https://www.dachcom-digital.com)
+ * @license    GPLv3 and DCL
+ */
+
 namespace DsElasticSearchBundle\Index\Field;
 
 final class DynamicField extends AbstractType

src/Index/Field/ExplicitField.php

@@ -1,5 +1,16 @@
 <?php
 
+/*
+ * This source file is available under two different licenses:
+ *   - GNU General Public License version 3 (GPLv3)
+ *   - DACHCOM Commercial License (DCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ * @copyright  Copyright (c) DACHCOM.DIGITAL AG (https://www.dachcom-digital.com)
+ * @license    GPLv3 and DCL
+ */
+
 namespace DsElasticSearchBundle\Index\Field;
 
 final class ExplicitField extends AbstractType

src/Normalizer/DocumentRawNormalizer.php

@@ -1,5 +1,16 @@
 <?php
 
+/*
+ * This source file is available under two different licenses:
+ *   - GNU General Public License version 3 (GPLv3)
+ *   - DACHCOM Commercial License (DCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ * @copyright  Copyright (c) DACHCOM.DIGITAL AG (https://www.dachcom-digital.com)
+ * @license    GPLv3 and DCL
+ */
+
 namespace DsElasticSearchBundle\Normalizer;
 
 use DynamicSearchBundle\Context\ContextDefinitionInterface;
@@ -25,6 +36,7 @@ public function normalize(RawResultInterface $rawResult, ContextDefinitionInterf
     {
         if ($rawResult->hasParameter('fullDatabaseResponse') === false) {
             $message = sprintf('Parameter "fullDatabaseResponse" is required to normalize raw result but is missing');
+
             throw new NormalizerException($message, __CLASS__);
         }
 

src/Normalizer/DocumentSourceNormalizer.php

@@ -1,5 +1,16 @@
 <?php
 
+/*
+ * This source file is available under two different licenses:
+ *   - GNU General Public License version 3 (GPLv3)
+ *   - DACHCOM Commercial License (DCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ * @copyright  Copyright (c) DACHCOM.DIGITAL AG (https://www.dachcom-digital.com)
+ * @license    GPLv3 and DCL
+ */
+
 namespace DsElasticSearchBundle\Normalizer;
 
 use DynamicSearchBundle\Context\ContextDefinitionInterface;
@@ -27,6 +38,7 @@ public function normalize(RawResultInterface $rawResult, ContextDefinitionInterf
 
         if (!is_array($data)) {
             $message = sprintf('Data needs to be type of "array", "%s" given', is_object($data) ? get_class($data) : gettype($data));
+
             throw new NormalizerException($message, __CLASS__);
         }
 

src/OutputChannel/Filter/AggregationFilter.php

@@ -1,5 +1,16 @@
 <?php
 
+/*
+ * This source file is available under two different licenses:
+ *   - GNU General Public License version 3 (GPLv3)
+ *   - DACHCOM Commercial License (DCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ * @copyright  Copyright (c) DACHCOM.DIGITAL AG (https://www.dachcom-digital.com)
+ * @license    GPLv3 and DCL
+ */
+
 namespace DsElasticSearchBundle\OutputChannel\Filter;
 
 use DynamicSearchBundle\EventDispatcher\OutputChannelModifierEventDispatcher;
@@ -31,7 +42,7 @@ public function configureOptions(OptionsResolver $resolver): void
         $resolver->setAllowedTypes('relation_label', ['closure', 'null']);
         $resolver->setAllowedTypes('field', ['string']);
         $resolver->setAllowedTypes('query_type', ['string']);
-        
+
         $resolver->setDefaults([
             'query_type'         => BoolQuery::MUST,
             'show_in_frontend'   => true,
@@ -96,7 +107,7 @@ public function buildViewVars(RawResultInterface $rawResult, $filterValues, $que
         $response = $rawResult->getParameter('fullDatabaseResponse');
 
         $viewVars = [
-            'name' => $this->name,
+            'name'     => $this->name,
             'template' => [sprintf('%s/%s.html.twig', self::VIEW_TEMPLATE_PATH, $this->name), sprintf('%s/aggregation.html.twig', self::VIEW_TEMPLATE_PATH)],
             'label'    => $this->options['label'],
             'multiple' => $this->options['multiple'],
@@ -119,7 +130,6 @@ protected function addQueryFilter(Search $query, array $queryFields): void
         }
 
         foreach ($queryFields as $key => $value) {
-
             if ($key !== $this->name) {
                 continue;
             }
@@ -159,7 +169,6 @@ protected function buildResultArray(array $buckets): array
 
         $values = [];
         foreach ($buckets as $bucket) {
-
             $relationLabel = null;
             if ($this->options['relation_label'] !== null) {
                 $relationLabel = call_user_func($this->options['relation_label'], $bucket['key'], $queryFields['locale'] ?? null);