xref: /webtrees/app/Elements/MultimediaFormat.php (revision 8c0307cf16655c4b150cca250af60f736bb4d9c3)

<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2021 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 strtolower;

/**
 * MULTIMEDIA_FORMAT := {Size=3:4}
 * [ bmp | gif | jpg | ole | pcx | tif | wav ]
 * Indicates the format of the multimedia data associated with the specific
 * GEDCOM context. This allows processors to determine whether they can process
 * the data object. Any linked files should contain the data required, in the
 * indicated format, to process the file data.
 */
class MultimediaFormat extends AbstractElement
{
    protected const SUBTAGS = [
        'TYPE' => '0:1',
    ];

    // GEDCOM uses the abbreviated versions of these extensions
    protected const EXTENSIONS = [
        'jpeg' => 'jpg',
        'tiff' => 'tif',
    ];

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

        return self::EXTENSIONS[$value] ?? $value;
    }
}