Php54.php

<?php

declare(strict_types=1);

/**
 * Copyright (c) 2019-2023 Andreas Möller
 *
 * For the full copyright and license information, please view
 * the LICENSE.md file that was distributed with this source code.
 *
 * @see https://github.com/ergebnis/php-cs-fixer-config
 */

namespace Ergebnis\PhpCsFixer\Config\RuleSet;

use Ergebnis\PhpCsFixer\Config\Fixers;
use Ergebnis\PhpCsFixer\Config\Name;
use Ergebnis\PhpCsFixer\Config\PhpVersion;
use Ergebnis\PhpCsFixer\Config\Rules;
use Ergebnis\PhpCsFixer\Config\RuleSet;
use ErickSkrauch\PhpCsFixer;
use PhpCsFixerCustomFixers\Fixer;

final class Php54
{
    public static function create(): RuleSet
    {
        $phpVersion = PhpVersion::create(
            PhpVersion\Major::fromInt(5),
            PhpVersion\Minor::fromInt(4),
            PhpVersion\Patch::fromInt(0),
        );

        return RuleSet::create(
            Fixers::fromFixers(
                new Fixer\PhpdocArrayStyleFixer(),
                new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
            ),
            Name::fromString(\sprintf(
                'ergebnis (PHP %d.%d)',
                $phpVersion->major()->toInt(),
                $phpVersion->minor()->toInt(),
            )),
            $phpVersion,
            Rules::fromArray([
                'ErickSkrauch/line_break_after_statements' => true,
                'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
                'align_multiline_comment' => [
                    'comment_type' => 'all_multiline',
                ],
                'array_indentation' => true,
                'array_push' => true,
                'array_syntax' => [
                    'syntax' => 'short',
                ],
                'assign_null_coalescing_to_coalesce_equal' => false,
                'attribute_empty_parentheses' => false,
                'backtick_to_shell_exec' => true,
                'binary_operator_spaces' => [
                    'default' => 'single_space',
                    'operators' => [],
                ],
                'blank_line_after_namespace' => true,
                'blank_line_after_opening_tag' => true,
                'blank_line_before_statement' => [
                    'statements' => [
                        'break',
                        'case',
                        'continue',
                        'declare',
                        'default',
                        'do',
                        'exit',
                        'for',
                        'foreach',
                        'goto',
                        'if',
                        'include',
                        'include_once',
                        'phpdoc',
                        'require',
                        'require_once',
                        'return',
                        'switch',
                        'throw',
                        'try',
                        'while',
                    ],
                ],
                'blank_line_between_import_groups' => false,
                'blank_lines_before_namespace' => [
                    'max_line_breaks' => 2,
                    'min_line_breaks' => 2,
                ],
                'braces_position' => [
                    'allow_single_line_anonymous_functions' => false,
                    'allow_single_line_empty_anonymous_classes' => false,
                    'anonymous_classes_opening_brace' => 'same_line',
                    'anonymous_functions_opening_brace' => 'same_line',
                    'classes_opening_brace' => 'next_line_unless_newline_at_signature_end',
                    'control_structures_opening_brace' => 'same_line',
                    'functions_opening_brace' => 'next_line_unless_newline_at_signature_end',
                ],
                'cast_spaces' => [
                    'space' => 'single',
                ],
                'class_attributes_separation' => [
                    'elements' => [
                        'const' => 'only_if_meta',
                        'method' => 'one',
                        'property' => 'only_if_meta',
                        'trait_import' => 'none',
                    ],
                ],
                'class_definition' => [
                    'inline_constructor_arguments' => true,
                    'multi_line_extends_each_single_line' => false,
                    'single_item_single_line' => false,
                    'single_line' => false,
                    'space_before_parenthesis' => false,
                ],
                'class_keyword' => false,
                'class_reference_name_casing' => true,
                'clean_namespace' => true,
                'combine_consecutive_issets' => true,
                'combine_consecutive_unsets' => true,
                'combine_nested_dirname' => true,
                'comment_to_phpdoc' => [
                    'ignored_tags' => [],
                ],
                'compact_nullable_type_declaration' => false,
                'concat_space' => [
                    'spacing' => 'one',
                ],
                'constant_case' => [
                    'case' => 'lower',
                ],
                'control_structure_braces' => true,
                'control_structure_continuation_position' => [
                    'position' => 'same_line',
                ],
                'date_time_create_from_format_call' => true,
                'date_time_immutable' => true,
                'declare_equal_normalize' => [
                    'space' => 'none',
                ],
                'declare_parentheses' => true,
                'declare_strict_types' => true,
                'dir_constant' => true,
                'doctrine_annotation_array_assignment' => [
                    'ignored_tags' => Doctrine::IGNORED_TAGS,
                    'operator' => ':',
                ],
                'doctrine_annotation_braces' => [
                    'ignored_tags' => Doctrine::IGNORED_TAGS,
                    'syntax' => 'without_braces',
                ],
                'doctrine_annotation_indentation' => [
                    'ignored_tags' => Doctrine::IGNORED_TAGS,
                    'indent_mixed_lines' => false,
                ],
                'doctrine_annotation_spaces' => [
                    'after_argument_assignments' => false,
                    'after_array_assignments_colon' => true,
                    'after_array_assignments_equals' => false,
                    'around_commas' => true,
                    'around_parentheses' => true,
                    'before_argument_assignments' => false,
                    'before_array_assignments_colon' => false,
                    'before_array_assignments_equals' => false,
                    'ignored_tags' => Doctrine::IGNORED_TAGS,
                ],
                'echo_tag_syntax' => [
                    'format' => 'long',
                    'long_function' => 'echo',
                    'shorten_simple_statements_only' => true,
                ],
                'elseif' => true,
                'empty_loop_body' => [
                    'style' => 'braces',
                ],
                'empty_loop_condition' => [
                    'style' => 'while',
                ],
                'encoding' => true,
                'ereg_to_preg' => true,
                'error_suppression' => [
                    'mute_deprecation_error' => true,
                    'noise_remaining_usages' => true,
                    'noise_remaining_usages_exclude' => [],
                ],
                'escape_implicit_backslashes' => [
                    'double_quoted' => true,
                    'heredoc_syntax' => true,
                    'single_quoted' => false,
                ],
                'explicit_indirect_variable' => true,
                'explicit_string_variable' => true,
                'final_class' => true,
                'final_internal_class' => [
                    'consider_absent_docblock_as_internal_class' => false,
                    'exclude' => [
                        '@Entity',
                        '@final',
                        '@Mapping\\Entity',
                        '@ORM\\Entity',
                        '@ORM\\Mapping\\Entity',
                    ],
                    'include' => [
                        '@internal',
                    ],
                ],
                'final_public_method_for_abstract_class' => true,
                'fopen_flag_order' => true,
                'fopen_flags' => [
                    'b_mode' => true,
                ],
                'full_opening_tag' => true,
                'fully_qualified_strict_types' => [
                    'import_symbols' => false,
                    'leading_backslash_in_global_namespace' => false,
                    'phpdoc_tags' => [
                        'param',
                        'phpstan-param',
                        'phpstan-property',
                        'phpstan-property-read',
                        'phpstan-property-write',
                        'phpstan-return',
                        'phpstan-var',
                        'property',
                        'property-read',
                        'property-write',
                        'psalm-param',
                        'psalm-property',
                        'psalm-property-read',
                        'psalm-property-write',
                        'psalm-return',
                        'psalm-var',
                        'return',
                        'see',
                        'throws',
                        'var',
                    ],
                ],
                'function_declaration' => [
                    'closure_fn_spacing' => 'one',
                    'closure_function_spacing' => 'one',
                    'trailing_comma_single_line' => false,
                ],
                'function_to_constant' => [
                    'functions' => [
                        'php_sapi_name',
                        'phpversion',
                        'pi',
                    ],
                ],
                'general_phpdoc_annotation_remove' => false,
                'general_phpdoc_tag_rename' => [
                    'case_sensitive' => false,
                    'fix_annotation' => true,
                    'fix_inline' => true,
                    'replacements' => [
                        'inheritdoc' => 'inheritdoc',
                        'inheritdocs' => 'inheritdoc',
                    ],
                ],
                'get_class_to_class_keyword' => false,
                'global_namespace_import' => false,
                'group_import' => false,
                'header_comment' => false,
                'heredoc_indentation' => false,
                'heredoc_to_nowdoc' => true,
                'implode_call' => true,
                'include' => true,
                'increment_style' => [
                    'style' => 'pre',
                ],
                'indentation_type' => true,
                'integer_literal_case' => true,
                'is_null' => true,
                'lambda_not_used_import' => true,
                'line_ending' => true,
                'linebreak_after_opening_tag' => true,
                'list_syntax' => [
                    'syntax' => 'short',
                ],
                'logical_operators' => true,
                'long_to_shorthand_operator' => true,
                'lowercase_cast' => true,
                'lowercase_keywords' => true,
                'lowercase_static_reference' => true,
                'magic_constant_casing' => true,
                'magic_method_casing' => true,
                'mb_str_functions' => true,
                'method_argument_space' => [
                    'after_heredoc' => false,
                    'attribute_placement' => 'standalone',
                    'keep_multiple_spaces_after_comma' => false,
                    'on_multiline' => 'ensure_fully_multiline',
                ],
                'method_chaining_indentation' => true,
                'modernize_strpos' => false,
                'modernize_types_casting' => true,
                'multiline_comment_opening_closing' => true,
                'multiline_whitespace_before_semicolons' => [
                    'strategy' => 'no_multi_line',
                ],
                'native_constant_invocation' => [
                    'exclude' => [
                        'false',
                        'null',
                        'true',
                    ],
                    'fix_built_in' => true,
                    'include' => [],
                    'scope' => 'all',
                    'strict' => false,
                ],
                'native_function_casing' => true,
                'native_function_invocation' => [
                    'exclude' => [],
                    'include' => [
                        '@internal',
                    ],
                    'scope' => 'all',
                    'strict' => false,
                ],
                'native_type_declaration_casing' => true,
                'new_with_parentheses' => [
                    'anonymous_class' => true,
                    'named_class' => true,
                ],
                'no_alias_functions' => [
                    'sets' => [
                        '@all',
                    ],
                ],
                'no_alias_language_construct_call' => true,
                'no_alternative_syntax' => [
                    'fix_non_monolithic_code' => true,
                ],
                'no_binary_string' => true,
                'no_blank_lines_after_class_opening' => true,
                'no_blank_lines_after_phpdoc' => true,
                'no_break_comment' => [
                    'comment_text' => 'no break',
                ],
                'no_closing_tag' => true,
                'no_empty_comment' => true,
                'no_empty_phpdoc' => true,
                'no_empty_statement' => true,
                'no_extra_blank_lines' => [
                    'tokens' => [
                        'break',
                        'case',
                        'continue',
                        'curly_brace_block',
                        'default',
                        'extra',
                        'parenthesis_brace_block',
                        'return',
                        'square_brace_block',
                        'switch',
                        'throw',
                        'use',
                    ],
                ],
                'no_homoglyph_names' => true,
                'no_leading_import_slash' => true,
                'no_leading_namespace_whitespace' => true,
                'no_mixed_echo_print' => [
                    'use' => 'echo',
                ],
                'no_multiline_whitespace_around_double_arrow' => true,
                'no_multiple_statements_per_line' => true,
                'no_null_property_initialization' => true,
                'no_php4_constructor' => false,
                'no_short_bool_cast' => true,
                'no_singleline_whitespace_before_semicolons' => true,
                'no_space_around_double_colon' => true,
                'no_spaces_after_function_name' => true,
                'no_spaces_around_offset' => [
                    'positions' => [
                        'inside',
                        'outside',
                    ],
                ],
                'no_superfluous_elseif' => true,
                'no_superfluous_phpdoc_tags' => [
                    'allow_mixed' => true,
                    'allow_unused_params' => false,
                    'remove_inheritdoc' => false,
                ],
                'no_trailing_comma_in_singleline' => [
                    'elements' => [
                        'arguments',
                        'array',
                        'array_destructuring',
                        'group_import',
                    ],
                ],
                'no_trailing_whitespace' => true,
                'no_trailing_whitespace_in_comment' => true,
                'no_trailing_whitespace_in_string' => true,
                'no_unneeded_braces' => [
                    'namespaces' => false,
                ],
                'no_unneeded_control_parentheses' => [
                    'statements' => [
                        'break',
                        'clone',
                        'continue',
                        'echo_print',
                        'negative_instanceof',
                        'others',
                        'return',
                        'switch_case',
                    ],
                ],
                'no_unneeded_final_method' => [
                    'private_methods' => true,
                ],
                'no_unneeded_import_alias' => true,
                'no_unreachable_default_argument_value' => true,
                'no_unset_cast' => true,
                'no_unset_on_property' => true,
                'no_unused_imports' => true,
                'no_useless_concat_operator' => [
                    'juggle_simple_strings' => true,
                ],
                'no_useless_else' => true,
                'no_useless_nullsafe_operator' => false,
                'no_useless_return' => true,
                'no_useless_sprintf' => true,
                'no_whitespace_before_comma_in_array' => [
                    'after_heredoc' => false,
                ],
                'no_whitespace_in_blank_line' => true,
                'non_printable_character' => [
                    'use_escape_sequences_in_strings' => false,
                ],
                'normalize_index_brace' => true,
                'not_operator_with_space' => false,
                'not_operator_with_successor_space' => false,
                'nullable_type_declaration' => false,
                'nullable_type_declaration_for_default_null_value' => [
                    'use_nullable_type_declaration' => true,
                ],
                'object_operator_without_whitespace' => true,
                'octal_notation' => false,
                'operator_linebreak' => [
                    'only_booleans' => true,
                    'position' => 'beginning',
                ],
                'ordered_class_elements' => [
                    'case_sensitive' => false,
                    'order' => [
                        'use_trait',
                        'constant_public',
                        'constant_protected',
                        'constant_private',
                        'property_public',
                        'property_protected',
                        'property_private',
                        'construct',
                        'destruct',
                        'magic',
                        'phpunit',
                        'method_public',
                        'method_protected',
                        'method_private',
                    ],
                    'sort_algorithm' => 'none',
                ],
                'ordered_imports' => [
                    'case_sensitive' => false,
                    'imports_order' => [
                        'class',
                        'const',
                        'function',
                    ],
                    'sort_algorithm' => 'alpha',
                ],
                'ordered_interfaces' => [
                    'case_sensitive' => false,
                    'direction' => 'ascend',
                    'order' => 'alpha',
                ],
                'ordered_traits' => false,
                'ordered_types' => [
                    'case_sensitive' => false,
                    'null_adjustment' => 'always_first',
                    'sort_algorithm' => 'alpha',
                ],
                'php_unit_construct' => [
                    'assertions' => [
                        'assertEquals',
                        'assertNotEquals',
                        'assertNotSame',
                        'assertSame',
                    ],
                ],
                'php_unit_data_provider_name' => false,
                'php_unit_data_provider_return_type' => false,
                'php_unit_data_provider_static' => [
                    'force' => false,
                ],
                'php_unit_dedicate_assert' => [
                    'target' => 'newest',
                ],
                'php_unit_dedicate_assert_internal_type' => [
                    'target' => 'newest',
                ],
                'php_unit_expectation' => [
                    'target' => 'newest',
                ],
                'php_unit_fqcn_annotation' => true,
                'php_unit_internal_class' => false,
                'php_unit_method_casing' => [
                    'case' => 'camel_case',
                ],
                'php_unit_mock' => [
                    'target' => 'newest',
                ],
                'php_unit_mock_short_will_return' => true,
                'php_unit_namespaced' => [
                    'target' => 'newest',
                ],
                'php_unit_no_expectation_annotation' => [
                    'target' => 'newest',
                    'use_class_const' => true,
                ],
                'php_unit_set_up_tear_down_visibility' => true,
                'php_unit_size_class' => false,
                'php_unit_strict' => false,
                'php_unit_test_annotation' => [
                    'style' => 'prefix',
                ],
                'php_unit_test_case_static_method_calls' => [
                    'call_type' => 'self',
                    'methods' => [],
                ],
                'php_unit_test_class_requires_covers' => false,
                'phpdoc_add_missing_param_annotation' => [
                    'only_untyped' => true,
                ],
                'phpdoc_align' => [
                    'align' => 'vertical',
                    'tags' => [
                        'method',
                        'param',
                        'property',
                        'property-read',
                        'property-write',
                        'return',
                        'throws',
                        'type',
                        'var',
                    ],
                ],
                'phpdoc_annotation_without_dot' => true,
                'phpdoc_indent' => true,
                'phpdoc_inline_tag_normalizer' => [
                    'tags' => [
                        'example',
                        'id',
                        'inheritdoc',
                        'inheritdocs',
                        'internal',
                        'link',
                        'source',
                        'toc',
                        'tutorial',
                    ],
                ],
                'phpdoc_line_span' => [
                    'const' => 'multi',
                    'method' => 'multi',
                    'property' => 'multi',
                ],
                'phpdoc_no_access' => true,
                'phpdoc_no_alias_tag' => [
                    'replacements' => [
                        'link' => 'see',
                        'property-read' => 'property',
                        'property-write' => 'property',
                        'type' => 'var',
                    ],
                ],
                'phpdoc_no_empty_return' => true,
                'phpdoc_no_package' => true,
                'phpdoc_no_useless_inheritdoc' => true,
                'phpdoc_order' => [
                    'order' => [
                        'deprecated',
                        'internal',
                        'covers',
                        'uses',
                        'dataProvider',
                        'param',
                        'throws',
                        'return',
                    ],
                ],
                'phpdoc_order_by_value' => [
                    'annotations' => [
                        'author',
                        'covers',
                        'coversNothing',
                        'dataProvider',
                        'depends',
                        'group',
                        'internal',
                        'method',
                        'mixin',
                        'property',
                        'property-read',
                        'property-write',
                        'requires',
                        'throws',
                        'uses',
                    ],
                ],
                'phpdoc_param_order' => true,
                'phpdoc_readonly_class_comment_to_keyword' => false,
                'phpdoc_return_self_reference' => [
                    'replacements' => [
                        '$self' => 'self',
                        '$static' => 'static',
                        '@self' => 'self',
                        '@static' => 'static',
                        '@this' => '$this',
                        'this' => '$this',
                    ],
                ],
                'phpdoc_scalar' => [
                    'types' => [
                        'boolean',
                        'callback',
                        'double',
                        'integer',
                        'real',
                        'str',
                    ],
                ],
                'phpdoc_separation' => [
                    'groups' => [
                        [
                            'deprecated',
                        ],
                        [
                            'link',
                            'see',
                            'since',
                        ],
                        [
                            'author',
                            'copyright',
                            'license',
                        ],
                        [
                            'category',
                            'package',
                            'subpackage',
                        ],
                        [
                            'property',
                            'property-read',
                            'property-write',
                        ],
                    ],
                    'skip_unlisted_annotations' => false,
                ],
                'phpdoc_single_line_var_spacing' => true,
                'phpdoc_summary' => true,
                'phpdoc_tag_casing' => [
                    'tags' => [
                        'inheritDoc',
                    ],
                ],
                'phpdoc_tag_type' => [
                    'tags' => [
                        'inheritdoc' => 'inline',
                    ],
                ],
                'phpdoc_to_comment' => false,
                'phpdoc_to_param_type' => false,
                'phpdoc_to_property_type' => false,
                'phpdoc_to_return_type' => false,
                'phpdoc_trim' => true,
                'phpdoc_trim_consecutive_blank_line_separation' => true,
                'phpdoc_types' => [
                    'groups' => [
                        'alias',
                        'meta',
                        'simple',
                    ],
                ],
                'phpdoc_types_order' => [
                    'case_sensitive' => false,
                    'null_adjustment' => 'always_first',
                    'sort_algorithm' => 'alpha',
                ],
                'phpdoc_var_annotation_correct_order' => true,
                'phpdoc_var_without_name' => true,
                'pow_to_exponentiation' => false,
                'protected_to_private' => true,
                'psr_autoloading' => [
                    'dir' => null,
                ],
                'random_api_migration' => [
                    'replacements' => [
                        'getrandmax' => 'mt_getrandmax',
                        'rand' => 'mt_rand',
                        'srand' => 'mt_srand',
                    ],
                ],
                'regular_callable_call' => true,
                'return_assignment' => true,
                'return_to_yield_from' => false,
                'return_type_declaration' => false,
                'self_accessor' => true,
                'self_static_accessor' => true,
                'semicolon_after_instruction' => true,
                'set_type_to_cast' => true,
                'short_scalar_cast' => true,
                'simple_to_complex_string_variable' => true,
                'simplified_if_return' => false,
                'simplified_null_return' => false,
                'single_blank_line_at_eof' => true,
                'single_class_element_per_statement' => [
                    'elements' => [
                        'const',
                        'property',
                    ],
                ],
                'single_import_per_statement' => [
                    'group_to_single_imports' => true,
                ],
                'single_line_after_imports' => true,
                'single_line_comment_spacing' => true,
                'single_line_comment_style' => [
                    'comment_types' => [
                        'hash',
                    ],
                ],
                'single_line_empty_body' => false,
                'single_line_throw' => false,
                'single_quote' => [
                    'strings_containing_single_quote_chars' => false,
                ],
                'single_space_around_construct' => [
                    'constructs_contain_a_single_space' => [],
                    'constructs_followed_by_a_single_space' => [
                        'abstract',
                        'as',
                        'break',
                        'case',
                        'catch',
                        'class',
                        'clone',
                        'comment',
                        'const',
                        'const_import',
                        'continue',
                        'do',
                        'echo',
                        'else',
                        'elseif',
                        'extends',
                        'final',
                        'for',
                        'foreach',
                        'function',
                        'function_import',
                        'global',
                        'goto',
                        'if',
                        'implements',
                        'include',
                        'include_once',
                        'instanceof',
                        'insteadof',
                        'interface',
                        'namespace',
                        'new',
                        'open_tag_with_echo',
                        'php_doc',
                        'php_open',
                        'print',
                        'private',
                        'protected',
                        'public',
                        'require',
                        'require_once',
                        'return',
                        'static',
                        'switch',
                        'throw',
                        'trait',
                        'try',
                        'type_colon',
                        'use',
                        'use_lambda',
                        'use_trait',
                        'var',
                        'while',
                    ],
                    'constructs_preceded_by_a_single_space' => [
                        'use_lambda',
                    ],
                ],
                'single_trait_insert_per_statement' => true,
                'space_after_semicolon' => [
                    'remove_in_empty_for_expressions' => false,
                ],
                'spaces_inside_parentheses' => [
                    'space' => 'none',
                ],
                'standardize_increment' => true,
                'standardize_not_equals' => true,
                'statement_indentation' => [
                    'stick_comment_to_next_continuous_control_statement' => false,
                ],
                'static_lambda' => true,
                'strict_comparison' => true,
                'strict_param' => true,
                'string_length_to_empty' => true,
                'string_line_ending' => true,
                'switch_case_semicolon_to_colon' => true,
                'switch_case_space' => true,
                'switch_continue_to_break' => true,
                'ternary_operator_spaces' => true,
                'ternary_to_elvis_operator' => true,
                'ternary_to_null_coalescing' => true,
                'trailing_comma_in_multiline' => [
                    'after_heredoc' => false,
                    'elements' => [
                        'arrays',
                    ],
                ],
                'trim_array_spaces' => true,
                'type_declaration_spaces' => [
                    'elements' => [
                        'function',
                    ],
                ],
                'types_spaces' => [
                    'space' => 'none',
                    'space_multiple_catch' => 'none',
                ],
                'unary_operator_spaces' => [
                    'only_dec_inc' => false,
                ],
                'use_arrow_functions' => false,
                'visibility_required' => [
                    'elements' => [
                        'method',
                        'property',
                    ],
                ],
                'void_return' => false,
                'whitespace_after_comma_in_array' => [
                    'ensure_single_space' => true,
                ],
                'yield_from_array_to_yields' => false,
                'yoda_style' => [
                    'always_move_variable' => true,
                    'equal' => true,
                    'identical' => true,
                    'less_and_greater' => true,
                ],
            ]),
        );
    }
}