xref: /webtrees/app/Elements/GovIdentifier.php (revision e873f434551745f888937263ff89e80db3b0f785)
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\Tree;
23
24use function e;
25use function rawurlencode;
26
27/**
28 * A custom field used in _LOC records
29 */
30class GovIdentifier extends AbstractElement
31{
32    protected const string EXTERNAL_URL = 'https://gov.genealogy.net/item/show/';
33
34    protected const int MAXIMUM_LENGTH = 14;
35
36    /**
37     * Display the value of this type of element.
38     *
39     * @param string $value
40     * @param Tree   $tree
41     *
42     * @return string
43     */
44    public function value(string $value, Tree $tree): string
45    {
46        $canonical = $this->canonical($value);
47        $url       = static::EXTERNAL_URL . rawurlencode($canonical);
48
49        return '<a dir="ltr" href="' . e($url) . '" rel="nofollow">' . e($canonical) . '</a>';
50    }
51}
52