xref: /webtrees/app/Contracts/EncodingFactoryInterface.php (revision 81b514b4672980e5db010e9d89b55eaf131e798f) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2023 webtrees development team
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <https://www.gnu.org/licenses/>.
16 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Contracts;
21
22use Fisharebest\Webtrees\Encodings\EncodingInterface;
23
24/**
25 * Create an encoding object.
26 */
27interface EncodingFactoryInterface
28{
29    /**
30     * Detect an encoding from a GEDCOM header record.
31     *
32     * @param string $header
33     *
34     * @return EncodingInterface|null
35     */
36    public function detect(string $header): ?EncodingInterface;
37
38    /**
39     * Create a named encoding.
40     *
41     * @param string $name
42     *
43     * @return EncodingInterface
44     */
45    public function make(string $name): EncodingInterface;
46
47    /**
48     * A list of supported encodings and their names.
49     *
50     * @return array<string,string>
51     */
52    public function list(): array;
53}
54