xref: /webtrees/app/Elements/GovIdentifier.php (revision 5bfc689774bb9a6401271c4ed15a6d50652c991b)
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2022 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;
26use function strtoupper;
27
28/**
29 * A custom field used in _LOC records
30 */
31class GovIdentifier extends AbstractElement
32{
33    protected const EXTERNAL_URL = 'https://gov.genealogy.net/item/show/';
34
35    protected const MAXIMUM_LENGTH = 12;
36
37    /**
38     * Convert a value to a canonical form.
39     *
40     * @param string $value
41     *
42     * @return string
43     */
44    public function canonical(string $value): string
45    {
46        return strtoupper(parent::canonical($value));
47    }
48
49    /**
50     * Display the value of this type of element.
51     *
52     * @param string $value
53     * @param Tree   $tree
54     *
55     * @return string
56     */
57    public function value(string $value, Tree $tree): string
58    {
59        $canonical = $this->canonical($value);
60        $url       = static::EXTERNAL_URL . rawurlencode($canonical);
61
62        return '<a dir="ltr" href="' . e($url) . '" rel="nofollow">' . e($canonical) . '</a>';
63    }
64}
65