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

…main

[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 DsOpenSearchBundle\Builder;
 
 use DynamicSearchBundle\Logger\LoggerInterface;
@@ -9,7 +20,8 @@ class ClientBuilder implements ClientBuilderInterface
 {
     public function __construct(
         protected LoggerInterface $logger
-    ) {}
+    ) {
+    }
 
     public function build(array $indexOptions): Client
     {

src/Builder/ClientBuilderInterface.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 DsOpenSearchBundle\Builder;
 
 use OpenSearch\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 DsOpenSearchBundle\Command;
 
 use DsOpenSearchBundle\Manager\IndexManager;
@@ -34,6 +45,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         if (empty($contextName)) {
             $output->writeln('<error>no context definition name given</error>');
+
             return Command::FAILURE;
         }
 
@@ -52,6 +64,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $this->indexManager->rebuildIndex($contextName);
         } catch (\Throwable $e) {
             $output->writeln(sprintf('<error>Error rebuilding index mapping: %s</error>', $e->getMessage()));
+
             return Command::FAILURE;
         }
 

src/Controller/Admin/IndexController.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 DsOpenSearchBundle\Controller\Admin;
 
 use DsOpenSearchBundle\Manager\IndexManager;
@@ -11,8 +22,7 @@ class IndexController extends AdminAbstractController
 {
     public function __construct(
         protected IndexManager $indexManager
-    )
-    {
+    ) {
     }
 
     public function rebuildMappingAction(Request $request): Response
@@ -31,5 +41,4 @@ public function rebuildMappingAction(Request $request): Response
 
         return new Response();
     }
-
 }

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 DsOpenSearchBundle\DependencyInjection;
 
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;

src/DependencyInjection/DsOpenSearchExtension.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 DsOpenSearchBundle\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 DsOpenSearchExtension extends Extension
 {

src/DsOpenSearchBundle.php

@@ -1,10 +1,20 @@
 <?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 DsOpenSearchBundle;
 
 use DynamicSearchBundle\Provider\Extension\ProviderBundleInterface;
 use Pimcore\Extension\Bundle\AbstractPimcoreBundle;
-use Symfony\Component\HttpKernel\Bundle\Bundle;
 
 final class DsOpenSearchBundle extends AbstractPimcoreBundle implements ProviderBundleInterface
 {

src/DsOpenSearchEvents.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 DsOpenSearchBundle;
 
 final class DsOpenSearchEvents
 {
     /**
-     * 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_opensearch.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_opensearch.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_opensearch.post_commit';
 

src/EventListener/Admin/AssetListener.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 DsOpenSearchBundle\EventListener\Admin;
 
 use Pimcore\Event\BundleManager\PathsEvent;
@@ -21,5 +32,4 @@ public function addJsFiles(PathsEvent $event): void
             '/bundles/dsopensearch/js/backend/settings.js',
         ]);
     }
-
 }

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 DsOpenSearchBundle\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 DsOpenSearchBundle\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 DsOpenSearchBundle\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 DsOpenSearchBundle\Index\Field;
 
 final class ExplicitField extends AbstractType

src/Manager/IndexManager.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 DsOpenSearchBundle\Manager;
 
 use DsOpenSearchBundle\Builder\ClientBuilderInterface;
@@ -11,13 +22,11 @@
 
 class IndexManager
 {
-
     public function __construct(
         protected ContextDefinitionBuilderInterface $contextDefinitionBuilder,
         protected IndexDocumentGeneratorInterface $indexDocumentGenerator,
         protected ClientBuilderInterface $clientBuilder,
-    )
-    {
+    ) {
     }
 
     public function rebuildIndex(string $contextName): void
@@ -34,7 +43,8 @@ public function rebuildIndex(string $contextName): void
             throw new \Exception(
                 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
                 )
             );
         }
@@ -59,6 +69,4 @@ public function rebuildIndex(string $contextName): void
 
         $indexService->createIndex($indexDocument);
     }
-
-
 }

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 DsOpenSearchBundle\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 DsOpenSearchBundle\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__);
         }