xref: /webtrees/app/Elements/FamilySearchFamilyTreeId.php (revision d11be7027e34e3121be11cc025421873364403f9)

<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2023 webtrees development team
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace Fisharebest\Webtrees\Elements;

use function strtoupper;

/**
 * ANCESTRAL_FILE_NUMBER := {Size=1:12}
 * A unique permanent record number of an individual record contained in the
 * Family History Department's Ancestral File.
 */
class FamilySearchFamilyTreeId extends AbstractExternalLink
{
    protected const EXTERNAL_URL = 'https://www.familysearch.org/tree/person/details/{ID}';

    protected const MAXIMUM_LENGTH = 8;

    /**
     * Convert a value to a canonical form.
     *
     * @param string $value
     *
     * @return string
     */
    public function canonical(string $value): string
    {
        return strtoupper(parent::canonical($value));
    }
}