librenms/librenms

View on GitHub
LibreNMS/RRD/RrdDefinition.php

Summary

Maintainability
A
1 hr
Test Coverage

Method addDataset has 7 arguments (exceeds 4 allowed). Consider refactoring.
Open

    public function addDataset($name, $type, $min = null, $max = null, $heartbeat = null, $source_ds = null, $source_file = null)
Severity: Major
Found in LibreNMS/RRD/RrdDefinition.php - About 50 mins to fix

    Function createSource has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Open

        private function createSource(?string $ds, ?string $file): string
        {
            if (empty($ds)) {
                return '';
            }
    Severity: Minor
    Found in LibreNMS/RRD/RrdDefinition.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

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

        private function createSource(?string $ds, ?string $file): string
    Severity: Minor
    Found in LibreNMS/RRD/RrdDefinition.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

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

            $def = array_reduce($this->dataSets, function ($carry, $ds) {
    Severity: Minor
    Found in LibreNMS/RRD/RrdDefinition.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

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

            $sources = implode(' ', array_map(fn ($s) => "--source $s ", $this->sources));
    Severity: Minor
    Found in LibreNMS/RRD/RrdDefinition.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

    The property $invalid_source is not named in camelCase.
    Open

    class RrdDefinition
    {
        private static $types = ['GAUGE', 'DERIVE', 'COUNTER', 'ABSOLUTE', 'DCOUNTER', 'DDERIVE'];
        private $dataSets = [];
        private $sources = [];
    Severity: Minor
    Found in LibreNMS/RRD/RrdDefinition.php by phpmd

    CamelCasePropertyName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name attributes.

    Example

    class ClassName {
        protected $property_name;
    }

    Source

    Space before opening parenthesis of function call prohibited
    Open

            $sources = implode(' ', array_map(fn ($s) => "--source $s ", $this->sources));

    There are no issues that match your filters.

    Category
    Status