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