kai-jacobsen/kontentblocks

View on GitHub
core/Backend/Storage/ModuleStorage.php

Summary

Maintainability
A
2 hrs
Test Coverage

The class ModuleStorage has 11 public methods. Consider refactoring ModuleStorage to keep number of public methods under 10.
Open

class ModuleStorage implements \Countable
{
    /**
     * current post id
     * @var int

TooManyPublicMethods

Since: 0.1

A class with too many public methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.

By default it ignores methods starting with 'get' or 'set'.

Example

Source https://phpmd.org/rules/codesize.html#toomanypublicmethods

ModuleStorage has 21 functions (exceeds 20 allowed). Consider refactoring.
Open

class ModuleStorage implements \Countable
{
    /**
     * current post id
     * @var int
Severity: Minor
Found in core/Backend/Storage/ModuleStorage.php - About 2 hrs to fix

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

        public function hasModules($area)
        {
            if (!empty($this->index)) {
                foreach ($this->index as $module) {
                    if ($module->area->id === $area && $module['draft'] !== 'true' && $module['active'] !== false) {
    Severity: Minor
    Found in core/Backend/Storage/ModuleStorage.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 saveModule has a boolean flag argument $addslashes, which is a certain sign of a Single Responsibility Principle violation.
    Open

        public function saveModule($id, $data = '', $addslashes = false)

    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 getModuleDefinition uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

            } else {
                return false;
            }

    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 cleanIndex uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

                } else {
                    // TODO remove from index;
                }

    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 __construct uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

            } else {
                $this->dataProvider = $dataProvider;
            }

    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

    TODO found
    Open

         * TODO: Don't return non existing modules

    TODO found
    Open

                    // TODO remove from index;

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

        public function saveModule($id, $data = '', $addslashes = false)

    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