xref: /webtrees/app/Contracts/EncodingFactoryInterface.php (revision 2646b38f77cd9c3bce7f50f45c01724c9c469a1e) 
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    public function detect(string $header): EncodingInterface|null;
33
34    /**
35     * Create a named encoding.
36     *
37     * @param string $name
38     *
39     * @return EncodingInterface
40     */
41    public function make(string $name): EncodingInterface;
42
43    /**
44     * A list of supported encodings and their names.
45     *
46     * @return array<string,string>
47     */
48    public function list(): array;
49}
50