xref: /webtrees/app/Elements/AncestralFileNumber.php (revision 31fd4d4144a406cbee12959609e922a7a960533e)
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\Tree;
23
24use function e;
25use function rawurlencode;
26use function strtoupper;
27
28/**
29 * ANCESTRAL_FILE_NUMBER := {Size=1:12}
30 * A unique permanent record number of an individual record contained in the
31 * Family History Department's Ancestral File.
32 */
33class AncestralFileNumber extends AbstractElement
34{
35    protected const EXTERNAL_URL = 'https://www.familysearch.org/search/family-trees/results?q.afnId=';
36
37    protected const MAX_LENGTH = 12;
38
39    /**
40     * Convert a value to a canonical form.
41     *
42     * @param string $value
43     *
44     * @return string
45     */
46    public function canonical(string $value): string
47    {
48        return strtoupper(parent::canonical($value));
49    }
50
51    /**
52     * Display the value of this type of element.
53     *
54     * @param string $value
55     * @param Tree   $tree
56     *
57     * @return string
58     */
59    public function value(string $value, Tree $tree): string
60    {
61        $canonical = $this->canonical($value);
62        $url       = static::EXTERNAL_URL . rawurlencode($canonical);
63
64        return '<a dir="ltr" href="' . e($url) . '" rel="nofollow">' . e($canonical) . '</a>';
65    }
66}
67