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

…master [CS] Refactor
dachcom-digital · Jan 6, 2025 · 5fd3769 · 5fd3769
2 parents 1ff5171 + 4ca5b9f
commit 5fd3769
Show file tree

Hide file tree

Showing 33 changed files with 375 additions and 11 deletions.
diff --git a/src/Configuration/Configuration.php b/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 DsLuceneBundle\Configuration;
 
 class Configuration implements ConfigurationInterface

diff --git a/src/Configuration/ConfigurationInterface.php b/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 DsLuceneBundle\Configuration;
 
 interface ConfigurationInterface

diff --git a/src/DependencyInjection/Configuration.php b/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 DsLuceneBundle\DependencyInjection;
 
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
@@ -23,6 +34,6 @@ public function getConfigTreeBuilder(): TreeBuilder
                 ->end()
             ->end();
 
-         return $treeBuilder;
+        return $treeBuilder;
     }
 }
diff --git a/src/DependencyInjection/DsLuceneExtension.php b/src/DependencyInjection/DsLuceneExtension.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 DsLuceneBundle\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 DsLuceneExtension extends Extension
 {

diff --git a/src/DsLuceneBundle.php b/src/DsLuceneBundle.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 DsLuceneBundle;
 
 use DynamicSearchBundle\Provider\Extension\ProviderBundleInterface;

diff --git a/src/DsLuceneEvents.php b/src/DsLuceneEvents.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 DsLuceneBundle;
 
 final class DsLuceneEvents

diff --git a/src/Event/AnalyzerEvent.php b/src/Event/AnalyzerEvent.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 DsLuceneBundle\Event;
 
 use Symfony\Contracts\EventDispatcher\Event;

diff --git a/src/Exception/LuceneException.php b/src/Exception/LuceneException.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 DsLuceneBundle\Exception;
 
 final class LuceneException extends \Exception

diff --git a/src/Factory/AnalyzerFactory.php b/src/Factory/AnalyzerFactory.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 DsLuceneBundle\Factory;
 
 use DsLuceneBundle\DsLuceneEvents;

diff --git a/src/Index/Field/AbstractType.php b/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 DsLuceneBundle\Index\Field;
 
 use DynamicSearchBundle\Index\IndexFieldInterface;

diff --git a/src/Index/Field/BinaryField.php b/src/Index/Field/BinaryField.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 DsLuceneBundle\Index\Field;
 
 use ZendSearch\Lucene;

diff --git a/src/Index/Field/KeywordField.php b/src/Index/Field/KeywordField.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 DsLuceneBundle\Index\Field;
 
 use ZendSearch\Lucene;

diff --git a/src/Index/Field/TextField.php b/src/Index/Field/TextField.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 DsLuceneBundle\Index\Field;
 
 use ZendSearch\Lucene;

diff --git a/src/Index/Field/UnIndexedField.php b/src/Index/Field/UnIndexedField.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 DsLuceneBundle\Index\Field;
 
 use ZendSearch\Lucene;

diff --git a/src/Index/Field/UnStoredField.php b/src/Index/Field/UnStoredField.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 DsLuceneBundle\Index\Field;
 
 use ZendSearch\Lucene;

diff --git a/src/Lucene/Analyzer/CaseInsensitive.php b/src/Lucene/Analyzer/CaseInsensitive.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 DsLuceneBundle\Lucene\Analyzer;
 
 use ZendSearch\Lucene\Analysis\Analyzer\Common;

diff --git a/src/Lucene/Analyzer/Syllable.php b/src/Lucene/Analyzer/Syllable.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 DsLuceneBundle\Lucene\Analyzer;
 
 use Org\Heigl\Hyphenator;

diff --git a/src/Lucene/Filter/AsciiFolding/AsciiFoldingFilter.php b/src/Lucene/Filter/AsciiFolding/AsciiFoldingFilter.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 DsLuceneBundle\Lucene\Filter\AsciiFolding;
 
 use ZendSearch\Lucene\Analysis\Token;

diff --git a/src/Lucene/Filter/Stemming/SnowBallStemmingFilter.php b/src/Lucene/Filter/Stemming/SnowBallStemmingFilter.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 DsLuceneBundle\Lucene\Filter\Stemming;
 
 use Wamania\Snowball\Stemmer;
@@ -11,7 +22,6 @@ class SnowBallStemmingFilter implements TokenFilterInterface
     public const MIN_TOKEN_LENGTH = 1;
 
     protected ?string $locale = null;
-
     protected array $cache = [];
     protected array $mapping = [
         'da' => 'Danish',

diff --git a/src/Modifier/TermModifier.php b/src/Modifier/TermModifier.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 DsLuceneBundle\Modifier;
 
 /**

diff --git a/src/Normalizer/DocumentKeyValueNormalizer.php b/src/Normalizer/DocumentKeyValueNormalizer.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 DsLuceneBundle\Normalizer;
 
 use DsLuceneBundle\Normalizer\Helper\LuceneDocumentDataExtractor;
@@ -39,6 +50,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__);
         }