src/Phan/LanguageServer/DefinitionResolver.php

Summary

Maintainability
F
3 days
Test Coverage

File DefinitionResolver.php has 348 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

declare(strict_types=1);

namespace Phan\LanguageServer;
Severity: Minor
Found in src/Phan/LanguageServer/DefinitionResolver.php - About 4 hrs to fix

    Function locateNamespaceUseDefinition has a Cognitive Complexity of 24 (exceeds 5 allowed). Consider refactoring.
    Open

        public static function locateNamespaceUseDefinition(GoToDefinitionRequest $request, CodeBase $code_base, Node $node): void
        {
            // TODO: Support GroupUse (See ScopeVisitor->visitGroupUse)
            $targets = ScopeVisitor::aliasTargetMapFromUseNode($node);
            if (count($targets) !== 1) {
    Severity: Minor
    Found in src/Phan/LanguageServer/DefinitionResolver.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 DefinitionResolver has an overall complexity of 86 which is very high. The configured complexity threshold is 50.
    Open

    class DefinitionResolver
    {
        /**
         * @return Closure(Context,Node,list<Node>):void
         * NOTE: The helper methods distinguish between "Go to definition"

    Method createGoToDefinitionClosure has 53 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public static function createGoToDefinitionClosure(GoToDefinitionRequest $request, CodeBase $code_base): Closure
        {
            /**
             * @param list<Node> $parent_node_list
             */
    Severity: Major
    Found in src/Phan/LanguageServer/DefinitionResolver.php - About 2 hrs to fix

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

          public static function locateNamespaceUseDefinition(GoToDefinitionRequest $request, CodeBase $code_base, Node $node): void
          {
              // TODO: Support GroupUse (See ScopeVisitor->visitGroupUse)
              $targets = ScopeVisitor::aliasTargetMapFromUseNode($node);
              if (count($targets) !== 1) {
      Severity: Minor
      Found in src/Phan/LanguageServer/DefinitionResolver.php - About 1 hr to fix

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

            private static function locateConstructorDefinitionForUnionType(
                GoToDefinitionRequest $request,
                CodeBase $code_base,
                UnionType $union_type
            ): void {
        Severity: Minor
        Found in src/Phan/LanguageServer/DefinitionResolver.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 locateGlobalConstantDefinitionFromComment has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
        Open

            private static function locateGlobalConstantDefinitionFromComment(
                GoToDefinitionRequest $request,
                CodeBase $code_base,
                Context $context,
                string $selected_fragment
        Severity: Minor
        Found in src/Phan/LanguageServer/DefinitionResolver.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 locateGlobalFunctionDefinitionFromComment has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
        Open

            private static function locateGlobalFunctionDefinitionFromComment(
                GoToDefinitionRequest $request,
                CodeBase $code_base,
                Context $context,
                string $selected_fragment
        Severity: Minor
        Found in src/Phan/LanguageServer/DefinitionResolver.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 createGoToDefinitionClosure has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
        Open

            public static function createGoToDefinitionClosure(GoToDefinitionRequest $request, CodeBase $code_base): Closure
            {
                /**
                 * @param list<Node> $parent_node_list
                 */
        Severity: Minor
        Found in src/Phan/LanguageServer/DefinitionResolver.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

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

            private static function locateClassDefinitionForUnionType(
                GoToDefinitionRequest $request,
                CodeBase $code_base,
                UnionType $union_type
            ): bool {
        Severity: Minor
        Found in src/Phan/LanguageServer/DefinitionResolver.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

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

            public static function createGoToDefinitionClosure(GoToDefinitionRequest $request, CodeBase $code_base): Closure
            {
                /**
                 * @param list<Node> $parent_node_list
                 */

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

            public static function locateNamespaceUseDefinition(GoToDefinitionRequest $request, CodeBase $code_base, Node $node): void
            {
                // TODO: Support GroupUse (See ScopeVisitor->visitGroupUse)
                $targets = ScopeVisitor::aliasTargetMapFromUseNode($node);
                if (count($targets) !== 1) {

        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 class DefinitionResolver has a coupling between objects value of 20. Consider to reduce the number of dependencies under 13.
        Open

        class DefinitionResolver
        {
            /**
             * @return Closure(Context,Node,list<Node>):void
             * NOTE: The helper methods distinguish between "Go to definition"

        CouplingBetweenObjects

        Since: 1.1.0

        A class with too many dependencies has negative impacts on several quality aspects of a class. This includes quality criteria like stability, maintainability and understandability

        Example

        class Foo {
            /**
             * @var \foo\bar\X
             */
            private $x = null;
        
            /**
             * @var \foo\bar\Y
             */
            private $y = null;
        
            /**
             * @var \foo\bar\Z
             */
            private $z = null;
        
            public function setFoo(\Foo $foo) {}
            public function setBar(\Bar $bar) {}
            public function setBaz(\Baz $baz) {}
        
            /**
             * @return \SplObjectStorage
             * @throws \OutOfRangeException
             * @throws \InvalidArgumentException
             * @throws \ErrorException
             */
            public function process(\Iterator $it) {}
        
            // ...
        }

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

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

            private static function locateGlobalConstantDefinitionFromComment(
                GoToDefinitionRequest $request,
                CodeBase $code_base,
                Context $context,
                string $selected_fragment
        Severity: Major
        Found in src/Phan/LanguageServer/DefinitionResolver.php and 1 other location - About 4 hrs to fix
        src/Phan/LanguageServer/DefinitionResolver.php on lines 166..193

        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 182.

        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

            private static function locateGlobalFunctionDefinitionFromComment(
                GoToDefinitionRequest $request,
                CodeBase $code_base,
                Context $context,
                string $selected_fragment
        Severity: Major
        Found in src/Phan/LanguageServer/DefinitionResolver.php and 1 other location - About 4 hrs to fix
        src/Phan/LanguageServer/DefinitionResolver.php on lines 195..222

        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 182.

        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

        There are no issues that match your filters.

        Category
        Status