.phan/plugins/PregRegexCheckerPlugin.php

Summary

Maintainability
D
2 days
Test Coverage

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

class PregRegexCheckerPlugin extends PluginV3 implements AnalyzeFunctionCallCapability
{
    // Skip over analyzing regex keys that couldn't be resolved.
    // Don't try to convert values to PHP data (should be closures)
    private const RESOLVE_REGEX_KEY_FLAGS = (ContextNode::RESOLVE_DEFAULT | ContextNode::RESOLVE_KEYS_SKIP_UNKNOWN_KEYS) &

Method getAnalyzeFunctionCallClosures has 83 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function getAnalyzeFunctionCallClosures(CodeBase $code_base): array
    {
        /**
         * @param list<Node|string|int|float> $args the nodes for the arguments to the invocation
         */
Severity: Major
Found in .phan/plugins/PregRegexCheckerPlugin.php - About 3 hrs to fix

    File PregRegexCheckerPlugin.php has 279 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    <?php
    
    declare(strict_types=1);
    
    use ast\Node;
    Severity: Minor
    Found in .phan/plugins/PregRegexCheckerPlugin.php - About 2 hrs to fix

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

          public function getAnalyzeFunctionCallClosures(CodeBase $code_base): array
          {
              /**
               * @param list<Node|string|int|float> $args the nodes for the arguments to the invocation
               */
      Severity: Minor
      Found in .phan/plugins/PregRegexCheckerPlugin.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 analyzePattern has 37 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          private static function analyzePattern(CodeBase $code_base, Context $context, Func $function, string $pattern): void
          {
              /**
               * @suppress PhanParamSuspiciousOrder 100% deliberate use of varying regex and constant $subject for preg_match
               * @return ?array<string,mixed>
      Severity: Minor
      Found in .phan/plugins/PregRegexCheckerPlugin.php - About 1 hr to fix

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

            private static function extractStringsFromStringOrArray(
                CodeBase $code_base,
                Context $context,
                $pattern
            ): array {
        Severity: Minor
        Found in .phan/plugins/PregRegexCheckerPlugin.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 tokenizeRegexParts has 31 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            private static function tokenizeRegexParts(string $inner): Generator
            {
                $inner_len = strlen($inner);
                for ($j = 0; $j < $inner_len;) {
                    switch ($c = $inner[$j]) {
        Severity: Minor
        Found in .phan/plugins/PregRegexCheckerPlugin.php - About 1 hr to fix

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

              private static function tokenizeRegexParts(string $inner): Generator
              {
                  $inner_len = strlen($inner);
                  for ($j = 0; $j < $inner_len;) {
                      switch ($c = $inner[$j]) {
          Severity: Minor
          Found in .phan/plugins/PregRegexCheckerPlugin.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 checkForSuspiciousRegexPatterns has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
          Open

              private static function checkForSuspiciousRegexPatterns(string $pattern): Generator
              {
                  $pattern = \trim($pattern);
          
                  $start_chr = $pattern[0] ?? '/';
          Severity: Minor
          Found in .phan/plugins/PregRegexCheckerPlugin.php - About 45 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 analyzeReplacementTemplate has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
          Open

              private static function analyzeReplacementTemplate(CodeBase $code_base, Context $context, array $patterns, $replacement_node): void
              {
                  $replacement_templates = self::extractStringsFromStringOrArray($code_base, $context, $replacement_node);
                  $pattern_keys = null;
          
          
          Severity: Minor
          Found in .phan/plugins/PregRegexCheckerPlugin.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;
          Severity: Major
          Found in .phan/plugins/PregRegexCheckerPlugin.php - About 30 mins to fix

            Avoid too many return statements within this method.
            Open

                    return [
                        // call
                        'preg_filter'                 => $preg_pattern_or_array_callback,
                        'preg_grep'                   => $preg_pattern_callback,
                        'preg_match'                  => $preg_pattern_callback,
            Severity: Major
            Found in .phan/plugins/PregRegexCheckerPlugin.php - About 30 mins to fix

              Avoid too many return statements within this method.
              Open

                              return;
              Severity: Major
              Found in .phan/plugins/PregRegexCheckerPlugin.php - About 30 mins to fix

                Avoid too many return statements within this method.
                Open

                                return;
                Severity: Major
                Found in .phan/plugins/PregRegexCheckerPlugin.php - About 30 mins to fix

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

                      private static function extractTemplateKeys(string $template): array
                      {
                          $result = [];
                          // > replacement may contain references of the form \\n or $n,
                          // ...
                  Severity: Minor
                  Found in .phan/plugins/PregRegexCheckerPlugin.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 getAnalyzeFunctionCallClosures() has 105 lines of code. Current threshold is set to 100. Avoid really long methods.
                  Open

                      public function getAnalyzeFunctionCallClosures(CodeBase $code_base): array
                      {
                          /**
                           * @param list<Node|string|int|float> $args the nodes for the arguments to the invocation
                           */

                  The method getAnalyzeFunctionCallClosures() has an NPath complexity of 6144. The configured NPath complexity threshold is 200.
                  Open

                      public function getAnalyzeFunctionCallClosures(CodeBase $code_base): array
                      {
                          /**
                           * @param list<Node|string|int|float> $args the nodes for the arguments to the invocation
                           */

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

                      public function getAnalyzeFunctionCallClosures(CodeBase $code_base): array
                      {
                          /**
                           * @param list<Node|string|int|float> $args the nodes for the arguments to the invocation
                           */

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

                  class PregRegexCheckerPlugin extends PluginV3 implements AnalyzeFunctionCallCapability
                  {
                      // Skip over analyzing regex keys that couldn't be resolved.
                      // Don't try to convert values to PHP data (should be closures)
                      private const RESOLVE_REGEX_KEY_FLAGS = (ContextNode::RESOLVE_DEFAULT | ContextNode::RESOLVE_KEYS_SKIP_UNKNOWN_KEYS) &

                  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

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

                              switch ($c = $inner[$j]) {

                  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

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

                          $i = \strpos('({[', $start_chr);

                  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