Sign upLogin

librenms/librenms

View on GitHub
Star
LibreNMS/Modules/Xdsl.php

Summary

Maintainability
C
1 day
Test Coverage

Function pollAdsl has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
Open

    private function pollAdsl(OS $os, ?DataStorageInterface $datastore = null): Collection
    {
        $adsl = \SnmpQuery::hideMib()->walk('ADSL-LINE-MIB::adslMibObjects')->table(1);
        $adslPorts = new Collection;
Severity: Minor
Found in LibreNMS/Modules/Xdsl.php - About 2 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 storeAdsl has 54 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    private function storeAdsl(PortAdsl $port, array $data, int $ifIndex, OS $os, DataStorageInterface $datastore): void
    {
        $rrd_def = RrdDefinition::make()
            ->addDataset('AtucCurrSnrMgn', 'GAUGE', 0, 635)
            ->addDataset('AtucCurrAtn', 'GAUGE', 0, 635)
Severity: Major
Found in LibreNMS/Modules/Xdsl.php - About 2 hrs to fix

    Method storeVdsl has 30 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        private function storeVdsl(PortVdsl $port, array $data, int $ifIndex, OS $os, DataStorageInterface $datastore): void
    {
        // Attainable
        $datastore->put($os->getDeviceArray(), 'xdsl2LineStatusAttainableRate', [
            'ifName' => $os->ifIndexToName($ifIndex),
    Severity: Minor
    Found in LibreNMS/Modules/Xdsl.php - About 1 hr to fix

      Method pollAdsl has 28 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          private function pollAdsl(OS $os, ?DataStorageInterface $datastore = null): Collection
    {
        $adsl = \SnmpQuery::hideMib()->walk('ADSL-LINE-MIB::adslMibObjects')->table(1);
        $adslPorts = new Collection;
      Severity: Minor
      Found in LibreNMS/Modules/Xdsl.php - About 1 hr to fix

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

            private function pollVdsl(OS $os, ?DataStorageInterface $datastore = null): Collection
    {
        $vdsl = \SnmpQuery::hideMib()->walk(['VDSL2-LINE-MIB::xdsl2ChannelStatusTable', 'VDSL2-LINE-MIB::xdsl2LineTable'])->table(1);
        $vdslPorts = new Collection;
        Severity: Minor
        Found in LibreNMS/Modules/Xdsl.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

        Method storeAdsl has 5 arguments (exceeds 4 allowed). Consider refactoring.
        Open

            private function storeAdsl(PortAdsl $port, array $data, int $ifIndex, OS $os, DataStorageInterface $datastore): void
        Severity: Minor
        Found in LibreNMS/Modules/Xdsl.php - About 35 mins to fix

          Method storeVdsl has 5 arguments (exceeds 4 allowed). Consider refactoring.
          Open

              private function storeVdsl(PortVdsl $port, array $data, int $ifIndex, OS $os, DataStorageInterface $datastore): void
          Severity: Minor
          Found in LibreNMS/Modules/Xdsl.php - About 35 mins to fix

            The class Xdsl has a coupling between objects value of 13. Consider to reduce the number of dependencies under 13.
            Open

            class Xdsl implements Module
{
    use SyncsModels;

    /** @var string[] */
            Severity: Minor
            Found in LibreNMS/Modules/Xdsl.php by phpmd

            CouplingBetweenObjects

            Since: 1.1.0

            A class with too many dependencies has negative impacts on several quality aspects of a class. This includes quality criteria like stability, maintainability and understandability

            Example

            class Foo {
    /**
     * @var \foo\bar\X
     */
    private $x = null;

    /**
     * @var \foo\bar\Y
     */
    private $y = null;

    /**
     * @var \foo\bar\Z
     */
    private $z = null;

    public function setFoo(\Foo $foo) {}
    public function setBar(\Bar $bar) {}
    public function setBaz(\Baz $baz) {}

    /**
     * @return \SplObjectStorage
     * @throws \OutOfRangeException
     * @throws \InvalidArgumentException
     * @throws \ErrorException
     */
    public function process(\Iterator $it) {}

    // ...
}

            Source https://phpmd.org/rules/design.html#couplingbetweenobjects

            Avoid unused private fields such as '$ifNameMap'.
            Open

                private $ifNameMap;
            Severity: Minor
            Found in LibreNMS/Modules/Xdsl.php by phpmd

            UnusedPrivateField

            Since: 0.2

            Detects when a private field is declared and/or assigned a value, but not used.

            Example

            class Something
{
    private static $FOO = 2; // Unused
    private $i = 5; // Unused
    private $j = 6;
    public function addOne()
    {
        return $this->j++;
    }
}

            Source https://phpmd.org/rules/unusedcode.html#unusedprivatefield

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

                private function pollAdsl(OS $os, ?DataStorageInterface $datastore = null): Collection
            Severity: Minor
            Found in LibreNMS/Modules/Xdsl.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 $os. Configured minimum length is 3.
            Open

                public function poll(OS $os, DataStorageInterface $datastore): void
            Severity: Minor
            Found in LibreNMS/Modules/Xdsl.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 $os. Configured minimum length is 3.
            Open

                public function shouldDiscover(OS $os, ModuleStatus $status): bool
            Severity: Minor
            Found in LibreNMS/Modules/Xdsl.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 $os. Configured minimum length is 3.
            Open

                public function discover(OS $os): void
            Severity: Minor
            Found in LibreNMS/Modules/Xdsl.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 $os. Configured minimum length is 3.
            Open

                private function pollVdsl(OS $os, ?DataStorageInterface $datastore = null): Collection
            Severity: Minor
            Found in LibreNMS/Modules/Xdsl.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 $os. Configured minimum length is 3.
            Open

                private function storeAdsl(PortAdsl $port, array $data, int $ifIndex, OS $os, DataStorageInterface $datastore): void
            Severity: Minor
            Found in LibreNMS/Modules/Xdsl.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 $os. Configured minimum length is 3.
            Open

                private function storeVdsl(PortVdsl $port, array $data, int $ifIndex, OS $os, DataStorageInterface $datastore): void
            Severity: Minor
            Found in LibreNMS/Modules/Xdsl.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 $os. Configured minimum length is 3.
            Open

                public function shouldPoll(OS $os, ModuleStatus $status): bool
            Severity: Minor
            Found in LibreNMS/Modules/Xdsl.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

            There are no issues that match your filters.

            Category
            Status