yiisoft/yii2

View on GitHub
framework/web/User.php

Summary

Maintainability
C
7 hrs
Test Coverage

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

class User extends Component
{
    const EVENT_BEFORE_LOGIN = 'beforeLogin';
    const EVENT_AFTER_LOGIN = 'afterLogin';
    const EVENT_BEFORE_LOGOUT = 'beforeLogout';
Severity: Minor
Found in framework/web/User.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

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

    protected function renewAuthStatus()
    {
        $session = Yii::$app->getSession();
        $id = $session->getHasSessionId() || $session->getIsActive() ? $session->get($this->idParam) : null;

Severity: Minor
Found in framework/web/User.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

Function switchIdentity has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
Open

    public function switchIdentity($identity, $duration = 0)
    {
        $this->setIdentity($identity);

        if (!$this->enableSession) {
Severity: Minor
Found in framework/web/User.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

The class User has 16 fields. Consider redesigning User to keep the number of fields under 15.
Open

class User extends Component
{
    const EVENT_BEFORE_LOGIN = 'beforeLogin';
    const EVENT_AFTER_LOGIN = 'afterLogin';
    const EVENT_BEFORE_LOGOUT = 'beforeLogout';
Severity: Minor
Found in framework/web/User.php by phpmd

Since: PHPMD 0.1

Classes that have too many fields could be redesigned to have fewer fields, possibly through some nested object grouping of some of the information. For example, a class with city/state/zip fields could instead have one Address field.

Example:

class Person {
     protected $one;
     private $two;
     private $three;
     [... many more fields ...]
  }

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

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

    public function getIdentity($autoRenew = true)
    {
        if ($this->_identity === false) {
            if ($this->enableSession && $autoRenew) {
                try {
Severity: Minor
Found in framework/web/User.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 getIdentityAndDurationFromCookie has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
Open

    protected function getIdentityAndDurationFromCookie()
    {
        $value = Yii::$app->getRequest()->getCookies()->getValue($this->identityCookie['name']);
        if ($value === null) {
            return null;
Severity: Minor
Found in framework/web/User.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 loginRequired has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
Open

    public function loginRequired($checkAjax = true, $checkAcceptHeader = true)
    {
        $request = Yii::$app->getRequest();
        $canRedirect = !$checkAcceptHeader || $this->checkRedirectAcceptable();
        if ($this->enableSession
Severity: Minor
Found in framework/web/User.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 checkRedirectAcceptable has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
Open

    protected function checkRedirectAcceptable()
    {
        $acceptableTypes = Yii::$app->getRequest()->getAcceptableContentTypes();
        if (empty($acceptableTypes) || count($acceptableTypes) === 1 && array_keys($acceptableTypes)[0] === '*/*') {
            return true;
Severity: Minor
Found in framework/web/User.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 switchIdentity() has an NPath complexity of 208. The configured NPath complexity threshold is 200.
Open

    public function switchIdentity($identity, $duration = 0)
    {
        $this->setIdentity($identity);

        if (!$this->enableSession) {
Severity: Minor
Found in framework/web/User.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 renewAuthStatus() has an NPath complexity of 432. The configured NPath complexity threshold is 200.
Open

    protected function renewAuthStatus()
    {
        $session = Yii::$app->getSession();
        $id = $session->getHasSessionId() || $session->getIsActive() ? $session->get($this->idParam) : null;

Severity: Minor
Found in framework/web/User.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 loginRequired() has a Cyclomatic Complexity of 10. The configured cyclomatic complexity threshold is 10.
Open

    public function loginRequired($checkAjax = true, $checkAcceptHeader = true)
    {
        $request = Yii::$app->getRequest();
        $canRedirect = !$checkAcceptHeader || $this->checkRedirectAcceptable();
        if ($this->enableSession
Severity: Minor
Found in framework/web/User.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 switchIdentity() has a Cyclomatic Complexity of 11. The configured cyclomatic complexity threshold is 10.
Open

    public function switchIdentity($identity, $duration = 0)
    {
        $this->setIdentity($identity);

        if (!$this->enableSession) {
Severity: Minor
Found in framework/web/User.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 renewAuthStatus() has a Cyclomatic Complexity of 17. The configured cyclomatic complexity threshold is 10.
Open

    protected function renewAuthStatus()
    {
        $session = Yii::$app->getSession();
        $id = $session->getHasSessionId() || $session->getIsActive() ? $session->get($this->idParam) : null;

Severity: Minor
Found in framework/web/User.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 class User has a coupling between objects value of 13. Consider to reduce the number of dependencies under 13.
Open

class User extends Component
{
    const EVENT_BEFORE_LOGIN = 'beforeLogin';
    const EVENT_AFTER_LOGIN = 'afterLogin';
    const EVENT_BEFORE_LOGOUT = 'beforeLogout';
Severity: Minor
Found in framework/web/User.php by phpmd

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

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

    public function loginRequired($checkAjax = true, $checkAcceptHeader = true)
Severity: Minor
Found in framework/web/User.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 logout has a boolean flag argument $destroySession, which is a certain sign of a Single Responsibility Principle violation.
Open

    public function logout($destroySession = true)
Severity: Minor
Found in framework/web/User.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 can has a boolean flag argument $allowCaching, which is a certain sign of a Single Responsibility Principle violation.
Open

    public function can($permissionName, $params = [], $allowCaching = true)
Severity: Minor
Found in framework/web/User.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 loginRequired has a boolean flag argument $checkAjax, which is a certain sign of a Single Responsibility Principle violation.
Open

    public function loginRequired($checkAjax = true, $checkAcceptHeader = true)
Severity: Minor
Found in framework/web/User.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 getIdentity has a boolean flag argument $autoRenew, which is a certain sign of a Single Responsibility Principle violation.
Open

    public function getIdentity($autoRenew = true)
Severity: Minor
Found in framework/web/User.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

Avoid unused local variables such as '$params'.
Open

        foreach ($acceptableTypes as $type => $params) {
Severity: Minor
Found in framework/web/User.php by phpmd

Since: PHPMD 0.2

Detects when a local variable is declared and/or assigned, but not used.

Example:

class Foo {
      public function doSomething()
      {
          $i = 5; // Unused
      }
  }

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

There are no issues that match your filters.

Category
Status