|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
declare(strict_types=1); |
|
4
|
|
|
|
|
5
|
|
|
/* |
|
6
|
|
|
* This file is part of the league/commonmark package. |
|
7
|
|
|
* |
|
8
|
|
|
* (c) Colin O'Dell <[email protected]> |
|
9
|
|
|
* |
|
10
|
|
|
* For the full copyright and license information, please view the LICENSE |
|
11
|
|
|
* file that was distributed with this source code. |
|
12
|
|
|
*/ |
|
13
|
|
|
|
|
14
|
|
|
namespace League\CommonMark\Extension\TableOfContents; |
|
15
|
|
|
|
|
16
|
|
|
use League\CommonMark\Event\DocumentParsedEvent; |
|
17
|
|
|
use League\CommonMark\Exception\InvalidArgumentException; |
|
18
|
|
|
use League\CommonMark\Extension\CommonMark\Node\Block\Heading; |
|
19
|
|
|
use League\CommonMark\Extension\HeadingPermalink\HeadingPermalink; |
|
20
|
|
|
use League\CommonMark\Extension\TableOfContents\Node\TableOfContents; |
|
21
|
|
|
use League\CommonMark\Extension\TableOfContents\Node\TableOfContentsPlaceholder; |
|
22
|
|
|
use League\CommonMark\Extension\TableOfContents\Node\TableOfContentsWrapper; |
|
23
|
|
|
use League\CommonMark\Node\Block\AbstractBlock; |
|
24
|
|
|
use League\CommonMark\Node\Block\Document; |
|
25
|
|
|
use League\CommonMark\Node\NodeIterator; |
|
26
|
|
|
use League\Config\ConfigurationAwareInterface; |
|
27
|
|
|
use League\Config\ConfigurationInterface; |
|
28
|
|
|
use League\Config\Exception\InvalidConfigurationException; |
|
29
|
|
|
|
|
30
|
|
|
final class TableOfContentsBuilder implements ConfigurationAwareInterface |
|
31
|
|
|
{ |
|
32
|
|
|
public const POSITION_TOP = 'top'; |
|
33
|
|
|
public const POSITION_BEFORE_HEADINGS = 'before-headings'; |
|
34
|
|
|
public const POSITION_PLACEHOLDER = 'placeholder'; |
|
35
|
|
|
|
|
36
|
66 |
|
/** @psalm-readonly-allow-private-mutation */ |
|
37
|
|
|
private ConfigurationInterface $config; |
|
38
|
66 |
|
|
|
39
|
|
|
public function onDocumentParsed(DocumentParsedEvent $event): void |
|
40
|
66 |
|
{ |
|
41
|
66 |
|
$document = $event->getDocument(); |
|
42
|
66 |
|
|
|
43
|
66 |
|
$generator = new TableOfContentsGenerator( |
|
44
|
66 |
|
(string) $this->config->get('table_of_contents/style'), |
|
45
|
66 |
|
(string) $this->config->get('table_of_contents/normalize'), |
|
46
|
66 |
|
(int) $this->config->get('table_of_contents/min_heading_level'), |
|
47
|
|
|
(int) $this->config->get('table_of_contents/max_heading_level'), |
|
48
|
66 |
|
(string) $this->config->get('heading_permalink/fragment_prefix'), |
|
49
|
66 |
|
(string) $this->config->get('table_of_contents/label'), |
|
50
|
|
|
); |
|
51
|
8 |
|
|
|
52
|
|
|
$toc = $generator->generate($document); |
|
53
|
|
|
if ($toc === null) { |
|
54
|
|
|
// No linkable headers exist, so no TOC could be generated |
|
55
|
58 |
|
return; |
|
56
|
58 |
|
} |
|
57
|
58 |
|
|
|
58
|
|
|
// Add custom CSS class(es), if defined |
|
59
|
|
|
$class = $this->config->get('table_of_contents/html_class'); |
|
60
|
|
|
if ($class !== null) { |
|
61
|
58 |
|
if ($toc instanceof TableOfContentsWrapper) { |
|
62
|
58 |
|
$toc->getInnerToc()->data->append('attributes/class', $class); |
|
63
|
46 |
|
} else { |
|
64
|
12 |
|
$toc->data->append('attributes/class', $class); |
|
65
|
4 |
|
} |
|
66
|
8 |
|
} |
|
67
|
8 |
|
|
|
68
|
|
|
// Add the TOC to the Document |
|
69
|
|
|
$position = $this->config->get('table_of_contents/position'); |
|
70
|
|
|
if ($position === self::POSITION_TOP) { |
|
71
|
|
|
$document->prependChild($toc); |
|
72
|
|
|
} elseif ($position === self::POSITION_BEFORE_HEADINGS) { |
|
73
|
4 |
|
$this->insertBeforeFirstLinkedHeading($document, $toc); |
|
74
|
|
|
} elseif ($position === self::POSITION_PLACEHOLDER) { |
|
75
|
4 |
|
$this->replacePlaceholders($document, $toc); |
|
76
|
4 |
|
} else { |
|
77
|
4 |
|
throw InvalidConfigurationException::forConfigOption('table_of_contents/position', $position); |
|
78
|
|
|
} |
|
79
|
|
|
} |
|
80
|
4 |
|
|
|
81
|
4 |
|
/** |
|
82
|
4 |
|
* @psalm-param TableOfContents|TableOfContentsWrapper $toc |
|
83
|
|
|
* |
|
84
|
4 |
|
* @phpstan-param TableOfContents|TableOfContentsWrapper $toc |
|
85
|
|
|
*/ |
|
86
|
|
|
private function insertBeforeFirstLinkedHeading(Document $document, AbstractBlock $toc): void |
|
87
|
|
|
{ |
|
88
|
|
|
// @phpstan-ignore booleanAnd.alwaysFalse |
|
89
|
|
|
if (! $toc instanceof TableOfContents && ! $toc instanceof TableOfContentsWrapper) { |
|
90
|
8 |
|
throw new InvalidArgumentException( |
|
91
|
|
|
'Toc should be a TableOfContents or TableOfContentsWrapper, got ' . \get_class($toc) |
|
92
|
8 |
|
); |
|
93
|
|
|
} |
|
94
|
8 |
|
|
|
95
|
8 |
|
foreach ($document->iterator(NodeIterator::FLAG_BLOCKS_ONLY) as $node) { |
|
96
|
|
|
if (! $node instanceof Heading) { |
|
97
|
|
|
continue; |
|
98
|
4 |
|
} |
|
99
|
|
|
|
|
100
|
|
|
foreach ($node->children() as $child) { |
|
101
|
|
|
if ($child instanceof HeadingPermalink) { |
|
102
|
66 |
|
$node->insertBefore($toc); |
|
103
|
|
|
|
|
104
|
66 |
|
return; |
|
105
|
|
|
} |
|
106
|
|
|
} |
|
107
|
|
|
} |
|
108
|
|
|
} |
|
109
|
|
|
|
|
110
|
|
|
/** |
|
111
|
|
|
* @psalm-param TableOfContents|TableOfContentsWrapper $toc |
|
112
|
|
|
* |
|
113
|
|
|
* @phpstan-param TableOfContents|TableOfContentsWrapper $toc |
|
114
|
|
|
*/ |
|
115
|
|
|
private function replacePlaceholders(Document $document, AbstractBlock $toc): void |
|
116
|
|
|
{ |
|
117
|
|
|
// @phpstan-ignore booleanAnd.alwaysFalse |
|
118
|
|
|
if (! $toc instanceof TableOfContents && ! $toc instanceof TableOfContentsWrapper) { |
|
119
|
|
|
throw new InvalidArgumentException( |
|
120
|
|
|
'Toc should be a TableOfContents or TableOfContentsWrapper, got ' . \get_class($toc) |
|
121
|
|
|
); |
|
122
|
|
|
} |
|
123
|
|
|
|
|
124
|
|
|
foreach ($document->iterator(NodeIterator::FLAG_BLOCKS_ONLY) as $node) { |
|
125
|
|
|
// Add the block once we find a placeholder |
|
126
|
|
|
if (! $node instanceof TableOfContentsPlaceholder) { |
|
127
|
|
|
continue; |
|
128
|
|
|
} |
|
129
|
|
|
|
|
130
|
|
|
$node->replaceWith(clone $toc); |
|
131
|
|
|
} |
|
132
|
|
|
} |
|
133
|
|
|
|
|
134
|
|
|
public function setConfiguration(ConfigurationInterface $configuration): void |
|
135
|
|
|
{ |
|
136
|
|
|
$this->config = $configuration; |
|
137
|
|
|
} |
|
138
|
|
|
} |
|
139
|
|
|
|
thephpleague /
commonmark
