/plugins/com.aptana.editor.php.epl/Resources/language/php5/mbstring.php

https://github.com/haegyung/aptana-php · PHP · 1172 lines · 75 code · 70 blank · 1027 comment · 0 complexity · 80953a601318752f5328ea9a9433cac4 MD5 · raw file

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