/bundles/com.aptana.editor.php.epl/Resources/language/php5.4/mbstring.php

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