xref: /webtrees/app/CommonMark/XrefExtension.php (revision b11cdcd45131b1585d66693fab363cfeb18c51a4)
1<?php
2
3/**
4 * webtrees: online genealogy
5 * 'Copyright (C) 2023 webtrees development team
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <https://www.gnu.org/licenses/>.
16 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\CommonMark;
21
22use Fisharebest\Webtrees\Tree;
23use League\CommonMark\Environment\EnvironmentBuilderInterface;
24use League\CommonMark\Extension\ExtensionInterface;
25
26/**
27 * Convert XREFs within markdown text to links
28 */
29class XrefExtension implements ExtensionInterface
30{
31    private Tree $tree;
32
33    /**
34     * MarkdownXrefParser constructor.
35     *
36     * @param Tree $tree Match XREFs in this tree
37     */
38    public function __construct(Tree $tree)
39    {
40        $this->tree = $tree;
41    }
42
43    /**
44     * @param EnvironmentBuilderInterface $environment
45     */
46    public function register(EnvironmentBuilderInterface $environment): void
47    {
48        $environment
49            ->addInlineParser(new XrefParser($this->tree))
50            ->addRenderer(XrefNode::class, new XrefRenderer());
51    }
52}
53