rhosocial/yii2-base-models

View on GitHub
traits/RegistrationTrait.php

Summary

Maintainability
B
6 hrs
Test Coverage

Function register has a Cognitive Complexity of 26 (exceeds 5 allowed). Consider refactoring.
Open

    public function register(?array $associatedModels = [], array|string|null $authRoles = []): bool
    {
        if (!$this->getIsNewRecord()) {
            return false;
        }
Severity: Minor
Found in traits/RegistrationTrait.php - About 3 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

Method register has 42 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function register(?array $associatedModels = [], array|string|null $authRoles = []): bool
    {
        if (!$this->getIsNewRecord()) {
            return false;
        }
Severity: Minor
Found in traits/RegistrationTrait.php - About 1 hr to fix

    Function unregister has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

        public function unregister(): bool
        {
            if ($this->getIsNewRecord()) {
                return false;
            }
    Severity: Minor
    Found in traits/RegistrationTrait.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

    The method register() has an NPath complexity of 446. The configured NPath complexity threshold is 200.
    Open

        public function register(?array $associatedModels = [], array|string|null $authRoles = []): bool
        {
            if (!$this->getIsNewRecord()) {
                return false;
            }
    Severity: Minor
    Found in traits/RegistrationTrait.php by phpmd

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

        public function register(?array $associatedModels = [], array|string|null $authRoles = []): bool
        {
            if (!$this->getIsNewRecord()) {
                return false;
            }
    Severity: Minor
    Found in traits/RegistrationTrait.php by phpmd

    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

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

                    Yii::error($ex->getMessage(), __METHOD__);
    Severity: Minor
    Found in traits/RegistrationTrait.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 assigning values to variables in if clauses and the like (line '93', column '18').
    Open

        public function register(?array $associatedModels = [], array|string|null $authRoles = []): bool
        {
            if (!$this->getIsNewRecord()) {
                return false;
            }
    Severity: Minor
    Found in traits/RegistrationTrait.php by phpmd

    IfStatementAssignment

    Since: 2.7.0

    Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.

    Example

    class Foo
    {
        public function bar($flag)
        {
            if ($foo = 'bar') { // possible typo
                // ...
            }
            if ($baz = 0) { // always false
                // ...
            }
        }
    }

    Source http://phpmd.org/rules/cleancode.html#ifstatementassignment

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

                    Yii::error($ex->getMessage(), __METHOD__);
    Severity: Minor
    Found in traits/RegistrationTrait.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 'unregister'.
    Open

                Yii::warning($ex->getMessage(), __METHOD__);
    Severity: Minor
    Found in traits/RegistrationTrait.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 'register'.
    Open

                Yii::warning($ex->getMessage(), __METHOD__);
    Severity: Minor
    Found in traits/RegistrationTrait.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

    Property name "$_sourceRules" should not be prefixed with an underscore to indicate visibility
    Open

        private array $_sourceRules = [];
    Severity: Minor
    Found in traits/RegistrationTrait.php by phpcodesniffer

    Only one argument is allowed per line in a multi-line function call
    Open

                            ('Registration Error(s) Occurred: Associated Models Save Failed.', $model->getErrors());
    Severity: Minor
    Found in traits/RegistrationTrait.php by phpcodesniffer

    Space before opening parenthesis of function call prohibited
    Open

                            throw new IntegrityException
    Severity: Minor
    Found in traits/RegistrationTrait.php by phpcodesniffer

    Closing parenthesis of a multi-line function call must be on a line by itself
    Open

                            ('Registration Error(s) Occurred: Associated Models Save Failed.', $model->getErrors());
    Severity: Minor
    Found in traits/RegistrationTrait.php by phpcodesniffer

    Opening parenthesis of a multi-line function call must be the last content on the line
    Open

                            throw new IntegrityException
    Severity: Minor
    Found in traits/RegistrationTrait.php by phpcodesniffer

    There are no issues that match your filters.

    Category
    Status