src/Phan/Plugin/Internal/MethodSearcherPlugin.php

Summary

Maintainability
D
2 days
Test Coverage

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

final class MethodSearcherPlugin extends PluginV3 implements
    BeforeAnalyzeCapability
{
    /** @var list<UnionType> the param type we're looking for. */
    public static $param_types;

File MethodSearcherPlugin.php has 304 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

declare(strict_types=1);

namespace Phan\Plugin\Internal;
Severity: Minor
Found in src/Phan/Plugin/Internal/MethodSearcherPlugin.php - About 3 hrs to fix

    Function getTypeMatchingBonus has a Cognitive Complexity of 22 (exceeds 5 allowed). Consider refactoring.
    Open

        public static function getTypeMatchingBonus(CodeBase $code_base, UnionType $actual_signature_type, UnionType $desired_type): float
        {
            if (self::isMixed($desired_type) || self::isMixed($actual_signature_type)) {
                return 0;
            }
    Severity: Minor
    Found in src/Phan/Plugin/Internal/MethodSearcherPlugin.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

    Function beforeAnalyze has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
    Open

        public function beforeAnalyze(CodeBase $code_base): void
        {
            self::addMissingNamespacesToTypes($code_base);
    
            $code_base->eagerlyLoadAllSignatures();
    Severity: Minor
    Found in src/Phan/Plugin/Internal/MethodSearcherPlugin.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

    Function functionMatchesSignature has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
    Open

        public function functionMatchesSignature(
            CodeBase $code_base,
            FunctionInterface $function
        ): float {
            // TODO: Account for visibility
    Severity: Minor
    Found in src/Phan/Plugin/Internal/MethodSearcherPlugin.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

    Function addMissingNamespaces has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
    Open

        public static function addMissingNamespaces(CodeBase $code_base, UnionType $union_type): UnionType
        {
            foreach ($union_type->getTypeSet() as $type) {
                if ($type->isObjectWithKnownFQSEN()) {
                    $replacements = self::getReplacementTypesForFullyQualifiedClassName($code_base, $type);
    Severity: Minor
    Found in src/Phan/Plugin/Internal/MethodSearcherPlugin.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

    Method beforeAnalyze has 39 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function beforeAnalyze(CodeBase $code_base): void
        {
            self::addMissingNamespacesToTypes($code_base);
    
            $code_base->eagerlyLoadAllSignatures();
    Severity: Minor
    Found in src/Phan/Plugin/Internal/MethodSearcherPlugin.php - About 1 hr to fix

      Method functionMatchesSignature has 38 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public function functionMatchesSignature(
              CodeBase $code_base,
              FunctionInterface $function
          ): float {
              // TODO: Account for visibility
      Severity: Minor
      Found in src/Phan/Plugin/Internal/MethodSearcherPlugin.php - About 1 hr to fix

        Method getTypeMatchingBonus has 32 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            public static function getTypeMatchingBonus(CodeBase $code_base, UnionType $actual_signature_type, UnionType $desired_type): float
            {
                if (self::isMixed($desired_type) || self::isMixed($actual_signature_type)) {
                    return 0;
                }
        Severity: Minor
        Found in src/Phan/Plugin/Internal/MethodSearcherPlugin.php - About 1 hr to fix

          Function matchesParamTypes has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
          Open

              public static function matchesParamTypes(CodeBase $code_base, array $search_param_types, array $signature_param_types): float
              {
                  if (\count($search_param_types) === 0) {
                      // Award extra points for having the same number of matches
                      return \max(1, 5 - count($signature_param_types)) / 2;
          Severity: Minor
          Found in src/Phan/Plugin/Internal/MethodSearcherPlugin.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 setSearchString has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
          Open

              public static function setSearchString(string $search_string): void
              {
                  // XXX improve parsing this
                  $parts = \array_map('trim', \explode('->', $search_string));
                  $result = [];
          Severity: Minor
          Found in src/Phan/Plugin/Internal/MethodSearcherPlugin.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

          Method matchesParamTypes has 27 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              public static function matchesParamTypes(CodeBase $code_base, array $search_param_types, array $signature_param_types): float
              {
                  if (\count($search_param_types) === 0) {
                      // Award extra points for having the same number of matches
                      return \max(1, 5 - count($signature_param_types)) / 2;
          Severity: Minor
          Found in src/Phan/Plugin/Internal/MethodSearcherPlugin.php - About 1 hr to fix

            Function guessUnionType has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
            Open

                private static function guessUnionType(FunctionInterface $function): UnionType
                {
                    if ($function instanceof Method) {
                        // convert __set to void, __sleep to string[], etc.
                        $union_type = $function->getUnionTypeOfMagicIfKnown();
            Severity: Minor
            Found in src/Phan/Plugin/Internal/MethodSearcherPlugin.php - About 55 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

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

                private static function isCastableButNotSubtype(UnionType $actual_type, Type $inner_type): bool
                {
                    if ($inner_type instanceof ObjectType) {
                        foreach ($actual_type->getTypeSet() as $type) {
                            if ($type->isPossiblyObject() && !$type->isObjectWithKnownFQSEN()) {
            Severity: Minor
            Found in src/Phan/Plugin/Internal/MethodSearcherPlugin.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 0;
            Severity: Major
            Found in src/Phan/Plugin/Internal/MethodSearcherPlugin.php - About 30 mins to fix

              Avoid too many return statements within this method.
              Open

                      return \max(0.1, $result + $adjustment + self::getTypeMatchingBonus($code_base, $return_type, self::$return_type));
              Severity: Major
              Found in src/Phan/Plugin/Internal/MethodSearcherPlugin.php - About 30 mins to fix

                The method functionMatchesSignature() has an NPath complexity of 2160. The configured NPath complexity threshold is 200.
                Open

                    public function functionMatchesSignature(
                        CodeBase $code_base,
                        FunctionInterface $function
                    ): float {
                        // TODO: Account for visibility

                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 beforeAnalyze() has an NPath complexity of 360. The configured NPath complexity threshold is 200.
                Open

                    public function beforeAnalyze(CodeBase $code_base): void
                    {
                        self::addMissingNamespacesToTypes($code_base);
                
                        $code_base->eagerlyLoadAllSignatures();

                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 getTypeMatchingBonus() has a Cyclomatic Complexity of 14. The configured cyclomatic complexity threshold is 10.
                Open

                    public static function getTypeMatchingBonus(CodeBase $code_base, UnionType $actual_signature_type, UnionType $desired_type): float
                    {
                        if (self::isMixed($desired_type) || self::isMixed($actual_signature_type)) {
                            return 0;
                        }

                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 beforeAnalyze() has a Cyclomatic Complexity of 11. The configured cyclomatic complexity threshold is 10.
                Open

                    public function beforeAnalyze(CodeBase $code_base): void
                    {
                        self::addMissingNamespacesToTypes($code_base);
                
                        $code_base->eagerlyLoadAllSignatures();

                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 functionMatchesSignature() has a Cyclomatic Complexity of 14. The configured cyclomatic complexity threshold is 10.
                Open

                    public function functionMatchesSignature(
                        CodeBase $code_base,
                        FunctionInterface $function
                    ): float {
                        // TODO: Account for visibility

                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 beforeAnalyze() contains an exit expression.
                Open

                        exit(\EXIT_SUCCESS);

                ExitExpression

                Since: 0.2

                An exit-expression within regular code is untestable and therefore it should be avoided. Consider to move the exit-expression into some kind of startup script where an error/exception code is returned to the calling environment.

                Example

                class Foo {
                    public function bar($param)  {
                        if ($param === 42) {
                            exit(23);
                        }
                    }
                }

                Source https://phpmd.org/rules/design.html#exitexpression

                The method getReplacementTypesForFullyQualifiedClassName() contains an exit expression.
                Open

                            exit(\EXIT_FAILURE);

                ExitExpression

                Since: 0.2

                An exit-expression within regular code is untestable and therefore it should be avoided. Consider to move the exit-expression into some kind of startup script where an error/exception code is returned to the calling environment.

                Example

                class Foo {
                    public function bar($param)  {
                        if ($param === 42) {
                            exit(23);
                        }
                    }
                }

                Source https://phpmd.org/rules/design.html#exitexpression

                There are no issues that match your filters.

                Category
                Status