/stubs/mbstring.php

https://github.com/FractalizeR/php-stubs · PHP · 1203 lines · 76 code · 71 blank · 1056 comment · 0 complexity · b82ae3fa70bad652a2188b79508663d0 MD5 · raw file

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