src/Phan/Config.php

Summary

Maintainability
F
6 days
Test Coverage

File Config.php has 683 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

declare(strict_types=1);

namespace Phan;
Severity: Major
Found in src/Phan/Config.php - About 1 day to fix

    Method getConfigErrors has 200 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public static function getConfigErrors(array $configuration): array
        {
            /**
             * @param mixed $value
             */
    Severity: Major
    Found in src/Phan/Config.php - About 1 day to fix

      Config has 34 functions (exceeds 20 allowed). Consider refactoring.
      Open

      class Config
      {
          /**
           * The version of the AST (defined in php-ast) that we're using.
           * @see https://github.com/nikic/php-ast#ast-versioning
      Severity: Minor
      Found in src/Phan/Config.php - About 4 hrs to fix

        Function getConfigErrors has a Cognitive Complexity of 27 (exceeds 5 allowed). Consider refactoring.
        Open

            public static function getConfigErrors(array $configuration): array
            {
                /**
                 * @param mixed $value
                 */
        Severity: Minor
        Found in src/Phan/Config.php - About 3 hrs to fix

        Cognitive Complexity

        Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

        A method's cognitive complexity is based on a few simple rules:

        • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
        • Code is considered more complex for each "break in the linear flow of the code"
        • Code is considered more complex when "flow breaking structures are nested"

        Further reading

        The class Config has an overall complexity of 114 which is very high. The configured complexity threshold is 50.
        Open

        class Config
        {
            /**
             * The version of the AST (defined in php-ast) that we're using.
             * @see https://github.com/nikic/php-ast#ast-versioning
        Severity: Minor
        Found in src/Phan/Config.php by phpmd

        Function setValue has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
        Open

            public static function setValue(string $name, $value): void
            {
                self::$configuration[$name] = $value;
                switch ($name) {
                    case 'ignore_undeclared_functions_with_known_signatures':
        Severity: Minor
        Found in src/Phan/Config.php - About 2 hrs to fix

        Cognitive Complexity

        Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

        A method's cognitive complexity is based on a few simple rules:

        • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
        • Code is considered more complex for each "break in the linear flow of the code"
        • Code is considered more complex when "flow breaking structures are nested"

        Further reading

        Method setValue has 63 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            public static function setValue(string $name, $value): void
            {
                self::$configuration[$name] = $value;
                switch ($name) {
                    case 'ignore_undeclared_functions_with_known_signatures':
        Severity: Major
        Found in src/Phan/Config.php - About 2 hrs to fix

          Function normalizeScalarImplicitPartial has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
          Open

              private static function normalizeScalarImplicitPartial($value): array
              {
                  if (!is_array($value)) {
                      return [];
                  }
          Severity: Minor
          Found in src/Phan/Config.php - About 1 hr to fix

          Cognitive Complexity

          Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

          A method's cognitive complexity is based on a few simple rules:

          • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
          • Code is considered more complex for each "break in the linear flow of the code"
          • Code is considered more complex when "flow breaking structures are nested"

          Further reading

          Function computeClosestTargetPHPVersionId has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
          Open

              private static function computeClosestTargetPHPVersionId(string $version): int
              {
                  if (\version_compare($version, '6.0') < 0) {
                      return 50600;
                  } elseif (\version_compare($version, '7.1') < 0) {
          Severity: Minor
          Found in src/Phan/Config.php - About 35 mins to fix

          Cognitive Complexity

          Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

          A method's cognitive complexity is based on a few simple rules:

          • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
          • Code is considered more complex for each "break in the linear flow of the code"
          • Code is considered more complex when "flow breaking structures are nested"

          Further reading

          Avoid too many return statements within this method.
          Open

                          return null;
          Severity: Major
          Found in src/Phan/Config.php - About 30 mins to fix

            Avoid too many return statements within this method.
            Open

                        return 'Expected a string' . self::errSuffixGotType($value);
            Severity: Major
            Found in src/Phan/Config.php - About 30 mins to fix

              Avoid too many return statements within this method.
              Open

                      return $library_composer_settings;
              Severity: Major
              Found in src/Phan/Config.php - About 30 mins to fix

                Avoid too many return statements within this method.
                Open

                            return 'Expected an array' . self::errSuffixGotType($value);
                Severity: Major
                Found in src/Phan/Config.php - About 30 mins to fix

                  Avoid too many return statements within this method.
                  Open

                                  return 'Expected an associative array mapping strings to strings'  . self::errSuffixGotType($value);
                  Severity: Major
                  Found in src/Phan/Config.php - About 30 mins to fix

                    Avoid too many return statements within this method.
                    Open

                                    return 'Expected a list of strings' . self::errSuffixGotType($value);
                    Severity: Major
                    Found in src/Phan/Config.php - About 30 mins to fix

                      Avoid too many return statements within this method.
                      Open

                                  return null;
                      Severity: Major
                      Found in src/Phan/Config.php - About 30 mins to fix

                        Avoid too many return statements within this method.
                        Open

                                        return null;
                        Severity: Major
                        Found in src/Phan/Config.php - About 30 mins to fix

                          Avoid too many return statements within this method.
                          Open

                                          return 'Expected null or a list of strings' . self::errSuffixGotType($value);
                          Severity: Major
                          Found in src/Phan/Config.php - About 30 mins to fix

                            Avoid too many return statements within this method.
                            Open

                                            return null;
                            Severity: Major
                            Found in src/Phan/Config.php - About 30 mins to fix

                              Avoid too many return statements within this method.
                              Open

                                          return 'Expected a boolean' . self::errSuffixGotType($value);
                              Severity: Major
                              Found in src/Phan/Config.php - About 30 mins to fix

                                Avoid too many return statements within this method.
                                Open

                                            return null;
                                Severity: Major
                                Found in src/Phan/Config.php - About 30 mins to fix

                                  Avoid too many return statements within this method.
                                  Open

                                          return $result;
                                  Severity: Major
                                  Found in src/Phan/Config.php - About 30 mins to fix

                                    Avoid too many return statements within this method.
                                    Open

                                                    return null;
                                    Severity: Major
                                    Found in src/Phan/Config.php - About 30 mins to fix

                                      Avoid too many return statements within this method.
                                      Open

                                                  return null;
                                      Severity: Major
                                      Found in src/Phan/Config.php - About 30 mins to fix

                                        Avoid too many return statements within this method.
                                        Open

                                                            return "Expected a list of strings: index $i is type '" . gettype($element) . "'";
                                        Severity: Major
                                        Found in src/Phan/Config.php - About 30 mins to fix

                                          Avoid too many return statements within this method.
                                          Open

                                                              return "Expected null or a list of strings: index $i is type '" . gettype($element) . "'";
                                          Severity: Major
                                          Found in src/Phan/Config.php - About 30 mins to fix

                                            Avoid too many return statements within this method.
                                            Open

                                                                return "Expected an associative array mapping strings to strings: index $i is '" . gettype($element) . "'";
                                            Severity: Major
                                            Found in src/Phan/Config.php - About 30 mins to fix

                                              Avoid too many return statements within this method.
                                              Open

                                                          return 80000;
                                              Severity: Major
                                              Found in src/Phan/Config.php - About 30 mins to fix

                                                Avoid too many return statements within this method.
                                                Open

                                                                return null;
                                                Severity: Major
                                                Found in src/Phan/Config.php - About 30 mins to fix

                                                  Avoid too many return statements within this method.
                                                  Open

                                                              return 'Expected a string' . self::errSuffixGotType($value);
                                                  Severity: Major
                                                  Found in src/Phan/Config.php - About 30 mins to fix

                                                    Avoid too many return statements within this method.
                                                    Open

                                                                    return null;
                                                    Severity: Major
                                                    Found in src/Phan/Config.php - About 30 mins to fix

                                                      Avoid too many return statements within this method.
                                                      Open

                                                                  return 70300;
                                                      Severity: Major
                                                      Found in src/Phan/Config.php - About 30 mins to fix

                                                        Avoid too many return statements within this method.
                                                        Open

                                                                    return 70400;
                                                        Severity: Major
                                                        Found in src/Phan/Config.php - About 30 mins to fix

                                                          Avoid too many return statements within this method.
                                                          Open

                                                                      return 'Expected an integer' . self::errSuffixGotType($value);
                                                          Severity: Major
                                                          Found in src/Phan/Config.php - About 30 mins to fix

                                                            Function updateClosestTargetPHPVersion has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                                                            Open

                                                                private static function updateClosestTargetPHPVersion(): void
                                                                {
                                                                    $value = self::$configuration['target_php_version'];
                                                                    if (is_int($value) || is_float($value)) {
                                                                        $value = \sprintf("%.1f", $value);
                                                            Severity: Minor
                                                            Found in src/Phan/Config.php - About 25 mins to fix

                                                            Cognitive Complexity

                                                            Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

                                                            A method's cognitive complexity is based on a few simple rules:

                                                            • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
                                                            • Code is considered more complex for each "break in the linear flow of the code"
                                                            • Code is considered more complex when "flow breaking structures are nested"

                                                            Further reading

                                                            The method getConfigErrors() has an NPath complexity of 933120. The configured NPath complexity threshold is 200.
                                                            Open

                                                                public static function getConfigErrors(array $configuration): array
                                                                {
                                                                    /**
                                                                     * @param mixed $value
                                                                     */
                                                            Severity: Minor
                                                            Found in src/Phan/Config.php by phpmd

                                                            NPathComplexity

                                                            Since: 0.1

                                                            The NPath complexity of a method is the number of acyclic execution paths through that method. A threshold of 200 is generally considered the point where measures should be taken to reduce complexity.

                                                            Example

                                                            class Foo {
                                                                function bar() {
                                                                    // lots of complicated code
                                                                }
                                                            }

                                                            Source https://phpmd.org/rules/codesize.html#npathcomplexity

                                                            The method getConfigErrors() has 234 lines of code. Current threshold is set to 100. Avoid really long methods.
                                                            Open

                                                                public static function getConfigErrors(array $configuration): array
                                                                {
                                                                    /**
                                                                     * @param mixed $value
                                                                     */
                                                            Severity: Minor
                                                            Found in src/Phan/Config.php by phpmd

                                                            The class Config has 1655 lines of code. Current threshold is 1000. Avoid really long classes.
                                                            Open

                                                            class Config
                                                            {
                                                                /**
                                                                 * The version of the AST (defined in php-ast) that we're using.
                                                                 * @see https://github.com/nikic/php-ast#ast-versioning
                                                            Severity: Minor
                                                            Found in src/Phan/Config.php by phpmd

                                                            The method setValue() has a Cyclomatic Complexity of 24. The configured cyclomatic complexity threshold is 10.
                                                            Open

                                                                public static function setValue(string $name, $value): void
                                                                {
                                                                    self::$configuration[$name] = $value;
                                                                    switch ($name) {
                                                                        case 'ignore_undeclared_functions_with_known_signatures':
                                                            Severity: Minor
                                                            Found in src/Phan/Config.php by phpmd

                                                            CyclomaticComplexity

                                                            Since: 0.1

                                                            Complexity is determined by the number of decision points in a method plus one for the method entry. The decision points are 'if', 'while', 'for', and 'case labels'. Generally, 1-4 is low complexity, 5-7 indicates moderate complexity, 8-10 is high complexity, and 11+ is very high complexity.

                                                            Example

                                                            // Cyclomatic Complexity = 11
                                                            class Foo {
                                                            1   public function example() {
                                                            2       if ($a == $b) {
                                                            3           if ($a1 == $b1) {
                                                                            fiddle();
                                                            4           } elseif ($a2 == $b2) {
                                                                            fiddle();
                                                                        } else {
                                                                            fiddle();
                                                                        }
                                                            5       } elseif ($c == $d) {
                                                            6           while ($c == $d) {
                                                                            fiddle();
                                                                        }
                                                            7        } elseif ($e == $f) {
                                                            8           for ($n = 0; $n < $h; $n++) {
                                                                            fiddle();
                                                                        }
                                                                    } else {
                                                                        switch ($z) {
                                                            9               case 1:
                                                                                fiddle();
                                                                                break;
                                                            10              case 2:
                                                                                fiddle();
                                                                                break;
                                                            11              case 3:
                                                                                fiddle();
                                                                                break;
                                                                            default:
                                                                                fiddle();
                                                                                break;
                                                                        }
                                                                    }
                                                                }
                                                            }

                                                            Source https://phpmd.org/rules/codesize.html#cyclomaticcomplexity

                                                            The method getConfigErrors() has a Cyclomatic Complexity of 24. The configured cyclomatic complexity threshold is 10.
                                                            Open

                                                                public static function getConfigErrors(array $configuration): array
                                                                {
                                                                    /**
                                                                     * @param mixed $value
                                                                     */
                                                            Severity: Minor
                                                            Found in src/Phan/Config.php by phpmd

                                                            CyclomaticComplexity

                                                            Since: 0.1

                                                            Complexity is determined by the number of decision points in a method plus one for the method entry. The decision points are 'if', 'while', 'for', and 'case labels'. Generally, 1-4 is low complexity, 5-7 indicates moderate complexity, 8-10 is high complexity, and 11+ is very high complexity.

                                                            Example

                                                            // Cyclomatic Complexity = 11
                                                            class Foo {
                                                            1   public function example() {
                                                            2       if ($a == $b) {
                                                            3           if ($a1 == $b1) {
                                                                            fiddle();
                                                            4           } elseif ($a2 == $b2) {
                                                                            fiddle();
                                                                        } else {
                                                                            fiddle();
                                                                        }
                                                            5       } elseif ($c == $d) {
                                                            6           while ($c == $d) {
                                                                            fiddle();
                                                                        }
                                                            7        } elseif ($e == $f) {
                                                            8           for ($n = 0; $n < $h; $n++) {
                                                                            fiddle();
                                                                        }
                                                                    } else {
                                                                        switch ($z) {
                                                            9               case 1:
                                                                                fiddle();
                                                                                break;
                                                            10              case 2:
                                                                                fiddle();
                                                                                break;
                                                            11              case 3:
                                                                                fiddle();
                                                                                break;
                                                                            default:
                                                                                fiddle();
                                                                                break;
                                                                        }
                                                                    }
                                                                }
                                                            }

                                                            Source https://phpmd.org/rules/codesize.html#cyclomaticcomplexity

                                                            The method normalizeScalarImplicitPartial() has a Cyclomatic Complexity of 10. The configured cyclomatic complexity threshold is 10.
                                                            Open

                                                                private static function normalizeScalarImplicitPartial($value): array
                                                                {
                                                                    if (!is_array($value)) {
                                                                        return [];
                                                                    }
                                                            Severity: Minor
                                                            Found in src/Phan/Config.php by phpmd

                                                            CyclomaticComplexity

                                                            Since: 0.1

                                                            Complexity is determined by the number of decision points in a method plus one for the method entry. The decision points are 'if', 'while', 'for', and 'case labels'. Generally, 1-4 is low complexity, 5-7 indicates moderate complexity, 8-10 is high complexity, and 11+ is very high complexity.

                                                            Example

                                                            // Cyclomatic Complexity = 11
                                                            class Foo {
                                                            1   public function example() {
                                                            2       if ($a == $b) {
                                                            3           if ($a1 == $b1) {
                                                                            fiddle();
                                                            4           } elseif ($a2 == $b2) {
                                                                            fiddle();
                                                                        } else {
                                                                            fiddle();
                                                                        }
                                                            5       } elseif ($c == $d) {
                                                            6           while ($c == $d) {
                                                                            fiddle();
                                                                        }
                                                            7        } elseif ($e == $f) {
                                                            8           for ($n = 0; $n < $h; $n++) {
                                                                            fiddle();
                                                                        }
                                                                    } else {
                                                                        switch ($z) {
                                                            9               case 1:
                                                                                fiddle();
                                                                                break;
                                                            10              case 2:
                                                                                fiddle();
                                                                                break;
                                                            11              case 3:
                                                                                fiddle();
                                                                                break;
                                                                            default:
                                                                                fiddle();
                                                                                break;
                                                                        }
                                                                    }
                                                                }
                                                            }

                                                            Source https://phpmd.org/rules/codesize.html#cyclomaticcomplexity

                                                            Similar blocks of code found in 2 locations. Consider refactoring.
                                                            Open

                                                                    $is_associative_string_array = static function ($value): ?string {
                                                                        if (!is_array($value)) {
                                                                            return 'Expected an associative array mapping strings to strings'  . self::errSuffixGotType($value);
                                                                        }
                                                                        foreach ($value as $i => $element) {
                                                            Severity: Minor
                                                            Found in src/Phan/Config.php and 1 other location - About 45 mins to fix
                                                            src/Phan/Config.php on lines 1494..1504

                                                            Duplicated Code

                                                            Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                                                            Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                                                            When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                                                            Tuning

                                                            This issue has a mass of 95.

                                                            We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                                                            The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                                                            If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                                                            See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                                                            Refactorings

                                                            Further Reading

                                                            Similar blocks of code found in 2 locations. Consider refactoring.
                                                            Open

                                                                    $is_string_list = static function ($value): ?string {
                                                                        if (!is_array($value)) {
                                                                            return 'Expected a list of strings' . self::errSuffixGotType($value);
                                                                        }
                                                                        foreach ($value as $i => $element) {
                                                            Severity: Minor
                                                            Found in src/Phan/Config.php and 1 other location - About 45 mins to fix
                                                            src/Phan/Config.php on lines 1525..1535

                                                            Duplicated Code

                                                            Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                                                            Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                                                            When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                                                            Tuning

                                                            This issue has a mass of 95.

                                                            We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                                                            The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                                                            If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                                                            See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                                                            Refactorings

                                                            Further Reading

                                                            Avoid variables with short names like $_. Configured minimum length is 3.
                                                            Open

                                                                    [$version, $_] = Initializer::determineTargetPHPVersion($settings);
                                                            Severity: Minor
                                                            Found in src/Phan/Config.php by phpmd

                                                            ShortVariable

                                                            Since: 0.2

                                                            Detects when a field, local, or parameter has a very short name.

                                                            Example

                                                            class Something {
                                                                private $q = 15; // VIOLATION - Field
                                                                public static function main( array $as ) { // VIOLATION - Formal
                                                                    $r = 20 + $this->q; // VIOLATION - Local
                                                                    for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
                                                                        $r += $this->q;
                                                                    }
                                                                }
                                                            }

                                                            Source https://phpmd.org/rules/naming.html#shortvariable

                                                            There are no issues that match your filters.

                                                            Category
                                                            Status