xref: /webtrees/app/Elements/FileName.php (revision d11be7027e34e3121be11cc025421873364403f9)
1c2ed51d1SGreg Roach<?php
2c2ed51d1SGreg Roach
3c2ed51d1SGreg Roach/**
4c2ed51d1SGreg Roach * webtrees: online genealogy
5*d11be702SGreg Roach * Copyright (C) 2023 webtrees development team
6c2ed51d1SGreg Roach * This program is free software: you can redistribute it and/or modify
7c2ed51d1SGreg Roach * it under the terms of the GNU General Public License as published by
8c2ed51d1SGreg Roach * the Free Software Foundation, either version 3 of the License, or
9c2ed51d1SGreg Roach * (at your option) any later version.
10c2ed51d1SGreg Roach * This program is distributed in the hope that it will be useful,
11c2ed51d1SGreg Roach * but WITHOUT ANY WARRANTY; without even the implied warranty of
12c2ed51d1SGreg Roach * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13c2ed51d1SGreg Roach * GNU General Public License for more details.
14c2ed51d1SGreg Roach * You should have received a copy of the GNU General Public License
15c2ed51d1SGreg Roach * along with this program. If not, see <https://www.gnu.org/licenses/>.
16c2ed51d1SGreg Roach */
17c2ed51d1SGreg Roach
18c2ed51d1SGreg Roachdeclare(strict_types=1);
19c2ed51d1SGreg Roach
20c2ed51d1SGreg Roachnamespace Fisharebest\Webtrees\Elements;
21c2ed51d1SGreg Roach
22c2ed51d1SGreg Roach/**
23c2ed51d1SGreg Roach * FILE_NAME := {Size=1:90}
24c2ed51d1SGreg Roach * The name of the GEDCOM transmission file. If the file name includes a file
25c2ed51d1SGreg Roach * extension it must be shown in the form (filename.ext).
26c2ed51d1SGreg Roach */
27c2ed51d1SGreg Roachclass FileName extends AbstractElement
28c2ed51d1SGreg Roach{
29ae0043b7SGreg Roach    protected const MAXIMUM_LENGTH = 90;
30c2ed51d1SGreg Roach
31c2ed51d1SGreg Roach    /**
32c2ed51d1SGreg Roach     * Convert a value to a canonical form.
33c2ed51d1SGreg Roach     *
34c2ed51d1SGreg Roach     * @param string $value
35c2ed51d1SGreg Roach     *
36c2ed51d1SGreg Roach     * @return string
37c2ed51d1SGreg Roach     */
38c2ed51d1SGreg Roach    public function canonical(string $value): string
39c2ed51d1SGreg Roach    {
403d2c98d1SGreg Roach        // Leading/trailing/multiple spaces are valid in filenames.
413d2c98d1SGreg Roach        return strtr($value, ["\t" => '', "\r" => '', "\n" => '']);
42c2ed51d1SGreg Roach    }
43c2ed51d1SGreg Roach}
44