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