xref: /webtrees/app/CommonMark/XrefRenderer.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 League\CommonMark\Node\Node;
23use League\CommonMark\Renderer\ChildNodeRendererInterface;
24use League\CommonMark\Renderer\NodeRendererInterface;
25use League\CommonMark\Util\HtmlElement;
26use Stringable;
27
28/**
29 * Convert XREFs within markdown text to links
30 */
31class XrefRenderer implements NodeRendererInterface
32{
33    /**
34     * @param Node                       $node
35     * @param ChildNodeRendererInterface $childRenderer
36     *
37     * @return Stringable
38     */
39    public function render(Node $node, ChildNodeRendererInterface $childRenderer): Stringable
40    {
41        XrefNode::assertInstanceOf($node);
42
43        /** @var XrefNode $node */
44        $href = $node->record()->url();
45        $html = $node->record()->fullName();
46
47        return new HtmlElement('a', ['href' => $href], $html);
48    }
49}
50