[Github Action] Setup php-cs fixer (#13)

* task: add cs fixer workflow

* change to "on push"

* fix cs fixer dist paths

* Apply php-cs-fixer changes

* change to be executed on merge in main branches

---------

Co-authored-by: kingjia90 <kingjia90@users.noreply.github.com>

.github/workflows/php-cs-fixer.yaml

@@ -0,0 +1,28 @@
+
+name: "PHP-CS-Fixer"
+
+on:
+    push:
+        branches:
+            - "[0-9]+.[0-9]+"
+            - "[0-9]+.x"
+
+permissions:
+    contents: read
+
+jobs:
+    php-cs-fixer:
+        permissions:
+            contents: write  # for stefanzweifel/git-auto-commit-action to push code in repo
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v2
+              with:
+                  ref: ${{ github.head_ref }}
+
+            - name: PHP-CS-Fixer
+              uses: docker://oskarstark/php-cs-fixer-ga:latest
+
+            - uses: stefanzweifel/git-auto-commit-action@v4
+              with:
+                  commit_message: Apply php-cs-fixer changes

.gitignore

@@ -11,7 +11,7 @@ Thumbs.db
 
 # PHP-CS-Fixer
 /.php_cs
-/.php_cs.cache
+/.php-cs-fixer.cache
 
 # composer
 /composer.lock

.php-cs-fixer.dist.php

@@ -0,0 +1,80 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->in([
+        __DIR__ . '/src',
+        __DIR__ . '/config'
+    ])
+
+    ->exclude([
+        __DIR__ . '/tests/_output',
+        __DIR__ . '/tests/Support/_generated',
+    ])
+
+    // do not fix views
+    ->notName('*.html.php')
+;
+
+// do not enable self_accessor as it breaks pimcore models relying on get_called_class()
+$config = new PhpCsFixer\Config();
+$config->setRules([
+    '@PSR1'                  => true,
+    '@PSR2'                  => true,
+    'array_syntax'           => ['syntax' => 'short'],
+
+    'header_comment'         => [
+        'comment_type' => 'PHPDoc',
+        'header' => 'Pimcore' . PHP_EOL . PHP_EOL .
+            'This source file is available under two different licenses:' . PHP_EOL .
+            '- GNU General Public License version 3 (GPLv3)' . PHP_EOL .
+            '- Pimcore Commercial License (PCL)' . PHP_EOL .
+            'Full copyright and license information is available in' . PHP_EOL .
+            'LICENSE.md which is distributed with this source code.' . PHP_EOL .
+            PHP_EOL .
+            ' @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)' . PHP_EOL .
+            ' @license    http://www.pimcore.org/license     GPLv3 and PCL'
+    ],
+
+    'blank_line_before_statement'         => true,
+    'encoding'                            => true,
+    'function_typehint_space'             => true,
+    'single_line_comment_style'           => true,
+    'lowercase_cast'                      => true,
+    'magic_constant_casing'               => true,
+    'method_argument_space'               => ['on_multiline' => 'ignore'],
+    'class_attributes_separation'         => true,
+    'native_function_casing'              => true,
+    'no_blank_lines_after_class_opening'  => true,
+    'no_blank_lines_after_phpdoc'         => true,
+    'no_empty_comment'                    => true,
+    'no_empty_phpdoc'                     => true,
+    'no_empty_statement'                  => true,
+    'no_extra_blank_lines'                => true,
+    'no_leading_import_slash'             => true,
+    'no_leading_namespace_whitespace'     => true,
+    'no_short_bool_cast'                  => true,
+    'no_spaces_around_offset'             => true,
+    'no_unneeded_control_parentheses'     => true,
+    'no_unused_imports'                   => true,
+    'no_whitespace_before_comma_in_array' => true,
+    'no_whitespace_in_blank_line'         => true,
+    'object_operator_without_whitespace'  => true,
+    'ordered_imports'                     => true,
+    'phpdoc_indent'                       => true,
+    'phpdoc_no_useless_inheritdoc'        => true,
+    'phpdoc_scalar'                       => true,
+    'phpdoc_separation'                   => true,
+    'phpdoc_single_line_var_spacing'      => true,
+    'return_type_declaration'             => true,
+    'short_scalar_cast'                   => true,
+    'single_blank_line_before_namespace'  => true,
+    'single_quote'                        => true,
+    'space_after_semicolon'               => true,
+    'standardize_not_equals'              => true,
+    'ternary_operator_spaces'             => true,
+    'trailing_comma_in_multiline'         => true,
+    'whitespace_after_comma_in_array'     => true,
+]);
+
+$config->setFinder($finder);
+return $config;

src/DependencyInjection/PimcoreWebToPrintExtension.php

@@ -16,7 +16,6 @@
 
 namespace Pimcore\Bundle\WebToPrintBundle\DependencyInjection;
 
-use Pimcore\Bundle\CoreBundle\DependencyInjection\ConfigurationHelper;
 use Pimcore\Config\LocationAwareConfigRepository;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;

src/PimcoreWebToPrintBundle.php

@@ -55,4 +55,3 @@ public function getPath(): string
         return \dirname(__DIR__);
     }
 }
-

src/Processor.php

@@ -291,4 +291,3 @@ protected function getLock(PrintAbstract $document): LockInterface
      */
     abstract public function getPdfFromString(string $html, array $params = [], bool $returnFilePath = false): string;
 }
-

src/Processor/PdfReactor.php

@@ -229,4 +229,3 @@ protected function includeApi(): void
         include_once(__DIR__ . '/Api/PDFreactor.class.php');
     }
 }
-

src/Twig/Extension/PrintCatalogExtension.php

@@ -197,4 +197,3 @@ public static function toUrl(?string $text): string
         return urlencode(str_replace($search, $replace, $text));
     }
 }
-