vikpe/php-html-heading-normalizer

View on GitHub
src/HtmlHeadingNormalizer.php

Summary

Maintainability
A
0 mins
Test Coverage

Missing class import via use statement (line '37', column '28').
Open

        $domDocument = new \DOMDocument();
Severity: Minor
Found in src/HtmlHeadingNormalizer.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 '161', column '28').
Open

        $domDocument = new \DOMDocument();
Severity: Minor
Found in src/HtmlHeadingNormalizer.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 formatResult uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
Open

        } else {
            $bodyDomElement = $domDocument->getElementsByTagName('body')
                                          ->item(0);

            $html = $domDocument->saveHTML($bodyDomElement);
Severity: Minor
Found in src/HtmlHeadingNormalizer.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

Avoid excessively long variable names like $normalizationIsRequired. Keep variable name length under 20.
Open

        $normalizationIsRequired = ((abs($numberOfLevels) > 0) && self::containsHeadings($html));
Severity: Minor
Found in src/HtmlHeadingNormalizer.php by phpmd

LongVariable

Since: 0.2

Detects when a field, formal or local variable is declared with a long name.

Example

class Something {
    protected $reallyLongIntName = -3; // VIOLATION - Field
    public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
        $otherReallyLongName = -5; // VIOLATION - Local
        for ($interestingIntIndex = 0; // VIOLATION - For
             $interestingIntIndex < 10;
             $interestingIntIndex++ ) {
        }
    }
}

Source https://phpmd.org/rules/naming.html#longvariable

There are no issues that match your filters.

Category
Status