Completed
Pull Request — master (#55)
by Volodymyr
01:53
created

AbstractSimpleHtmlDom   A

Complexity

Total Complexity 40

Size/Duplication

Total Lines 227
Duplicated Lines 12.33 %

Coupling/Cohesion

Components 0
Dependencies 2

Test Coverage

Coverage 81.94%

Importance

Changes 0
Metric Value
dl 28
loc 227
ccs 59
cts 72
cp 0.8194
rs 9.2
c 0
b 0
f 0
wmc 40
lcom 0
cbo 2

19 Methods

Rating   Name   Duplication   Size   Complexity  
A __call() 0 10 2
A __invoke() 0 4 1
C __get() 0 38 16
B __isset() 22 22 10
B __set() 6 26 9
A __toString() 0 4 1
A __unset() 0 5 1
find() 0 1 ?
getAllAttributes() 0 1 ?
getAttribute() 0 1 ?
hasAttribute() 0 1 ?
html() 0 1 ?
innerHtml() 0 1 ?
removeAttribute() 0 1 ?
replaceChildWithString() 0 1 ?
replaceNodeWithString() 0 1 ?
replaceTextWithString() 0 1 ?
setAttribute() 0 1 ?
text() 0 1 ?

How to fix   Duplicated Code    Complexity   

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:

Complex Class

 Tip:   Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like AbstractSimpleHtmlDom often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use AbstractSimpleHtmlDom, and based on these observations, apply Extract Interface, too.

1
<?php
2
3
declare(strict_types=1);
4
5
namespace voku\helper;
6
7
abstract class AbstractSimpleHtmlDom
8
{
9
    /**
10
     * @var array
11
     */
12
    protected static $functionAliases = [
13
        'children'     => 'childNodes',
14
        'first_child'  => 'firstChild',
15
        'last_child'   => 'lastChild',
16
        'next_sibling' => 'nextSibling',
17
        'prev_sibling' => 'previousSibling',
18
        'parent'       => 'parentNode',
19
        'outertext'    => 'html',
20
        'outerhtml'    => 'html',
21
        'innertext'    => 'innerHtml',
22
        'innerhtml'    => 'innerHtml',
23
    ];
24
25
    /**
26
     * @var \DOMElement|\DOMNode|null
27
     */
28
    protected $node;
29
30
    /**
31
     * @var SimpleHtmlAttributes|null
32
     */
33
    private $classListCache;
34
35
    /**
36
     * @param string $name
37
     * @param array  $arguments
38
     *
39
     * @throws \BadMethodCallException
40
     *
41
     * @return SimpleHtmlDomInterface|string|null
42
     */
43
    public function __call($name, $arguments)
44
    {
45
        $name = \strtolower($name);
46
47
        if (isset(self::$functionAliases[$name])) {
48
            return \call_user_func_array([$this, self::$functionAliases[$name]], $arguments);
49
        }
50
51
        throw new \BadMethodCallException('Method does not exist');
52
    }
53
54
    /**
55
     * @param string $name
56
     *
57
     * @return SimpleHtmlAttributes|string|string[]|null
58
     */
59 81
    public function __get($name)
60
    {
61 81
        $nameOrig = $name;
62 81
        $name = \strtolower($name);
63
64 81
        switch ($name) {
65 81
            case 'outerhtml':
66 73
            case 'outertext':
67 63
            case 'html':
68 28
                return $this->html();
69 63
            case 'innerhtml':
70 51
            case 'innertext':
71 20
                return $this->innerHtml();
72 46
            case 'text':
73 41
            case 'plaintext':
74 21
                return $this->text();
75 29
            case 'tag':
76 5
                return $this->node ? $this->node->nodeName : '';
77 27
            case 'attr':
78
                return $this->getAllAttributes();
79 27
            case 'classlist':
80 12
                if ($this->classListCache === null) {
81 12
                    $this->classListCache = new SimpleHtmlAttributes($this->node ?? null, 'class');
0 ignored issues
show
Bug introduced by
It seems like $this->node ?? null can also be of type object<DOMNode>; however, voku\helper\SimpleHtmlAttributes::__construct() does only seem to accept object<DOMElement>|null, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
82
                }
83
84 12
                return $this->classListCache;
85
            default:
86 15
                if ($this->node && \property_exists($this->node, $nameOrig)) {
87 2
                    if (\is_string($this->node->{$nameOrig})) {
88 2
                        return HtmlDomParser::putReplacedBackToPreserveHtmlEntities($this->node->{$nameOrig});
89
                    }
90
91
                    return $this->node->{$nameOrig};
92
                }
93
94 15
                return $this->getAttribute($name);
95
        }
96
    }
97
98
    /**
99
     * @param string $selector
100
     * @param int    $idx
101
     *
102
     * @return SimpleHtmlDomInterface|SimpleHtmlDomInterface[]|SimpleHtmlDomNodeInterface<SimpleHtmlDomInterface>
0 ignored issues
show
Documentation introduced by
The doc-type SimpleHtmlDomInterface|S...SimpleHtmlDomInterface> could not be parsed: Expected "|" or "end of type", but got "<" at position 74. (view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
103
     */
104 12
    public function __invoke($selector, $idx = null)
105
    {
106 12
        return $this->find($selector, $idx);
107
    }
108
109
    /**
110
     * @param string $name
111
     *
112
     * @return bool
113
     */
114 1 View Code Duplication
    public function __isset($name)
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...
115
    {
116 1
        $nameOrig = $name;
117 1
        $name = \strtolower($name);
118
119 1
        switch ($name) {
120 1
            case 'outertext':
121 1
            case 'outerhtml':
122 1
            case 'innertext':
123 1
            case 'innerhtml':
124 1
            case 'plaintext':
125 1
            case 'text':
126 1
            case 'tag':
127
                return true;
128
            default:
129 1
                if ($this->node && \property_exists($this->node, $nameOrig)) {
130
                    return isset($this->node->{$nameOrig});
131
                }
132
133 1
                return $this->hasAttribute($name);
134
        }
135
    }
136
137
    /**
138
     * @param string $name
139
     * @param mixed  $value
140
     *
141
     * @return SimpleHtmlDomInterface|null
142
     */
143 24
    public function __set($name, $value)
144
    {
145 24
        $nameOrig = $name;
146 24
        $name = \strtolower($name);
147
148 24
        switch ($name) {
149 24
            case 'outerhtml':
150 20
            case 'outertext':
151 6
                return $this->replaceNodeWithString($value);
152 18
            case 'innertext':
153 15
            case 'innerhtml':
154 9
                return $this->replaceChildWithString($value);
155 13
            case 'plaintext':
156 1
                return $this->replaceTextWithString($value);
157 12
            case 'classlist':
158 1
                $name = 'class';
159 1
                $nameOrig = 'class';
160
                // no break
161 View Code Duplication
            default:
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
162 12
                if ($this->node && \property_exists($this->node, $nameOrig)) {
163
                    return $this->node->{$nameOrig} = $value;
164
                }
165
166 12
                return $this->setAttribute($name, $value);
167
        }
168
    }
169
170
    /**
171
     * @return string
172
     */
173 3
    public function __toString()
174
    {
175 3
        return $this->html();
176
    }
177
178
    /**
179
     * @param string $name
180
     *
181
     * @return void
182
     */
183
    public function __unset($name)
184
    {
185
        /** @noinspection UnusedFunctionResultInspection */
186
        $this->removeAttribute($name);
187
    }
188
189
    /**
190
     * @param string $selector
191
     * @param int|null   $idx
192
     *
193
     * @return mixed
194
     */
195
    abstract public function find(string $selector, $idx = null);
196
197
    /**
198
     * @return string[]|null
199
     */
200
    abstract public function getAllAttributes();
201
202
    abstract public function getAttribute(string $name): string;
203
204
    abstract public function hasAttribute(string $name): bool;
205
206
    abstract public function html(bool $multiDecodeNewHtmlEntity = false): string;
207
208
    abstract public function innerHtml(bool $multiDecodeNewHtmlEntity = false): string;
209
210
    abstract public function removeAttribute(string $name): SimpleHtmlDomInterface;
211
212
    abstract protected function replaceChildWithString(string $string): SimpleHtmlDomInterface;
213
214
    abstract protected function replaceNodeWithString(string $string): SimpleHtmlDomInterface;
215
216
    /**
217
     * @param string $string
218
     *
219
     * @return SimpleHtmlDomInterface
220
     */
221
    abstract protected function replaceTextWithString($string): SimpleHtmlDomInterface;
222
223
    /**
224
     * @param string $name
225
     * @param string|null   $value
226
     * @param bool   $strict
227
     *
228
     * @return SimpleHtmlDomInterface
229
     */
230
    abstract public function setAttribute(string $name, $value = null, bool $strict = false): SimpleHtmlDomInterface;
231
232
    abstract public function text(): string;
233
}
234