xref: /webtrees/app/Contracts/EncodingFactoryInterface.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\Contracts;

use Fisharebest\Webtrees\Encodings\EncodingInterface;

/**
 * Create an encoding object.
 */
interface EncodingFactoryInterface
{
    /**
     * Detect an encoding from a GEDCOM header record.
     *
     * @param string $header
     *
     * @return EncodingInterface|null
     */
    public function detect(string $header): ?EncodingInterface;

    /**
     * Create a named encoding.
     *
     * @param string $name
     *
     * @return EncodingInterface
     */
    public function make(string $name): EncodingInterface;

    /**
     * A list of supported encodings and their names.
     *
     * @return array<string,string>
     */
    public function list(): array;
}