efureev/u.php

View on GitHub
src/uSecurity.php

Summary

Maintainability
C
1 day
Test Coverage

Function generateRandomKey has a Cognitive Complexity of 38 (exceeds 5 allowed). Consider refactoring.
Open

    public function generateRandomKey($length = 32)
    {
        if (!is_int($length)) {
            throw new \Exception('First parameter ($length) must be an integer');
        }
Severity: Minor
Found in src/uSecurity.php - About 5 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 generateRandomKey has 70 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function generateRandomKey($length = 32)
    {
        if (!is_int($length)) {
            throw new \Exception('First parameter ($length) must be an integer');
        }
Severity: Major
Found in src/uSecurity.php - About 2 hrs to fix

    The method generateRandomKey() has an NPath complexity of 36000. The configured NPath complexity threshold is 200.
    Open

        public function generateRandomKey($length = 32)
        {
            if (!is_int($length)) {
                throw new \Exception('First parameter ($length) must be an integer');
            }
    Severity: Minor
    Found in src/uSecurity.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 generateRandomKey() has a Cyclomatic Complexity of 27. The configured cyclomatic complexity threshold is 10.
    Open

        public function generateRandomKey($length = 32)
        {
            if (!is_int($length)) {
                throw new \Exception('First parameter ($length) must be an integer');
            }
    Severity: Minor
    Found in src/uSecurity.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

    Remove error control operator '@' on line 69.
    Open

        public function generateRandomKey($length = 32)
        {
            if (!is_int($length)) {
                throw new \Exception('First parameter ($length) must be an integer');
            }
    Severity: Minor
    Found in src/uSecurity.php by phpmd

    ErrorControlOperator

    Error suppression should be avoided if possible as it doesn't just suppress the error, that you are trying to stop, but will also suppress errors that you didn't predict would ever occur. Consider changing error_reporting() level and/or setting up your own error handler.

    Example

    function foo($filePath) {
        $file = @fopen($filPath); // hides exceptions
        $key = @$array[$notExistingKey]; // assigns null to $key
    }

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

    Missing class import via use statement (line '20', column '23').
    Open

                throw new \Exception('First parameter ($length) must be greater than 0');
    Severity: Minor
    Found in src/uSecurity.php by phpmd

    MissingImport

    Since: 2.7.0

    Importing all external classes in a file through use statements makes them clearly visible.

    Example

    function make() {
        return new \stdClass();
    }

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

    Missing class import via use statement (line '128', column '23').
    Open

                throw new \Exception('First parameter ($length) must be greater than 0');
    Severity: Minor
    Found in src/uSecurity.php by phpmd

    MissingImport

    Since: 2.7.0

    Importing all external classes in a file through use statements makes them clearly visible.

    Example

    function make() {
        return new \stdClass();
    }

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

    Missing class import via use statement (line '43', column '27').
    Open

                    throw new \Exception(
    Severity: Minor
    Found in src/uSecurity.php by phpmd

    MissingImport

    Since: 2.7.0

    Importing all external classes in a file through use statements makes them clearly visible.

    Example

    function make() {
        return new \stdClass();
    }

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

    Missing class import via use statement (line '109', column '19').
    Open

            throw new \Exception('Unable to generate a random key');
    Severity: Minor
    Found in src/uSecurity.php by phpmd

    MissingImport

    Since: 2.7.0

    Importing all external classes in a file through use statements makes them clearly visible.

    Example

    function make() {
        return new \stdClass();
    }

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

    Missing class import via use statement (line '16', column '23').
    Open

                throw new \Exception('First parameter ($length) must be an integer');
    Severity: Minor
    Found in src/uSecurity.php by phpmd

    MissingImport

    Since: 2.7.0

    Importing all external classes in a file through use statements makes them clearly visible.

    Example

    function make() {
        return new \stdClass();
    }

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

    Missing class import via use statement (line '124', column '23').
    Open

                throw new \Exception('First parameter ($length) must be an integer');
    Severity: Minor
    Found in src/uSecurity.php by phpmd

    MissingImport

    Since: 2.7.0

    Importing all external classes in a file through use statements makes them clearly visible.

    Example

    function make() {
        return new \stdClass();
    }

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

    Avoid using static access to class 'efureev\uString' in method 'generateRandomKey'.
    Open

                if ($key !== false && uString::byteLength($key) === $length) {
    Severity: Minor
    Found in src/uSecurity.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 'efureev\uString' in method 'generateRandomKey'.
    Open

                if (uString::byteLength($key) === $length) {
    Severity: Minor
    Found in src/uSecurity.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 'efureev\uString' in method 'generateRandomKey'.
    Open

                    $stillNeed -= uString::byteLength($someBytes);
    Severity: Minor
    Found in src/uSecurity.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

    The class uSecurity is not named in CamelCase.
    Open

    class uSecurity
    {
    
        public function generateRandomKey($length = 32)
        {
    Severity: Minor
    Found in src/uSecurity.php by phpmd

    CamelCaseClassName

    Since: 0.2

    It is considered best practice to use the CamelCase notation to name classes.

    Example

    class class_name {
    }

    Source

    The closing brace for the class must go on the next line after the body
    Open

    }
    Severity: Minor
    Found in src/uSecurity.php by phpcodesniffer

    Class name "uSecurity" is not in camel caps format
    Open

    class uSecurity
    Severity: Minor
    Found in src/uSecurity.php by phpcodesniffer

    There are no issues that match your filters.

    Category
    Status