xref: /webtrees/app/Encodings/EncodingInterface.php (revision 8d018ab2fe3b6881cab8124d97e1a69e0be79d32) 
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\Encodings;
21
22/**
23 * Convert between UTF-8 and another encoding.
24 */
25interface EncodingInterface
26{
27    // Concrete classes should re-define this.  Use the ICONV name, where possible.
28    //public const NAME = '????';
29
30    /**
31     * Convert a string from UTF-8 encoding to another encoding.
32     *
33     * @param string $text
34     *
35     * @return string
36     */
37    public function fromUtf8(string $text): string;
38
39    /**
40     * Convert a string from another encoding to UTF-8 encoding.
41     *
42     * @param string $text
43     *
44     * @return string
45     */
46    public function toUtf8(string $text): string;
47
48    /**
49     * When reading multi-byte encodings using a stream, we must avoid incomplete characters.
50     *
51     * @param string $text
52     *
53     * @return int
54     */
55    public function convertibleBytes(string $text): int;
56}
57