Update and run CS fixer

terminal42 · Mar 16, 2023 · f29490e · f29490e
1 parent 57d6fc9
commit f29490e
Show file tree

Hide file tree

Showing 17 changed files with 467 additions and 206 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,4 @@
-/vendor
+/node_modules/
+/tools/**/vendor/
+/vendor/
 /composer.lock
-/.php_cs.cache
-/node_modules
diff --git a/.php_cs b/.php_cs
diff --git a/composer.json b/composer.json
@@ -35,8 +35,7 @@
         "doctrine/dbal": "^2.11 || ^3.0"
     },
     "require-dev": {
-        "contao/manager-plugin": "^2.0",
-        "friendsofphp/php-cs-fixer": "^2.1"
+        "contao/manager-plugin": "^2.0"
     },
     "conflict": {
         "contao/manager-plugin": "<2.0 || >=3.0"
@@ -52,10 +51,7 @@
     "extra": {
         "contao-manager-plugin": "Terminal42\\DcMultilingualBundle\\ContaoManager\\Plugin"
     },
-    "config": {
-        "allow-plugins": {
-            "composer/package-versions-deprecated": true,
-            "contao/manager-plugin": true
-        }
+    "scripts": {
+        "cs-fixer": "@php tools/ecs/vendor/bin/ecs check src --config tools/ecs/config.php --fix --ansi"
     }
 }
diff --git a/src/ContaoManager/Plugin.php b/src/ContaoManager/Plugin.php
@@ -1,13 +1,6 @@
 <?php
 
-/*
- * dc_multilingual Extension for Contao Open Source CMS
- *
- * @copyright  Copyright (c) 2011-2017, terminal42 gmbh
- * @author     terminal42 gmbh <info@terminal42.ch>
- * @license    http://opensource.org/licenses/lgpl-3.0.html LGPL
- * @link       http://github.com/terminal42/contao-dc_multilingual
- */
+declare(strict_types=1);
 
 namespace Terminal42\DcMultilingualBundle\ContaoManager;
 

diff --git a/src/DC_Multilingual.php b/src/DC_Multilingual.php
@@ -1,11 +1,14 @@
 <?php
 
+declare(strict_types=1);
+
 use Terminal42\DcMultilingualBundle\Driver;
+
 /*
  * dc_multilingual Extension for Contao Open Source CMS
  *
- * @copyright  Copyright (c) 2011-2017, terminal42 gmbh
- * @author     terminal42 gmbh <info@terminal42.ch>
+ * @copyright  Copyright (c) 2011-2017, terminal42 gmbh
+ * @author     terminal42 gmbh <info@terminal42.ch>
  * @license    http://opensource.org/licenses/lgpl-3.0.html LGPL
  * @link       http://github.com/terminal42/contao-dc_multilingual
  */

diff --git a/src/DependencyInjection/Terminal42DcMultilingualExtension.php b/src/DependencyInjection/Terminal42DcMultilingualExtension.php
@@ -1,13 +1,6 @@
 <?php
 
-/*
- * dc_multilingual Extension for Contao Open Source CMS
- *
- * @copyright  Copyright (c) 2011-2017, terminal42 gmbh
- * @author     terminal42 gmbh <info@terminal42.ch>
- * @license    http://opensource.org/licenses/lgpl-3.0.html LGPL
- * @link       http://github.com/terminal42/contao-dc_multilingual
- */
+declare(strict_types=1);
 
 namespace Terminal42\DcMultilingualBundle\DependencyInjection;
 
@@ -18,7 +11,7 @@
 
 class Terminal42DcMultilingualExtension extends Extension
 {
-    public function load(array $configs, ContainerBuilder $container)
+    public function load(array $configs, ContainerBuilder $container): void
     {
         $loader = new YamlFileLoader($container, new FileLocator(__DIR__.'/../../config'));
 

diff --git a/src/Model/Multilingual.php b/src/Model/Multilingual.php
@@ -1,13 +1,6 @@
 <?php
 
-/*
- * dc_multilingual Extension for Contao Open Source CMS
- *
- * @copyright  Copyright (c) 2011-2017, terminal42 gmbh
- * @author     terminal42 gmbh <info@terminal42.ch>
- * @license    http://opensource.org/licenses/lgpl-3.0.html LGPL
- * @link       http://github.com/terminal42/contao-dc_multilingual
- */
+declare(strict_types=1);
 
 namespace Terminal42\DcMultilingualBundle\Model;
 

diff --git a/src/Model/MultilingualTrait.php b/src/Model/MultilingualTrait.php
@@ -1,13 +1,6 @@
 <?php
 
-/*
- * dc_multilingual Extension for Contao Open Source CMS
- *
- * @copyright  Copyright (c) 2011-2017, terminal42 gmbh
- * @author     terminal42 gmbh <info@terminal42.ch>
- * @license    http://opensource.org/licenses/lgpl-3.0.html LGPL
- * @link       http://github.com/terminal42/contao-dc_multilingual
- */
+declare(strict_types=1);
 
 namespace Terminal42\DcMultilingualBundle\Model;
 
@@ -19,6 +12,7 @@
 use Contao\System;
 use Doctrine\DBAL\Query\QueryBuilder;
 use Terminal42\DcMultilingualBundle\QueryBuilder\MultilingualQueryBuilderFactoryInterface;
+use Terminal42\DcMultilingualBundle\QueryBuilder\MultilingualQueryBuilderInterface;
 
 trait MultilingualTrait
 {
@@ -86,8 +80,9 @@ public function getAlias($language, $aliasColumnName = 'alias')
      */
     public static function findByAlias($alias, $aliasColumnName = 'alias', $options = [])
     {
-        $table   = static::getTable();
-        $options = array_merge([
+        $table = static::getTable();
+        $options = array_merge(
+            [
                 'limit' => 1,
                 'column' => ["$table.$aliasColumnName=?"],
                 'value' => [$alias],
@@ -110,8 +105,9 @@ public static function findByAlias($alias, $aliasColumnName = 'alias', $options
      */
     public static function findByMultilingualAlias($alias, $aliasColumnName = 'alias', $options = [])
     {
-        $table   = static::getTable();
-        $options = array_merge([
+        $table = static::getTable();
+        $options = array_merge(
+            [
                 'limit' => 1,
                 'column' => ["($table.$aliasColumnName=? OR translation.$aliasColumnName=?)"],
                 'value' => [$alias, $alias],
@@ -169,6 +165,7 @@ protected static function buildFindQuery(array $options)
 
         // Consider the fallback language
         $fallbackLang = static::getFallbackLanguage();
+
         if (null !== $fallbackLang && $fallbackLang === $options['language']) {
             $options['language'] = '';
         }
@@ -206,7 +203,7 @@ protected static function buildCountQuery(array $options)
     }
 
     /**
-     * Prevent model from saving when creating a model from a database result. See #51
+     * Prevent model from saving when creating a model from a database result. See #51.
      *
      * @param Result $objResult The database result object
      *
@@ -221,7 +218,7 @@ protected static function createModelFromDbResult(Result $objResult)
     }
 
     /**
-     * Prevent new models from saving when creating a new collection from a database result. See #51
+     * Prevent new models from saving when creating a new collection from a database result. See #51.
      *
      * @param Result $objResult The database result object
      * @param string $strTable  The table name
@@ -242,15 +239,12 @@ protected static function createCollectionFromDbResult(Result $objResult, $strTa
 
     /**
      * Apply the model options to the query builder.
-     *
-     * @param QueryBuilder $qb
-     * @param array        $options
      */
-    protected static function applyOptionsToQueryBuilder(QueryBuilder $qb, array $options)
+    protected static function applyOptionsToQueryBuilder(QueryBuilder $qb, array $options): void
     {
         // Columns
         if (!empty($options['column'])) {
-            if (is_array($options['column'])) {
+            if (\is_array($options['column'])) {
                 foreach ($options['column'] as $column) {
                     $qb->andWhere($column);
                 }
@@ -280,7 +274,7 @@ protected static function applyOptionsToQueryBuilder(QueryBuilder $qb, array $op
     /**
      * Get the MultilingualQueryBuilder.
      *
-     * @return \Terminal42\DcMultilingualBundle\QueryBuilder\MultilingualQueryBuilderInterface
+     * @return MultilingualQueryBuilderInterface
      */
     protected static function getMultilingualQueryBuilder()
     {
@@ -303,7 +297,7 @@ protected static function getMultilingualQueryBuilder()
      */
     protected static function getRegularFields()
     {
-        $extractor    = DcaExtractor::getInstance(static::getTable());
+        $extractor = DcaExtractor::getInstance(static::getTable());
         $tableColumns = Database::getInstance()->getFieldNames(static::getTable());
 
         return array_intersect($tableColumns, array_keys($extractor->getFields()));
@@ -318,11 +312,11 @@ protected static function getTranslatableFields()
     {
         static::ensureDataContainerIsLoaded();
 
-        $fields       = [];
+        $fields = [];
         $tableColumns = Database::getInstance()->getFieldNames(static::getTable());
 
         foreach ($GLOBALS['TL_DCA'][static::getTable()]['fields'] as $field => $data) {
-            if (!isset($data['eval']['translatableFor']) || !in_array($field, $tableColumns, true)) {
+            if (!isset($data['eval']['translatableFor']) || !\in_array($field, $tableColumns, true)) {
                 continue;
             }
 
@@ -347,7 +341,7 @@ protected static function getPidColumn()
     /**
      * Ensure the data container is loaded.
      */
-    protected static function ensureDataContainerIsLoaded()
+    protected static function ensureDataContainerIsLoaded(): void
     {
         if (!isset($GLOBALS['TL_DCA'][static::getTable()])) {
             $loader = new DcaLoader(static::getTable());

diff --git a/src/Picker/MultilingualPickerProvider.php b/src/Picker/MultilingualPickerProvider.php
@@ -2,27 +2,16 @@
 
 declare(strict_types=1);
 
-/*
- * dc_multilingual Extension for Contao Open Source CMS
- *
- * @copyright  Copyright (c) 2011-2022, terminal42 gmbh
- * @author     terminal42 gmbh <info@terminal42.ch>
- * @license    http://opensource.org/licenses/lgpl-3.0.html LGPL
- * @link       http://github.com/terminal42/contao-dc_multilingual
- */
-
 namespace Terminal42\DcMultilingualBundle\Picker;
 
 use Contao\CoreBundle\Framework\ContaoFramework;
 use Contao\CoreBundle\Picker\AbstractTablePickerProvider;
 use Contao\DcaLoader;
-use DC_Multilingual;
 use Doctrine\DBAL\Connection;
 use Knp\Menu\FactoryInterface;
 use Symfony\Component\Routing\RouterInterface;
 use Symfony\Contracts\Translation\TranslatorInterface;
 use Terminal42\DcMultilingualBundle\Driver;
-use function strpos;
 
 final class MultilingualPickerProvider extends AbstractTablePickerProvider
 {
@@ -45,17 +34,12 @@ public function getName(): string
         return 'multilingualPicker';
     }
 
-    protected function getDataContainer(): string
-    {
-        return Driver::class;
-    }
-
     /**
      * We have to reimplement whole method because we have to check two names of the data container driver.
      */
     public function supportsContext($context): bool
     {
-        if (0 !== strpos($context, self::PREFIX)) {
+        if (0 !== \strpos($context, self::PREFIX)) {
             return false;
         }
 
@@ -64,10 +48,15 @@ public function supportsContext($context): bool
         $this->framework->initialize();
         $this->framework->createInstance(DcaLoader::class, [$table])->load();
 
-        $drivers = ['Multilingual', Driver::class, DC_Multilingual::class];
+        $drivers = ['Multilingual', Driver::class, \DC_Multilingual::class];
 
         return isset($GLOBALS['TL_DCA'][$table]['config']['dataContainer'])
             && \in_array($GLOBALS['TL_DCA'][$table]['config']['dataContainer'], $drivers, true)
             && 0 !== \count($this->getModulesForTable($table));
     }
+
+    protected function getDataContainer(): string
+    {
+        return Driver::class;
+    }
 }