mambax7/songlist

View on GitHub
include/onupdate.php

Summary

Maintainability
B
5 hrs
Test Coverage

xoops_module_update_songlist accesses the super-global variable $GLOBALS.
Open

function xoops_module_update_songlist(\XoopsModule $module, $previousVersion = null): bool
{
    $moduleDirName      = \basename(\dirname(__DIR__));
    $moduleDirNameUpper = \mb_strtoupper($moduleDirName);

Severity: Minor
Found in include/onupdate.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

xoops_module_update_songlist accesses the super-global variable $GLOBALS.
Open

function xoops_module_update_songlist(\XoopsModule $module, $previousVersion = null): bool
{
    $moduleDirName      = \basename(\dirname(__DIR__));
    $moduleDirNameUpper = \mb_strtoupper($moduleDirName);

Severity: Minor
Found in include/onupdate.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

xoops_module_update_songlist accesses the super-global variable $GLOBALS.
Open

function xoops_module_update_songlist(\XoopsModule $module, $previousVersion = null): bool
{
    $moduleDirName      = \basename(\dirname(__DIR__));
    $moduleDirNameUpper = \mb_strtoupper($moduleDirName);

Severity: Minor
Found in include/onupdate.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

xoops_module_update_songlist accesses the super-global variable $GLOBALS.
Open

function xoops_module_update_songlist(\XoopsModule $module, $previousVersion = null): bool
{
    $moduleDirName      = \basename(\dirname(__DIR__));
    $moduleDirNameUpper = \mb_strtoupper($moduleDirName);

Severity: Minor
Found in include/onupdate.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

Function xoops_module_update_songlist has a Cognitive Complexity of 25 (exceeds 5 allowed). Consider refactoring.
Open

function xoops_module_update_songlist(\XoopsModule $module, $previousVersion = null): bool
{
    $moduleDirName      = \basename(\dirname(__DIR__));
    $moduleDirNameUpper = \mb_strtoupper($moduleDirName);

Severity: Minor
Found in include/onupdate.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 xoops_module_update_songlist has 40 lines of code (exceeds 25 allowed). Consider refactoring.
Open

function xoops_module_update_songlist(\XoopsModule $module, $previousVersion = null): bool
{
    $moduleDirName      = \basename(\dirname(__DIR__));
    $moduleDirNameUpper = \mb_strtoupper($moduleDirName);

Severity: Minor
Found in include/onupdate.php - About 1 hr to fix

    The function xoops_module_update_songlist() has a Cyclomatic Complexity of 11. The configured cyclomatic complexity threshold is 10.
    Open

    function xoops_module_update_songlist(\XoopsModule $module, $previousVersion = null): bool
    {
        $moduleDirName      = \basename(\dirname(__DIR__));
        $moduleDirNameUpper = \mb_strtoupper($moduleDirName);
    
    
    Severity: Minor
    Found in include/onupdate.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 unused local variables such as '$moduleDirName'.
    Open

        $moduleDirName = \basename(\dirname(__DIR__));
    Severity: Minor
    Found in include/onupdate.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 unused local variables such as '$moduleDirNameUpper'.
    Open

        $moduleDirNameUpper = \mb_strtoupper($moduleDirName);
    Severity: Minor
    Found in include/onupdate.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 unused local variables such as '$helper'.
    Open

        $helper  = Songlist\Helper::getInstance();
    Severity: Minor
    Found in include/onupdate.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 unused local variables such as '$helper'.
    Open

        $helper       = Songlist\Helper::getInstance();
    Severity: Minor
    Found in include/onupdate.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 using static access to class '\XoopsModules\Songlist\Helper' in method 'xoops_module_update_songlist'.
    Open

        $helper       = Songlist\Helper::getInstance();
    Severity: Minor
    Found in include/onupdate.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 'XoopsFile' in method 'xoops_module_update_songlist'.
    Open

                    $folderHandler = XoopsFile::getHandler('folder', $tempFolder);
    Severity: Minor
    Found in include/onupdate.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 '\XoopsModules\Songlist\Helper' in method 'xoops_module_pre_update_songlist'.
    Open

        $helper  = Songlist\Helper::getInstance();
    Severity: Minor
    Found in include/onupdate.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

    A file should declare new symbols (classes, functions, constants, etc.) and cause no other side effects, or it should execute logic with side effects, but should not do both. The first symbol is defined on line 31 and the first side effect is on line 22.
    Open

    <?php declare(strict_types=1);
    Severity: Minor
    Found in include/onupdate.php by phpcodesniffer

    Line exceeds 120 characters; contains 171 characters
    Open

            $sql = 'DELETE FROM ' . $GLOBALS['xoopsDB']->prefix('tplfile') . " WHERE `tpl_module` = '" . $module->getVar('dirname', 'n') . '\' AND `tpl_file` LIKE \'%.tpl%\'';
    Severity: Minor
    Found in include/onupdate.php by phpcodesniffer

    There are no issues that match your filters.

    Category
    Status