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 |
|
|
|
|
21
|
|
|
// "template" elements required. |
22
|
|
|
$headingContentElementCount = 0; |
|
|
|
|
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) { |
|
|
|
|
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
|
|
|
|
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.