diff --git a/.php-cs-fixer.php b/.php-cs-fixer.php index ae6b328..886a480 100644 --- a/.php-cs-fixer.php +++ b/.php-cs-fixer.php @@ -5,58 +5,407 @@ use PhpCsFixer\Config; use PhpCsFixer\Finder; -$rules = [ - '@Symfony' => true, - '@Symfony:risky' => true, - 'array_syntax' => [ - 'syntax' => 'short' - ], - 'binary_operator_spaces' => [ - 'operators' => [ - '=>' => 'align' - ] - ], - 'concat_space' => [ - 'spacing' => 'one' - ], - 'declare_strict_types' => true, - 'get_class_to_class_keyword' => false, - 'global_namespace_import' => false, - 'linebreak_after_opening_tag' => true, - 'mb_str_functions' => true, - 'native_function_invocation' => [ - 'include' => [ - '@all' - ] +$aliasRules = [ + 'array_push' => true, + 'backtick_to_shell_exec' => true, + 'ereg_to_preg' => true, + 'mb_str_functions' => true, + 'modernize_strpos' => ['modernize_stripos' => true], + 'no_alias_functions' => ['sets' => ['@all']], + 'no_alias_language_construct_call' => true, + 'no_mixed_echo_print' => ['use' => 'echo'], + 'pow_to_exponentiation' => true, + 'random_api_migration' => ['replacements' => ['getrandmax' => 'mt_getrandmax', 'srand' => 'mt_srand', 'mt_rand' => 'random_int', 'rand' => 'random_int']], + 'set_type_to_cast' => true +]; + +$arrayNotationRules = [ + 'array_syntax' => ['syntax' => 'short'], + 'no_multiline_whitespace_around_double_arrow' => true, + 'no_whitespace_before_comma_in_array' => ['after_heredoc' => true], + 'normalize_index_brace' => true, + 'return_to_yield_from' => true, + 'trim_array_spaces' => true, + 'whitespace_after_comma_in_array' => ['ensure_single_space' => true], + 'yield_from_array_to_yields' => true +]; + +$attributeNotationRules = [ + 'attribute_empty_parentheses' => ['use_parentheses' => false], + 'general_attribute_remove' => ['attributes' => []], + 'ordered_attributes' => ['order' => [], 'sort_algorithm' => 'alpha'] +]; + +$basicRules = [ + 'braces_position' => [ + 'allow_single_line_anonymous_functions' => true, + 'allow_single_line_empty_anonymous_classes' => true, + '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' ], - 'no_php4_constructor' => true, - 'no_superfluous_phpdoc_tags' => true, + 'encoding' => true, + 'no_multiple_statements_per_line' => true, + 'no_trailing_comma_in_singleline' => ['elements' => ['arguments', 'array', 'array_destructuring', 'group_import']], + 'non_printable_character' => ['use_escape_sequences_in_strings' => true], + 'numeric_literal_separator' => false, + 'octal_notation' => true, + 'psr_autoloading' => ['dir' => null], + 'single_line_empty_body' => true +]; + +$casingRules = [ + 'class_reference_name_casing' => true, + 'constant_case' => ['case' => 'lower'], + 'integer_literal_case' => true, + 'lowercase_keywords' => true, + 'lowercase_static_reference' => true, + 'magic_constant_casing' => true, + 'magic_method_casing' => true, + 'native_function_casing' => true, + 'native_type_declaration_casing' => true +]; + +$castNotationRules = [ + 'cast_spaces' => ['space' => 'single'], + 'lowercase_cast' => true, + 'modernize_types_casting' => true, + 'no_short_bool_cast' => true, + 'no_unset_cast' => true, + 'short_scalar_cast' => true +]; + +$classNotationRules = [ + 'class_attributes_separation' => ['elements' => ['const' => 'one', 'method' => 'one', 'property' => 'one', 'trait_import' => 'none', 'case' => 'none']], + 'class_definition' => ['inline_constructor_arguments' => true, 'multi_line_extends_each_single_line' => false, 'single_item_single_line' => true, 'single_line' => true, 'space_before_parenthesis' => false], + 'final_class' => false, + 'final_internal_class' => false, + 'final_public_method_for_abstract_class' => false, + 'no_blank_lines_after_class_opening' => true, + 'no_null_property_initialization' => true, + 'no_php4_constructor' => true, + 'no_unneeded_final_method' => ['private_methods' => true], + 'ordered_class_elements' => ['case_sensitive' => false, 'order' => ['use_trait', 'case', 'constant_public', 'constant_protected', 'constant_private', 'property_public', 'property_protected', 'property_private', 'construct', 'destruct', 'magic', 'phpunit'], 'sort_algorithm' => 'none'], + 'ordered_interfaces' => ['case_sensitive' => false, 'direction' => 'ascend', 'order' => 'alpha'], + 'ordered_traits' => ['case_sensitive' => false], + 'ordered_types' => ['case_sensitive' => false, 'null_adjustment' => 'always_last', 'sort_algorithm' => 'alpha'], + 'phpdoc_readonly_class_comment_to_keyword' => true, + 'protected_to_private' => false, + 'self_accessor' => true, + 'self_static_accessor' => true, + 'single_class_element_per_statement' => ['elements' => ['const', 'property']], + 'single_trait_insert_per_statement' => true, + 'visibility_required' => ['elements' => ['const', 'method', 'property']] +]; + +$classUsageRules = [ + 'date_time_immutable' => true +]; + +$commentRules = [ + 'comment_to_phpdoc' => ['ignored_tags' => []], + 'header_comment' => false, + 'multiline_comment_opening_closing' => true, + 'no_empty_comment' => true, + 'no_trailing_whitespace_in_comment' => true, + 'single_line_comment_spacing' => true, + 'single_line_comment_style' => ['comment_types' => ['asterisk', 'hash']] +]; + +$constantNotationRules = [ + 'native_constant_invocation' => ['exclude' => ['null', 'false', 'true'], 'fix_built_in' => true, 'include' => [], 'scope' => 'all', 'strict' => false], +]; + +$controlStructureRules = [ + 'control_structure_braces' => true, + 'control_structure_continuation_position' => ['position' => 'same_line'], + 'elseif' => true, + 'empty_loop_body' => ['style' => 'braces'], + 'empty_loop_condition' => ['style' => 'while'], + 'include' => true, + 'no_alternative_syntax' => ['fix_non_monolithic_code' => true], + 'no_break_comment' => ['comment_text' => 'no break'], + 'no_superfluous_elseif' => true, + 'no_unneeded_braces' => ['namespaces' => true], + 'no_unneeded_control_parentheses' => ['statements' => ['break', 'clone', 'continue', 'echo_print', 'others', 'return', 'switch_case', 'yield', 'yield_from']], + 'no_useless_else' => true, + 'simplified_if_return' => true, + 'switch_case_semicolon_to_colon' => true, + 'switch_case_space' => true, + 'switch_continue_to_break' => true, + 'trailing_comma_in_multiline' => false, + 'yoda_style' => false +]; + +$doctrineAnnotationRules = [ + 'doctrine_annotation_array_assignment' => false, + 'doctrine_annotation_braces' => false, + 'doctrine_annotation_indentation' => false, + 'doctrine_annotation_spaces' => false +]; + +$functionNotationRules = [ + 'combine_nested_dirname' => true, + 'date_time_create_from_format_call' => true, + 'fopen_flag_order' => true, + 'fopen_flags' => ['b_mode' => false], + 'function_declaration' => ['closure_fn_spacing' => 'one', 'closure_function_spacing' => 'one', 'trailing_comma_single_line' => false], + 'implode_call' => true, + 'lambda_not_used_import' => true, + 'method_argument_space' => ['after_heredoc' => false, 'attribute_placement' => 'ignore', 'keep_multiple_spaces_after_comma' => false, 'on_multiline' => 'ignore'], + 'native_function_invocation' => ['exclude' => [], 'include' => ['@all', '@compiler_optimized', '@internal'], 'scope' => 'all', 'strict' => false], + 'no_spaces_after_function_name' => true, 'no_unreachable_default_argument_value' => true, - 'no_useless_else' => true, - 'no_useless_return' => true, + 'no_useless_sprintf' => true, 'nullable_type_declaration_for_default_null_value' => true, - 'ordered_imports' => true, - 'php_unit_strict' => true, - 'phpdoc_order' => true, - 'semicolon_after_instruction' => true, - 'single_import_per_statement' => false, - 'strict_comparison' => true, - 'strict_param' => true, + 'phpdoc_to_param_type' => false, + 'phpdoc_to_property_type' => false, + 'phpdoc_to_return_type' => false, + 'regular_callable_call' => true, + 'return_type_declaration' => ['space_before' => 'none'], 'single_line_throw' => false, - 'trailing_comma_in_multiline' => false, - 'yoda_style' => [ - 'equal' => false, - 'identical' => false, - 'less_and_greater' => false - ], + 'static_lambda' => true, + 'use_arrow_functions' => false, + 'void_return' => true +]; + +$importRules = [ + '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']], + 'global_namespace_import' => ['import_classes' => false, 'import_constants' => false, 'import_functions' => false], + 'group_import' => false, + 'no_leading_import_slash' => true, + 'no_unneeded_import_alias' => true, + 'no_unused_imports' => true, + 'ordered_imports' => ['case_sensitive' => false, 'imports_order' => ['class', 'function', 'const'], 'sort_algorithm' => 'alpha'], + 'single_import_per_statement' => ['group_to_single_imports' => true], + 'single_line_after_imports' => true +]; + +$languageConstructRules = [ + 'class_keyword' => true, + 'combine_consecutive_issets' => true, + 'combine_consecutive_unsets' => true, + 'declare_equal_normalize' => ['space' => 'none'], + 'declare_parentheses' => true, + 'dir_constant' => true, + 'error_suppression' => ['mute_deprecation_error' => true, 'noise_remaining_usages' => false, 'noise_remaining_usages_exclude' => []], + 'explicit_indirect_variable' => true, + 'function_to_constant' => ['functions' => ['get_called_class', 'get_class', 'get_class_this', 'php_sapi_name', 'phpversion', 'pi']], + 'get_class_to_class_keyword' => true, + 'is_null' => true, + 'no_unset_on_property' => true, + 'nullable_type_declaration' => ['syntax' => 'question_mark'], + 'single_space_around_construct' => ['constructs_contain_a_single_space' => ['yield_from'], 'constructs_followed_by_a_single_space' => ['abstract', 'as', 'attribute', 'break', 'case', 'catch', 'class', 'clone', 'comment', 'const', 'const_import', 'continue', 'do', 'echo', 'else', 'elseif', 'enum', 'extends', 'final', 'finally', 'for', 'foreach', 'function', 'function_import', 'global', 'goto', 'if', 'implements', 'include', 'include_once', 'instanceof', 'insteadof', 'interface', 'match', 'named_argument', 'namespace', 'new', 'open_tag_with_echo', 'php_doc', 'php_open', 'print', 'private', 'protected', 'public', 'readonly', 'require', 'require_once', 'return', 'static', 'switch', 'throw', 'trait', 'try', 'type_colon', 'use', 'use_lambda', 'use_trait', 'var', 'while', 'yield', 'yield_from'], 'constructs_preceded_by_a_single_space' => ['as', 'else', 'elseif', 'use_lambda']] +]; + +$listNotationRules = [ + 'list_syntax' => ['syntax' => 'short'] +]; + +$namespaceNotationRules = [ + 'blank_line_after_namespace' => true, + 'blank_lines_before_namespace' => ['min_line_breaks' => 2, 'max_line_breaks' => 2], + 'clean_namespace' => true, + 'no_leading_namespace_whitespace' => true +]; + +$namingRules = [ + 'no_homoglyph_names' => true +]; + +$operatorRules = [ + 'assign_null_coalescing_to_coalesce_equal' => true, + 'binary_operator_spaces' => ['default' => 'single_space', 'operators' => ['=>' => 'align']], + 'concat_space' => ['spacing' => 'one'], + 'increment_style' => ['style' => 'pre'], + 'logical_operators' => true, + 'long_to_shorthand_operator' => true, + 'new_with_parentheses' => ['anonymous_class' => true, 'named_class' => true], + 'no_space_around_double_colon' => true, + 'no_useless_concat_operator' => ['juggle_simple_strings' => false], + 'no_useless_nullsafe_operator' => true, + 'not_operator_with_space' => false, + 'not_operator_with_successor_space' => false, + 'object_operator_without_whitespace' => true, + 'operator_linebreak' => ['only_booleans' => true, 'position' => 'beginning'], + 'standardize_increment' => true, + 'standardize_not_equals' => true, + 'ternary_operator_spaces' => true, + 'ternary_to_elvis_operator' => true, + 'ternary_to_null_coalescing' => true, + 'unary_operator_spaces' => ['only_dec_inc' => false] +]; + +$phpTagRules = [ + 'blank_line_after_opening_tag' => true, + 'echo_tag_syntax' => ['format' => 'long', 'long_function' => 'echo', 'shorten_simple_statements_only' => true], + 'full_opening_tag' => true, + 'linebreak_after_opening_tag' => true, + 'no_closing_tag' => true +]; + +$phpUnitRules = [ + 'php_unit_assert_new_names' => true, + 'php_unit_attributes' => ['keep_annotations' => false], + 'php_unit_construct' => ['assertions' => ['assertEquals', 'assertNotEquals', 'assertNotSame', 'assertSame']], + 'php_unit_data_provider_method_order' => ['placement' => 'before'], + 'php_unit_data_provider_name' => ['prefix' => 'provide', 'suffix' => 'DataCases'], + 'php_unit_data_provider_return_type' => true, + 'php_unit_data_provider_static' => ['force' => true], + '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' => ['types' => ['abstract', 'final', 'normal']], + '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' => ['assertions' => ['assertAttributeEquals', 'assertAttributeNotEquals', 'assertEquals', 'assertNotEquals']], + 'php_unit_test_annotation' => ['style' => 'prefix'], + 'php_unit_test_case_static_method_calls' => ['call_type' => 'static', 'methods' => []], + 'php_unit_test_class_requires_covers' => false ]; +$phpDocRules = [ + 'align_multiline_comment' => ['comment_type' => 'phpdocs_only'], + 'general_phpdoc_annotation_remove' => ['annotations' => [], 'case_sensitive' => false], + 'general_phpdoc_tag_rename' => ['case_sensitive' => false, 'fix_annotation' => true, 'fix_inline' => true, 'replacements' => ['inheritDocs' => 'inheritDoc']], + 'no_blank_lines_after_phpdoc' => true, + 'no_empty_phpdoc' => true, + 'no_superfluous_phpdoc_tags' => ['allow_hidden_params' => false, 'allow_mixed' => false, 'allow_unused_params' => false, 'remove_inheritdoc' => true], + 'phpdoc_add_missing_param_annotation' => ['only_untyped' => true], + 'phpdoc_align' => ['align' => 'vertical', 'spacing' => ['_default' => 1], 'tags' => ['method', 'param', 'property', 'property-read', 'property-write', 'return', 'throws', 'type', 'var']], + 'phpdoc_annotation_without_dot' => true, + 'phpdoc_array_type' => false, + 'phpdoc_indent' => true, + 'phpdoc_inline_tag_normalizer' => ['tags' => ['example', 'id', 'internal', 'inheritdoc', 'inheritdocs', 'link', 'source', 'toc', 'tutorial']], + 'phpdoc_line_span' => ['const' => 'single', 'method' => 'single', 'property' => 'single'], + 'phpdoc_list_type' => false, + 'phpdoc_no_access' => true, + 'phpdoc_no_alias_tag' => ['replacements' => ['property-read' => 'property', 'property-write' => 'property', 'type' => 'var', 'link' => 'see']], + 'phpdoc_no_empty_return' => true, + 'phpdoc_no_package' => true, + 'phpdoc_no_useless_inheritdoc' => true, + 'phpdoc_order_by_value' => ['annotations' => ['author', 'covers', 'coversNothing', 'dataProvider', 'depends', 'group', 'internal', 'method', 'mixin', 'property', 'property-read', 'property-write', 'requires', 'throws', 'uses']], + 'phpdoc_order' => ['order' => ['param', 'throws', 'return']], + 'phpdoc_param_order' => true, + 'phpdoc_return_self_reference' => ['replacements' => ['this' => '$this', '@this' => '$this', '$self' => 'self', '@self' => 'self', '$static' => 'static', '@static' => 'static']], + 'phpdoc_scalar' => ['types' => ['boolean', 'callback', 'double', 'integer', 'real', 'str']], + 'phpdoc_separation' => ['groups' => [['author', 'copyright', 'license'], ['category', 'package', 'subpackage'], ['property', 'property-read', 'property-write'], ['deprecated', 'link', 'see', 'since']], 'skip_unlisted_annotations' => true], + 'phpdoc_single_line_var_spacing' => true, + 'phpdoc_summary' => true, + 'phpdoc_tag_casing' => ['tags' => ['inheritDoc']], + 'phpdoc_tag_type' => ['tags' => ['inheritDoc' => 'inline']], + 'phpdoc_to_comment' => ['allow_before_return_statement' => false, 'ignored_tags' => []], + 'phpdoc_trim_consecutive_blank_line_separation' => true, + 'phpdoc_trim' => true, + 'phpdoc_types' => ['groups' => ['alias', 'meta', 'simple']], + 'phpdoc_types_order' => ['case_sensitive' => false, 'null_adjustment' => 'always_last', 'sort_algorithm' => 'alpha'], + 'phpdoc_var_annotation_correct_order' => true, + 'phpdoc_var_without_name' => true +]; + +$returnNotationRules = [ + 'no_useless_return' => true, + 'return_assignment' => true, + 'simplified_null_return' => true +]; + +$semicolonRules = [ + 'multiline_whitespace_before_semicolons' => ['strategy' => 'no_multi_line'], + 'no_empty_statement' => true, + 'no_singleline_whitespace_before_semicolons' => true, + 'semicolon_after_instruction' => true, + 'space_after_semicolon' => ['remove_in_empty_for_expressions' => true] +]; + +$strictRules = [ + 'declare_strict_types' => true, + 'strict_comparison' => true, + 'strict_param' => true +]; + +$stringNotationRules = [ + 'explicit_string_variable' => true, + 'heredoc_closing_marker' => ['closing_marker' => 'EOD', 'explicit_heredoc_style' => false, 'reserved_closing_markers' => ['CSS', 'DIFF', 'HTML', 'JS', 'JSON', 'MD', 'PHP', 'PYTHON', 'RST', 'TS', 'SQL', 'XML', 'YAML']], + 'heredoc_to_nowdoc' => true, + 'multiline_string_to_heredoc' => true, + 'no_binary_string' => true, + 'no_trailing_whitespace_in_string' => true, + 'simple_to_complex_string_variable' => true, + 'single_quote' => ['strings_containing_single_quote_chars' => false], + 'string_implicit_backslashes' => false, + 'string_length_to_empty' => true, + 'string_line_ending' => true +]; + +$whitespaceRules = [ + 'array_indentation' => true, + 'blank_line_before_statement' => ['statements' => ['break', 'continue', 'declare', 'phpdoc', 'return', 'throw', 'try', 'yield', 'yield_from']], + 'blank_line_between_import_groups' => true, + 'compact_nullable_type_declaration' => true, + 'heredoc_indentation' => ['indentation' => 'same_as_start'], + 'indentation_type' => true, + 'line_ending' => true, + 'method_chaining_indentation' => true, + 'no_extra_blank_lines' => ['tokens' => ['attribute', 'break', 'case', 'continue', 'curly_brace_block', 'default', 'extra', 'parenthesis_brace_block', 'return', 'square_brace_block', 'switch', 'throw', 'use']], + 'no_spaces_around_offset' => ['positions' => ['inside', 'outside']], + 'no_trailing_whitespace' => true, + 'no_whitespace_in_blank_line' => true, + 'single_blank_line_at_eof' => true, + 'spaces_inside_parentheses' => ['space' => 'none'], + 'statement_indentation' => ['stick_comment_to_next_continuous_control_statement' => false], + 'type_declaration_spaces' => ['elements' => ['constant', 'function', 'property']], + 'types_spaces' => ['space' => 'none', 'space_multiple_catch' => 'none'] +]; + +$rules = \array_merge( + $aliasRules, + $arrayNotationRules, + $attributeNotationRules, + $basicRules, + $casingRules, + $castNotationRules, + $classNotationRules, + $classUsageRules, + $commentRules, + $constantNotationRules, + $controlStructureRules, + $doctrineAnnotationRules, + $functionNotationRules, + $importRules, + $languageConstructRules, + $listNotationRules, + $namespaceNotationRules, + $namingRules, + $operatorRules, + $phpTagRules, + $phpUnitRules, + $phpDocRules, + $returnNotationRules, + $semicolonRules, + $strictRules, + $stringNotationRules, + $whitespaceRules +); + $finder = Finder::create() ->in([ - __DIR__ . '/src' + __DIR__ . '/src', + __DIR__ . '/tests' + ]) + ->notPath([ + 'complete.env.cache.php', + 'multilines.env.cache.php', + 'root.env.cache.php' ]) ->name('*.php') - ->path(__DIR__ . '/tests/EnvironmentTest.php') ->ignoreDotFiles(true) ->ignoreVCS(true); diff --git a/composer.json b/composer.json index ca192b2..81059bc 100644 --- a/composer.json +++ b/composer.json @@ -34,7 +34,7 @@ "@test" ], "lint": [ - "php-cs-fixer fix" + "php-cs-fixer fix -vvv" ], "test": [ "phpunit --colors --coverage-html ./coverage" diff --git a/src/Environment.php b/src/Environment.php index 61cdd4b..8cf11c1 100644 --- a/src/Environment.php +++ b/src/Environment.php @@ -9,13 +9,17 @@ */ class Environment { - public const GETENV = 0x01; - public const ENV = 0x02; - public const SERVER = 0x04; + public const int GETENV = 0x01; - public const GETENV_ALL = 0x08; - public const ENV_ALL = 0x10; - public const SERVER_ALL = 0x20; + public const int ENV = 0x02; + + public const int SERVER = 0x04; + + public const int GETENV_ALL = 0x08; + + public const int ENV_ALL = 0x10; + + public const int SERVER_ALL = 0x20; protected array $env = []; @@ -47,7 +51,6 @@ class Environment * Environment constructor. * * @param array|string $folders - * @param string $filename */ public function __construct($folders, string $filename = '.env') { @@ -59,9 +62,7 @@ public function __construct($folders, string $filename = '.env') $this->filename = $filename; } - /** - * @throws EnvironmentException - */ + /** @throws EnvironmentException */ public function load(): void { $filepath = $this->findFileInFolders(); @@ -82,13 +83,7 @@ public function load(): void $this->hasLoaded = true; } - /** - * @param int $currentIdx - * - * @throws EnvironmentException - * - * @return string - */ + /** @throws EnvironmentException */ protected function findFileInFolders(int $currentIdx = 0): string { if ($currentIdx >= \count($this->folders)) { @@ -111,12 +106,6 @@ protected function findFileInFolders(int $currentIdx = 0): string return $filepath; } - /** - * @param string $folder - * @param string $filename - * - * @return string - */ protected function createFilepath(string $folder, string $filename): string { $separator = ''; @@ -127,12 +116,7 @@ protected function createFilepath(string $folder, string $filename): string return $folder . $separator . $filename; } - /** - * @param string $content - * @param int $depth - * - * @throws EnvironmentException - */ + /** @throws EnvironmentException */ protected function parse(string $content, int $depth = 0): void { if ($depth > $this->maxtDepth) { @@ -142,7 +126,7 @@ protected function parse(string $content, int $depth = 0): void $lines = \mb_split("\n", $content); foreach ($lines as $line) { if ($this->inMultilines === false) { - $line = \ltrim($line); + $line = \mb_ltrim($line); if ($this->isEmptyLine($line)) { continue; } @@ -164,7 +148,7 @@ protected function parse(string $content, int $depth = 0): void $this->tempKey = $parts[0]; $this->extractText($parts[1]); } else { - $parts[1] = \rtrim($parts[1]); + $parts[1] = \mb_rtrim($parts[1]); $this->inMultilines = false; $parts[1] = $this->convertType($parts[1]); if (\is_string($parts[1])) { @@ -182,11 +166,6 @@ protected function parse(string $content, int $depth = 0): void } } - /** - * @param string $line - * - * @return bool - */ protected function isEmptyLine(string $line): bool { $char = \mb_substr($line, 0, 1); @@ -194,16 +173,11 @@ protected function isEmptyLine(string $line): bool return empty($line) || $char === '#' || $char === ';'; } - /** - * @param string $line - * @param int $depth - * - * @throws EnvironmentException - */ + /** @throws EnvironmentException */ protected function detectIncludingEnvFile(string $line, int $depth): void { if (\mb_strpos($line, '@') === 0) { - $line = \rtrim($line); + $line = \mb_rtrim($line); $filename = \mb_substr($line, 1, \mb_strlen($line)); $filepath = $this->createFilepath($this->currentFolder, $filename); if (!\file_exists($filepath)) { @@ -213,11 +187,6 @@ protected function detectIncludingEnvFile(string $line, int $depth): void } } - /** - * @param string $line - * - * @return bool - */ protected function hasQuotes(string $line): bool { $val = \mb_strtolower($line); @@ -225,9 +194,6 @@ protected function hasQuotes(string $line): bool return \mb_strpos($val, '"') === 0; } - /** - * @param string $line - */ protected function extractText(string $line): void { $string = $line; @@ -241,7 +207,7 @@ protected function extractText(string $line): void do { $lastPosition = \mb_strpos($string, '"', $lastPosition); if ($lastPosition === false) { - $this->tempText .= \rtrim($string, "\r\n") . $this->endline; + $this->tempText .= \mb_rtrim($string, "\r\n") . $this->endline; $endLine = true; } elseif (\mb_substr($string, $lastPosition - 1, 1) !== '\\') { $this->tempText .= \mb_substr($string, 0, $lastPosition); @@ -262,12 +228,8 @@ protected function extractText(string $line): void } } - /** - * @param string $value - * - * @return bool|float|int|string|null - */ - protected function convertType(string $value) + /** @return bool|float|int|string|null */ + protected function convertType(string $value): mixed { $val = \mb_strtolower($value); if ($val === 'true') { @@ -293,13 +255,7 @@ protected function convertType(string $value) return $value; } - /** - * @param string $value - * - * @throws EnvironmentException - * - * @return string - */ + /** @throws EnvironmentException */ protected function replaceVariables(string $value): string { foreach ($this->env as $keyEnv => $valueEnv) { @@ -313,10 +269,6 @@ protected function replaceVariables(string $value): string return $value; } - /** - * @param string $key - * @param mixed $value - */ protected function set(string $key, $value): void { $this->env[$key] = $value; @@ -335,11 +287,8 @@ protected function saveInCache(): void } /** - * @param string $key - * @param mixed $default - * + * @param mixed|null $default * @throws EnvironmentException - * * @return mixed|null */ public function get(string $key, $default = null) @@ -353,11 +302,7 @@ public function get(string $key, $default = null) return $this->env[$key]; } - /** - * @throws EnvironmentException - * - * @return array - */ + /** @throws EnvironmentException */ public function getAll(): array { $this->autoload(); @@ -366,11 +311,9 @@ public function getAll(): array } /** - * @param string|array $keys + * @param array|string $keys * * @throws EnvironmentException - * - * @return bool */ public function exists($keys): bool { @@ -389,9 +332,7 @@ public function exists($keys): bool return true; } - /** - * @throws EnvironmentException - */ + /** @throws EnvironmentException */ protected function autoload(): void { if (!$this->hasLoaded) { @@ -399,14 +340,7 @@ protected function autoload(): void } } - /** - * @param string $name - * @param array $values - * - * @throws EnvironmentException - * - * @return bool - */ + /** @throws EnvironmentException */ public function allowedValues(string $name, array $values): bool { if (!$this->exists($name)) { @@ -431,27 +365,17 @@ public function flushCache(): void $this->hasToFlush = true; } - /** - * @param string $endline - */ public function setEndline(string $endline): void { $this->endline = $endline; } - /** - * @return string - */ public function getEndline(): string { return $this->endline; } - /** - * @param int $flags - * - * @throws EnvironmentException - */ + /** @throws EnvironmentException */ public function complete(int $flags): void { $this->autoload(); @@ -520,11 +444,7 @@ public function complete(int $flags): void } } - /** - * @param int $flags - * - * @throws EnvironmentException - */ + /** @throws EnvironmentException */ public function override(int $flags): void { $this->autoload(); diff --git a/src/EnvironmentException.php b/src/EnvironmentException.php index 080ae05..8081131 100644 --- a/src/EnvironmentException.php +++ b/src/EnvironmentException.php @@ -4,11 +4,7 @@ namespace Rancoud\Environment; -use Exception; - /** * Class EnvironmentException. */ -class EnvironmentException extends Exception -{ -} +class EnvironmentException extends \Exception {} diff --git a/tests/EnvironmentTest.php b/tests/EnvironmentTest.php index 71eebb8..56dec43 100644 --- a/tests/EnvironmentTest.php +++ b/tests/EnvironmentTest.php @@ -7,10 +7,11 @@ use PHPUnit\Framework\TestCase; use Rancoud\Environment\Environment; use Rancoud\Environment\EnvironmentException; -use ReflectionClass; /** * Class EnvironmentTest. + * + * @internal */ class EnvironmentTest extends TestCase { @@ -59,17 +60,10 @@ class EnvironmentTest extends TestCase 'FROM_NOWHERE' => 'value04' ]; - /** - * @param Environment $env - * @param string $name - * - * @throws \ReflectionException - * - * @return mixed - */ + /** @throws \ReflectionException */ protected function getProtectedValue(Environment $env, string $name) { - $reflexion = new ReflectionClass(Environment::class); + $reflexion = new \ReflectionClass(Environment::class); $prop = $reflexion->getProperty($name); $prop->setAccessible(true); @@ -89,9 +83,7 @@ public function testBitmasking(): void static::assertSame(32, $flags & Environment::SERVER_ALL); } - /** - * @throws \ReflectionException - */ + /** @throws \ReflectionException */ public function testConstruct(): void { $folders = ['a', 'b']; @@ -110,9 +102,7 @@ public function testConstruct(): void static::assertSame('.env', $this->getProtectedValue($env, 'filename')); } - /** - * @throws EnvironmentException - */ + /** @throws EnvironmentException */ public function testLoad(): void { $folders = [__DIR__]; @@ -143,9 +133,7 @@ public function testLoadException(): void $env->load(); } - /** - * @throws EnvironmentException - */ + /** @throws EnvironmentException */ public function testGetAllAutoload(): void { $folders = [__DIR__]; @@ -155,9 +143,7 @@ public function testGetAllAutoload(): void static::assertSame($this->fileEnvContent, $env->getAll()); } - /** - * @throws EnvironmentException - */ + /** @throws EnvironmentException */ public function testGetAutoload(): void { $folders = [__DIR__]; @@ -167,9 +153,7 @@ public function testGetAutoload(): void static::assertSame($this->fileEnvContent['STRING'], $env->get('STRING')); } - /** - * @throws EnvironmentException - */ + /** @throws EnvironmentException */ public function testGetDefault(): void { $folders = [__DIR__]; @@ -179,9 +163,7 @@ public function testGetDefault(): void static::assertSame('dev', $env->get('env', 'dev')); } - /** - * @throws EnvironmentException - */ + /** @throws EnvironmentException */ public function testExists(): void { $folders = [__DIR__]; @@ -196,9 +178,7 @@ public function testExists(): void static::assertFalse($env->exists(['ERROR', 'STRING'])); } - /** - * @throws EnvironmentException - */ + /** @throws EnvironmentException */ public function testAllowedValues(): void { $folders = [__DIR__]; @@ -222,9 +202,7 @@ public function testAllowedValuesException(): void static::assertTrue($env->allowedValues('env', [])); } - /** - * @throws EnvironmentException - */ + /** @throws EnvironmentException */ public function testVariablesInEnvFile(): void { $folders = [__DIR__]; @@ -252,9 +230,7 @@ public function testMissingVariablesInEnvFileException(): void $env->load(); } - /** - * @throws EnvironmentException - */ + /** @throws EnvironmentException */ public function testIncludeEnvFile(): void { $folders = [__DIR__]; @@ -297,9 +273,6 @@ public function testInfiniteIncludeEnvFileException(): void $env->load(); } - /** - * @param string $filepath - */ private function erasePreviousFile(string $filepath): void { if (\file_exists($filepath)) { @@ -307,9 +280,7 @@ private function erasePreviousFile(string $filepath): void } } - /** - * @throws EnvironmentException - */ + /** @throws EnvironmentException */ public function testUseCacheFile(): void { $filepath = __DIR__ . \DIRECTORY_SEPARATOR . 'root.env.cache.php'; @@ -338,9 +309,7 @@ public function testUseCacheFile(): void static::assertSame($this->fileEnvContent, $data); } - /** - * @throws EnvironmentException - */ + /** @throws EnvironmentException */ public function testUseCacheFileAlreadyCreate(): void { $filepath = __DIR__ . \DIRECTORY_SEPARATOR . 'root.env.cache.php'; @@ -417,9 +386,7 @@ public function testUseCacheFileAlreadyCreate(): void static::assertSame($this->fileEnvContent['BOOL_FALSE'], $env->get('BOOL_FALSE')); } - /** - * @throws EnvironmentException - */ + /** @throws EnvironmentException */ public function testMultilines(): void { $filepath = __DIR__ . \DIRECTORY_SEPARATOR . 'multilines.env.cache.php'; @@ -444,9 +411,7 @@ public function testMultilines(): void static::assertSame($this->fileMultilinesEnvContent, $data); } - /** - * @throws EnvironmentException - */ + /** @throws EnvironmentException */ public function testGetSetEndline(): void { $endline = '
'; @@ -498,9 +463,7 @@ public function testKeyNumericForbiddenException(): void $env->load(); } - /** - * @throws EnvironmentException - */ + /** @throws EnvironmentException */ public function testComplete(): void { $_ENV['FROM_ENV'] = 'env_value'; @@ -531,9 +494,7 @@ public function testComplete(): void static::assertSame($_SERVER['FROM_SERVER'], $env->get('FROM_SERVER')); } - /** - * @throws EnvironmentException - */ + /** @throws EnvironmentException */ public function testOverride(): void { $_ENV['FROM_ENV'] = 'env_value'; @@ -562,9 +523,7 @@ public function testOverride(): void static::assertSame($_SERVER['FROM_SERVER'], $env->get('FROM_SERVER')); } - /** - * @throws EnvironmentException - */ + /** @throws EnvironmentException */ public function testCompleteNoEraseValues(): void { $_ENV['FROM_ENV'] = 'env_value'; @@ -589,9 +548,7 @@ public function testCompleteNoEraseValues(): void static::assertSame($this->fileOverrideContent['FROM_NOWHERE'], $env->get('FROM_NOWHERE')); } - /** - * @throws EnvironmentException - */ + /** @throws EnvironmentException */ public function testCompleteAll(): void { $_ENV['FROM_ENV'] = 'env_value'; @@ -622,9 +579,7 @@ public function testCompleteAll(): void static::assertSame($_SERVER['FROM_SERVER'], $env->get('FROM_SERVER')); } - /** - * @throws EnvironmentException - */ + /** @throws EnvironmentException */ public function testOverrideAll(): void { $_ENV['FROM_ENV'] = 'env_value'; @@ -649,9 +604,7 @@ public function testOverrideAll(): void static::assertSame($_SERVER['FROM_SERVER'], $env->get('FROM_SERVER')); } - /** - * @throws EnvironmentException - */ + /** @throws EnvironmentException */ public function testOverrideGetEnvAll(): void { $_ENV['FROM_ENV'] = 'env_value'; @@ -668,9 +621,7 @@ public function testOverrideGetEnvAll(): void static::assertFalse($env->get('FROM_SERVER', false)); } - /** - * @throws EnvironmentException - */ + /** @throws EnvironmentException */ public function testOverrideEnvAll(): void { $_ENV['FROM_ENV'] = 'env_value'; @@ -687,9 +638,7 @@ public function testOverrideEnvAll(): void static::assertFalse($env->get('FROM_SERVER', false)); } - /** - * @throws EnvironmentException - */ + /** @throws EnvironmentException */ public function testOverrideServerAll(): void { $_ENV['FROM_ENV'] = 'env_value';