Debian Codegraph @

vendor/chillerlan/php-qrcode/src/Common/ECICharset.php

raw
1 <?php
2 /**
3 * Class ECICharset
4 *
5 * @created 21.01.2021
6 * @author ZXing Authors
7 * @author smiley <[email protected]>
8 * @copyright 2021 smiley
9 * @license Apache-2.0
10 */
11 declare(strict_types=1);
12
13 namespace chillerlan\QRCode\Common;
14
15 use chillerlan\QRCode\QRCodeException;
16 use function sprintf;
17
18 /**
19 * ISO/IEC 18004:2000 - 8.4.1 Extended Channel Interpretation (ECI) Mode
20 */
21 final class ECICharset{
22
23 public const CP437 = 0; // Code page 437, DOS Latin US
24 public const ISO_IEC_8859_1_GLI = 1; // GLI encoding with characters 0 to 127 identical to ISO/IEC 646 and characters 128 to 255 identical to ISO 8859-1
25 public const CP437_WO_GLI = 2; // An equivalent code table to CP437, without the return-to-GLI 0 logic
26 public const ISO_IEC_8859_1 = 3; // Latin-1 (Default)
27 public const ISO_IEC_8859_2 = 4; // Latin-2
28 public const ISO_IEC_8859_3 = 5; // Latin-3
29 public const ISO_IEC_8859_4 = 6; // Latin-4
30 public const ISO_IEC_8859_5 = 7; // Latin/Cyrillic
31 public const ISO_IEC_8859_6 = 8; // Latin/Arabic
32 public const ISO_IEC_8859_7 = 9; // Latin/Greek
33 public const ISO_IEC_8859_8 = 10; // Latin/Hebrew
34 public const ISO_IEC_8859_9 = 11; // Latin-5
35 public const ISO_IEC_8859_10 = 12; // Latin-6
36 public const ISO_IEC_8859_11 = 13; // Latin/Thai
37 // 14 reserved
38 public const ISO_IEC_8859_13 = 15; // Latin-7 (Baltic Rim)
39 public const ISO_IEC_8859_14 = 16; // Latin-8 (Celtic)
40 public const ISO_IEC_8859_15 = 17; // Latin-9
41 public const ISO_IEC_8859_16 = 18; // Latin-10
42 // 19 reserved
43 public const SHIFT_JIS = 20; // JIS X 0208 Annex 1 + JIS X 0201
44 public const WINDOWS_1250_LATIN_2 = 21; // Superset of Latin-2, Central Europe
45 public const WINDOWS_1251_CYRILLIC = 22; // Latin/Cyrillic
46 public const WINDOWS_1252_LATIN_1 = 23; // Superset of Latin-1
47 public const WINDOWS_1256_ARABIC = 24;
48 public const ISO_IEC_10646_UCS_2 = 25; // High order byte first (UTF-16BE)
49 public const ISO_IEC_10646_UTF_8 = 26; // UTF-8
50 public const ISO_IEC_646_1991 = 27; // International Reference Version of ISO 7-bit coded character set (US-ASCII)
51 public const BIG5 = 28; // Big 5 (Taiwan) Chinese Character Set
52 public const GB18030 = 29; // GB (PRC) Chinese Character Set
53 public const EUC_KR = 30; // Korean Character Set
54
55 /**
56 * map of charset id -> name
57 *
58 * @see \mb_list_encodings()
59 */
60 public const MB_ENCODINGS = [
61 self::CP437 => null,
62 self::ISO_IEC_8859_1_GLI => null,
63 self::CP437_WO_GLI => null,
64 self::ISO_IEC_8859_1 => 'ISO-8859-1',
65 self::ISO_IEC_8859_2 => 'ISO-8859-2',
66 self::ISO_IEC_8859_3 => 'ISO-8859-3',
67 self::ISO_IEC_8859_4 => 'ISO-8859-4',
68 self::ISO_IEC_8859_5 => 'ISO-8859-5',
69 self::ISO_IEC_8859_6 => 'ISO-8859-6',
70 self::ISO_IEC_8859_7 => 'ISO-8859-7',
71 self::ISO_IEC_8859_8 => 'ISO-8859-8',
72 self::ISO_IEC_8859_9 => 'ISO-8859-9',
73 self::ISO_IEC_8859_10 => 'ISO-8859-10',
74 self::ISO_IEC_8859_11 => null,
75 self::ISO_IEC_8859_13 => 'ISO-8859-13',
76 self::ISO_IEC_8859_14 => 'ISO-8859-14',
77 self::ISO_IEC_8859_15 => 'ISO-8859-15',
78 self::ISO_IEC_8859_16 => 'ISO-8859-16',
79 self::SHIFT_JIS => 'SJIS',
80 self::WINDOWS_1250_LATIN_2 => null, // @see https://www.php.net/manual/en/function.mb-convert-encoding.php#112547
81 self::WINDOWS_1251_CYRILLIC => 'Windows-1251',
82 self::WINDOWS_1252_LATIN_1 => 'Windows-1252',
83 self::WINDOWS_1256_ARABIC => null, // @see https://stackoverflow.com/a/8592995
84 self::ISO_IEC_10646_UCS_2 => 'UTF-16BE',
85 self::ISO_IEC_10646_UTF_8 => 'UTF-8',
86 self::ISO_IEC_646_1991 => 'ASCII',
87 self::BIG5 => 'BIG-5',
88 self::GB18030 => 'GB18030',
89 self::EUC_KR => 'EUC-KR',
90 ];
91
92 /**
93 * The current ECI character set ID
94 */
95 private int $charsetID;
96
97 /**
98 * @throws \chillerlan\QRCode\QRCodeException
99 */
100 public function __construct(int $charsetID){
101
102 if($charsetID < 0 || $charsetID > 999999){
103 throw new QRCodeException(sprintf('invalid charset id: "%s"', $charsetID));
104 }
105
106 $this->charsetID = $charsetID;
107 }
108
109 /**
110 * Returns the current character set ID
111 * @deprecated 6.0.1 This method will be removed. In v7, use the property "ECICharset::$charsetID" instead.
112 */
113 public function getID():int{
114 return $this->charsetID;
115 }
116
117 /**
118 * Returns the name of the current character set or null if no name is available
119 *
120 * @see \mb_convert_encoding()
121 * @see \iconv()
122 */
123 public function getName():string|null{
124 return (self::MB_ENCODINGS[$this->charsetID] ?? null);
125 }
126
127 }