TokenContainer   A
last analyzed

Complexity

Total Complexity 16

Size/Duplication

Total Lines 106
Duplicated Lines 6.6 %

Coupling/Cohesion

Components 1
Dependencies 5

Test Coverage

Coverage 100%

Importance

Changes 0
Metric Value
wmc 16
lcom 1
cbo 5
dl 7
loc 106
ccs 42
cts 42
cp 1
rs 10
c 0
b 0
f 0

8 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 5 1
A getChildren() 0 4 1
A hasChild() 0 4 1
A appendChild() 0 4 1
A prependChild() 0 4 1
A removeChild() 7 7 2
A clean() 0 8 1
C remove() 0 30 8

How to fix   Duplicated Code   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

1
<?php
2
3
namespace Groundskeeper\Tokens;
4
5
use Groundskeeper\Configuration;
6
use Psr\Log\LoggerInterface;
7
8
final class TokenContainer implements Cleanable, ContainsChildren, Removable
9
{
10
    /** @var Token[] */
11
    private $children;
12
13
    /** @var Configuration */
14
    private $configuration;
15
16
    /**
17
     * Constructor
18
     */
19 156
    public function __construct(Configuration $configuration)
20
    {
21 156
        $this->children = array();
22 156
        $this->configuration = $configuration;
23 156
    }
24
25
    /**
26
     * Required by ContainsChildren interface.
27
     */
28 156
    public function getChildren() : array
29
    {
30 156
        return $this->children;
31
    }
32
33
    /**
34
     * Required by ContainsChildren interface.
35
     */
36 1
    public function hasChild(Token $token) : bool
37
    {
38 1
        return in_array($token, $this->children, true);
39
    }
40
41
    /**
42
     * Required by ContainsChildren interface.
43
     */
44 155
    public function appendChild(Token $token)
45
    {
46 155
        $this->children[] = $token;
47 155
    }
48
49
    /**
50
     * Required by ContainsChildren interface.
51
     */
52 1
    public function prependChild(Token $token)
53
    {
54 1
        array_unshift($this->children, $token);
55 1
    }
56
57
    /**
58
     * Required by ContainsChildren interface.
59
     */
60 5 View Code Duplication
    public function removeChild(Token $token)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
61
    {
62 5
        $key = array_search($token, $this->children, true);
63 5
        if ($key !== false) {
64 5
            unset($this->children[$key]);
65
        }
66 5
    }
67
68
    /**
69
     * Required by Cleanable interface.
70
     */
71 148
    public function clean(LoggerInterface $logger) : bool
72
    {
73 148
        return AbstractToken::cleanChildTokens(
74 148
            $this->configuration,
75 148
            $this->children,
76 148
            $logger
77
        );
78
    }
79
80
    /**
81
     * Required by the Removable interface.
82
     */
83 147
    public function remove(LoggerInterface $logger)
84
    {
85 147
        $hasRemovableElements = $this->configuration->get('element-blacklist') != '';
86 147
        $hasRemovableTypes = $this->configuration->get('type-blacklist') != '';
87 147
        foreach ($this->children as $child) {
88
            // Check types.
89 147
            if ($hasRemovableTypes &&
90 147
                !$this->configuration->isAllowedType($child->getType())) {
91 2
                $logger->debug('Removing ' . $child . ' on type blacklist.');
92 2
                $this->removeChild($child);
93
94 2
                continue;
95
            }
96
97
            // Check elements.
98 147
            if ($hasRemovableElements &&
99 147
                $child instanceof Element &&
100 147
                !$this->configuration->isAllowedElement($child->getName())) {
101 2
                $logger->debug('Removing ' . $child . ' on element blacklist.');
102 2
                $this->removeChild($child);
103
104 2
                continue;
105
            }
106
107
            // Check children.
108 145
            if ($child instanceof Removable) {
109 145
                $child->remove($logger);
110
            }
111
        }
112 147
    }
113
}
114