kai-jacobsen/kontentblocks

View on GitHub
core/Frontend/Renderer/SlotRenderer.php

Summary

Maintainability
A
45 mins
Test Coverage

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

    public function slot($pos = null, $returnModule = false, $args = array())
    {
        if (is_null($pos)) {
            $pos = $this->position;
        }
Severity: Minor
Found in core/Frontend/Renderer/SlotRenderer.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

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

    public function slot($pos = null, $returnModule = false, $args = array())

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

Avoid assigning values to variables in if clauses and the like (line '112', column '17').
Open

    public function slot($pos = null, $returnModule = false, $args = array())
    {
        if (is_null($pos)) {
            $pos = $this->position;
        }

IfStatementAssignment

Since: 2.7.0

Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.

Example

class Foo
{
    public function bar($flag)
    {
        if ($foo = 'bar') { // possible typo
            // ...
        }
        if ($baz = 0) { // always false
            // ...
        }
    }
}

Source http://phpmd.org/rules/cleancode.html#ifstatementassignment

There are no issues that match your filters.

Category
Status