Sign upLogin

mambax7/songlist

View on GitHub
Star
class/FieldHandler.php

Summary

Maintainability
C
1 day
Test Coverage

Function insert has a Cognitive Complexity of 36 (exceeds 5 allowed). Consider refactoring.
Open

    public function insert(\XoopsObject $obj, $force = false)
    {
        $objectsHandler = \XoopsModules\Songlist\Helper::getInstance()->getHandler('Extras');
        $obj->setVar('field_name', \str_replace(' ', '_', $obj->getVar('field_name')));
        $obj->cleanVars();
Severity: Minor
Found in class/FieldHandler.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 insert has 115 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function insert(\XoopsObject $obj, $force = false)
    {
        $objectsHandler = \XoopsModules\Songlist\Helper::getInstance()->getHandler('Extras');
        $obj->setVar('field_name', \str_replace(' ', '_', $obj->getVar('field_name')));
        $obj->cleanVars();
Severity: Major
Found in class/FieldHandler.php - About 4 hrs to fix

    The class FieldHandler has an overall complexity of 58 which is very high. The configured complexity threshold is 50.
    Open

    class FieldHandler extends \XoopsPersistableObjectHandler
{
    /**
     * FieldHandler constructor.
     * @param \XoopsDatabase $db
    Severity: Minor
    Found in class/FieldHandler.php by phpmd

    Function delete has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

        public function delete(\XoopsObject $obj, $force = false): bool
    {
        $objectsHandler = \XoopsModules\Songlist\Helper::getInstance()->getHandler('Extras');
        // remove column from table
        $sql = 'ALTER TABLE ' . $objectsHandler->table . ' DROP `' . $obj->getVar('field_name', 'n') . '`';
    Severity: Minor
    Found in class/FieldHandler.php - About 55 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

    Function loadFields has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

        public function loadFields($force_update = false)
    {
        static $fields = [];
        if (!empty($force_update) || 0 == \count($fields)) {
            $criteria = new \Criteria('field_id', 0, '!=');
    Severity: Minor
    Found in class/FieldHandler.php - About 25 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 insert() has an NPath complexity of 11840. The configured NPath complexity threshold is 200.
    Open

        public function insert(\XoopsObject $obj, $force = false)
    {
        $objectsHandler = \XoopsModules\Songlist\Helper::getInstance()->getHandler('Extras');
        $obj->setVar('field_name', \str_replace(' ', '_', $obj->getVar('field_name')));
        $obj->cleanVars();
    Severity: Minor
    Found in class/FieldHandler.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 insert() has 131 lines of code. Current threshold is set to 100. Avoid really long methods.
    Open

        public function insert(\XoopsObject $obj, $force = false)
    {
        $objectsHandler = \XoopsModules\Songlist\Helper::getInstance()->getHandler('Extras');
        $obj->setVar('field_name', \str_replace(' ', '_', $obj->getVar('field_name')));
        $obj->cleanVars();
    Severity: Minor
    Found in class/FieldHandler.php by phpmd

    The method insert() has a Cyclomatic Complexity of 45. The configured cyclomatic complexity threshold is 10.
    Open

        public function insert(\XoopsObject $obj, $force = false)
    {
        $objectsHandler = \XoopsModules\Songlist\Helper::getInstance()->getHandler('Extras');
        $obj->setVar('field_name', \str_replace(' ', '_', $obj->getVar('field_name')));
        $obj->cleanVars();
    Severity: Minor
    Found in class/FieldHandler.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

    Missing class import via use statement (line '208', column '45').
    Open

                        $criteria         = new \CriteriaCompo(new \Criteria('gperm_modid', $objects_module->getVar('mid')));
    Severity: Minor
    Found in class/FieldHandler.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 '209', column '40').
    Open

                        $criteria->add(new \Criteria('gperm_itemid', $obj->getVar('field_id')));
    Severity: Minor
    Found in class/FieldHandler.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

    The method delete has a boolean flag argument $force, which is a certain sign of a Single Responsibility Principle violation.
    Open

        public function delete(\XoopsObject $obj, $force = false): bool
    Severity: Minor
    Found in class/FieldHandler.php by phpmd

    BooleanArgumentFlag

    Since: 1.4.0

    A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

    Example

    class Foo {
    public function bar($flag = true) {
    }
}

    Source https://phpmd.org/rules/cleancode.html#booleanargumentflag

    Missing class import via use statement (line '30', column '29').
    Open

                $criteria = new \Criteria('field_id', 0, '!=');
    Severity: Minor
    Found in class/FieldHandler.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 '208', column '64').
    Open

                        $criteria         = new \CriteriaCompo(new \Criteria('gperm_modid', $objects_module->getVar('mid')));
    Severity: Minor
    Found in class/FieldHandler.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

    The method insert has a boolean flag argument $force, which is a certain sign of a Single Responsibility Principle violation.
    Open

        public function insert(\XoopsObject $obj, $force = false)
    Severity: Minor
    Found in class/FieldHandler.php by phpmd

    BooleanArgumentFlag

    Since: 1.4.0

    A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

    Example

    class Foo {
    public function bar($flag = true) {
    }
}

    Source https://phpmd.org/rules/cleancode.html#booleanargumentflag

    The method loadFields has a boolean flag argument $force_update, which is a certain sign of a Single Responsibility Principle violation.
    Open

        public function loadFields($force_update = false)
    Severity: Minor
    Found in class/FieldHandler.php by phpmd

    BooleanArgumentFlag

    Since: 1.4.0

    A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

    Example

    class Foo {
    public function bar($flag = true) {
    }
}

    Source https://phpmd.org/rules/cleancode.html#booleanargumentflag

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

                } else {
                //update column information
                $changetype = 'CHANGE `' . $obj->getVar('field_name', 'n') . '`';
            }
    Severity: Minor
    Found in class/FieldHandler.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 parameter $force_update is not named in camelCase.
    Open

        public function loadFields($force_update = false)
    {
        static $fields = [];
        if (!empty($force_update) || 0 == \count($fields)) {
            $criteria = new \Criteria('field_id', 0, '!=');
    Severity: Minor
    Found in class/FieldHandler.php by phpmd

    CamelCaseParameterName

    Since: 0.2

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

    Example

    class ClassName {
    public function doSomething($user_name) {
    }
}

    Source

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

        public function __construct(\XoopsDatabase $db)
    Severity: Minor
    Found in class/FieldHandler.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

    Line exceeds 120 characters; contains 121 characters
    Open

                        $criteria         = new \CriteriaCompo(new \Criteria('gperm_modid', $objects_module->getVar('mid')));
    Severity: Minor
    Found in class/FieldHandler.php by phpcodesniffer

    Line exceeds 120 characters; contains 188 characters
    Open

                $sql = 'ALTER TABLE `' . $objectsHandler->table . '` ' . $changetype . ' `' . $obj->cleanVars['field_name'] . '` ' . $type . $maxlengthstring . $notnullstring . $defaultstring;
    Severity: Minor
    Found in class/FieldHandler.php by phpcodesniffer

    The variable $objects_module is not named in camelCase.
    Open

        public function delete(\XoopsObject $obj, $force = false): bool
    {
        $objectsHandler = \XoopsModules\Songlist\Helper::getInstance()->getHandler('Extras');
        // remove column from table
        $sql = 'ALTER TABLE ' . $objectsHandler->table . ' DROP `' . $obj->getVar('field_name', 'n') . '`';
    Severity: Minor
    Found in class/FieldHandler.php by phpmd

    CamelCaseVariableName

    Since: 0.2

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

    Example

    class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

    Source

    The variable $field_objs is not named in camelCase.
    Open

        public function loadFields($force_update = false)
    {
        static $fields = [];
        if (!empty($force_update) || 0 == \count($fields)) {
            $criteria = new \Criteria('field_id', 0, '!=');
    Severity: Minor
    Found in class/FieldHandler.php by phpmd

    CamelCaseVariableName

    Since: 0.2

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

    Example

    class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

    Source

    The variable $field_objs is not named in camelCase.
    Open

        public function loadFields($force_update = false)
    {
        static $fields = [];
        if (!empty($force_update) || 0 == \count($fields)) {
            $criteria = new \Criteria('field_id', 0, '!=');
    Severity: Minor
    Found in class/FieldHandler.php by phpmd

    CamelCaseVariableName

    Since: 0.2

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

    Example

    class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

    Source

    The variable $objects_module is not named in camelCase.
    Open

        public function delete(\XoopsObject $obj, $force = false): bool
    {
        $objectsHandler = \XoopsModules\Songlist\Helper::getInstance()->getHandler('Extras');
        // remove column from table
        $sql = 'ALTER TABLE ' . $objectsHandler->table . ' DROP `' . $obj->getVar('field_name', 'n') . '`';
    Severity: Minor
    Found in class/FieldHandler.php by phpmd

    CamelCaseVariableName

    Since: 0.2

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

    Example

    class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

    Source

    The variable $objects_module is not named in camelCase.
    Open

        public function delete(\XoopsObject $obj, $force = false): bool
    {
        $objectsHandler = \XoopsModules\Songlist\Helper::getInstance()->getHandler('Extras');
        // remove column from table
        $sql = 'ALTER TABLE ' . $objectsHandler->table . ' DROP `' . $obj->getVar('field_name', 'n') . '`';
    Severity: Minor
    Found in class/FieldHandler.php by phpmd

    CamelCaseVariableName

    Since: 0.2

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

    Example

    class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

    Source

    The variable $field_objs is not named in camelCase.
    Open

        public function loadFields($force_update = false)
    {
        static $fields = [];
        if (!empty($force_update) || 0 == \count($fields)) {
            $criteria = new \Criteria('field_id', 0, '!=');
    Severity: Minor
    Found in class/FieldHandler.php by phpmd

    CamelCaseVariableName

    Since: 0.2

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

    Example

    class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

    Source

    The variable $field_objs is not named in camelCase.
    Open

        public function loadFields($force_update = false)
    {
        static $fields = [];
        if (!empty($force_update) || 0 == \count($fields)) {
            $criteria = new \Criteria('field_id', 0, '!=');
    Severity: Minor
    Found in class/FieldHandler.php by phpmd

    CamelCaseVariableName

    Since: 0.2

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

    Example

    class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

    Source

    The variable $force_update is not named in camelCase.
    Open

        public function loadFields($force_update = false)
    {
        static $fields = [];
        if (!empty($force_update) || 0 == \count($fields)) {
            $criteria = new \Criteria('field_id', 0, '!=');
    Severity: Minor
    Found in class/FieldHandler.php by phpmd

    CamelCaseVariableName

    Since: 0.2

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

    Example

    class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

    Source

    There are no issues that match your filters.

    Category
    Status