Hyde\Framework\Actions\GeneratesTableOfContents

Complexity

Total Complexity

4

Size/Duplication

Total Lines	47
Duplicated Lines	0 %

Importance

Changes	6
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	extractTableOfContents()	0	10	2
A	execute()	0	26	1

<?php

declare(strict_types=1);

namespace Hyde\Framework\Actions;

use Hyde\Facades\Config;
use Hyde\Markdown\Models\Markdown;
use League\CommonMark\Environment\Environment;
use League\CommonMark\Extension\CommonMark\CommonMarkCoreExtension;
use League\CommonMark\Extension\HeadingPermalink\HeadingPermalinkExtension;
use League\CommonMark\Extension\TableOfContents\TableOfContentsExtension;
use League\CommonMark\MarkdownConverter;

use function strpos;
use function substr;

/**
 * Generates a table of contents for the Markdown document, most commonly used for the sidebar.
 */
class GeneratesTableOfContents
{
    protected string $markdown;

    public function __construct(Markdown|string $markdown)
    {
        $this->markdown = (string) $markdown;
    }

    public function execute(): string
    {
        $config = [
            'table_of_contents' => [
                'html_class' => 'table-of-contents',
                'position' => 'placeholder',
                'placeholder' => '[[START_TOC]]',
                'style' => 'bullet',
                'min_heading_level' => Config::getInt('docs.table_of_contents.min_heading_level', 2),
                'max_heading_level' => Config::getInt('docs.table_of_contents.max_heading_level', 4),
                'normalize' => 'relative',
            ],
            'heading_permalink' => [
                'fragment_prefix' => '',
            ],
        ];

        $environment = new Environment($config);
        $environment->addExtension(new CommonMarkCoreExtension());
        $environment->addExtension(new HeadingPermalinkExtension());
        $environment->addExtension(new TableOfContentsExtension());

        $converter = new MarkdownConverter($environment);
        $html = $converter->convert($this->markdown."\n[[START_TOC]]")->getContent();

        return $this->extractTableOfContents($html);
    }

    protected function extractTableOfContents(string $html): string
    {
        // The table of contents is always at the end of the document, so we can just strip everything before it.
        $position = strpos($html, '<ul class="table-of-contents">');
        if ($position === false) {
            // The document has no headings, so we'll just return an empty string.
            return '';
        }

        return substr($html, $position);
    }
}