src/Phan/Language/Element/Method.php

Summary

Maintainability
F
5 days
Test Coverage

File Method.php has 648 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

declare(strict_types=1);

namespace Phan\Language\Element;
Severity: Major
Found in src/Phan/Language/Element/Method.php - About 1 day to fix

    Method has 42 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class Method extends ClassElement implements FunctionInterface
    {
        use Analyzable;
        use Memoize;
        use FunctionTrait;
    Severity: Minor
    Found in src/Phan/Language/Element/Method.php - About 5 hrs to fix

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

          public function resolveTemplateType(
              CodeBase $code_base,
              UnionType $object_union_type
          ): Method {
              $defining_fqsen = $this->getDefiningClassFQSEN();
      Severity: Minor
      Found in src/Phan/Language/Element/Method.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

      Method fromNode has 84 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public static function fromNode(
              Context $context,
              CodeBase $code_base,
              Node $node,
              FullyQualifiedMethodName $fqsen,
      Severity: Major
      Found in src/Phan/Language/Element/Method.php - About 3 hrs to fix

        The class Method has 15 public methods. Consider refactoring Method to keep number of public methods under 10.
        Open

        class Method extends ClassElement implements FunctionInterface
        {
            use Analyzable;
            use Memoize;
            use FunctionTrait;
        Severity: Minor
        Found in src/Phan/Language/Element/Method.php by phpmd

        TooManyPublicMethods

        Since: 0.1

        A class with too many public methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.

        By default it ignores methods starting with 'get' or 'set'.

        Example

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

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

        class Method extends ClassElement implements FunctionInterface
        {
            use Analyzable;
            use Memoize;
            use FunctionTrait;
        Severity: Minor
        Found in src/Phan/Language/Element/Method.php by phpmd

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

            public static function fromNode(
                Context $context,
                CodeBase $code_base,
                Node $node,
                FullyQualifiedMethodName $fqsen,
        Severity: Minor
        Found in src/Phan/Language/Element/Method.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 createUseAlias has 41 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            public function createUseAlias(
                Clazz $clazz,
                string $alias_method_name,
                int $new_visibility_flags
            ): Method {
        Severity: Minor
        Found in src/Phan/Language/Element/Method.php - About 1 hr to fix

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

              public function resolveTemplateType(
                  CodeBase $code_base,
                  UnionType $object_union_type
              ): Method {
                  $defining_fqsen = $this->getDefiningClassFQSEN();
          Severity: Minor
          Found in src/Phan/Language/Element/Method.php - About 1 hr to fix

            Function computeNewTypeForComment has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
            Open

                private static function computeNewTypeForComment(CodeBase $code_base, Context $context, UnionType $signature_union_type, UnionType $comment_return_union_type): UnionType
                {
                    $new_type = $comment_return_union_type;
                    foreach ($comment_return_union_type->getTypeSet() as $type) {
                        if (!$type->asPHPDocUnionType()->canAnyTypeStrictCastToUnionType($code_base, $signature_union_type)) {
            Severity: Minor
            Found in src/Phan/Language/Element/Method.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 getOverriddenMethods has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
            Open

                public function getOverriddenMethods(
                    CodeBase $code_base
                ): array {
                    // Get the class that defines this method
                    $class = $this->getClass($code_base);
            Severity: Minor
            Found in src/Phan/Language/Element/Method.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 getMarkupDescription has 29 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                public function getMarkupDescription(): string
                {
                    $string = '';
                    // It's an error to have visibility or abstract in an interface's stub (e.g. JsonSerializable)
                    if ($this->isPrivate()) {
            Severity: Minor
            Found in src/Phan/Language/Element/Method.php - About 1 hr to fix

              Method toStub has 28 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                  public function toStub(bool $class_is_interface = false): string
                  {
                      $string = '    ';
                      if ($this->isFinal()) {
                          $string .= 'final ';
              Severity: Minor
              Found in src/Phan/Language/Element/Method.php - About 1 hr to fix

                Function getMarkupDescription has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
                Open

                    public function getMarkupDescription(): string
                    {
                        $string = '';
                        // It's an error to have visibility or abstract in an interface's stub (e.g. JsonSerializable)
                        if ($this->isPrivate()) {
                Severity: Minor
                Found in src/Phan/Language/Element/Method.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 defaultConstructorForClass has 26 lines of code (exceeds 25 allowed). Consider refactoring.
                Open

                    public static function defaultConstructorForClass(
                        Clazz $clazz,
                        CodeBase $code_base
                    ): Method {
                        if ($clazz->getFQSEN()->getNamespace() === '\\' && $clazz->hasMethodWithName($code_base, $clazz->getName(), true)) {
                Severity: Minor
                Found in src/Phan/Language/Element/Method.php - About 1 hr to fix

                  Method getOverriddenMethods has 26 lines of code (exceeds 25 allowed). Consider refactoring.
                  Open

                      public function getOverriddenMethods(
                          CodeBase $code_base
                      ): array {
                          // Get the class that defines this method
                          $class = $this->getClass($code_base);
                  Severity: Minor
                  Found in src/Phan/Language/Element/Method.php - About 1 hr to fix

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

                        public function toStub(bool $class_is_interface = false): string
                        {
                            $string = '    ';
                            if ($this->isFinal()) {
                                $string .= 'final ';
                    Severity: Minor
                    Found in src/Phan/Language/Element/Method.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

                    Method __construct has 6 arguments (exceeds 4 allowed). Consider refactoring.
                    Open

                            Context $context,
                            string $name,
                            UnionType $type,
                            int $flags,
                            FullyQualifiedMethodName $fqsen,
                    Severity: Minor
                    Found in src/Phan/Language/Element/Method.php - About 45 mins to fix

                      Method fromNode has 5 arguments (exceeds 4 allowed). Consider refactoring.
                      Open

                              Context $context,
                              CodeBase $code_base,
                              Node $node,
                              FullyQualifiedMethodName $fqsen,
                              ?Clazz $class = null
                      Severity: Minor
                      Found in src/Phan/Language/Element/Method.php - About 35 mins to fix

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

                            public function addReference(FileRef $file_ref): void
                            {
                                if (Config::get_track_references()) {
                                    // Currently, we don't need to track references to PHP-internal methods/functions/constants
                                    // such as PHP_VERSION, strlen(), Closure::bind(), etc.
                        Severity: Minor
                        Found in src/Phan/Language/Element/Method.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 class Method has 1018 lines of code. Current threshold is 1000. Avoid really long classes.
                        Open

                        class Method extends ClassElement implements FunctionInterface
                        {
                            use Analyzable;
                            use Memoize;
                            use FunctionTrait;
                        Severity: Minor
                        Found in src/Phan/Language/Element/Method.php by phpmd

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

                            public static function fromNode(
                                Context $context,
                                CodeBase $code_base,
                                Node $node,
                                FullyQualifiedMethodName $fqsen,
                        Severity: Minor
                        Found in src/Phan/Language/Element/Method.php by phpmd

                        The method resolveTemplateType() has an NPath complexity of 338. The configured NPath complexity threshold is 200.
                        Open

                            public function resolveTemplateType(
                                CodeBase $code_base,
                                UnionType $object_union_type
                            ): Method {
                                $defining_fqsen = $this->getDefiningClassFQSEN();
                        Severity: Minor
                        Found in src/Phan/Language/Element/Method.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 fromNode() has an NPath complexity of 1728. The configured NPath complexity threshold is 200.
                        Open

                            public static function fromNode(
                                Context $context,
                                CodeBase $code_base,
                                Node $node,
                                FullyQualifiedMethodName $fqsen,
                        Severity: Minor
                        Found in src/Phan/Language/Element/Method.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 resolveTemplateType() has a Cyclomatic Complexity of 12. The configured cyclomatic complexity threshold is 10.
                        Open

                            public function resolveTemplateType(
                                CodeBase $code_base,
                                UnionType $object_union_type
                            ): Method {
                                $defining_fqsen = $this->getDefiningClassFQSEN();
                        Severity: Minor
                        Found in src/Phan/Language/Element/Method.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 computeNewTypeForComment() has a Cyclomatic Complexity of 10. The configured cyclomatic complexity threshold is 10.
                        Open

                            private static function computeNewTypeForComment(CodeBase $code_base, Context $context, UnionType $signature_union_type, UnionType $comment_return_union_type): UnionType
                            {
                                $new_type = $comment_return_union_type;
                                foreach ($comment_return_union_type->getTypeSet() as $type) {
                                    if (!$type->asPHPDocUnionType()->canAnyTypeStrictCastToUnionType($code_base, $signature_union_type)) {
                        Severity: Minor
                        Found in src/Phan/Language/Element/Method.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 fromNode() has a Cyclomatic Complexity of 14. The configured cyclomatic complexity threshold is 10.
                        Open

                            public static function fromNode(
                                Context $context,
                                CodeBase $code_base,
                                Node $node,
                                FullyQualifiedMethodName $fqsen,
                        Severity: Minor
                        Found in src/Phan/Language/Element/Method.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 class Method has a coupling between objects value of 17. Consider to reduce the number of dependencies under 13.
                        Open

                        class Method extends ClassElement implements FunctionInterface
                        {
                            use Analyzable;
                            use Memoize;
                            use FunctionTrait;
                        Severity: Minor
                        Found in src/Phan/Language/Element/Method.php by phpmd

                        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

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

                                foreach ($object_union_type->asExpandedTypes($code_base)->getTypeSet() as $type) {
                                    if (!$type->hasTemplateParameterTypes()) {
                                        continue;
                                    }
                                    if (!$type->isObjectWithKnownFQSEN()) {
                        Severity: Minor
                        Found in src/Phan/Language/Element/Method.php and 1 other location - About 30 mins to fix
                        src/Phan/Language/Element/Method.php on lines 967..983

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

                        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

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

                                foreach ($object_union_type->getTypeSet() as $type) {
                                    if (!$type->hasTemplateParameterTypes()) {
                                        continue;
                                    }
                                    if (!$type->isObjectWithKnownFQSEN()) {
                        Severity: Minor
                        Found in src/Phan/Language/Element/Method.php and 1 other location - About 30 mins to fix
                        src/Phan/Language/Element/Method.php on lines 985..1001

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

                        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