[CS] Refactor (#173)

Co-authored-by: DACHCOM Bot <[email protected]>
dachcom-digital · Dec 4, 2024 · d4a83f7 · d4a83f7
1 parent 5930192
commit d4a83f7
Show file tree

Hide file tree

Showing 102 changed files with 1,225 additions and 138 deletions.
diff --git a/src/Adapter/LocaleProvider/AbstractLocaleProvider.php b/src/Adapter/LocaleProvider/AbstractLocaleProvider.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 I18nBundle\Adapter\LocaleProvider;
 
 abstract class AbstractLocaleProvider implements LocaleProviderInterface

diff --git a/src/Adapter/LocaleProvider/LocaleProviderInterface.php b/src/Adapter/LocaleProvider/LocaleProviderInterface.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 I18nBundle\Adapter\LocaleProvider;
 
 use I18nBundle\Model\ZoneInterface;

diff --git a/src/Adapter/LocaleProvider/SystemLocaleProvider.php b/src/Adapter/LocaleProvider/SystemLocaleProvider.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 I18nBundle\Adapter\LocaleProvider;
 
 use I18nBundle\Definitions;

diff --git a/src/Adapter/PathGenerator/AbstractPathGenerator.php b/src/Adapter/PathGenerator/AbstractPathGenerator.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 I18nBundle\Adapter\PathGenerator;
 
 use I18nBundle\Transformer\AlternateRouteItemTransformer;

diff --git a/src/Adapter/PathGenerator/Document.php b/src/Adapter/PathGenerator/Document.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 I18nBundle\Adapter\PathGenerator;
 
 use I18nBundle\Context\I18nContextInterface;
@@ -91,7 +102,6 @@ private function resolveDocumentRoutes(I18nContextInterface $i18nContext, Pimcor
         }
 
         foreach ($zoneSites as $zoneSite) {
-
             if (empty($zoneSite->getLocale())) {
                 continue;
             }
@@ -104,6 +114,7 @@ private function resolveDocumentRoutes(I18nContextInterface $i18nContext, Pimcor
                 if ($zoneSite->getType() === 'hardlink') {
                     $virtualProxyZoneSites[] = $zoneSite;
                 }
+
                 continue;
             }
 
@@ -135,7 +146,6 @@ private function resolveDocumentRoutes(I18nContextInterface $i18nContext, Pimcor
         }
 
         foreach ($virtualProxyZoneSites as $virtualProxyZoneSite) {
-
             $sameLanguageContextIndex = array_search($virtualProxyZoneSite->getLanguageIso(), array_column($routes, 'languageIso'), true);
             if ($sameLanguageContextIndex === false) {
                 continue;

diff --git a/src/Adapter/PathGenerator/DynamicRoute.php b/src/Adapter/PathGenerator/DynamicRoute.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 I18nBundle\Adapter\PathGenerator;
 
 use I18nBundle\Context\I18nContextInterface;
@@ -37,7 +48,6 @@ protected function buildAlternateRoutesStack(I18nContextInterface $i18nContext,
         $this->eventDispatcher->dispatch($event, $eventName);
 
         foreach ($event->getAlternateRouteItems() as $alternateRouteItem) {
-
             if ($alternateRouteItem->isValidAlternateRoute() === false) {
                 continue;
             }
@@ -55,4 +65,3 @@ protected function buildAlternateRoutesStack(I18nContextInterface $i18nContext,
         return $routes;
     }
 }
-
diff --git a/src/Adapter/PathGenerator/PathGeneratorInterface.php b/src/Adapter/PathGenerator/PathGeneratorInterface.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 I18nBundle\Adapter\PathGenerator;
 
 use I18nBundle\Context\I18nContextInterface;

diff --git a/src/Adapter/PathGenerator/StaticRoute.php b/src/Adapter/PathGenerator/StaticRoute.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 I18nBundle\Adapter\PathGenerator;
 
 use I18nBundle\Context\I18nContextInterface;
@@ -45,4 +56,3 @@ protected function generateLink(AlternateRouteItemInterface $routeItem): string
         return $this->router->generate($routeItem->getRouteName() ?? '', $routeParameters, UrlGeneratorInterface::ABSOLUTE_URL);
     }
 }
-
diff --git a/src/Adapter/PathGenerator/Symfony.php b/src/Adapter/PathGenerator/Symfony.php
@@ -1,15 +1,26 @@
 <?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 I18nBundle\Adapter\PathGenerator;
 
 use I18nBundle\Context\I18nContextInterface;
 use I18nBundle\I18nEvents;
 use I18nBundle\Model\RouteItem\AlternateRouteItemInterface;
 use I18nBundle\Model\RouteItem\RouteItemInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 use Symfony\Component\Routing\RouterInterface;
 use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
-use Symfony\Component\OptionsResolver\OptionsResolver;
 
 class Symfony extends DynamicRoute
 {

diff --git a/src/Adapter/Redirector/AbstractRedirector.php b/src/Adapter/Redirector/AbstractRedirector.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 I18nBundle\Adapter\Redirector;
 
 use Symfony\Component\OptionsResolver\OptionsResolver;

diff --git a/src/Adapter/Redirector/CookieRedirector.php b/src/Adapter/Redirector/CookieRedirector.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 I18nBundle\Adapter\Redirector;
 
 use I18nBundle\Helper\CookieHelper;
@@ -8,7 +19,6 @@
 
 class CookieRedirector extends AbstractRedirector
 {
-
     public function makeDecision(RedirectorBag $redirectorBag): void
     {
         $cookieHelper = new CookieHelper($this->config['cookie']);
@@ -48,16 +58,16 @@ protected function getConfigResolver(): OptionsResolver
     {
         $resolver = new OptionsResolver();
         $resolver->setRequired('cookie');
-        $resolver->setDefault('cookie', function(OptionsResolver $cookieResolver) {
+        $resolver->setDefault('cookie', function (OptionsResolver $cookieResolver) {
             $cookieResolver
                 ->setRequired(['path', 'domain', 'secure', 'http_only', 'same_site'])
                 ->setDefaults([
-                    'path' => '/',
-                    'domain' => null,
-                    'secure' => false,
+                    'path'      => '/',
+                    'domain'    => null,
+                    'secure'    => false,
                     'http_only' => true,
                     'same_site' => Cookie::SAMESITE_LAX,
-                    'expire' => '+1 year'
+                    'expire'    => '+1 year'
                 ])
                 ->setAllowedTypes('path', 'string')
                 ->setAllowedTypes('domain', ['string', 'null'])

diff --git a/src/Adapter/Redirector/FallbackRedirector.php b/src/Adapter/Redirector/FallbackRedirector.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 I18nBundle\Adapter\Redirector;
 
 use I18nBundle\Model\ZoneSiteInterface;
@@ -20,6 +31,7 @@ public function makeDecision(RedirectorBag $redirectorBag): void
 
         if (!$zoneSite instanceof ZoneSiteInterface) {
             $this->setDecision(['valid' => false]);
+
             return;
         }
 

diff --git a/src/Adapter/Redirector/GeoRedirector.php b/src/Adapter/Redirector/GeoRedirector.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 I18nBundle\Adapter\Redirector;
 
 use I18nBundle\Helper\UserHelper;
@@ -23,7 +34,7 @@ public function makeDecision(RedirectorBag $redirectorBag): void
 
         /**
          * - Based on string source HTTP_ACCEPT_LANGUAGE ("de,en;q=0.9,de-DE;q=0.8;...")
-         * - Transformed by symfony to [de, en, de_DE, ...]
+         * - Transformed by symfony to [de, en, de_DE, ...].
          */
         $userLanguagesIso = $this->userHelper->getLanguagesAcceptedByUser();
 
@@ -52,7 +63,6 @@ public function makeDecision(RedirectorBag $redirectorBag): void
 
         foreach ($prioritisedList as $index => $list) {
             foreach ($userLanguagesIso as $priority => $userLocale) {
-
                 $country = $list['ignore_country'] ? null : $userCountryIso;
                 $countryStrictMode = $list['strict_country'];
                 $languageStrictMode = $list['strict_language'];
@@ -62,6 +72,7 @@ public function makeDecision(RedirectorBag $redirectorBag): void
                         'priority' => $index === 0 ? -1 : $priority,
                         'site'     => $zoneSite
                     ];
+
                     break;
                 }
             }
@@ -70,6 +81,7 @@ public function makeDecision(RedirectorBag $redirectorBag): void
         // nothing found.
         if (count($prioritisedListQuery) === 0) {
             $this->setDecision(['valid' => false, 'redirectorOptions' => $redirectorOptions]);
+
             return;
         }
 
@@ -97,11 +109,9 @@ protected function findZoneSite(
         bool $countryStrictMode = true,
         bool $languageStrictMode = false
     ): ?ZoneSiteInterface {
-
         $locale = $languageStrictMode ? substr($locale, 0, 2) : $locale;
 
         if ($countryIso === null) {
-
             $indexId = array_search($locale, array_map(static function (ZoneSiteInterface $site) {
                 return $site->getLocale();
             }, $zoneSites), true);
@@ -143,14 +153,14 @@ protected function getConfigResolver(): OptionsResolver
         $resolver = new OptionsResolver();
         $resolver
             ->setRequired('rules')
-            ->setDefault('rules', function(OptionsResolver $rulesResolver) {
-           $rulesResolver
-               ->setPrototype(true)
-               ->setRequired(['ignore_country', 'strict_country', 'strict_language'])
-               ->setAllowedTypes('ignore_country', 'bool')
-               ->setAllowedTypes('strict_country', 'bool')
-               ->setAllowedTypes('strict_language', 'bool');
-        });
+            ->setDefault('rules', function (OptionsResolver $rulesResolver) {
+                $rulesResolver
+                    ->setPrototype(true)
+                    ->setRequired(['ignore_country', 'strict_country', 'strict_language'])
+                    ->setAllowedTypes('ignore_country', 'bool')
+                    ->setAllowedTypes('strict_country', 'bool')
+                    ->setAllowedTypes('strict_language', 'bool');
+            });
 
         return $resolver;
     }

diff --git a/src/Adapter/Redirector/RedirectorBag.php b/src/Adapter/Redirector/RedirectorBag.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 I18nBundle\Adapter\Redirector;
 
 use I18nBundle\Context\I18nContextInterface;