src/Phan/Language/Type/GenericIterableType.php

Summary

Maintainability
F
6 days
Test Coverage

File GenericIterableType.php has 322 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

declare(strict_types=1);

namespace Phan\Language\Type;
Severity: Minor
Found in src/Phan/Language/Type/GenericIterableType.php - About 3 hrs to fix

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

    final class GenericIterableType extends IterableType
    {
        /** @phan-override */
        public const NAME = 'iterable';
    
    

    The class GenericIterableType has 11 public methods. Consider refactoring GenericIterableType to keep number of public methods under 10.
    Open

    final class GenericIterableType extends IterableType
    {
        /** @phan-override */
        public const NAME = 'iterable';
    
    

    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

    GenericIterableType has 23 functions (exceeds 20 allowed). Consider refactoring.
    Open

    final class GenericIterableType extends IterableType
    {
        /** @phan-override */
        public const NAME = 'iterable';
    
    
    Severity: Minor
    Found in src/Phan/Language/Type/GenericIterableType.php - About 2 hrs to fix

      Method asExpandedTypes has 58 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public function asExpandedTypes(
              CodeBase $code_base,
              int $recursion_depth = 0
          ): UnionType {
              // We're going to assume that if the type hierarchy
      Severity: Major
      Found in src/Phan/Language/Type/GenericIterableType.php - About 2 hrs to fix

        Method asExpandedTypesPreservingTemplate has 58 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            public function asExpandedTypesPreservingTemplate(
                CodeBase $code_base,
                int $recursion_depth = 0
            ): UnionType {
                // We're going to assume that if the type hierarchy
        Severity: Major
        Found in src/Phan/Language/Type/GenericIterableType.php - About 2 hrs to fix

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

              public function asExpandedTypesPreservingTemplate(
                  CodeBase $code_base,
                  int $recursion_depth = 0
              ): UnionType {
                  // We're going to assume that if the type hierarchy

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

              public function asExpandedTypes(
                  CodeBase $code_base,
                  int $recursion_depth = 0
              ): UnionType {
                  // We're going to assume that if the type hierarchy

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

          final class GenericIterableType extends IterableType
          {
              /** @phan-override */
              public const NAME = 'iterable';
          
          

          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

              public function asExpandedTypesPreservingTemplate(
                  CodeBase $code_base,
                  int $recursion_depth = 0
              ): UnionType {
                  // We're going to assume that if the type hierarchy
          Severity: Major
          Found in src/Phan/Language/Type/GenericIterableType.php and 1 other location - About 2 days to fix
          src/Phan/Language/Type/GenericIterableType.php on lines 295..372

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

          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

              public function asExpandedTypes(
                  CodeBase $code_base,
                  int $recursion_depth = 0
              ): UnionType {
                  // We're going to assume that if the type hierarchy
          Severity: Major
          Found in src/Phan/Language/Type/GenericIterableType.php and 1 other location - About 2 days to fix
          src/Phan/Language/Type/GenericIterableType.php on lines 388..465

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

          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