Completed
Push — master ( 9fbe45...817727 )
by Kevin
03:24
created

Hgroup::removeInvalidChildren()   C

Complexity

Conditions 11
Paths 5

Size

Total Lines 31
Code Lines 19

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 132

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 31
ccs 0
cts 25
cp 0
rs 5.2653
cc 11
eloc 19
nc 5
nop 1
crap 132

How to fix   Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
3
namespace Groundskeeper\Tokens\Elements;
4
5
use Groundskeeper\Tokens\ElementTypes\FlowContent;
6
use Groundskeeper\Tokens\ElementTypes\HeadingContent;
7
use Groundskeeper\Tokens\ElementTypes\OpenElement;
8
use Groundskeeper\Tokens\Token;
9
use Psr\Log\LoggerInterface;
10
11
/**
12
 * "hgroup" element
13
 *
14
 * https://html.spec.whatwg.org/multipage/semantics.html#the-hgroup-element
15
 */
16
class Hgroup extends OpenElement implements FlowContent, HeadingContent
17
{
18
    protected function removeInvalidChildren(LoggerInterface $logger)
19
    {
20
        // One or more "h1", "h2", "h3", "h4", "h5", "h6", and
0 ignored issues
show
Unused Code Comprehensibility introduced by
54% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
21
        // "template" elements required.
22
        $headingContentElementCount = 0;
0 ignored issues
show
Unused Code introduced by
$headingContentElementCount is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
23
        foreach ($this->children as $child) {
24
            if ($child->getType() === Token::COMMENT) {
25
                continue;
26
            }
27
28
            if ($child->getType() !== Token::ELEMENT) {
29
                $logger->debug('Removing ' . $child . '. Only "h1"-"h6" and "template" elements allowed as child of "hgroup" element.');
30
                $this->removeChild($child);
31
32
                continue;
33
            }
34
35
            if ($child->getName() !== 'h1' &&
36
                $child->getName() !== 'h2' &&
37
                $child->getName() !== 'h3' &&
38
                $child->getName() !== 'h4' &&
39
                $child->getName() !== 'h5' &&
40
                $child->getName() !== 'h6' &&
41
                $child->getName() !== 'tempate') {
42
                $logger->debug('Removing ' .  $child . '. Only "h1"-"h6" and "template" elements allowed as child of "hgroup" element.');
43
                $this->removeChild($child);
44
45
                continue;
46
            }
47
        }
48
    }
49
50
    protected function removeInvalidSelf(LoggerInterface $logger)
51
    {
52
        foreach ($this->children as $child) {
53
            if ($child instanceof HeadingContent) {
54
                return false;
55
            }
56
        }
57
58
        // Handle no child HeadingContent.
59
        if ($headingContentElementCount == 0) {
0 ignored issues
show
Bug introduced by
The variable $headingContentElementCount does not exist. Did you forget to declare it?

This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug.

Loading history...
60
            $logger->debug($this . ' must contain at least one of the following elements: "h1", "h2", "h3", "h4", "h5", "h6", or "template".');
61
62
            return true;
63
        }
64
65
        return false;
66
    }
67
}
68