Passed
Push — markdown ( d911a6 )
by Greg
10:14
created

XrefParser::getMatchDefinition()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 1
nc 1
nop 0
dl 0
loc 3
rs 10
c 0
b 0
f 0
1
<?php
2
3
/**
4
 * webtrees: online genealogy
5
 * Copyright (C) 2021 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
18
declare(strict_types=1);
19
20
namespace Fisharebest\Webtrees\CommonMark;
21
22
use Fisharebest\Webtrees\Gedcom;
23
use Fisharebest\Webtrees\GedcomRecord;
24
use Fisharebest\Webtrees\Registry;
25
use Fisharebest\Webtrees\Tree;
26
use League\CommonMark\Parser\Inline\InlineParserInterface;
27
use League\CommonMark\Parser\Inline\InlineParserMatch;
28
use League\CommonMark\Parser\InlineParserContext;
29
30
/**
31
 * Convert XREFs within markdown text to links
32
 */
33
class XrefParser implements InlineParserInterface
34
{
35
    private Tree $tree;
36
37
    /**
38
     * MarkdownXrefParser constructor.
39
     *
40
     * @param Tree $tree Match XREFs in this tree
41
     */
42
    public function __construct(Tree $tree)
43
    {
44
        $this->tree = $tree;
45
    }
46
47
    /**
48
     * We are only interested in text that begins with '@'.
49
     *
50
     * @return InlineParserMatch
51
     */
52
    public function getMatchDefinition(): InlineParserMatch
53
    {
54
        return InlineParserMatch::regex('@(' . Gedcom::REGEX_XREF . ')@');
55
    }
56
57
    /**
58
     * @param InlineParserContext $inlineContext
59
     *
60
     * @return bool
61
     */
62
    public function parse(InlineParserContext $inlineContext): bool
63
    {
64
        $cursor = $inlineContext->getCursor();
65
        [$xref] = $inlineContext->getSubMatches();
66
        $record = Registry::gedcomRecordFactory()->make($xref, $this->tree);
67
68
        if ($record instanceof GedcomRecord) {
69
            $cursor->advanceBy($inlineContext->getFullMatchLength());
70
71
            $inlineContext->getContainer()->appendChild(new XrefNode($record));
72
73
            return true;
74
        }
75
76
        return false;
77
    }
78
}
79