librenms/librenms

View on GitHub
LibreNMS/Alert/AlertUtil.php

Summary

Maintainability
B
6 hrs
Test Coverage

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

    public static function getContacts($results)
    {
        if (empty($results)) {
            return [];
        }
Severity: Minor
Found in LibreNMS/Alert/AlertUtil.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 getContacts has 49 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public static function getContacts($results)
    {
        if (empty($results)) {
            return [];
        }
Severity: Minor
Found in LibreNMS/Alert/AlertUtil.php - About 1 hr to fix

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

        public static function runMacros($rule, $x = 1)
        {
            $macros = Config::get('alert.macros.rule', []);
            krsort($macros);
            foreach ($macros as $macro => $value) {
    Severity: Minor
    Found in LibreNMS/Alert/AlertUtil.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 getContacts() has an NPath complexity of 61440. The configured NPath complexity threshold is 200.
    Open

        public static function getContacts($results)
        {
            if (empty($results)) {
                return [];
            }
    Severity: Minor
    Found in LibreNMS/Alert/AlertUtil.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 getContacts() has a Cyclomatic Complexity of 22. The configured cyclomatic complexity threshold is 10.
    Open

        public static function getContacts($results)
        {
            if (empty($results)) {
                return [];
            }
    Severity: Minor
    Found in LibreNMS/Alert/AlertUtil.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 assigning values to variables in if clauses and the like (line '178', column '17').
    Open

        public static function findContactsOwners(array $results): array
        {
            return User::whereNot('email', '')->where(function (Builder $query) use ($results) {
                if ($device_ids = array_filter(Arr::pluck($results, 'device_id'))) {
                    $query->orWhereHas('devicesOwned', fn ($q) => $q->whereIn('devices_perms.device_id', $device_ids));
    Severity: Minor
    Found in LibreNMS/Alert/AlertUtil.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

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

                } else {
                    $tmp_contacts[$email] = $name;
                }
    Severity: Minor
    Found in LibreNMS/Alert/AlertUtil.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 runMacros uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

                } else {
                    return false;
                }
    Severity: Minor
    Found in LibreNMS/Alert/AlertUtil.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 assigning values to variables in if clauses and the like (line '175', column '17').
    Open

        public static function findContactsOwners(array $results): array
        {
            return User::whereNot('email', '')->where(function (Builder $query) use ($results) {
                if ($device_ids = array_filter(Arr::pluck($results, 'device_id'))) {
                    $query->orWhereHas('devicesOwned', fn ($q) => $q->whereIn('devices_perms.device_id', $device_ids));
    Severity: Minor
    Found in LibreNMS/Alert/AlertUtil.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 assigning values to variables in if clauses and the like (line '172', column '17').
    Open

        public static function findContactsOwners(array $results): array
        {
            return User::whereNot('email', '')->where(function (Builder $query) use ($results) {
                if ($device_ids = array_filter(Arr::pluck($results, 'device_id'))) {
                    $query->orWhereHas('devicesOwned', fn ($q) => $q->whereIn('devices_perms.device_id', $device_ids));
    Severity: Minor
    Found in LibreNMS/Alert/AlertUtil.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 unused local variables such as '$tmp_name'.
    Open

                foreach ($tmp_contacts as $tmp_email => $tmp_name) {
    Severity: Minor
    Found in LibreNMS/Alert/AlertUtil.php by phpmd

    UnusedLocalVariable

    Since: 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 https://phpmd.org/rules/unusedcode.html#unusedlocalvariable

    Avoid variables with short names like $x. Configured minimum length is 3.
    Open

        public static function runMacros($rule, $x = 1)
    Severity: Minor
    Found in LibreNMS/Alert/AlertUtil.php by phpmd

    ShortVariable

    Since: 0.2

    Detects when a field, local, or parameter has a very short name.

    Example

    class Something {
        private $q = 15; // VIOLATION - Field
        public static function main( array $as ) { // VIOLATION - Formal
            $r = 20 + $this->q; // VIOLATION - Local
            for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
                $r += $this->q;
            }
        }
    }

    Source https://phpmd.org/rules/naming.html#shortvariable

    Space before opening parenthesis of function call prohibited
    Open

                    $query->orWhereHas('portsOwned', fn ($q) => $q->whereIn('ports_perms.port_id', $port_ids));
    Severity: Minor
    Found in LibreNMS/Alert/AlertUtil.php by phpcodesniffer

    Space before opening parenthesis of function call prohibited
    Open

                    $query->orWhereHas('devicesOwned', fn ($q) => $q->whereIn('devices_perms.device_id', $device_ids));
    Severity: Minor
    Found in LibreNMS/Alert/AlertUtil.php by phpcodesniffer

    Space before opening parenthesis of function call prohibited
    Open

                    $query->orWhereHas('bills', fn ($q) => $q->whereIn('bill_perms.bill_id', $bill_ids));
    Severity: Minor
    Found in LibreNMS/Alert/AlertUtil.php by phpcodesniffer

    There are no issues that match your filters.

    Category
    Status