Commaaa2
This commit is contained in:
@@ -1,5 +1,7 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* This file is part of the league/commonmark package.
|
||||
*
|
||||
@@ -11,59 +13,36 @@
|
||||
|
||||
namespace League\CommonMark\Extension\TableOfContents;
|
||||
|
||||
use League\CommonMark\Block\Element\Document;
|
||||
use League\CommonMark\Block\Element\Heading;
|
||||
use League\CommonMark\Event\DocumentParsedEvent;
|
||||
use League\CommonMark\Exception\InvalidOptionException;
|
||||
use League\CommonMark\Extension\CommonMark\Node\Block\Heading;
|
||||
use League\CommonMark\Extension\HeadingPermalink\HeadingPermalink;
|
||||
use League\CommonMark\Extension\TableOfContents\Node\TableOfContents;
|
||||
use League\CommonMark\Extension\TableOfContents\Node\TableOfContentsPlaceholder;
|
||||
use League\CommonMark\Util\ConfigurationAwareInterface;
|
||||
use League\CommonMark\Util\ConfigurationInterface;
|
||||
use League\CommonMark\Node\Block\Document;
|
||||
use League\CommonMark\Node\NodeIterator;
|
||||
use League\Config\ConfigurationAwareInterface;
|
||||
use League\Config\ConfigurationInterface;
|
||||
use League\Config\Exception\InvalidConfigurationException;
|
||||
|
||||
final class TableOfContentsBuilder implements ConfigurationAwareInterface
|
||||
{
|
||||
/**
|
||||
* @deprecated Use TableOfContentsGenerator::STYLE_BULLET instead
|
||||
*/
|
||||
public const STYLE_BULLET = TableOfContentsGenerator::STYLE_BULLET;
|
||||
|
||||
/**
|
||||
* @deprecated Use TableOfContentsGenerator::STYLE_ORDERED instead
|
||||
*/
|
||||
public const STYLE_ORDERED = TableOfContentsGenerator::STYLE_ORDERED;
|
||||
|
||||
/**
|
||||
* @deprecated Use TableOfContentsGenerator::NORMALIZE_DISABLED instead
|
||||
*/
|
||||
public const NORMALIZE_DISABLED = TableOfContentsGenerator::NORMALIZE_DISABLED;
|
||||
|
||||
/**
|
||||
* @deprecated Use TableOfContentsGenerator::NORMALIZE_RELATIVE instead
|
||||
*/
|
||||
public const NORMALIZE_RELATIVE = TableOfContentsGenerator::NORMALIZE_RELATIVE;
|
||||
|
||||
/**
|
||||
* @deprecated Use TableOfContentsGenerator::NORMALIZE_FLAT instead
|
||||
*/
|
||||
public const NORMALIZE_FLAT = TableOfContentsGenerator::NORMALIZE_FLAT;
|
||||
|
||||
public const POSITION_TOP = 'top';
|
||||
public const POSITION_TOP = 'top';
|
||||
public const POSITION_BEFORE_HEADINGS = 'before-headings';
|
||||
public const POSITION_PLACEHOLDER = 'placeholder';
|
||||
public const POSITION_PLACEHOLDER = 'placeholder';
|
||||
|
||||
/** @var ConfigurationInterface */
|
||||
private $config;
|
||||
/** @psalm-readonly-allow-private-mutation */
|
||||
private ConfigurationInterface $config;
|
||||
|
||||
public function onDocumentParsed(DocumentParsedEvent $event): void
|
||||
{
|
||||
$document = $event->getDocument();
|
||||
|
||||
$generator = new TableOfContentsGenerator(
|
||||
$this->config->get('table_of_contents/style', TableOfContentsGenerator::STYLE_BULLET),
|
||||
$this->config->get('table_of_contents/normalize', TableOfContentsGenerator::NORMALIZE_RELATIVE),
|
||||
(int) $this->config->get('table_of_contents/min_heading_level', 1),
|
||||
(int) $this->config->get('table_of_contents/max_heading_level', 6)
|
||||
(string) $this->config->get('table_of_contents/style'),
|
||||
(string) $this->config->get('table_of_contents/normalize'),
|
||||
(int) $this->config->get('table_of_contents/min_heading_level'),
|
||||
(int) $this->config->get('table_of_contents/max_heading_level'),
|
||||
(string) $this->config->get('heading_permalink/fragment_prefix'),
|
||||
);
|
||||
|
||||
$toc = $generator->generate($document);
|
||||
@@ -73,13 +52,13 @@ final class TableOfContentsBuilder implements ConfigurationAwareInterface
|
||||
}
|
||||
|
||||
// Add custom CSS class(es), if defined
|
||||
$class = $this->config->get('table_of_contents/html_class', 'table-of-contents');
|
||||
if (!empty($class)) {
|
||||
$toc->data['attributes']['class'] = $class;
|
||||
$class = $this->config->get('table_of_contents/html_class');
|
||||
if ($class !== null) {
|
||||
$toc->data->append('attributes/class', $class);
|
||||
}
|
||||
|
||||
// Add the TOC to the Document
|
||||
$position = $this->config->get('table_of_contents/position', self::POSITION_TOP);
|
||||
$position = $this->config->get('table_of_contents/position');
|
||||
if ($position === self::POSITION_TOP) {
|
||||
$document->prependChild($toc);
|
||||
} elseif ($position === self::POSITION_BEFORE_HEADINGS) {
|
||||
@@ -87,41 +66,41 @@ final class TableOfContentsBuilder implements ConfigurationAwareInterface
|
||||
} elseif ($position === self::POSITION_PLACEHOLDER) {
|
||||
$this->replacePlaceholders($document, $toc);
|
||||
} else {
|
||||
throw new InvalidOptionException(\sprintf('Invalid config option "%s" for "table_of_contents/position"', $position));
|
||||
throw InvalidConfigurationException::forConfigOption('table_of_contents/position', $position);
|
||||
}
|
||||
}
|
||||
|
||||
private function insertBeforeFirstLinkedHeading(Document $document, TableOfContents $toc): void
|
||||
{
|
||||
$walker = $document->walker();
|
||||
while ($event = $walker->next()) {
|
||||
if ($event->isEntering() && ($node = $event->getNode()) instanceof HeadingPermalink && ($parent = $node->parent()) instanceof Heading) {
|
||||
$parent->insertBefore($toc);
|
||||
foreach ($document->iterator(NodeIterator::FLAG_BLOCKS_ONLY) as $node) {
|
||||
if (! $node instanceof Heading) {
|
||||
continue;
|
||||
}
|
||||
|
||||
return;
|
||||
foreach ($node->children() as $child) {
|
||||
if ($child instanceof HeadingPermalink) {
|
||||
$node->insertBefore($toc);
|
||||
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private function replacePlaceholders(Document $document, TableOfContents $toc): void
|
||||
{
|
||||
$walker = $document->walker();
|
||||
while ($event = $walker->next()) {
|
||||
// Add the block once we find a placeholder (and we're about to leave it)
|
||||
if (!$event->getNode() instanceof TableOfContentsPlaceholder) {
|
||||
foreach ($document->iterator(NodeIterator::FLAG_BLOCKS_ONLY) as $node) {
|
||||
// Add the block once we find a placeholder
|
||||
if (! $node instanceof TableOfContentsPlaceholder) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($event->isEntering()) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$event->getNode()->replaceWith(clone $toc);
|
||||
$node->replaceWith(clone $toc);
|
||||
}
|
||||
}
|
||||
|
||||
public function setConfiguration(ConfigurationInterface $config)
|
||||
public function setConfiguration(ConfigurationInterface $configuration): void
|
||||
{
|
||||
$this->config = $config;
|
||||
$this->config = $configuration;
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user