xref: /webtrees/app/Elements/AncestralFileNumber.php (revision c2ed51d13a57743094c11c8fe84befd9d4f158cd)
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 strtoupper;
26
27/**
28 * ANCESTRAL_FILE_NUMBER := {Size=1:12}
29 * A unique permanent record number of an individual record contained in the
30 * Family History Department's Ancestral File.
31 */
32class AncestralFileNumber extends AbstractElement
33{
34    protected const MAX_LENGTH = 12;
35
36    /**
37     * Convert a value to a canonical form.
38     *
39     * @param string $value
40     *
41     * @return string
42     */
43    public function canonical(string $value): string
44    {
45        return strtoupper(parent::canonical($value));
46    }
47
48    /**
49     * Display the value of this type of element.
50     *
51     * @param string $value
52     * @param Tree   $tree
53     *
54     * @return string
55     */
56    public function value(string $value, Tree $tree): string
57    {
58        return '<span dir="ltr">' . e($this->canonical($value)) . '</span>';
59    }
60}
61