Sign upLogin

rhosocial/yii2-base-models

View on GitHub
Star
traits/IPTrait.php

Summary

Maintainability
A
2 hrs
Test Coverage

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

    public function getIPAddress(): ?string
    {
        if ($this->enableIP <= 0 || $this->enableIP > 3) {
            return null;
        }
Severity: Minor
Found in traits/IPTrait.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 setIPAddress has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Open

    public function setIPAddress(?string $ipAddress): int|string|null
    {
        if (!$ipAddress || !$this->enableIP) {
            return null;
        }
Severity: Minor
Found in traits/IPTrait.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 null;
Severity: Major
Found in traits/IPTrait.php - About 30 mins to fix

    Avoid too many return statements within this method.
    Open

                        return $this->getIPv6Address();
    Severity: Major
    Found in traits/IPTrait.php - About 30 mins to fix

      The method setIPAddress uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
      Open

              } else {
            return 0;
        }
      Severity: Minor
      Found in traits/IPTrait.php by phpmd

      ElseExpression

      Since: 1.4.0

      An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

      Example

      class Foo
{
    public function bar($flag)
    {
        if ($flag) {
            // one branch
        } else {
            // another branch
        }
    }
}

      Source https://phpmd.org/rules/cleancode.html#elseexpression

      The method getWebRequest uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
      Open

              } else {
            $request = Yii::$app->request;
        }
      Severity: Minor
      Found in traits/IPTrait.php by phpmd

      ElseExpression

      Since: 1.4.0

      An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

      Example

      class Foo
{
    public function bar($flag)
    {
        if ($flag) {
            // one branch
        } else {
            // another branch
        }
    }
}

      Source https://phpmd.org/rules/cleancode.html#elseexpression

      Avoid using static access to class '\rhosocial\base\helpers\IP' in method 'setIPAddress'.
      Open

              $ipType = IP::judgeIPtype($ipAddress);
      Severity: Minor
      Found in traits/IPTrait.php by phpmd

      StaticAccess

      Since: 1.4.0

      Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

      Example

      class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

      Source https://phpmd.org/rules/cleancode.html#staticaccess

      Avoid using static access to class '\Yii' in method 'getIPAddress'.
      Open

                  Yii::error($ex->getMessage(), __METHOD__);
      Severity: Minor
      Found in traits/IPTrait.php by phpmd

      StaticAccess

      Since: 1.4.0

      Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

      Example

      class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

      Source https://phpmd.org/rules/cleancode.html#staticaccess

      There must be a comment when fall-through is intentional in a non-empty case body
      Open

                  case self::IP_V4_ENABLED:
      Severity: Minor
      Found in traits/IPTrait.php by phpcodesniffer

      There must be a comment when fall-through is intentional in a non-empty case body
      Open

                  case self::IP_ALL_ENABLED:
      Severity: Minor
      Found in traits/IPTrait.php by phpcodesniffer

      There are no issues that match your filters.

      Category
      Status