xref: /webtrees/app/Elements/FileName.php (revision 2ebcf907ed34213f816592af04e6c160335d6311)
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
22/**
23 * FILE_NAME := {Size=1:90}
24 * The name of the GEDCOM transmission file. If the file name includes a file
25 * extension it must be shown in the form (filename.ext).
26 */
27class FileName extends AbstractElement
28{
29    protected const MAXIMUM_LENGTH = 90;
30
31    /**
32     * Convert a value to a canonical form.
33     *
34     * @param string $value
35     *
36     * @return string
37     */
38    public function canonical(string $value): string
39    {
40        // Leading/trailing/multiple spaces are valid in filenames.
41        return strtr($value, ["\t" => '', "\r" => '', "\n" => '']);
42    }
43}
44