[CS] Refactor (#99)

Co-authored-by: DACHCOM Bot <[email protected]>

src/Builder/ContextDefinitionBuilder.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 DynamicSearchBundle\Builder;
 
 use DynamicSearchBundle\Context\ContextDefinitionInterface;
@@ -20,5 +31,4 @@ public function buildContextDefinitionStack(string $dispatchType, array $runtime
     {
         return $this->contextDefinitionFactory->createStack($dispatchType, $runtimeValues);
     }
-
 }

src/Builder/ContextDefinitionBuilderInterface.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 DynamicSearchBundle\Builder;
 
 use DynamicSearchBundle\Context\ContextDefinitionInterface;

src/Command/SearchCommand.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 DynamicSearchBundle\Command;
 
 use DynamicSearchBundle\Command\Traits\SignalWatchTrait;
@@ -23,7 +34,6 @@ public function __construct(
         protected LockServiceInterface $lockService
     ) {
         parent::__construct();
-
     }
 
     protected function configure(): void
@@ -38,7 +48,6 @@ protected function configure(): void
             );
     }
 
-
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         // should we skip context indexing if queue index is running?

src/Command/Traits/SignalWatchTrait.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 DynamicSearchBundle\Command\Traits;
 
 trait SignalWatchTrait

src/Configuration/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 DynamicSearchBundle\Configuration;
 
 class Configuration implements ConfigurationInterface

src/Configuration/ConfigurationInterface.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 DynamicSearchBundle\Configuration;
 
 interface ConfigurationInterface

src/Context/ContextDefinition.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 DynamicSearchBundle\Context;
 
 class ContextDefinition implements ContextDefinitionInterface

src/Context/ContextDefinitionInterface.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 DynamicSearchBundle\Context;
 
 use DynamicSearchBundle\Exception\ContextConfigurationException;

src/Controller/Admin/SettingsController.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 DynamicSearchBundle\Controller\Admin;
 
 use DynamicSearchBundle\Manager\QueueManagerInterface;
@@ -16,15 +27,13 @@ class SettingsController extends AdminAbstractController
 {
     public function __construct(
         private array $contextFullConfiguration
-    )
-    {
+    ) {
     }
 
     public function healthStateAction(HealthStateRegistryInterface $healthStateRegistry): JsonResponse
     {
         $stateLines = [];
         foreach ($healthStateRegistry->all() as $healthStateService) {
-
             $stateIcon = 'pimcore_icon_save';
             if ($healthStateService->getState() === HealthStateInterface::STATE_WARNING) {
                 $stateIcon = 'pimcore_icon_info';
@@ -40,7 +49,6 @@ public function healthStateAction(HealthStateRegistryInterface $healthStateRegis
                 'comment' => $healthStateService->getComment(),
                 'icon'    => $stateIcon,
             ];
-
         }
 
         return $this->json([
@@ -59,7 +67,7 @@ public function indexQueueInfoAction(QueueManagerInterface $queueManager): JsonR
     {
         return $this->json([
             'tableName' => $queueManager->getQueueTableName(),
-            'count' => $queueManager->getTotalQueuedItems()
+            'count'     => $queueManager->getTotalQueuedItems()
         ]);
     }
 

src/Controller/SearchController.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 DynamicSearchBundle\Controller;
 
 use DynamicSearchBundle\Configuration\ConfigurationInterface;

src/Controller/SearchFrontendController.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 DynamicSearchBundle\Controller;
 
 use DynamicSearchBundle\Configuration\ConfigurationInterface;
@@ -69,8 +80,12 @@ protected function renderFrontendSearch(Request $request, string $outputChannelN
                 $outputChannelResult = $this->outputChannelWorkflowProcessor->dispatchOutputChannelQuery($contextName, $outputChannelName);
             } catch (\Throwable $e) {
                 $hasError = true;
-                $errorMessage = sprintf('Error while loading search output channel "%s" for "%s" context. Error was: %s', $outputChannelName, $contextName,
-                    $e->getMessage());
+                $errorMessage = sprintf(
+                    'Error while loading search output channel "%s" for "%s" context. Error was: %s',
+                    $outputChannelName,
+                    $contextName,
+                    $e->getMessage()
+                );
             }
         }
 
@@ -163,7 +178,7 @@ protected function prepareQueryVars(OutputChannelResultInterface $outputChannelR
         ];
     }
 
-    protected function outputChannelExists(string $contextName, string $outputChannelName, bool $multiSearchOnly = false) :bool
+    protected function outputChannelExists(string $contextName, string $outputChannelName, bool $multiSearchOnly = false): bool
     {
         $channelConfig = $this->getOutputChannelConfig($contextName, $outputChannelName);
 
@@ -186,7 +201,7 @@ protected function outputChannelExists(string $contextName, string $outputChanne
         return $channelConfig['use_frontend_controller'] === true;
     }
 
-    protected function getOutputChannelView(string $contextName, string $outputChannelName, string $default) :string
+    protected function getOutputChannelView(string $contextName, string $outputChannelName, string $default): string
     {
         $channelConfig = $this->getOutputChannelConfig($contextName, $outputChannelName);
 

src/DependencyInjection/Compiler/ContextGuardPass.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 DynamicSearchBundle\DependencyInjection\Compiler;
 
 use DynamicSearchBundle\Registry\ContextGuardRegistry;

src/DependencyInjection/Compiler/DataProviderPass.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 DynamicSearchBundle\DependencyInjection\Compiler;
 
 use DynamicSearchBundle\DependencyInjection\Compiler\Helper\OptionsResolverValidator;
@@ -20,7 +31,6 @@ public function process(ContainerBuilder $container): void
 
         foreach ($container->findTaggedServiceIds(self::DATA_PROVIDER_TAG, true) as $id => $tags) {
             foreach ($tags as $attributes) {
-
                 $alias = $attributes['identifier'] ?? null;
                 $serviceName = $alias ?? $id;
 
@@ -32,9 +42,9 @@ public function process(ContainerBuilder $container): void
         $this->validateOptions($container, $serviceDefinitionStack);
     }
 
-    protected function validateOptions(ContainerBuilder $container, array $serviceDefinitionStack): void
+    private function validateOptions(ContainerBuilder $container, array $serviceDefinitionStack): void
     {
-        /** @phpstan-ignore-next-line */
+        /* @phpstan-ignore-next-line */
         if (!$container->hasParameter('dynamic_search.context.full_configuration')) {
             return;
         }
@@ -44,7 +54,6 @@ protected function validateOptions(ContainerBuilder $container, array $serviceDe
         $contextConfiguration = $container->getParameter('dynamic_search.context.full_configuration');
 
         foreach ($contextConfiguration as $contextName => &$contextConfig) {
-
             $contextService = [
                 'serviceName' => $contextConfig['data_provider']['service'] ?? null,
                 'options'     => $contextConfig['data_provider']['options'] ?? null

src/DependencyInjection/Compiler/DefinitionBuilderPass.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 DynamicSearchBundle\DependencyInjection\Compiler;
 
 use DynamicSearchBundle\Registry\DefinitionBuilderRegistry;

src/DependencyInjection/Compiler/HealthStatePass.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 DynamicSearchBundle\DependencyInjection\Compiler;
 
 use DynamicSearchBundle\Registry\HealthStateRegistry;