.php_cs.dist

<?php

$finder = PhpCsFixer\Finder::create()
    ->in([
        __DIR__ . '/src',
    ])

    ->exclude([
        __DIR__ . '/pimcore/tests/_output',
        __DIR__ . '/pimcore/tests/_support/_generated',
    ])

    // do not fix views
    ->notName('*.html.php')

    // using notPath instead of exclude here as they can be nested (install-profiles)
    ->notPath('/var\/config/')
    ->notPath('/var\/classes/')
;

// do not enable self_accessor as it breaks pimcore models relying on get_called_class()
return PhpCsFixer\Config::create()
    ->setRules([
        '@PSR1'                               => true,
        '@PSR2'                               => true,
        'array_syntax'                        => ['syntax' => 'short'],

        'header_comment'         => [
                                        'commentType' => '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'
                                    ],

        // keep aligned = and => operators as they are: do not force aligning, but do not remove it
        'binary_operator_spaces'              => ['align_double_arrow' => null, 'align_equals' => null],

        'blank_line_before_return'            => true,
        'encoding'                            => true,
        'function_typehint_space'             => true,
        'hash_to_slash_comment'               => true,
        'lowercase_cast'                      => true,
        'magic_constant_casing'               => true,
        'method_argument_space'               => ['ensure_fully_multiline' => false],
        'method_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_consecutive_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,
        'self_accessor'                       => 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,
        'whitespace_after_comma_in_array'     => true,
    ])
    ->setFinder($finder);