yiisoft/yii2

View on GitHub
framework/helpers/BaseConsole.php

Summary

Maintainability
C
7 hrs
Test Coverage

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

class BaseConsole
{
    // foreground color control codes
    const FG_BLACK = 30;
    const FG_RED = 31;
Severity: Minor
Found in framework/helpers/BaseConsole.php by phpmd

Since: PHPMD 0.2.5

The Weighted Method Count (WMC) of a class is a good indicator of how much time and effort is required to modify and maintain this class. The WMC metric is defined as the sum of complexities of all methods declared in a class. A large number of methods also means that this class has a greater potential impact on derived classes.

Example:

class Foo {
      public function bar() {
          if ($a == $b)  {
              if ($a1 == $b1) {
                  fiddle();
              } elseif ($a2 == $b2) {
                  fiddle();
              } else {
              }
          }
      }
      public function baz() {
          if ($a == $b) {
              if ($a1 == $b1) {
                  fiddle();
              } elseif ($a2 == $b2) {
                  fiddle();
              } else {
              }
          }
      }
      // Several other complex methods
  }

Source: http://phpmd.org/rules/codesize.txt

The class BaseConsole has 48 non-getter- and setter-methods. Consider refactoring BaseConsole to keep number of methods under 25.
Open

class BaseConsole
{
    // foreground color control codes
    const FG_BLACK = 30;
    const FG_RED = 31;
Severity: Minor
Found in framework/helpers/BaseConsole.php by phpmd

Since: PHPMD 0.1

A class with too many 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'. The default was changed from 10 to 25 in PHPMD 2.3.

Source: http://phpmd.org/rules/codesize.txt

The class BaseConsole has 47 public methods. Consider refactoring BaseConsole to keep number of public methods under 10.
Open

class BaseConsole
{
    // foreground color control codes
    const FG_BLACK = 30;
    const FG_RED = 31;
Severity: Minor
Found in framework/helpers/BaseConsole.php by phpmd

Since: PHPMD 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'.

Source: http://phpmd.org/rules/codesize.txt

Function getScreenSize has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
Open

    public static function getScreenSize($refresh = false)
    {
        static $size;
        if ($size !== null && !$refresh) {
            return $size;
Severity: Minor
Found in framework/helpers/BaseConsole.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

The class BaseConsole has 48 public methods and attributes. Consider reducing the number of public items to less than 45.
Open

class BaseConsole
{
    // foreground color control codes
    const FG_BLACK = 30;
    const FG_RED = 31;
Severity: Minor
Found in framework/helpers/BaseConsole.php by phpmd

Since: PHPMD 0.1

A large number of public methods and attributes declared in a class can indicate the class may need to be broken up as increased effort will be required to thoroughly test it.

Example:

public class Foo {
      public $value;
      public $something;
      public $var;
      // [... more more public attributes ...]

      public function doWork() {}
      public function doMoreWork() {}
      public function doWorkAgain() {}
      // [... more more public methods ...]
  }

Source: http://phpmd.org/rules/codesize.txt

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

    public static function prompt($text, $options = [])
    {
        $options = ArrayHelper::merge(
            [
                'required' => false,
Severity: Minor
Found in framework/helpers/BaseConsole.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 updateProgress has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
Open

    public static function updateProgress($done, $total, $prefix = null)
    {
        if ($prefix === null) {
            $prefix = self::$_progressPrefix;
        } else {
Severity: Minor
Found in framework/helpers/BaseConsole.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 confirm has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
Open

    public static function confirm($message, $default = false)
    {
        while (true) {
            static::stdout($message . ' (yes|no) [' . ($default ? 'yes' : 'no') . ']:');
            $input = trim(static::stdin());
Severity: Minor
Found in framework/helpers/BaseConsole.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

Avoid too many return statements within this method.
Open

                return $size = [$width, $height];
Severity: Major
Found in framework/helpers/BaseConsole.php - About 30 mins to fix

    Avoid too many return statements within this method.
    Open

            return $size = false;
    Severity: Major
    Found in framework/helpers/BaseConsole.php - About 30 mins to fix

      Avoid too many return statements within this method.
      Open

                      return $size = [$width, $height];
      Severity: Major
      Found in framework/helpers/BaseConsole.php - About 30 mins to fix

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

            public static function wrapText($text, $indent = 0, $refresh = false)
            {
                $size = static::getScreenSize($refresh);
                if ($size === false || $size[0] <= $indent) {
                    return $text;
        Severity: Minor
        Found in framework/helpers/BaseConsole.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

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

            public static function select($prompt, $options = [])
            {
                top:
                static::stdout("$prompt [" . implode(',', array_keys($options)) . ',?]: ');
                $input = static::stdin();
        Severity: Minor
        Found in framework/helpers/BaseConsole.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 BaseConsole has 1102 lines of code. Current threshold is 1000. Avoid really long classes.
        Open

        class BaseConsole
        {
            // foreground color control codes
            const FG_BLACK = 30;
            const FG_RED = 31;
        Severity: Minor
        Found in framework/helpers/BaseConsole.php by phpmd

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

            public static function ansiToHtml($string, $styleMap = [])
            {
                $styleMap = [
                    // http://www.w3.org/TR/CSS2/syndata.html#value-def-color
                    self::FG_BLACK => ['color' => 'black'],
        Severity: Minor
        Found in framework/helpers/BaseConsole.php by phpmd

        The method ansiToHtml() has an NPath complexity of 6120. The configured NPath complexity threshold is 200.
        Open

            public static function ansiToHtml($string, $styleMap = [])
            {
                $styleMap = [
                    // http://www.w3.org/TR/CSS2/syndata.html#value-def-color
                    self::FG_BLACK => ['color' => 'black'],
        Severity: Minor
        Found in framework/helpers/BaseConsole.php by phpmd

        Since: PHPMD 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: http://phpmd.org/rules/codesize.txt

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

            public static function ansiToHtml($string, $styleMap = [])
            {
                $styleMap = [
                    // http://www.w3.org/TR/CSS2/syndata.html#value-def-color
                    self::FG_BLACK => ['color' => 'black'],
        Severity: Minor
        Found in framework/helpers/BaseConsole.php by phpmd

        Since: PHPMD 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: http://phpmd.org/rules/codesize.txt

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

            public static function getScreenSize($refresh = false)
            {
                static $size;
                if ($size !== null && !$refresh) {
                    return $size;
        Severity: Minor
        Found in framework/helpers/BaseConsole.php by phpmd

        Since: PHPMD 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: http://phpmd.org/rules/codesize.txt

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

            public static function prompt($text, $options = [])
            {
                $options = ArrayHelper::merge(
                    [
                        'required' => false,
        Severity: Minor
        Found in framework/helpers/BaseConsole.php by phpmd

        Since: PHPMD 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: http://phpmd.org/rules/codesize.txt

        The method wrapText has a boolean flag argument $refresh, which is a certain sign of a Single Responsibility Principle violation.
        Open

            public static function wrapText($text, $indent = 0, $refresh = false)
        Severity: Minor
        Found in framework/helpers/BaseConsole.php by phpmd

        Since: PHPMD 1.4.0

        A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

        Example:

        class Foo {
              public function bar($flag = true) {
              }
          }

        Source: http://phpmd.org/rules/cleancode.txt

        The method endProgress has a boolean flag argument $keepPrefix, which is a certain sign of a Single Responsibility Principle violation.
        Open

            public static function endProgress($remove = false, $keepPrefix = true)
        Severity: Minor
        Found in framework/helpers/BaseConsole.php by phpmd

        Since: PHPMD 1.4.0

        A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

        Example:

        class Foo {
              public function bar($flag = true) {
              }
          }

        Source: http://phpmd.org/rules/cleancode.txt

        The method renderColoredString has a boolean flag argument $colored, which is a certain sign of a Single Responsibility Principle violation.
        Open

            public static function renderColoredString($string, $colored = true)
        Severity: Minor
        Found in framework/helpers/BaseConsole.php by phpmd

        Since: PHPMD 1.4.0

        A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

        Example:

        class Foo {
              public function bar($flag = true) {
              }
          }

        Source: http://phpmd.org/rules/cleancode.txt

        The method confirm has a boolean flag argument $default, which is a certain sign of a Single Responsibility Principle violation.
        Open

            public static function confirm($message, $default = false)
        Severity: Minor
        Found in framework/helpers/BaseConsole.php by phpmd

        Since: PHPMD 1.4.0

        A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

        Example:

        class Foo {
              public function bar($flag = true) {
              }
          }

        Source: http://phpmd.org/rules/cleancode.txt

        The method getScreenSize has a boolean flag argument $refresh, which is a certain sign of a Single Responsibility Principle violation.
        Open

            public static function getScreenSize($refresh = false)
        Severity: Minor
        Found in framework/helpers/BaseConsole.php by phpmd

        Since: PHPMD 1.4.0

        A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

        Example:

        class Foo {
              public function bar($flag = true) {
              }
          }

        Source: http://phpmd.org/rules/cleancode.txt

        The method endProgress has a boolean flag argument $remove, which is a certain sign of a Single Responsibility Principle violation.
        Open

            public static function endProgress($remove = false, $keepPrefix = true)
        Severity: Minor
        Found in framework/helpers/BaseConsole.php by phpmd

        Since: PHPMD 1.4.0

        A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

        Example:

        class Foo {
              public function bar($flag = true) {
              }
          }

        Source: http://phpmd.org/rules/cleancode.txt

        The method stdin has a boolean flag argument $raw, which is a certain sign of a Single Responsibility Principle violation.
        Open

            public static function stdin($raw = false)
        Severity: Minor
        Found in framework/helpers/BaseConsole.php by phpmd

        Since: PHPMD 1.4.0

        A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

        Example:

        class Foo {
              public function bar($flag = true) {
              }
          }

        Source: http://phpmd.org/rules/cleancode.txt

        The method prompt() utilizes a goto statement.
        Open

                    goto top;
        Severity: Minor
        Found in framework/helpers/BaseConsole.php by phpmd

        Since: PHPMD 1.1.0

        Goto makes code harder to read and it is nearly impossible to understand the control flow of an application that uses this language construct. Therefore it should be avoided. Consider to replace Goto with regular control structures and separate methods/function, which are easier to read.

        Example:

        class Foo {
              public function bar($param)  {
                  A:
                  if ($param === 42) {
                      goto X;
                  }
                  Y:
                  if (time() % 42 === 23) {
                      goto Z;
                  }
                  X:
                  if (time() % 23 === 42) {
                      goto Y;
                  }
                  Z:
                  return 42;
              }
          }

        Source: http://phpmd.org/rules/design.txt

        The method select() utilizes a goto statement.
        Open

                    goto top;
        Severity: Minor
        Found in framework/helpers/BaseConsole.php by phpmd

        Since: PHPMD 1.1.0

        Goto makes code harder to read and it is nearly impossible to understand the control flow of an application that uses this language construct. Therefore it should be avoided. Consider to replace Goto with regular control structures and separate methods/function, which are easier to read.

        Example:

        class Foo {
              public function bar($param)  {
                  A:
                  if ($param === 42) {
                      goto X;
                  }
                  Y:
                  if (time() % 42 === 23) {
                      goto Z;
                  }
                  X:
                  if (time() % 23 === 42) {
                      goto Y;
                  }
                  Z:
                  return 42;
              }
          }

        Source: http://phpmd.org/rules/design.txt

        The method prompt() utilizes a goto statement.
        Open

                        goto top;
        Severity: Minor
        Found in framework/helpers/BaseConsole.php by phpmd

        Since: PHPMD 1.1.0

        Goto makes code harder to read and it is nearly impossible to understand the control flow of an application that uses this language construct. Therefore it should be avoided. Consider to replace Goto with regular control structures and separate methods/function, which are easier to read.

        Example:

        class Foo {
              public function bar($param)  {
                  A:
                  if ($param === 42) {
                      goto X;
                  }
                  Y:
                  if (time() % 42 === 23) {
                      goto Z;
                  }
                  X:
                  if (time() % 23 === 42) {
                      goto Y;
                  }
                  Z:
                  return 42;
              }
          }

        Source: http://phpmd.org/rules/design.txt

        The method prompt() utilizes a goto statement.
        Open

                    goto top;
        Severity: Minor
        Found in framework/helpers/BaseConsole.php by phpmd

        Since: PHPMD 1.1.0

        Goto makes code harder to read and it is nearly impossible to understand the control flow of an application that uses this language construct. Therefore it should be avoided. Consider to replace Goto with regular control structures and separate methods/function, which are easier to read.

        Example:

        class Foo {
              public function bar($param)  {
                  A:
                  if ($param === 42) {
                      goto X;
                  }
                  Y:
                  if (time() % 42 === 23) {
                      goto Z;
                  }
                  X:
                  if (time() % 23 === 42) {
                      goto Y;
                  }
                  Z:
                  return 42;
              }
          }

        Source: http://phpmd.org/rules/design.txt

        The method select() utilizes a goto statement.
        Open

                    goto top;
        Severity: Minor
        Found in framework/helpers/BaseConsole.php by phpmd

        Since: PHPMD 1.1.0

        Goto makes code harder to read and it is nearly impossible to understand the control flow of an application that uses this language construct. Therefore it should be avoided. Consider to replace Goto with regular control structures and separate methods/function, which are easier to read.

        Example:

        class Foo {
              public function bar($param)  {
                  A:
                  if ($param === 42) {
                      goto X;
                  }
                  Y:
                  if (time() % 42 === 23) {
                      goto Z;
                  }
                  X:
                  if (time() % 23 === 42) {
                      goto Y;
                  }
                  Z:
                  return 42;
              }
          }

        Source: http://phpmd.org/rules/design.txt

        TODO found
        Open

                // TODO rework/refactor according to https://github.com/yiisoft/yii2/issues/746
        Severity: Minor
        Found in framework/helpers/BaseConsole.php by fixme

        TODO found
        Open

                // TODO rework/refactor according to https://github.com/yiisoft/yii2/issues/746
        Severity: Minor
        Found in framework/helpers/BaseConsole.php by fixme

        There are no issues that match your filters.

        Category
        Status