xref: /webtrees/app/CommonMark/XrefParser.php (revision 6f4ec3cadc983f0a7294108c634bef48846b4311) 
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\Gedcom;
23use Fisharebest\Webtrees\GedcomRecord;
24use Fisharebest\Webtrees\Registry;
25use Fisharebest\Webtrees\Tree;
26use League\CommonMark\Parser\Inline\InlineParserInterface;
27use League\CommonMark\Parser\Inline\InlineParserMatch;
28use League\CommonMark\Parser\InlineParserContext;
29
30/**
31 * Convert XREFs within markdown text to links
32 */
33class XrefParser implements InlineParserInterface
34{
35    private Tree $tree;
36
37    /**
38     * @param Tree $tree Match XREFs in this tree
39     */
40    public function __construct(Tree $tree)
41    {
42        $this->tree = $tree;
43    }
44
45    /**
46     * We are only interested in text that begins with '@'.
47     *
48     * @return InlineParserMatch
49     */
50    public function getMatchDefinition(): InlineParserMatch
51    {
52        return InlineParserMatch::regex('@(' . Gedcom::REGEX_XREF . ')@');
53    }
54
55    /**
56     * @param InlineParserContext $inlineContext
57     *
58     * @return bool
59     */
60    public function parse(InlineParserContext $inlineContext): bool
61    {
62        $cursor = $inlineContext->getCursor();
63        [$xref] = $inlineContext->getSubMatches();
64        $record = Registry::gedcomRecordFactory()->make($xref, $this->tree);
65
66        if ($record instanceof GedcomRecord) {
67            $cursor->advanceBy($inlineContext->getFullMatchLength());
68
69            $inlineContext->getContainer()->appendChild(new XrefNode($record));
70
71            return true;
72        }
73
74        return false;
75    }
76}
77