majkel89/tcpdf-warper

View on GitHub
src/org/majkel/tcpdfwarper/generator/Generator.php

Summary

Maintainability
A
2 hrs
Test Coverage

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

    protected function getConfig() {
        if (is_null($this->config)) {
            $this->config = array();
            if (!file_exists($this->configFile)) {
                throw new GeneratorException("Config file `{$this->configFile}` does not exists.");
Severity: Minor
Found in src/org/majkel/tcpdfwarper/generator/Generator.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

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

                else {
                    $classDef = array(
                            'method' => $classDef,
                    );
                }

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

Avoid using static access to class 'org\majkel\tcpdfwarper\generator\ClassDefinition' in method 'generate'.
Open

            $class = ClassDefinition::fromConfigItem($classDef);

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 'org\majkel\tcpdfwarper\generator\ConfigItem' in method 'getConfig'.
Open

                $this->config[] = ConfigItem::fromArray($classDef);

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

There are no issues that match your filters.

Category
Status