Debian Codegraph @

codelitephp/resources/cc/mbstring.php

raw
1 <?php
2
3 // Start of mbstring v.
4
5 /**
6 * Perform case folding on a string
7 * @link http://www.php.net/manual/en/function.mb-convert-case.php
8 * @param str string <p>
9 * The string being converted.
10 * </p>
11 * @param mode int <p>
12 * The mode of the conversion. It can be one of
13 * MB_CASE_UPPER,
14 * MB_CASE_LOWER, or
15 * MB_CASE_TITLE.
16 * </p>
17 * @param encoding string[optional] &mbstring.encoding.parameter;
18 * @return string A case folded version of string converted in the
19 * way specified by mode.
20 */
21 function mb_convert_case ($str, $mode, $encoding = null) {}
22
23 /**
24 * Make a string uppercase
25 * @link http://www.php.net/manual/en/function.mb-strtoupper.php
26 * @param str string <p>
27 * The string being uppercased.
28 * </p>
29 * @param encoding string[optional] &mbstring.encoding.parameter;
30 * @return string str with all alphabetic characters converted to uppercase.
31 */
32 function mb_strtoupper ($str, $encoding = null) {}
33
34 /**
35 * Make a string lowercase
36 * @link http://www.php.net/manual/en/function.mb-strtolower.php
37 * @param str string <p>
38 * The string being lowercased.
39 * </p>
40 * @param encoding string[optional] &mbstring.encoding.parameter;
41 * @return string str with all alphabetic characters converted to lowercase.
42 */
43 function mb_strtolower ($str, $encoding = null) {}
44
45 /**
46 * Set/Get current language
47 * @link http://www.php.net/manual/en/function.mb-language.php
48 * @param language string[optional] <p>
49 * Used for encoding
50 * e-mail messages. Valid languages are "Japanese",
51 * "ja","English","en" and "uni"
52 * (UTF-8). mb_send_mail uses this setting to
53 * encode e-mail.
54 * </p>
55 * <p>
56 * Language and its setting is ISO-2022-JP/Base64 for
57 * Japanese, UTF-8/Base64 for uni, ISO-8859-1/quoted printable for
58 * English.
59 * </p>
60 * @return mixed If language is set and
61 * language is valid, it returns
62 * true. Otherwise, it returns false.
63 * When language is omitted, it returns the language
64 * name as a string. If no language is set previously, it then returns
65 * false.
66 */
67 function mb_language ($language = null) {}
68
69 /**
70 * Set/Get internal character encoding
71 * @link http://www.php.net/manual/en/function.mb-internal-encoding.php
72 * @param encoding string[optional] <p>
73 * encoding is the character encoding name
74 * used for the HTTP input character encoding conversion, HTTP output
75 * character encoding conversion, and the default character encoding
76 * for string functions defined by the mbstring module.
77 * You should notice that the internal encoding is totally different from the one for multibyte regex.
78 * </p>
79 * @return mixed If encoding is set, then
80 * Returns true on success, false on failure.
81 * In this case, the character encoding for multibyte regex is NOT changed.
82 * If encoding is omitted, then
83 * the current character encoding name is returned.
84 */
85 function mb_internal_encoding ($encoding = null) {}
86
87 /**
88 * Detect HTTP input character encoding
89 * @link http://www.php.net/manual/en/function.mb-http-input.php
90 * @param type string[optional] <p>
91 * Input string specifies the input type.
92 * "G" for GET, "P" for POST, "C" for COOKIE, "S" for string, "L" for list, and
93 * "I" for the whole list (will return array).
94 * If type is omitted, it returns the last input type processed.
95 * </p>
96 * @return mixed The character encoding name, as per the type.
97 * If mb_http_input does not process specified
98 * HTTP input, it returns false.
99 */
100 function mb_http_input ($type = null) {}
101
102 /**
103 * Set/Get HTTP output character encoding
104 * @link http://www.php.net/manual/en/function.mb-http-output.php
105 * @param encoding string[optional] <p>
106 * If encoding is set,
107 * mb_http_output sets the HTTP output character
108 * encoding to encoding.
109 * </p>
110 * <p>
111 * If encoding is omitted,
112 * mb_http_output returns the current HTTP output
113 * character encoding.
114 * </p>
115 * @return mixed If encoding is omitted,
116 * mb_http_output returns the current HTTP output
117 * character encoding. Otherwise,
118 * Returns true on success, false on failure.
119 */
120 function mb_http_output ($encoding = null) {}
121
122 /**
123 * Set/Get character encoding detection order
124 * @link http://www.php.net/manual/en/function.mb-detect-order.php
125 * @param encoding_list mixed[optional] <p>
126 * encoding_list is an array or
127 * comma separated list of character encoding. See supported encodings.
128 * </p>
129 * <p>
130 * If encoding_list is omitted, it returns
131 * the current character encoding detection order as array.
132 * </p>
133 * <p>
134 * This setting affects mb_detect_encoding and
135 * mb_send_mail.
136 * </p>
137 * <p>
138 * mbstring currently implements the following
139 * encoding detection filters. If there is an invalid byte sequence
140 * for the following encodings, encoding detection will fail.
141 * </p>
142 *
143 * UTF-8, UTF-7,
144 * ASCII,
145 * EUC-JP,SJIS,
146 * eucJP-win, SJIS-win,
147 * JIS, ISO-2022-JP
148 *
149 * <p>
150 * For ISO-8859-*, mbstring
151 * always detects as ISO-8859-*.
152 * </p>
153 * <p>
154 * For UTF-16, UTF-32,
155 * UCS2 and UCS4, encoding
156 * detection will fail always.
157 * </p>
158 * @return mixed Returns true on success, false on failure.
159 */
160 function mb_detect_order ($encoding_list = null) {}
161
162 /**
163 * Set/Get substitution character
164 * @link http://www.php.net/manual/en/function.mb-substitute-character.php
165 * @param substrchar mixed[optional] <p>
166 * Specify the Unicode value as an integer,
167 * or as one of the following strings:
168 *
169 *
170 *
171 * "none": no output
172 * @return mixed If substchar is set, it returns true for success,
173 * otherwise returns false.
174 * If substchar is not set, it returns the current
175 * setting.
176 */
177 function mb_substitute_character ($substrchar = null) {}
178
179 /**
180 * Parse GET/POST/COOKIE data and set global variable
181 * @link http://www.php.net/manual/en/function.mb-parse-str.php
182 * @param encoded_string string <p>
183 * The URL encoded data.
184 * </p>
185 * @param result array[optional] <p>
186 * An array containing decoded and character encoded converted values.
187 * </p>
188 * @return bool Returns true on success, false on failure.
189 */
190 function mb_parse_str ($encoded_string, array &$result = null) {}
191
192 /**
193 * Callback function converts character encoding in output buffer
194 * @link http://www.php.net/manual/en/function.mb-output-handler.php
195 * @param contents string <p>
196 * The contents of the output buffer.
197 * </p>
198 * @param status int <p>
199 * The status of the output buffer.
200 * </p>
201 * @return string The converted string.
202 */
203 function mb_output_handler ($contents, $status) {}
204
205 /**
206 * Get MIME charset string
207 * @link http://www.php.net/manual/en/function.mb-preferred-mime-name.php
208 * @param encoding string <p>
209 * The encoding being checked.
210 * </p>
211 * @return string The MIME charset string for character encoding
212 * encoding.
213 */
214 function mb_preferred_mime_name ($encoding) {}
215
216 /**
217 * Get string length
218 * @link http://www.php.net/manual/en/function.mb-strlen.php
219 * @param str string <p>
220 * The string being checked for length.
221 * </p>
222 * @param encoding string[optional] &mbstring.encoding.parameter;
223 * @return mixed the number of characters in
224 * string str having character encoding
225 * encoding. A multi-byte character is
226 * counted as 1.
227 * </p>
228 * <p>
229 * Returns false if the given encoding is invalid.
230 */
231 function mb_strlen ($str, $encoding = null) {}
232
233 /**
234 * Find position of first occurrence of string in a string
235 * @link http://www.php.net/manual/en/function.mb-strpos.php
236 * @param haystack string <p>
237 * The string being checked.
238 * </p>
239 * @param needle string <p>
240 * The string to find in haystack. In contrast
241 * with strpos, numeric values are not applied
242 * as the ordinal value of a character.
243 * </p>
244 * @param offset int[optional] <p>
245 * The search offset. If it is not specified, 0 is used.
246 * </p>
247 * @param encoding string[optional] &mbstring.encoding.parameter;
248 * @return int the numeric position of
249 * the first occurrence of needle in the
250 * haystack string. If
251 * needle is not found, it returns false.
252 */
253 function mb_strpos ($haystack, $needle, $offset = null, $encoding = null) {}
254
255 /**
256 * Find position of last occurrence of a string in a string
257 * @link http://www.php.net/manual/en/function.mb-strrpos.php
258 * @param haystack string <p>
259 * The string being checked, for the last occurrence
260 * of needle
261 * </p>
262 * @param needle string <p>
263 * The string to find in haystack.
264 * </p>
265 * @param offset int[optional] May be specified to begin searching an arbitrary number of characters into
266 * the string. Negative values will stop searching at an arbitrary point
267 * prior to the end of the string.
268 * @param encoding string[optional] &mbstring.encoding.parameter;
269 * @return int the numeric position of
270 * the last occurrence of needle in the
271 * haystack string. If
272 * needle is not found, it returns false.
273 */
274 function mb_strrpos ($haystack, $needle, $offset = null, $encoding = null) {}
275
276 /**
277 * Finds position of first occurrence of a string within another, case insensitive
278 * @link http://www.php.net/manual/en/function.mb-stripos.php
279 * @param haystack string <p>
280 * The string from which to get the position of the first occurrence
281 * of needle
282 * </p>
283 * @param needle string <p>
284 * The string to find in haystack
285 * </p>
286 * @param offset int[optional] <p>
287 * The position in haystack
288 * to start searching
289 * </p>
290 * @param encoding string[optional] <p>
291 * Character encoding name to use.
292 * If it is omitted, internal character encoding is used.
293 * </p>
294 * @return int Return the numeric position of the first occurrence of
295 * needle in the haystack
296 * string, or false if needle is not found.
297 */
298 function mb_stripos ($haystack, $needle, $offset = null, $encoding = null) {}
299
300 /**
301 * Finds position of last occurrence of a string within another, case insensitive
302 * @link http://www.php.net/manual/en/function.mb-strripos.php
303 * @param haystack string <p>
304 * The string from which to get the position of the last occurrence
305 * of needle
306 * </p>
307 * @param needle string <p>
308 * The string to find in haystack
309 * </p>
310 * @param offset int[optional] <p>
311 * The position in haystack
312 * to start searching
313 * </p>
314 * @param encoding string[optional] <p>
315 * Character encoding name to use.
316 * If it is omitted, internal character encoding is used.
317 * </p>
318 * @return int Return the numeric position of
319 * the last occurrence of needle in the
320 * haystack string, or false
321 * if needle is not found.
322 */
323 function mb_strripos ($haystack, $needle, $offset = null, $encoding = null) {}
324
325 /**
326 * Finds first occurrence of a string within another
327 * @link http://www.php.net/manual/en/function.mb-strstr.php
328 * @param haystack string <p>
329 * The string from which to get the first occurrence
330 * of needle
331 * </p>
332 * @param needle string <p>
333 * The string to find in haystack
334 * </p>
335 * @param before_needle bool[optional] <p>
336 * Determines which portion of haystack
337 * this function returns.
338 * If set to true, it returns all of haystack
339 * from the beginning to the first occurrence of needle (excluding needle).
340 * If set to false, it returns all of haystack
341 * from the first occurrence of needle to the end (including needle).
342 * </p>
343 * @param encoding string[optional] <p>
344 * Character encoding name to use.
345 * If it is omitted, internal character encoding is used.
346 * </p>
347 * @return string the portion of haystack,
348 * or false if needle is not found.
349 */
350 function mb_strstr ($haystack, $needle, $before_needle = null, $encoding = null) {}
351
352 /**
353 * Finds the last occurrence of a character in a string within another
354 * @link http://www.php.net/manual/en/function.mb-strrchr.php
355 * @param haystack string <p>
356 * The string from which to get the last occurrence
357 * of needle
358 * </p>
359 * @param needle string <p>
360 * The string to find in haystack
361 * </p>
362 * @param part bool[optional] <p>
363 * Determines which portion of haystack
364 * this function returns.
365 * If set to true, it returns all of haystack
366 * from the beginning to the last occurrence of needle.
367 * If set to false, it returns all of haystack
368 * from the last occurrence of needle to the end,
369 * </p>
370 * @param encoding string[optional] <p>
371 * Character encoding name to use.
372 * If it is omitted, internal character encoding is used.
373 * </p>
374 * @return string the portion of haystack.
375 * or false if needle is not found.
376 */
377 function mb_strrchr ($haystack, $needle, $part = null, $encoding = null) {}
378
379 /**
380 * Finds first occurrence of a string within another, case insensitive
381 * @link http://www.php.net/manual/en/function.mb-stristr.php
382 * @param haystack string <p>
383 * The string from which to get the first occurrence
384 * of needle
385 * </p>
386 * @param needle string <p>
387 * The string to find in haystack
388 * </p>
389 * @param before_needle bool[optional] <p>
390 * Determines which portion of haystack
391 * this function returns.
392 * If set to true, it returns all of haystack
393 * from the beginning to the first occurrence of needle (excluding needle).
394 * If set to false, it returns all of haystack
395 * from the first occurrence of needle to the end (including needle).
396 * </p>
397 * @param encoding string[optional] <p>
398 * Character encoding name to use.
399 * If it is omitted, internal character encoding is used.
400 * </p>
401 * @return string the portion of haystack,
402 * or false if needle is not found.
403 */
404 function mb_stristr ($haystack, $needle, $before_needle = null, $encoding = null) {}
405
406 /**
407 * Finds the last occurrence of a character in a string within another, case insensitive
408 * @link http://www.php.net/manual/en/function.mb-strrichr.php
409 * @param haystack string <p>
410 * The string from which to get the last occurrence
411 * of needle
412 * </p>
413 * @param needle string <p>
414 * The string to find in haystack
415 * </p>
416 * @param part bool[optional] <p>
417 * Determines which portion of haystack
418 * this function returns.
419 * If set to true, it returns all of haystack
420 * from the beginning to the last occurrence of needle.
421 * If set to false, it returns all of haystack
422 * from the last occurrence of needle to the end,
423 * </p>
424 * @param encoding string[optional] <p>
425 * Character encoding name to use.
426 * If it is omitted, internal character encoding is used.
427 * </p>
428 * @return string the portion of haystack.
429 * or false if needle is not found.
430 */
431 function mb_strrichr ($haystack, $needle, $part = null, $encoding = null) {}
432
433 /**
434 * Count the number of substring occurrences
435 * @link http://www.php.net/manual/en/function.mb-substr-count.php
436 * @param haystack string <p>
437 * The string being checked.
438 * </p>
439 * @param needle string <p>
440 * The string being found.
441 * </p>
442 * @param encoding string[optional] &mbstring.encoding.parameter;
443 * @return int The number of times the
444 * needle substring occurs in the
445 * haystack string.
446 */
447 function mb_substr_count ($haystack, $needle, $encoding = null) {}
448
449 /**
450 * Get part of string
451 * @link http://www.php.net/manual/en/function.mb-substr.php
452 * @param str string <p>
453 * The string to extract the substring from.
454 * </p>
455 * @param start int <p>
456 * Position of first character to use from str.
457 * </p>
458 * @param length int[optional] <p>
459 * Maximum number of characters to use from str. If
460 * omitted or NULL is passed, extract all characters to
461 * the end of the string.
462 * </p>
463 * @param encoding string[optional] &mbstring.encoding.parameter;
464 * @return string mb_substr returns the portion of
465 * str specified by the
466 * start and
467 * length parameters.
468 */
469 function mb_substr ($str, $start, $length = null, $encoding = null) {}
470
471 /**
472 * Get part of string
473 * @link http://www.php.net/manual/en/function.mb-strcut.php
474 * @param str string <p>
475 * The string being cut.
476 * </p>
477 * @param start int <p>
478 * Starting position in bytes.
479 * </p>
480 * @param length int[optional] <p>
481 * Length in bytes. If omitted or NULL
482 * is passed, extract all bytes to the end of the string.
483 * </p>
484 * @param encoding string[optional] &mbstring.encoding.parameter;
485 * @return string mb_strcut returns the portion of
486 * str specified by the
487 * start and
488 * length parameters.
489 */
490 function mb_strcut ($str, $start, $length = null, $encoding = null) {}
491
492 /**
493 * Return width of string
494 * @link http://www.php.net/manual/en/function.mb-strwidth.php
495 * @param str string <p>
496 * The string being decoded.
497 * </p>
498 * @param encoding string[optional] &mbstring.encoding.parameter;
499 * @return int The width of string str.
500 */
501 function mb_strwidth ($str, $encoding = null) {}
502
503 /**
504 * Get truncated string with specified width
505 * @link http://www.php.net/manual/en/function.mb-strimwidth.php
506 * @param str string <p>
507 * The string being decoded.
508 * </p>
509 * @param start int <p>
510 * The start position offset. Number of
511 * characters from the beginning of string. (First character is 0)
512 * </p>
513 * @param width int <p>
514 * The width of the desired trim.
515 * </p>
516 * @param trimmarker string[optional] <p>
517 * A string that is added to the end of string
518 * when string is truncated.
519 * </p>
520 * @param encoding string[optional] &mbstring.encoding.parameter;
521 * @return string The truncated string. If trimmarker is set,
522 * trimmarker is appended to the return value.
523 */
524 function mb_strimwidth ($str, $start, $width, $trimmarker = null, $encoding = null) {}
525
526 /**
527 * Convert character encoding
528 * @link http://www.php.net/manual/en/function.mb-convert-encoding.php
529 * @param str string <p>
530 * The string being encoded.
531 * </p>
532 * @param to_encoding string <p>
533 * The type of encoding that str is being converted to.
534 * </p>
535 * @param from_encoding mixed[optional] <p>
536 * Is specified by character code names before conversion. It is either
537 * an array, or a comma separated enumerated list.
538 * If from_encoding is not specified, the internal
539 * encoding will be used.
540 *
541 * </p>
542 * <p>
543 * See supported
544 * encodings.
545 * </p>
546 * @return string The encoded string.
547 */
548 function mb_convert_encoding ($str, $to_encoding, $from_encoding = null) {}
549
550 /**
551 * Detect character encoding
552 * @link http://www.php.net/manual/en/function.mb-detect-encoding.php
553 * @param str string <p>
554 * The string being detected.
555 * </p>
556 * @param encoding_list mixed[optional] <p>
557 * encoding_list is list of character
558 * encoding. Encoding order may be specified by array or comma
559 * separated list string.
560 * </p>
561 * <p>
562 * If encoding_list is omitted,
563 * detect_order is used.
564 * </p>
565 * @param strict bool[optional] <p>
566 * strict specifies whether to use
567 * the strict encoding detection or not.
568 * Default is false.
569 * </p>
570 * @return string The detected character encoding or false if the encoding cannot be
571 * detected from the given string.
572 */
573 function mb_detect_encoding ($str, $encoding_list = null, $strict = null) {}
574
575 /**
576 * Returns an array of all supported encodings
577 * @link http://www.php.net/manual/en/function.mb-list-encodings.php
578 * @return array a numerically indexed array.
579 */
580 function mb_list_encodings () {}
581
582 /**
583 * Get aliases of a known encoding type
584 * @link http://www.php.net/manual/en/function.mb-encoding-aliases.php
585 * @param encoding string <p>
586 * The encoding type being checked, for aliases.
587 * </p>
588 * @return array a numerically indexed array of encoding aliases on success,
589 * &return.falseforfailure;
590 */
591 function mb_encoding_aliases ($encoding) {}
592
593 /**
594 * Convert "kana" one from another ("zen-kaku", "han-kaku" and more)
595 * @link http://www.php.net/manual/en/function.mb-convert-kana.php
596 * @param str string <p>
597 * The string being converted.
598 * </p>
599 * @param option string[optional] <p>
600 * The conversion option.
601 * </p>
602 * <p>
603 * Specify with a combination of following options.
604 * <table>
605 * Applicable Conversion Options
606 *
607 *
608 * <tr valign="top">
609 * <td>Option</td>
610 * <td>Meaning</td>
611 * </tr>
612 *
613 *
614 * <tr valign="top">
615 * <td>r</td>
616 * <td>
617 * Convert "zen-kaku" alphabets to "han-kaku"
618 * </td>
619 * </tr>
620 * <tr valign="top">
621 * <td>R</td>
622 * <td>
623 * Convert "han-kaku" alphabets to "zen-kaku"
624 * </td>
625 * </tr>
626 * <tr valign="top">
627 * <td>n</td>
628 * <td>
629 * Convert "zen-kaku" numbers to "han-kaku"
630 * </td>
631 * </tr>
632 * <tr valign="top">
633 * <td>N</td>
634 * <td>
635 * Convert "han-kaku" numbers to "zen-kaku"
636 * </td>
637 * </tr>
638 * <tr valign="top">
639 * <td>a</td>
640 * <td>
641 * Convert "zen-kaku" alphabets and numbers to "han-kaku"
642 * </td>
643 * </tr>
644 * <tr valign="top">
645 * <td>A</td>
646 * <td>
647 * Convert "han-kaku" alphabets and numbers to "zen-kaku"
648 * (Characters included in "a", "A" options are
649 * U+0021 - U+007E excluding U+0022, U+0027, U+005C, U+007E)
650 * </td>
651 * </tr>
652 * <tr valign="top">
653 * <td>s</td>
654 * <td>
655 * Convert "zen-kaku" space to "han-kaku" (U+3000 -> U+0020)
656 * </td>
657 * </tr>
658 * <tr valign="top">
659 * <td>S</td>
660 * <td>
661 * Convert "han-kaku" space to "zen-kaku" (U+0020 -> U+3000)
662 * </td>
663 * </tr>
664 * <tr valign="top">
665 * <td>k</td>
666 * <td>
667 * Convert "zen-kaku kata-kana" to "han-kaku kata-kana"
668 * </td>
669 * </tr>
670 * <tr valign="top">
671 * <td>K</td>
672 * <td>
673 * Convert "han-kaku kata-kana" to "zen-kaku kata-kana"
674 * </td>
675 * </tr>
676 * <tr valign="top">
677 * <td>h</td>
678 * <td>
679 * Convert "zen-kaku hira-gana" to "han-kaku kata-kana"
680 * </td>
681 * </tr>
682 * <tr valign="top">
683 * <td>H</td>
684 * <td>
685 * Convert "han-kaku kata-kana" to "zen-kaku hira-gana"
686 * </td>
687 * </tr>
688 * <tr valign="top">
689 * <td>c</td>
690 * <td>
691 * Convert "zen-kaku kata-kana" to "zen-kaku hira-gana"
692 * </td>
693 * </tr>
694 * <tr valign="top">
695 * <td>C</td>
696 * <td>
697 * Convert "zen-kaku hira-gana" to "zen-kaku kata-kana"
698 * </td>
699 * </tr>
700 * <tr valign="top">
701 * <td>V</td>
702 * <td>
703 * Collapse voiced sound notation and convert them into a character. Use with "K","H"
704 * </td>
705 * </tr>
706 *
707 *
708 * </table>
709 * </p>
710 * @param encoding string[optional] &mbstring.encoding.parameter;
711 * @return string The converted string.
712 */
713 function mb_convert_kana ($str, $option = null, $encoding = null) {}
714
715 /**
716 * Encode string for MIME header
717 * @link http://www.php.net/manual/en/function.mb-encode-mimeheader.php
718 * @param str string <p>
719 * The string being encoded.
720 * </p>
721 * @param charset string[optional] <p>
722 * charset specifies the name of the character set
723 * in which str is represented in. The default value
724 * is determined by the current NLS setting (mbstring.language).
725 * mb_internal_encoding should be set to same encoding.
726 * </p>
727 * @param transfer_encoding string[optional] <p>
728 * transfer_encoding specifies the scheme of MIME
729 * encoding. It should be either "B" (Base64) or
730 * "Q" (Quoted-Printable). Falls back to
731 * "B" if not given.
732 * </p>
733 * @param linefeed string[optional] <p>
734 * linefeed specifies the EOL (end-of-line) marker
735 * with which mb_encode_mimeheader performs
736 * line-folding (a RFC term,
737 * the act of breaking a line longer than a certain length into multiple
738 * lines. The length is currently hard-coded to 74 characters).
739 * Falls back to "\r\n" (CRLF) if not given.
740 * </p>
741 * @param indent int[optional] <p>
742 * Indentation of the first line (number of characters in the header
743 * before str).
744 * </p>
745 * @return string A converted version of the string represented in ASCII.
746 */
747 function mb_encode_mimeheader ($str, $charset = null, $transfer_encoding = null, $linefeed = null, $indent = null) {}
748
749 /**
750 * Decode string in MIME header field
751 * @link http://www.php.net/manual/en/function.mb-decode-mimeheader.php
752 * @param str string <p>
753 * The string being decoded.
754 * </p>
755 * @return string The decoded string in internal character encoding.
756 */
757 function mb_decode_mimeheader ($str) {}
758
759 /**
760 * Convert character code in variable(s)
761 * @link http://www.php.net/manual/en/function.mb-convert-variables.php
762 * @param to_encoding string <p>
763 * The encoding that the string is being converted to.
764 * </p>
765 * @param from_encoding mixed <p>
766 * from_encoding is specified as an array
767 * or comma separated string, it tries to detect encoding from
768 * from-coding. When from_encoding
769 * is omitted, detect_order is used.
770 * </p>
771 * @param vars mixed <p>
772 * vars is the reference to the
773 * variable being converted. String, Array and Object are accepted.
774 * mb_convert_variables assumes all parameters
775 * have the same encoding.
776 * </p>
777 * @param _ mixed[optional]
778 * @return string The character encoding before conversion for success,
779 * or false for failure.
780 */
781 function mb_convert_variables ($to_encoding, $from_encoding, &$vars, &$_ = null) {}
782
783 /**
784 * Encode character to HTML numeric string reference
785 * @link http://www.php.net/manual/en/function.mb-encode-numericentity.php
786 * @param str string <p>
787 * The string being encoded.
788 * </p>
789 * @param convmap array <p>
790 * convmap is array specifies code area to
791 * convert.
792 * </p>
793 * @param encoding string[optional] &mbstring.encoding.parameter;
794 * @param is_hex bool[optional] <p>
795 * </p>
796 * @return string The converted string.
797 */
798 function mb_encode_numericentity ($str, array $convmap, $encoding = null, $is_hex = null) {}
799
800 /**
801 * Decode HTML numeric string reference to character
802 * @link http://www.php.net/manual/en/function.mb-decode-numericentity.php
803 * @param str string <p>
804 * The string being decoded.
805 * </p>
806 * @param convmap array <p>
807 * convmap is an array that specifies
808 * the code area to convert.
809 * </p>
810 * @param encoding string[optional] &mbstring.encoding.parameter;
811 * @return string The converted string.
812 */
813 function mb_decode_numericentity ($str, array $convmap, $encoding = null) {}
814
815 /**
816 * Send encoded mail
817 * @link http://www.php.net/manual/en/function.mb-send-mail.php
818 * @param to string <p>
819 * The mail addresses being sent to. Multiple
820 * recipients may be specified by putting a comma between each
821 * address in to.
822 * This parameter is not automatically encoded.
823 * </p>
824 * @param subject string <p>
825 * The subject of the mail.
826 * </p>
827 * @param message string <p>
828 * The message of the mail.
829 * </p>
830 * @param additional_headers string[optional] <p>
831 * String to be inserted at the end of the email header.
832 * </p>
833 * <p>
834 * This is typically used to add extra headers (From, Cc, and Bcc).
835 * Multiple extra headers should be separated with a CRLF (\r\n).
836 * Validate parameter not to be injected unwanted headers by attackers.
837 * </p>
838 *
839 * <p>
840 * When sending mail, the mail must contain
841 * a From header. This can be set with the
842 * additional_headers parameter, or a default
843 * can be set in &php.ini;.
844 * </p>
845 * <p>
846 * Failing to do this will result in an error
847 * message similar to Warning: mail(): "sendmail_from" not
848 * set in php.ini or custom "From:" header missing.
849 * The From header sets also
850 * Return-Path under Windows.
851 * </p>
852 *
853 *
854 * <p>
855 * If messages are not received, try using a LF (\n) only.
856 * Some Unix mail transfer agents (most notably
857 * qmail) replace LF by CRLF
858 * automatically (which leads to doubling CR if CRLF is used).
859 * This should be a last resort, as it does not comply with
860 * RFC 2822.
861 * </p>
862 * @param additional_parameter string[optional] <p>
863 * additional_parameter is a MTA command line
864 * parameter. It is useful when setting the correct Return-Path
865 * header when using sendmail.
866 * </p>
867 * <p>
868 * This parameter is escaped by escapeshellcmd internally
869 * to prevent command execution. escapeshellcmd prevents
870 * command execution, but allows to add addtional parameters. For security reason,
871 * this parameter should be validated.
872 * </p>
873 * <p>
874 * Since escapeshellcmd is applied automatically, some characters
875 * that are allowed as email addresses by internet RFCs cannot be used. Programs
876 * that are required to use these characters mail cannot be used.
877 * </p>
878 * <p>
879 * The user that the webserver runs as should be added as a trusted user to the
880 * sendmail configuration to prevent a 'X-Warning' header from being added
881 * to the message when the envelope sender (-f) is set using this method.
882 * For sendmail users, this file is /etc/mail/trusted-users.
883 * </p>
884 * @return bool Returns true on success, false on failure.
885 */
886 function mb_send_mail ($to, $subject, $message, $additional_headers = null, $additional_parameter = null) {}
887
888 /**
889 * Get internal settings of mbstring
890 * @link http://www.php.net/manual/en/function.mb-get-info.php
891 * @param type string[optional] <p>
892 * If type isn't specified or is specified to
893 * "all", an array having the elements "internal_encoding",
894 * "http_output", "http_input", "func_overload", "mail_charset",
895 * "mail_header_encoding", "mail_body_encoding" will be returned.
896 * </p>
897 * <p>
898 * If type is specified as "http_output",
899 * "http_input", "internal_encoding", "func_overload",
900 * the specified setting parameter will be returned.
901 * </p>
902 * @return mixed An array of type information if type
903 * is not specified, otherwise a specific type.
904 */
905 function mb_get_info ($type = null) {}
906
907 /**
908 * Check if the string is valid for the specified encoding
909 * @link http://www.php.net/manual/en/function.mb-check-encoding.php
910 * @param var string[optional] <p>
911 * The byte stream to check. If it is omitted, this function checks
912 * all the input from the beginning of the request.
913 * </p>
914 * @param encoding string[optional] <p>
915 * The expected encoding.
916 * </p>
917 * @return bool Returns true on success, false on failure.
918 */
919 function mb_check_encoding ($var = null, $encoding = null) {}
920
921 /**
922 * Set/Get character encoding for multibyte regex
923 * @link http://www.php.net/manual/en/function.mb-regex-encoding.php
924 * @param encoding string[optional] &mbstring.encoding.parameter;
925 * @return mixed
926 */
927 function mb_regex_encoding ($encoding = null) {}
928
929 /**
930 * Set/Get the default options for mbregex functions
931 * @link http://www.php.net/manual/en/function.mb-regex-set-options.php
932 * @param options string[optional] <p>
933 * The options to set. This is a string where each
934 * character is an option. To set a mode, the mode
935 * character must be the last one set, however there
936 * can only be set one mode but multiple options.
937 * </p>
938 * <table>
939 * Regex options
940 *
941 *
942 * <tr valign="top">
943 * <td>Option</td>
944 * <td>Meaning</td>
945 * </tr>
946 *
947 *
948 * <tr valign="top">
949 * <td>i</td>
950 * <td>Ambiguity match on</td>
951 * </tr>
952 * <tr valign="top">
953 * <td>x</td>
954 * <td>Enables extended pattern form</td>
955 * </tr>
956 * <tr valign="top">
957 * <td>m</td>
958 * <td>'.' matches with newlines</td>
959 * </tr>
960 * <tr valign="top">
961 * <td>s</td>
962 * <td>'^' -> '\A', '$' -> '\Z'</td>
963 * </tr>
964 * <tr valign="top">
965 * <td>p</td>
966 * <td>Same as both the m and s options</td>
967 * </tr>
968 * <tr valign="top">
969 * <td>l</td>
970 * <td>Finds longest matches</td>
971 * </tr>
972 * <tr valign="top">
973 * <td>n</td>
974 * <td>Ignores empty matches</td>
975 * </tr>
976 * <tr valign="top">
977 * <td>e</td>
978 * <td>eval resulting code</td>
979 * </tr>
980 *
981 *
982 * </table>
983 * <table>
984 * Regex syntax modes
985 *
986 *
987 * <tr valign="top">
988 * <td>Mode</td>
989 * <td>Meaning</td>
990 * </tr>
991 *
992 *
993 * <tr valign="top">
994 * <td>j</td>
995 * <td>Java (Sun java.util.regex)</td>
996 * </tr>
997 * <tr valign="top">
998 * <td>u</td>
999 * <td>GNU regex</td>
1000 * </tr>
1001 * <tr valign="top">
1002 * <td>g</td>
1003 * <td>grep</td>
1004 * </tr>
1005 * <tr valign="top">
1006 * <td>c</td>
1007 * <td>Emacs</td>
1008 * </tr>
1009 * <tr valign="top">
1010 * <td>r</td>
1011 * <td>Ruby</td>
1012 * </tr>
1013 * <tr valign="top">
1014 * <td>z</td>
1015 * <td>Perl</td>
1016 * </tr>
1017 * <tr valign="top">
1018 * <td>b</td>
1019 * <td>POSIX Basic regex</td>
1020 * </tr>
1021 * <tr valign="top">
1022 * <td>d</td>
1023 * <td>POSIX Extended regex</td>
1024 * </tr>
1025 *
1026 *
1027 * </table>
1028 * @return string The previous options. If options is omitted,
1029 * it returns the string that describes the current options.
1030 */
1031 function mb_regex_set_options ($options = null) {}
1032
1033 /**
1034 * Regular expression match with multibyte support
1035 * @link http://www.php.net/manual/en/function.mb-ereg.php
1036 * @param pattern string <p>
1037 * The search pattern.
1038 * </p>
1039 * @param string string <p>
1040 * The search string.
1041 * </p>
1042 * @param regs array[optional] <p>
1043 * Contains a substring of the matched string.
1044 * </p>
1045 * @return int
1046 */
1047 function mb_ereg ($pattern, $string, array $regs = null) {}
1048
1049 /**
1050 * Regular expression match ignoring case with multibyte support
1051 * @link http://www.php.net/manual/en/function.mb-eregi.php
1052 * @param pattern string <p>
1053 * The regular expression pattern.
1054 * </p>
1055 * @param string string <p>
1056 * The string being searched.
1057 * </p>
1058 * @param regs array[optional] <p>
1059 * Contains a substring of the matched string.
1060 * </p>
1061 * @return int
1062 */
1063 function mb_eregi ($pattern, $string, array $regs = null) {}
1064
1065 /**
1066 * Replace regular expression with multibyte support
1067 * @link http://www.php.net/manual/en/function.mb-ereg-replace.php
1068 * @param pattern string <p>
1069 * The regular expression pattern.
1070 * </p>
1071 * <p>
1072 * Multibyte characters may be used in pattern.
1073 * </p>
1074 * @param replacement string <p>
1075 * The replacement text.
1076 * </p>
1077 * @param string string <p>
1078 * The string being checked.
1079 * </p>
1080 * @param option string[optional] Matching condition can be set by option
1081 * parameter. If i is specified for this
1082 * parameter, the case will be ignored. If x is
1083 * specified, white space will be ignored. If m
1084 * is specified, match will be executed in multiline mode and line
1085 * break will be included in '.'. If p is
1086 * specified, match will be executed in POSIX mode, line break
1087 * will be considered as normal character. If e
1088 * is specified, replacement string will be
1089 * evaluated as PHP expression.
1090 * @return string The resultant string on success, or false on error.
1091 */
1092 function mb_ereg_replace ($pattern, $replacement, $string, $option = null) {}
1093
1094 /**
1095 * Replace regular expression with multibyte support ignoring case
1096 * @link http://www.php.net/manual/en/function.mb-eregi-replace.php
1097 * @param pattern string <p>
1098 * The regular expression pattern. Multibyte characters may be used. The case will be ignored.
1099 * </p>
1100 * @param replace string <p>
1101 * The replacement text.
1102 * </p>
1103 * @param string string <p>
1104 * The searched string.
1105 * </p>
1106 * @param option string[optional] option has the same meaning as in
1107 * mb_ereg_replace.
1108 * @return string The resultant string or false on error.
1109 */
1110 function mb_eregi_replace ($pattern, $replace, $string, $option = null) {}
1111
1112 /**
1113 * Perform a regular expresssion seach and replace with multibyte support using a callback
1114 * @link http://www.php.net/manual/en/function.mb-ereg-replace-callback.php
1115 * @param pattern string <p>
1116 * The regular expression pattern.
1117 * </p>
1118 * <p>
1119 * Multibyte characters may be used in pattern.
1120 * </p>
1121 * @param callback callable <p>
1122 * A callback that will be called and passed an array of matched elements
1123 * in the subject string. The callback should
1124 * return the replacement string.
1125 * </p>
1126 * <p>
1127 * You'll often need the callback function
1128 * for a mb_ereg_replace_callback in just one place.
1129 * In this case you can use an
1130 * anonymous function to
1131 * declare the callback within the call to
1132 * mb_ereg_replace_callback. By doing it this way
1133 * you have all information for the call in one place and do not
1134 * clutter the function namespace with a callback function's name
1135 * not used anywhere else.
1136 * </p>
1137 * @param string string <p>
1138 * The string being checked.
1139 * </p>
1140 * @param option string[optional] <p>
1141 * Matching condition can be set by option
1142 * parameter. If i is specified for this
1143 * parameter, the case will be ignored. If x is
1144 * specified, white space will be ignored. If m
1145 * is specified, match will be executed in multiline mode and line
1146 * break will be included in '.'. If p is
1147 * specified, match will be executed in POSIX mode, line break
1148 * will be considered as normal character. Note that e
1149 * cannot be used for mb_ereg_replace_callback.
1150 * </p>
1151 * @return string The resultant string on success, or false on error.
1152 */
1153 function mb_ereg_replace_callback ($pattern, $callback, $string, $option = null) {}
1154
1155 /**
1156 * Split multibyte string using regular expression
1157 * @link http://www.php.net/manual/en/function.mb-split.php
1158 * @param pattern string <p>
1159 * The regular expression pattern.
1160 * </p>
1161 * @param string string <p>
1162 * The string being split.
1163 * </p>
1164 * @param limit int[optional] If optional parameter limit is specified,
1165 * it will be split in limit elements as
1166 * maximum.
1167 * @return array The result as an array.
1168 */
1169 function mb_split ($pattern, $string, $limit = null) {}
1170
1171 /**
1172 * Regular expression match for multibyte string
1173 * @link http://www.php.net/manual/en/function.mb-ereg-match.php
1174 * @param pattern string <p>
1175 * The regular expression pattern.
1176 * </p>
1177 * @param string string <p>
1178 * The string being evaluated.
1179 * </p>
1180 * @param option string[optional] <p>
1181 *
1182 * </p>
1183 * @return bool
1184 */
1185 function mb_ereg_match ($pattern, $string, $option = null) {}
1186
1187 /**
1188 * Multibyte regular expression match for predefined multibyte string
1189 * @link http://www.php.net/manual/en/function.mb-ereg-search.php
1190 * @param pattern string[optional] <p>
1191 * The search pattern.
1192 * </p>
1193 * @param option string[optional] <p>
1194 * The search option.
1195 * </p>
1196 * @return bool
1197 */
1198 function mb_ereg_search ($pattern = null, $option = null) {}
1199
1200 /**
1201 * Returns position and length of a matched part of the multibyte regular expression for a predefined multibyte string
1202 * @link http://www.php.net/manual/en/function.mb-ereg-search-pos.php
1203 * @param pattern string[optional] <p>
1204 * The search pattern.
1205 * </p>
1206 * @param option string[optional] <p>
1207 * The search option.
1208 * </p>
1209 * @return array
1210 */
1211 function mb_ereg_search_pos ($pattern = null, $option = null) {}
1212
1213 /**
1214 * Returns the matched part of a multibyte regular expression
1215 * @link http://www.php.net/manual/en/function.mb-ereg-search-regs.php
1216 * @param pattern string[optional] <p>
1217 * The search pattern.
1218 * </p>
1219 * @param option string[optional] <p>
1220 * The search option.
1221 * </p>
1222 * @return array
1223 */
1224 function mb_ereg_search_regs ($pattern = null, $option = null) {}
1225
1226 /**
1227 * Setup string and regular expression for a multibyte regular expression match
1228 * @link http://www.php.net/manual/en/function.mb-ereg-search-init.php
1229 * @param string string <p>
1230 * The search string.
1231 * </p>
1232 * @param pattern string[optional] <p>
1233 * The search pattern.
1234 * </p>
1235 * @param option string[optional] <p>
1236 * The search option.
1237 * </p>
1238 * @return bool
1239 */
1240 function mb_ereg_search_init ($string, $pattern = null, $option = null) {}
1241
1242 /**
1243 * Retrieve the result from the last multibyte regular expression match
1244 * @link http://www.php.net/manual/en/function.mb-ereg-search-getregs.php
1245 * @return array
1246 */
1247 function mb_ereg_search_getregs () {}
1248
1249 /**
1250 * Returns start point for next regular expression match
1251 * @link http://www.php.net/manual/en/function.mb-ereg-search-getpos.php
1252 * @return int
1253 */
1254 function mb_ereg_search_getpos () {}
1255
1256 /**
1257 * Set start point of next regular expression match
1258 * @link http://www.php.net/manual/en/function.mb-ereg-search-setpos.php
1259 * @param position int <p>
1260 * The position to set.
1261 * </p>
1262 * @return bool
1263 */
1264 function mb_ereg_search_setpos ($position) {}
1265
1266 /**
1267 * @param encoding[optional]
1268 */
1269 function mbregex_encoding ($encoding) {}
1270
1271 /**
1272 * @param pattern
1273 * @param string
1274 * @param registers[optional]
1275 */
1276 function mbereg ($pattern, $string, &$registers) {}
1277
1278 /**
1279 * @param pattern
1280 * @param string
1281 * @param registers[optional]
1282 */
1283 function mberegi ($pattern, $string, &$registers) {}
1284
1285 /**
1286 * @param pattern
1287 * @param replacement
1288 * @param string
1289 * @param option[optional]
1290 */
1291 function mbereg_replace ($pattern, $replacement, $string, $option) {}
1292
1293 /**
1294 * @param pattern
1295 * @param replacement
1296 * @param string
1297 */
1298 function mberegi_replace ($pattern, $replacement, $string) {}
1299
1300 /**
1301 * @param pattern
1302 * @param string
1303 * @param limit[optional]
1304 */
1305 function mbsplit ($pattern, $string, $limit) {}
1306
1307 /**
1308 * @param pattern
1309 * @param string
1310 * @param option[optional]
1311 */
1312 function mbereg_match ($pattern, $string, $option) {}
1313
1314 /**
1315 * @param pattern[optional]
1316 * @param option[optional]
1317 */
1318 function mbereg_search ($pattern, $option) {}
1319
1320 /**
1321 * @param pattern[optional]
1322 * @param option[optional]
1323 */
1324 function mbereg_search_pos ($pattern, $option) {}
1325
1326 /**
1327 * @param pattern[optional]
1328 * @param option[optional]
1329 */
1330 function mbereg_search_regs ($pattern, $option) {}
1331
1332 /**
1333 * @param string
1334 * @param pattern[optional]
1335 * @param option[optional]
1336 */
1337 function mbereg_search_init ($string, $pattern, $option) {}
1338
1339 function mbereg_search_getregs () {}
1340
1341 function mbereg_search_getpos () {}
1342
1343 /**
1344 * @param position
1345 */
1346 function mbereg_search_setpos ($position) {}
1347
1348 define ('MB_OVERLOAD_MAIL', 1);
1349 define ('MB_OVERLOAD_STRING', 2);
1350 define ('MB_OVERLOAD_REGEX', 4);
1351 define ('MB_CASE_UPPER', 0);
1352 define ('MB_CASE_LOWER', 1);
1353 define ('MB_CASE_TITLE', 2);
1354
1355 // End of mbstring v.
1356 ?>