xref: /PHP-8.1/ext/mbstring/mbstring.stub.php (revision 8e6e9838) 
1<?php
2
3/** @generate-class-entries */
4
5/** @refcount 1 */
6function mb_language(?string $language = null): string|bool {}
7
8/** @refcount 1 */
9function mb_internal_encoding(?string $encoding = null): string|bool {}
10
11/**
12 * @return array<int, string>|string|false
13 * @refcount 1
14 */
15function mb_http_input(?string $type = null): array|string|false {}
16
17/** @refcount 1 */
18function mb_http_output(?string $encoding = null): string|bool {}
19
20/**
21 * @return array<int, string>|true
22 * @refcount 1
23 */
24function mb_detect_order(array|string|null $encoding = null): array|bool {}
25
26/** @refcount 1 */
27function mb_substitute_character(string|int|null $substitute_character = null): string|int|bool {}
28
29/** @refcount 1 */
30function mb_preferred_mime_name(string $encoding): string|false {}
31
32/** @param array $result */
33function mb_parse_str(string $string, &$result): bool {}
34
35/** @refcount 1 */
36function mb_output_handler(string $string, int $status): string {}
37
38function mb_str_split(string $string, int $length = 1, ?string $encoding = null): array {}
39
40function mb_strlen(string $string, ?string $encoding = null): int {}
41
42function mb_strpos(string $haystack, string $needle, int $offset = 0, ?string $encoding = null): int|false {}
43
44function mb_strrpos(string $haystack, string $needle, int $offset = 0, ?string $encoding = null): int|false {}
45
46function mb_stripos(string $haystack, string $needle, int $offset = 0, ?string $encoding = null): int|false {}
47
48function mb_strripos(string $haystack, string $needle, int $offset = 0, ?string $encoding = null): int|false {}
49
50/** @refcount 1 */
51function mb_strstr(string $haystack, string $needle, bool $before_needle = false, ?string $encoding = null): string|false {}
52
53/** @refcount 1 */
54function mb_strrchr(string $haystack, string $needle, bool $before_needle = false, ?string $encoding = null): string|false {}
55
56/** @refcount 1 */
57function mb_stristr(string $haystack, string $needle, bool $before_needle = false, ?string $encoding = null): string|false {}
58
59/** @refcount 1 */
60function mb_strrichr(string $haystack, string $needle, bool $before_needle = false, ?string $encoding = null): string|false {}
61
62function mb_substr_count(string $haystack, string $needle, ?string $encoding = null): int {}
63
64/** @refcount 1 */
65function mb_substr(string $string, int $start, ?int $length = null, ?string $encoding = null): string {}
66
67/** @refcount 1 */
68function mb_strcut(string $string, int $start, ?int $length = null, ?string $encoding = null): string {}
69
70function mb_strwidth(string $string, ?string $encoding = null): int {}
71
72/** @refcount 1 */
73function mb_strimwidth(string $string, int $start, int $width, string $trim_marker = "", ?string $encoding = null): string {}
74
75/**
76 * @return array<int|string, mixed>|string|false
77 * @refcount 1
78 */
79function mb_convert_encoding(array|string $string, string $to_encoding, array|string|null $from_encoding = null): array|string|false {}
80
81/** @refcount 1 */
82function mb_convert_case(string $string, int $mode, ?string $encoding = null): string {}
83
84/** @refcount 1 */
85function mb_strtoupper(string $string, ?string $encoding = null): string {}
86
87/** @refcount 1 */
88function mb_strtolower(string $string, ?string $encoding = null): string {}
89
90/** @refcount 1 */
91function mb_detect_encoding(string $string, array|string|null $encodings = null, bool $strict = false): string|false {}
92
93/**
94 * @return array<int, string>
95 * @refcount 1
96 */
97function mb_list_encodings(): array {}
98
99/**
100 * @return array<int, string>
101 * @refcount 1
102 */
103function mb_encoding_aliases(string $encoding): array {}
104
105/** @refcount 1 */
106function mb_encode_mimeheader(string $string, ?string $charset = null, ?string $transfer_encoding = null, string $newline = "\r\n", int $indent = 0): string {}
107
108/** @refcount 1 */
109function mb_decode_mimeheader(string $string): string {}
110
111/** @refcount 1 */
112function mb_convert_kana(string $string, string $mode = "KV", ?string $encoding = null): string {}
113
114/** @refcount 1 */
115function mb_convert_variables(string $to_encoding, array|string $from_encoding, mixed &$var, mixed &...$vars): string|false {}
116
117/** @refcount 1 */
118function mb_encode_numericentity(string $string, array $map, ?string $encoding = null, bool $hex = false): string {}
119
120/** @refcount 1 */
121function mb_decode_numericentity(string $string, array $map, ?string $encoding = null): string {}
122
123function mb_send_mail(string $to, string $subject, string $message, array|string $additional_headers = [], ?string $additional_params = null): bool {}
124
125/**
126 * @return array<int|string, int|string|array>|string|int|false
127 * @refcount 1
128 */
129function mb_get_info(string $type = "all"): array|string|int|false {}
130
131function mb_check_encoding(array|string|null $value = null, ?string $encoding = null): bool {}
132
133function mb_scrub(string $string, ?string $encoding = null): string {}
134
135function mb_ord(string $string, ?string $encoding = null): int|false {}
136
137function mb_chr(int $codepoint, ?string $encoding = null): string|false {}
138
139#ifdef HAVE_MBREGEX
140/** @refcount 1 */
141function mb_regex_encoding(?string $encoding = null): string|bool {}
142
143/** @param array $matches */
144function mb_ereg(string $pattern, string $string, &$matches = null): bool {}
145
146/** @param array $matches */
147function mb_eregi(string $pattern, string $string, &$matches = null): bool {}
148
149/** @refcount 1 */
150function mb_ereg_replace(string $pattern, string $replacement, string $string, ?string $options = null): string|false|null {}
151
152/** @refcount 1 */
153function mb_eregi_replace(string $pattern, string $replacement, string $string, ?string $options = null): string|false|null {}
154
155/** @refcount 1 */
156function mb_ereg_replace_callback(string $pattern, callable $callback, string $string, ?string $options = null): string|false|null {}
157
158/**
159 * @return array<int, string>|false
160 * @refcount 1
161 */
162function mb_split(string $pattern, string $string, int $limit = -1): array|false {}
163
164function mb_ereg_match(string $pattern, string $string, ?string $options = null): bool {}
165
166function mb_ereg_search(?string $pattern = null, ?string $options = null): bool {}
167
168/**
169 * @return array<int, int>|false
170 * @refcount 1
171 */
172function mb_ereg_search_pos(?string $pattern = null, ?string $options = null): array|false {}
173
174/**
175 * @return array<int|string, string|false>|false
176 * @refcount 1
177 */
178function mb_ereg_search_regs(?string $pattern = null, ?string $options = null): array|false {}
179
180function mb_ereg_search_init(string $string, ?string $pattern = null, ?string $options = null): bool {}
181
182/**
183 * @return array<int|string, string|false>|false
184 * @refcount 1
185 */
186function mb_ereg_search_getregs(): array|false {}
187
188function mb_ereg_search_getpos(): int {}
189
190function mb_ereg_search_setpos(int $offset): bool {}
191
192/** @refcount 1 */
193function mb_regex_set_options(?string $options = null): string {}
194#endif
195