xref: /webtrees/app/Elements/PhoneticType.php (revision e873f434551745f888937263ff89e80db3b0f785)

<?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;

/**
 * PHONETIC_TYPE := {Size=5:30}
 * [<user defined> | hangul | kana]
 * Indicates the method used in transforming the text to the phonetic variation.
 * <user define> record method used to arrive at the phonetic variation of the name.
 * hangul        Phonetic method for sounding Korean glifs.
 * kana          Hiragana and/or Katakana characters were used in sounding the Kanji
 *               character used by japanese
 */
class PhoneticType extends AbstractElement
{
    protected const int MAXIMUM_LENGTH = 30;

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

    /**
     * A list of controlled values for this element
     *
     * @return array<int|string,string>
     */
    public function values(): array
    {
        return [
            ''       => '',
            'HANGUL' => 'hangul',
            'KANA'   => 'kana',
        ];
    }
}