xref: /webtrees/app/Elements/AbstractXrefElement.php (revision 3340ecd27b8901a894bff51b7c40bfa2896a552b) 
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
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Elements;
21
22use Fisharebest\Webtrees\Gedcom;
23use Fisharebest\Webtrees\GedcomRecord;
24use Fisharebest\Webtrees\Tree;
25
26use function e;
27use function preg_match;
28
29/**
30 * Common behaviour for all XREF links
31 */
32class AbstractXrefElement extends AbstractElement
33{
34    /**
35     * Should we collapse the children of this element when editing?
36     *
37     * @return bool
38     */
39    public function collapseChildren(): bool
40    {
41        return true;
42    }
43
44    /**
45     * Escape @ signs in a GEDCOM export.
46     *
47     * @param string $value
48     *
49     * @return string
50     */
51    public function escape(string $value): string
52    {
53        return $value;
54    }
55
56    /**
57     * Display the value of this type of element - convert XREFs to links.
58     *
59     * @param string $value
60     * @param Tree   $tree
61     * @param mixed  $factory We can type-hint this from PHP 7.4
62     *
63     * @return string
64     */
65    protected function valueXrefLink(string $value, Tree $tree, $factory): string
66    {
67        if (preg_match('/^@(' . Gedcom::REGEX_XREF . ')@$/', $value, $match)) {
68            $record = $factory->make($match[1], $tree);
69
70            if ($record instanceof GedcomRecord) {
71                return '<a href="' . e($record->url()) . '">' . $record->fullName() . '</a>';
72            }
73        }
74
75        return '<span class="error">' . e($value) . '</span>';
76    }
77}
78