From a19afca43784d1e44a00cf996a97f89001b2d240 Mon Sep 17 00:00:00 2001 From: Philip Olson Date: Thu, 20 Sep 2007 20:55:38 +0000 Subject: [PATCH] WS, preparation for the new doc style git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@242741 c90b9560-bf6c-de11-be94-00142212c4b1 --- .../mbstring/functions/mb-convert-case.xml | 121 +++---- .../functions/mb-convert-encoding.xml | 84 ++--- .../mbstring/functions/mb-convert-kana.xml | 296 +++++++++--------- .../functions/mb-convert-variables.xml | 102 +++--- .../functions/mb-decode-mimeheader.xml | 50 +-- .../functions/mb-decode-numericentity.xml | 82 +++-- .../mbstring/functions/mb-detect-encoding.xml | 92 +++--- .../mbstring/functions/mb-detect-order.xml | 156 +++++---- .../functions/mb-encode-mimeheader.xml | 126 ++++---- .../functions/mb-encode-numericentity.xml | 98 +++--- .../mbstring/functions/mb-ereg-match.xml | 68 ++-- .../mbstring/functions/mb-ereg-replace.xml | 94 +++--- .../functions/mb-ereg-search-getpos.xml | 66 ++-- .../functions/mb-ereg-search-getregs.xml | 74 +++-- .../functions/mb-ereg-search-init.xml | 73 +++-- .../mbstring/functions/mb-ereg-search-pos.xml | 77 +++-- .../functions/mb-ereg-search-regs.xml | 68 ++-- .../functions/mb-ereg-search-setpos.xml | 58 ++-- .../mbstring/functions/mb-ereg-search.xml | 68 ++-- reference/mbstring/functions/mb-ereg.xml | 76 ++--- .../mbstring/functions/mb-eregi-replace.xml | 77 +++-- reference/mbstring/functions/mb-eregi.xml | 80 +++-- reference/mbstring/functions/mb-get-info.xml | 70 ++--- .../mbstring/functions/mb-http-input.xml | 72 ++--- .../mbstring/functions/mb-http-output.xml | 68 ++-- .../functions/mb-internal-encoding.xml | 98 +++--- reference/mbstring/functions/mb-language.xml | 87 +++-- .../mbstring/functions/mb-output-handler.xml | 168 +++++----- reference/mbstring/functions/mb-parse-str.xml | 78 +++-- .../functions/mb-preferred-mime-name.xml | 56 ++-- .../mbstring/functions/mb-regex-encoding.xml | 58 ++-- .../functions/mb-regex-set-options.xml | 64 ++-- reference/mbstring/functions/mb-send-mail.xml | 132 ++++---- reference/mbstring/functions/mb-split.xml | 78 ++--- reference/mbstring/functions/mb-strcut.xml | 90 +++--- .../mbstring/functions/mb-strimwidth.xml | 102 +++--- reference/mbstring/functions/mb-strlen.xml | 62 ++-- reference/mbstring/functions/mb-strpos.xml | 102 +++--- .../mbstring/functions/mb-strtolower.xml | 93 +++--- .../mbstring/functions/mb-strtoupper.xml | 93 +++--- reference/mbstring/functions/mb-strwidth.xml | 134 ++++---- .../functions/mb-substitute-character.xml | 118 +++---- .../mbstring/functions/mb-substr-count.xml | 75 ++--- reference/mbstring/functions/mb-substr.xml | 88 +++--- 44 files changed, 2015 insertions(+), 2057 deletions(-) diff --git a/reference/mbstring/functions/mb-convert-case.xml b/reference/mbstring/functions/mb-convert-case.xml index 6e4c035bc9..6a0563049c 100644 --- a/reference/mbstring/functions/mb-convert-case.xml +++ b/reference/mbstring/functions/mb-convert-case.xml @@ -1,51 +1,52 @@ - - - - mb_convert_case - Perform case folding on a string - - - Description - - stringmb_convert_case - stringstr - intmode - stringencoding - - - mb_convert_case returns case folded version of - string converted in the way specified by - mode. - - - mode can be one of MB_CASE_UPPER, MB_CASE_LOWER - or MB_CASE_TITLE. - - - encoding specifies the encoding of - str; if omitted, the internal character encoding - value will be used. - - - The return value is str with the appropriate case folding applied. - - - By contrast to the standard case folding functions such as - strtolower and strtoupper, - case folding is performed on the basis of the Unicode character - properties. Thus the behaviour of this function is not affected - by locale settings and it can convert any characters that have - 'alphabetic' property, such as A-umlaut (Ä). - - - For more information about the Unicode properties, please see &url.unicode.reports;. - - - - <function>mb_convert_case</function> example - + + + + mb_convert_case + Perform case folding on a string + + + + &reftitle.description; + + stringmb_convert_case + stringstr + intmode + stringencoding + + + mb_convert_case returns case folded version of + string converted in the way specified by + mode. + + + mode can be one of MB_CASE_UPPER, MB_CASE_LOWER + or MB_CASE_TITLE. + + + encoding specifies the encoding of + str; if omitted, the internal character encoding + value will be used. + + + The return value is str with the appropriate case folding applied. + + + By contrast to the standard case folding functions such as + strtolower and strtoupper, + case folding is performed on the basis of the Unicode character + properties. Thus the behaviour of this function is not affected + by locale settings and it can convert any characters that have + 'alphabetic' property, such as A-umlaut (Ä). + + + For more information about the Unicode properties, please see &url.unicode.reports;. + + + + <function>mb_convert_case</function> example + ]]> - - - - - See also mb_strtolower, - mb_strtoupper, - strtolower, - strtoupper, - ucfirst&listendand; - ucwords - - - + + + + + See also mb_strtolower, + mb_strtoupper, + strtolower, + strtoupper, + ucfirst&listendand; + ucwords + + + - - - - mb_convert_encoding - Convert character encoding - - - Description - - stringmb_convert_encoding - stringstr - stringto_encoding - mixedfrom_encoding - - - mb_convert_encoding converts - character encoding of string str from - from_encoding to - to_encoding. - - - str : String to be converted. - - - from_encoding is specified by character - code name before conversion. it can be array or string - comma - separated enumerated list. If it is not specified, the internal - encoding will be used. - - - - <function>mb_convert_encoding</function> example - + + + + mb_convert_encoding + Convert character encoding + + + + &reftitle.description; + + stringmb_convert_encoding + stringstr + stringto_encoding + mixedfrom_encoding + + + mb_convert_encoding converts + character encoding of string str from + from_encoding to + to_encoding. + + + str : String to be converted. + + + from_encoding is specified by character + code name before conversion. it can be array or string - comma + separated enumerated list. If it is not specified, the internal + encoding will be used. + + + + <function>mb_convert_encoding</function> example + ]]> - - - - - See also mb_detect_order. - - - + + + + + See also mb_detect_order. + + + - - - - mb_convert_kana - - Convert "kana" one from another ("zen-kaku", "han-kaku" and more) - - - - Description - - stringmb_convert_kana - stringstr - stringoption - stringencoding - - - mb_convert_kana performs "han-kaku" - - "zen-kaku" conversion for string str. It - returns converted string. This function is only useful for - Japanese. - - - option is conversion option. Default value - is "KV". - - - encoding is character encoding. If it is - omitted, internal character encoding is used. - - - Specify with combination of following options. Default - value is KV. - - Applicable Conversion Options - - - - Option - Meaning - - - - - r - - Convert "zen-kaku" alphabets to "han-kaku" - - - - R - - Convert "han-kaku" alphabets to "zen-kaku" - - - - n - - Convert "zen-kaku" numbers to "han-kaku" - - - - N - - Convert "han-kaku" numbers to "zen-kaku" - - - - a - - Convert "zen-kaku" alphabets and numbers to "han-kaku" - - - - A - - Convert "han-kaku" alphabets and numbers to "zen-kaku" - (Characters included in "a", "A" options are - U+0021 - U+007E excluding U+0022, U+0027, U+005C, U+007E) - - - - s - - Convert "zen-kaku" space to "han-kaku" (U+3000 -> U+0020) - - - - S - - Convert "han-kaku" space to "zen-kaku" (U+0020 -> U+3000) - - - - k - - Convert "zen-kaku kata-kana" to "han-kaku kata-kana" - - - - K - - Convert "han-kaku kata-kana" to "zen-kaku kata-kana" - - - - h - - Convert "zen-kaku hira-gana" to "han-kaku kata-kana" - - - - H - - Convert "han-kaku kata-kana" to "zen-kaku hira-gana" - - - - c - - Convert "zen-kaku kata-kana" to "zen-kaku hira-gana" - - - - C - - Convert "zen-kaku hira-gana" to "zen-kaku kata-kana" - - - - V - - Collapse voiced sound notation and convert them into a character. Use with "K","H" - - - - -
- - - - <function>mb_convert_kana</function> example - + + + + mb_convert_kana + Convert "kana" one from another ("zen-kaku", "han-kaku" and more) + + + + &reftitle.description; + + stringmb_convert_kana + stringstr + stringoption + stringencoding + + + mb_convert_kana performs "han-kaku" - + "zen-kaku" conversion for string str. It + returns converted string. This function is only useful for + Japanese. + + + option is conversion option. Default value + is "KV". + + + encoding is character encoding. If it is + omitted, internal character encoding is used. + + + Specify with combination of following options. Default + value is KV. + + Applicable Conversion Options + + + + Option + Meaning + + + + + r + + Convert "zen-kaku" alphabets to "han-kaku" + + + + R + + Convert "han-kaku" alphabets to "zen-kaku" + + + + n + + Convert "zen-kaku" numbers to "han-kaku" + + + + N + + Convert "han-kaku" numbers to "zen-kaku" + + + + a + + Convert "zen-kaku" alphabets and numbers to "han-kaku" + + + + A + + Convert "han-kaku" alphabets and numbers to "zen-kaku" + (Characters included in "a", "A" options are + U+0021 - U+007E excluding U+0022, U+0027, U+005C, U+007E) + + + + s + + Convert "zen-kaku" space to "han-kaku" (U+3000 -> U+0020) + + + + S + + Convert "han-kaku" space to "zen-kaku" (U+0020 -> U+3000) + + + + k + + Convert "zen-kaku kata-kana" to "han-kaku kata-kana" + + + + K + + Convert "han-kaku kata-kana" to "zen-kaku kata-kana" + + + + h + + Convert "zen-kaku hira-gana" to "han-kaku kata-kana" + + + + H + + Convert "han-kaku kata-kana" to "zen-kaku hira-gana" + + + + c + + Convert "zen-kaku kata-kana" to "zen-kaku hira-gana" + + + + C + + Convert "zen-kaku hira-gana" to "zen-kaku kata-kana" + + + + V + + Collapse voiced sound notation and convert them into a character. Use with "K","H" + + + + +
+ + + + <function>mb_convert_kana</function> example + ]]> - - - - - + + + + + - - - - mb_convert_variables - Convert character code in variable(s) - - - Description - - stringmb_convert_variables - stringto_encoding - mixedfrom_encoding - mixedvars - mixed... - - - mb_convert_variables convert - character encoding of variables vars in - encoding from_encoding to encoding - to_encoding. It returns character encoding - before conversion for success, &false; for failure. - - - mb_convert_variables join strings in Array - or Object to detect encoding, since encoding detection tends to - fail for short strings. Therefore, it is impossible to mix - encoding in single array or object. - - - It from_encoding is specified by - array or comma separated string, it tries to detect encoding from - from-coding. When - encoding is omitted, - detect_order is used. - - - vars (3rd and larger) is reference to - variable to be converted. String, Array and Object are accepted. - mb_convert_variables assumes all parameters - have the same encoding. - - - - <function>mb_convert_variables</function> example - + + + + mb_convert_variables + Convert character code in variable(s) + + + + &reftitle.description; + + stringmb_convert_variables + stringto_encoding + mixedfrom_encoding + mixedvars + mixed... + + + mb_convert_variables convert + character encoding of variables vars in + encoding from_encoding to encoding + to_encoding. It returns character encoding + before conversion for success, &false; for failure. + + + mb_convert_variables join strings in Array + or Object to detect encoding, since encoding detection tends to + fail for short strings. Therefore, it is impossible to mix + encoding in single array or object. + + + It from_encoding is specified by + array or comma separated string, it tries to detect encoding from + from-coding. When + encoding is omitted, + detect_order is used. + + + vars (3rd and larger) is reference to + variable to be converted. String, Array and Object are accepted. + mb_convert_variables assumes all parameters + have the same encoding. + + + + <function>mb_convert_variables</function> example + ]]> - - - - - + + + + + - - - - mb_decode_mimeheader - Decode string in MIME header field - - - Description - - stringmb_decode_mimeheader - stringstr - - - mb_decode_mimeheader decodes encoded-word - string str in MIME header. - - - It returns decoded string in internal character encoding. - - - See also mb_encode_mimeheader. - - - + + + + mb_decode_mimeheader + Decode string in MIME header field + + + + &reftitle.description; + + stringmb_decode_mimeheader + stringstr + + + mb_decode_mimeheader decodes encoded-word + string str in MIME header. + + + It returns decoded string in internal character encoding. + + + See also mb_encode_mimeheader. + + + - - - - mb_decode_numericentity - - Decode HTML numeric string reference to character - - - - Description - - stringmb_decode_numericentity - stringstr - arrayconvmap - stringencoding - - - Convert numeric string reference of string - str in specified block to character. It - returns converted string. - - - convmap is array to specifies code area to - convert. - - - encoding is character encoding. If it is - omitted, internal character encoding is used. - - - - <parameter>convmap</parameter> example - + + + + mb_decode_numericentity + Decode HTML numeric string reference to character + + + + &reftitle.description; + + stringmb_decode_numericentity + stringstr + arrayconvmap + stringencoding + + + Convert numeric string reference of string + str in specified block to character. It + returns converted string. + + + convmap is array to specifies code area to + convert. + + + encoding is character encoding. If it is + omitted, internal character encoding is used. + + + + <parameter>convmap</parameter> example + - - - - - See also mb_encode_numericentity. - - - + + + + + See also mb_encode_numericentity. + + + - - - - mb_detect_encoding - Detect character encoding - - - Description - - stringmb_detect_encoding - stringstr - mixedencoding_list - boolstrict - - - mb_detect_encoding detects character - encoding in string str. It returns - detected character encoding. - - - encoding_list is list of character - encoding. Encoding order may be specified by array or comma - separated list string. - - - If encoding_list is omitted, - detect_order is used. - - - strict specifies whether to use - the strict encoding detection or not. - Default is &false;. - - - - <function>mb_detect_encoding</function> example - + + + + mb_detect_encoding + Detect character encoding + + + + &reftitle.description; + + stringmb_detect_encoding + stringstr + mixedencoding_list + boolstrict + + + mb_detect_encoding detects character + encoding in string str. It returns + detected character encoding. + + + encoding_list is list of character + encoding. Encoding order may be specified by array or comma + separated list string. + + + If encoding_list is omitted, + detect_order is used. + + + strict specifies whether to use + the strict encoding detection or not. + Default is &false;. + + + + <function>mb_detect_encoding</function> example + ]]> - - - - - See also mb_detect_order. - - - + + + + + See also mb_detect_order. + + + - - - - mb_detect_order - - Set/Get character encoding detection order - - - - Description - - mixedmb_detect_order - mixedencoding_list - - - mb_detect_order sets automatic character - encoding detection order to encoding_list. - It returns &true; for success, - &false; for failure. - - - encoding_list is array or comma separated - list of character encoding. ("auto" is expanded to - "ASCII, JIS, UTF-8, EUC-JP, SJIS") - - - If encoding_list is omitted, it returns - current character encoding detection order as array. - - - This setting affects mb_detect_encoding and - mb_send_mail. - - - - mbstring currently implements following - encoding detection filters. If there is an invalid byte sequence - for following encoding, encoding detection will fail. - - - UTF-8, UTF-7, - ASCII, - EUC-JP,SJIS, - eucJP-win, SJIS-win, - JIS, ISO-2022-JP - - - For ISO-8859-*, mbstring - always detects as ISO-8859-*. - - - For UTF-16, UTF-32, - UCS2 and UCS4, encoding - detection will fail always. - - - - Useless detect order example - + + + + mb_detect_order + Set/Get character encoding detection order + + + + &reftitle.description; + + mixedmb_detect_order + mixedencoding_list + + + mb_detect_order sets automatic character + encoding detection order to encoding_list. + It returns &true; for success, + &false; for failure. + + + encoding_list is array or comma separated + list of character encoding. ("auto" is expanded to + "ASCII, JIS, UTF-8, EUC-JP, SJIS") + + + If encoding_list is omitted, it returns + current character encoding detection order as array. + + + This setting affects mb_detect_encoding and + mb_send_mail. + + + + mbstring currently implements following + encoding detection filters. If there is an invalid byte sequence + for following encoding, encoding detection will fail. + + + UTF-8, UTF-7, + ASCII, + EUC-JP,SJIS, + eucJP-win, SJIS-win, + JIS, ISO-2022-JP + + + For ISO-8859-*, mbstring + always detects as ISO-8859-*. + + + For UTF-16, UTF-32, + UCS2 and UCS4, encoding + detection will fail always. + + + + Useless detect order example + - - - - - - - <function>mb_detect_order</function> examples - + + + + + + + <function>mb_detect_order</function> examples + ]]> - - - - - See also mb_internal_encoding, - mb_http_input, - mb_http_output and - mb_send_mail. - - - + + + + + See also mb_internal_encoding, + mb_http_input, + mb_http_output and + mb_send_mail. + + + - - - - mb_encode_mimeheader - Encode string for MIME header - - - Description - - stringmb_encode_mimeheader - stringstr - stringcharset - stringtransfer_encoding - stringlinefeed - intindent - - - mb_encode_mimeheader encodes a given string - str by the MIME header encoding scheme. - Returns a converted version of the string represented in ASCII. - - - charset specifies the name of the character set - in which str is represented in. The default value - is determined by the current NLS setting (mbstring.language). - - - transfer_encoding specifies the scheme of MIME - encoding. It should be either "B" (Base64) or - "Q" (Quoted-Printable). Falls back to - "B" if not given. - - - linefeed specifies the EOL (end-of-line) marker - with which mb_encode_mimeheader performs - line-folding (a RFC term, - the act of breaking a line longer than a certain length into multiple - lines. The length is currently hard-coded to 74 characters). - Falls back to "\r\n" (CRLF) if not given. - - - - <function>mb_encode_mimeheader</function> example - + + + + mb_encode_mimeheader + Encode string for MIME header + + + + &reftitle.description; + + stringmb_encode_mimeheader + stringstr + stringcharset + stringtransfer_encoding + stringlinefeed + intindent + + + mb_encode_mimeheader encodes a given string + str by the MIME header encoding scheme. + Returns a converted version of the string represented in ASCII. + + + charset specifies the name of the character set + in which str is represented in. The default value + is determined by the current NLS setting (mbstring.language). + + + transfer_encoding specifies the scheme of MIME + encoding. It should be either "B" (Base64) or + "Q" (Quoted-Printable). Falls back to + "B" if not given. + + + linefeed specifies the EOL (end-of-line) marker + with which mb_encode_mimeheader performs + line-folding (a RFC term, + the act of breaking a line longer than a certain length into multiple + lines. The length is currently hard-coded to 74 characters). + Falls back to "\r\n" (CRLF) if not given. + + + + <function>mb_encode_mimeheader</function> example + ]]> - - - - - - This function isn't designed to break lines at higher-level - contextual break points (word boundaries, etc.). - This behaviour may clutter up the original string with unexpected spaces. - - - - The indent was added as of PHP 5. - - - See also mb_decode_mimeheader. - - - + + + + + + This function isn't designed to break lines at higher-level + contextual break points (word boundaries, etc.). + This behaviour may clutter up the original string with unexpected spaces. + + + + The indent was added as of PHP 5. + + + See also mb_decode_mimeheader. + + + - - - - mb_encode_numericentity - - Encode character to HTML numeric string reference - - - - Description - - stringmb_encode_numericentity - stringstr - arrayconvmap - stringencoding - - - mb_encode_numericentity converts - specified character codes in string str - from HTML numeric character reference to character code. It - returns converted string. - - - convmap is array specifies code area to - convert. - - - encoding is character encoding. - - - - <parameter>convmap</parameter> example - + + + + mb_encode_numericentity + Encode character to HTML numeric string reference + + + + &reftitle.description; + + stringmb_encode_numericentity + stringstr + arrayconvmap + stringencoding + + + mb_encode_numericentity converts + specified character codes in string str + from HTML numeric character reference to character code. It + returns converted string. + + + convmap is array specifies code area to + convert. + + + encoding is character encoding. + + + + <parameter>convmap</parameter> example + - - - - - - - <function>mb_encode_numericentity</function> example - - + + + + + + <function>mb_encode_numericentity</function> example + ]]> - - - - - See also mb_decode_numericentity. - - - + + + + + See also mb_decode_numericentity. + + + - - - - mb_ereg_match - - Regular expression match for multibyte string - - - - Description - - boolmb_ereg_match - stringpattern - stringstring - - stringoption - - - - mb_ereg_match returns &true; if - string matches regular expression - pattern, &false; if not. - - - The internal encoding or the character encoding specified in - mb_regex_encoding will be used as character - encoding. - - - See also: mb_regex_encoding, - mb_ereg. - - - + + + + mb_ereg_match + Regular expression match for multibyte string + + + + &reftitle.description; + + boolmb_ereg_match + stringpattern + stringstring + + stringoption + + + + mb_ereg_match returns &true; if + string matches regular expression + pattern, &false; if not. + + + The internal encoding or the character encoding specified in + mb_regex_encoding will be used as character + encoding. + + + See also: mb_regex_encoding, + mb_ereg. + + + - - - - mb_ereg_replace - Replace regular expression with multibyte support - - - Description - - stringmb_ereg_replace - stringpattern - stringreplacement - stringstring - stringoption - - - mb_ereg_replace scans - string for matches to - pattern, then replaces the matched text - with replacement and returns the result - string or &false; on error. Multibyte character can be used in - pattern. - - - Matching condition can be set by option - parameter. If i is specified for this - parameter, the case will be ignored. If x is - specified, white space will be ignored. If m - is specified, match will be executed in multiline mode and line - break will be included in '.'. If p is - specified, match will be executed in POSIX mode, line break - will be considered as normal character. If e - is specified, replacement string will be - evaluated as PHP expression. - - - The internal encoding or the character encoding specified in - mb_regex_encoding will be used as character - encoding. - - - See also: mb_regex_encoding, - mb_eregi_replace. - - - + + + + mb_ereg_replace + Replace regular expression with multibyte support + + + + &reftitle.description; + + stringmb_ereg_replace + stringpattern + stringreplacement + stringstring + stringoption + + + mb_ereg_replace scans + string for matches to + pattern, then replaces the matched text + with replacement and returns the result + string or &false; on error. Multibyte character can be used in + pattern. + + + Matching condition can be set by option + parameter. If i is specified for this + parameter, the case will be ignored. If x is + specified, white space will be ignored. If m + is specified, match will be executed in multiline mode and line + break will be included in '.'. If p is + specified, match will be executed in POSIX mode, line break + will be considered as normal character. If e + is specified, replacement string will be + evaluated as PHP expression. + + + The internal encoding or the character encoding specified in + mb_regex_encoding will be used as character + encoding. + + + See also: mb_regex_encoding, + mb_eregi_replace. + + + - - - - mb_ereg_search_getpos - - Returns start point for next regular expression match - - - - Description - - intmb_ereg_search_getpos - - - - mb_ereg_search_getpos returns - the point to start regular expression match for - mb_ereg_search, - mb_ereg_search_pos, - mb_ereg_search_regs. The position is - represented by bytes from the head of string. - - - The internal encoding or the character encoding specified in - mb_regex_encoding will be used as character - encoding. - - - See also: mb_regex_encoding, - mb_ereg_search_setpos. - - - + + + + mb_ereg_search_getpos + Returns start point for next regular expression match + + + + &reftitle.description; + + intmb_ereg_search_getpos + + + + mb_ereg_search_getpos returns + the point to start regular expression match for + mb_ereg_search, + mb_ereg_search_pos, + mb_ereg_search_regs. The position is + represented by bytes from the head of string. + + + The internal encoding or the character encoding specified in + mb_regex_encoding will be used as character + encoding. + + + See also: mb_regex_encoding, + mb_ereg_search_setpos. + + + - - - - mb_ereg_search_getregs - - Retrieve the result from the last multibyte regular expression - match - - - - Description - - arraymb_ereg_search_getregs - - - - mb_ereg_search_getregs returns an array - including the sub-string of matched part by last - mb_ereg_search, - mb_ereg_search_pos, - mb_ereg_search_regs. If there are some - maches, the first element will have the matched sub-string, the - second element will have the first part grouped with brackets, - the third element will have the second part grouped with - brackets, and so on. It returns &false; on error; - - - The internal encoding or the character encoding specified in - mb_regex_encoding will be used as character - encoding. - - - See also: mb_regex_encoding, - mb_ereg_search_init. - - - + + + + mb_ereg_search_getregs + Retrieve the result from the last multibyte regular expression match + + + + + &reftitle.description; + + arraymb_ereg_search_getregs + + + + mb_ereg_search_getregs returns an array + including the sub-string of matched part by last + mb_ereg_search, + mb_ereg_search_pos, + mb_ereg_search_regs. If there are some + matches, the first element will have the matched sub-string, the + second element will have the first part grouped with brackets, + the third element will have the second part grouped with + brackets, and so on. It returns &false; on error; + + + The internal encoding or the character encoding specified in + mb_regex_encoding will be used as character + encoding. + + + See also: mb_regex_encoding, + mb_ereg_search_init. + + + - - - - mb_ereg_search_init - - Setup string and regular expression for multibyte regular - expression match - - - - Description - - boolmb_ereg_search_init - stringstring - stringpattern - stringoption - - - mb_ereg_search_init sets - string and pattern - for multibyte regular expression. These values are used for - mb_ereg_search, - mb_ereg_search_pos, - mb_ereg_search_regs. It returns &true; for - success, &false; for error. - - - The internal encoding or the character encoding specified in - mb_regex_encoding will be used as character - encoding. - - - See also: mb_regex_encoding, - mb_ereg_search_regs. - - - + + + + mb_ereg_search_init + Setup string and regular expression for multibyte regularexpression match + + + + &reftitle.description; + + boolmb_ereg_search_init + stringstring + stringpattern + stringoption + + + mb_ereg_search_init sets + string and pattern + for multibyte regular expression. These values are used for + mb_ereg_search, + mb_ereg_search_pos, + mb_ereg_search_regs. It returns &true; for + success, &false; for error. + + + The internal encoding or the character encoding specified in + mb_regex_encoding will be used as character + encoding. + + + See also: mb_regex_encoding, + mb_ereg_search_regs. + + + - - - - mb_ereg_search_pos - - Return position and length of matched part of multibyte regular - expression for predefined multibyte string - - - - Description - - arraymb_ereg_search_pos - stringpattern - stringoption - - - mb_ereg_search_pos returns an array including - position of matched part for multibyte regular expression. - The first element of the array will be the beginning of matched - part, the second element will be length (bytes) of matched part. - It returns &false; on error. - - - The string for match is specified by - mb_ereg_search_init. If it is not specified, - the previous one will be used. - - - The internal encoding or the character encoding specified in - mb_regex_encoding will be used as character - encoding. - - - See also: mb_regex_encoding, - mb_ereg_search_init. - - - + + + + mb_ereg_search_pos + Return position and length of matched part of multibyte regular expression for predefined multibyte string + + + + &reftitle.description; + + arraymb_ereg_search_pos + stringpattern + stringoption + + + mb_ereg_search_pos returns an array including + position of matched part for multibyte regular expression. + The first element of the array will be the beginning of matched + part, the second element will be length (bytes) of matched part. + It returns &false; on error. + + + The string for match is specified by + mb_ereg_search_init. If it is not specified, + the previous one will be used. + + + The internal encoding or the character encoding specified in + mb_regex_encoding will be used as character + encoding. + + + See also: mb_regex_encoding, + mb_ereg_search_init. + + + - - - - mb_ereg_search_regs - - Returns the matched part of multibyte regular expression - - - - Description - - arraymb_ereg_search_regs - stringpattern - stringoption - - - mb_ereg_search_regs executes the multibyte - regular expression match, and if there are some matched part, it - returns an array including substring of matched part as first - element, the first grouped part with brackets as second element, - the second grouped part as third element, and so on. It returns - &false; on error. - - - The internal encoding or the character encoding specified in - mb_regex_encoding will be used as character - encoding. - - - See also: mb_regex_encoding, - mb_ereg_search_init. - - - + + + + mb_ereg_search_regs + Returns the matched part of multibyte regular expression + + + + &reftitle.description; + + arraymb_ereg_search_regs + stringpattern + stringoption + + + mb_ereg_search_regs executes the multibyte + regular expression match, and if there are some matched part, it + returns an array including substring of matched part as first + element, the first grouped part with brackets as second element, + the second grouped part as third element, and so on. It returns + &false; on error. + + + The internal encoding or the character encoding specified in + mb_regex_encoding will be used as character + encoding. + + + See also: mb_regex_encoding, + mb_ereg_search_init. + + + - - - - mb_ereg_search_setpos - - Set start point of next regular expression match - - - - Description - - boolmb_ereg_search_setpos - intposition - - - mb_ereg_search_setpos sets the starting - point of match for mb_ereg_search. - - - The internal encoding or the character encoding specified in - mb_regex_encoding will be used as character - encoding. - - - See also: mb_regex_encoding, - mb_ereg_search_init. - - - + + + + mb_ereg_search_setpos + Set start point of next regular expression match + + + + &reftitle.description; + + boolmb_ereg_search_setpos + intposition + + + mb_ereg_search_setpos sets the starting + point of match for mb_ereg_search. + + + The internal encoding or the character encoding specified in + mb_regex_encoding will be used as character + encoding. + + + See also: mb_regex_encoding, + mb_ereg_search_init. + + + - - - - mb_ereg_search - - Multibyte regular expression match for predefined multibyte string - - - - Description - - boolmb_ereg_search - stringpattern - stringoption - - - mb_ereg_search returns &true; if the - multibyte string matches with the regular expression, &false; for - otherwise. The string for matching is set by - mb_ereg_search_init. If - pattern is not specified, the previous one - is used. - - - The internal encoding or the character encoding specified in - mb_regex_encoding will be used as character - encoding. - - - See also: mb_regex_encoding, - mb_ereg_search_init. - - - + + + + mb_ereg_search + Multibyte regular expression match for predefined multibyte string + + + + &reftitle.description; + + boolmb_ereg_search + stringpattern + stringoption + + + mb_ereg_search returns &true; if the + multibyte string matches with the regular expression, &false; for + otherwise. The string for matching is set by + mb_ereg_search_init. If + pattern is not specified, the previous one + is used. + + + The internal encoding or the character encoding specified in + mb_regex_encoding will be used as character + encoding. + + + See also: mb_regex_encoding, + mb_ereg_search_init. + + + - - - - mb_ereg - Regular expression match with multibyte support - - - Description - - intmb_ereg - stringpattern - stringstring - - arrayregs - - - - mb_ereg executes the regular expression - match with multibyte support, and returns 1 if matches are found. - If the optional third parameter was specified, the function - returns the byte length of matched part, and the array - regs will contain the substring of matched - string. The functions returns 1 if it matches with the empty - string. If no matches found or error happend, &false; will be - returned. - - - The internal encoding or the character encoding specified in - mb_regex_encoding will be used as character - encoding. - - - See also: mb_regex_encoding, - mb_eregi - - - + + + + mb_ereg + Regular expression match with multibyte support + + + + &reftitle.description; + + intmb_ereg + stringpattern + stringstring + + arrayregs + + + + mb_ereg executes the regular expression + match with multibyte support, and returns 1 if matches are found. + If the optional third parameter was specified, the function + returns the byte length of matched part, and the array + regs will contain the substring of matched + string. The functions returns 1 if it matches with the empty + string. If no matches found or error happend, &false; will be + returned. + + + The internal encoding or the character encoding specified in + mb_regex_encoding will be used as character + encoding. + + + See also: mb_regex_encoding, + mb_eregi + + + - - - - mb_eregi_replace - - Replace regular expression with multibyte support - ignoring case - - - - Description - - stringmb_eregi_replace - stringpattern - stringreplace - stringstring - stringoption - - - mb_ereg_replace scans - string for matches to - pattern, then replaces the matched text - with replacement and returns the result - string or &false; on error. Multibyte character can be used in - pattern. The case will be ignored. - option has the same meaning as in - mb_ereg_replace. - - - The internal encoding or the character encoding specified in - mb_regex_encoding will be used as character - encoding. - - - See also: mb_regex_encoding, - mb_ereg_replace. - - - + + + + mb_eregi_replace + Replace regular expression with multibyte support ignoring case + + + + &reftitle.description; + + stringmb_eregi_replace + stringpattern + stringreplace + stringstring + stringoption + + + mb_ereg_replace scans + string for matches to + pattern, then replaces the matched text + with replacement and returns the result + string or &false; on error. Multibyte character can be used in + pattern. The case will be ignored. + option has the same meaning as in + mb_ereg_replace. + + + The internal encoding or the character encoding specified in + mb_regex_encoding will be used as character + encoding. + + + See also: mb_regex_encoding, + mb_ereg_replace. + + + - - - - mb_eregi - - Regular expression match ignoring case with multibyte support - - - - Description - - intmb_eregi - stringpattern - stringstring - - arrayregs - - - - mb_eregi executes the regular expression - match with multibyte support, and returns 1 if matches are found. - This function ignore case. - If the optional third parameter was specified, the function - returns the byte length of matched part, and the array - regs will contain the substring of matched - string. The functions returns 1 if it matches with the empty - string. If no matches found or error happend, &false; will be - returned. - - - The internal encoding or the character encoding specified in - mb_regex_encoding will be used as character - encoding. - - - See also: mb_regex_encoding, - mb_ereg. - - - + + + + mb_eregi + Regular expression match ignoring case with multibyte support + + + + &reftitle.description; + + intmb_eregi + stringpattern + stringstring + + arrayregs + + + + mb_eregi executes the regular expression + match with multibyte support, and returns 1 if matches are found. + This function ignore case. + If the optional third parameter was specified, the function + returns the byte length of matched part, and the array + regs will contain the substring of matched + string. The functions returns 1 if it matches with the empty + string. If no matches found or error happend, &false; will be + returned. + + + The internal encoding or the character encoding specified in + mb_regex_encoding will be used as character + encoding. + + + See also: mb_regex_encoding, + mb_ereg. + + + - - - - mb_get_info - Get internal settings of mbstring - - - Description - - mixedmb_get_info - stringtype - - - mb_get_info returns internal setting - parameter of mbstring. - - - If type isn't specified or is specified to - "all", an array having the elements "internal_encoding", - "http_output", "http_input", "func_overload", "mail_charset", - "mail_header_encoding", "mail_body_encoding" will be returned. The last - three elements are available since PHP 5.1.3. - - - If type is specified for "http_output", - "http_input", "internal_encoding", "func_overload", - the specified setting parameter will be returned. - - - See also mb_internal_encoding, - mb_http_output. - - - + + + + mb_get_info + Get internal settings of mbstring + + + + &reftitle.description; + + mixedmb_get_info + stringtype + + + mb_get_info returns internal setting + parameter of mbstring. + + + If type isn't specified or is specified to + "all", an array having the elements "internal_encoding", + "http_output", "http_input", "func_overload", "mail_charset", + "mail_header_encoding", "mail_body_encoding" will be returned. The last + three elements are available since PHP 5.1.3. + + + If type is specified for "http_output", + "http_input", "internal_encoding", "func_overload", + the specified setting parameter will be returned. + + + See also mb_internal_encoding, + mb_http_output. + + + - - - - mb_http_input - Detect HTTP input character encoding - - - Description - - mixedmb_http_input - stringtype - - - mb_http_input returns result of HTTP input - character encoding detection. - - - type: Input string specifies input - type. "G" for GET, "P" for POST, - "C" for COOKIE, "S" for string, "L" for list, "I" for whole - list (will return array). If type is omitted, it returns last - input type processed. - - - Return Value: Character encoding name. - If mb_http_input does not process specified - HTTP input, it returns &false;. - - - See also mb_internal_encoding, - mb_http_output, - mb_detect_order. - - - + + + + mb_http_input + Detect HTTP input character encoding + + + + &reftitle.description; + + mixedmb_http_input + stringtype + + + mb_http_input returns result of HTTP input + character encoding detection. + + + type: Input string specifies input + type. "G" for GET, "P" for POST, + "C" for COOKIE, "S" for string, "L" for list, "I" for whole + list (will return array). If type is omitted, it returns last + input type processed. + + + Return Value: Character encoding name. + If mb_http_input does not process specified + HTTP input, it returns &false;. + + + See also mb_internal_encoding, + mb_http_output, + mb_detect_order. + + + - - - - mb_http_output - Set/Get HTTP output character encoding - - - Description - - mixedmb_http_output - stringencoding - - - If encoding is set, - mb_http_output sets HTTP output character - encoding to encoding. Output after this - function is converted to encoding. - mb_http_output returns - &true; for success and &false; - for failure. - - - If encoding is omitted, - mb_http_output returns current HTTP output - character encoding. - - - See also mb_internal_encoding, - mb_http_input, - mb_detect_order. - - - + + + + mb_http_output + Set/Get HTTP output character encoding + + + + &reftitle.description; + + mixedmb_http_output + stringencoding + + + If encoding is set, + mb_http_output sets HTTP output character + encoding to encoding. Output after this + function is converted to encoding. + mb_http_output returns + &true; for success and &false; + for failure. + + + If encoding is omitted, + mb_http_output returns current HTTP output + character encoding. + + + See also mb_internal_encoding, + mb_http_input, + mb_detect_order. + + + - - - - mb_internal_encoding - - Set/Get internal character encoding - - - - Description - - mixedmb_internal_encoding - stringencoding - - - mb_internal_encoding sets internal character - encoding to encoding If parameter is - omitted, it returns current internal encoding. - - - encoding is used for HTTP input character - encoding conversion, HTTP output character encoding conversion - and default character encoding for string functions defined by - mbstring module. - - - encoding: Character encoding name - - - Return Value: If encoding is - set,mb_internal_encoding returns - &true; for success, otherwise returns - &false;. If encoding is - omitted, it returns current character encoding name. - - - - <function>mb_internal_encoding</function> example - + + + + mb_internal_encoding + Set/Get internal character encoding + + + + &reftitle.description; + + mixedmb_internal_encoding + stringencoding + + + mb_internal_encoding sets internal character + encoding to encoding If parameter is + omitted, it returns current internal encoding. + + + encoding is used for HTTP input character + encoding conversion, HTTP output character encoding conversion + and default character encoding for string functions defined by + mbstring module. + + + encoding: Character encoding name + + + Return Value: If encoding is + set,mb_internal_encoding returns + &true; for success, otherwise returns + &false;. If encoding is + omitted, it returns current character encoding name. + + + + <function>mb_internal_encoding</function> example + ]]> - - - - - See also mb_http_input, - mb_http_output and - mb_detect_order. - - - + + + + + See also mb_http_input, + mb_http_output and + mb_detect_order. + + + - - - - mb_language - - Set/Get current language - - - - Description - - mixedmb_language - stringlanguage - - - mb_language sets language. If - language is omitted, it returns current - language as string. - - - language setting is used for encoding - e-mail messages. Valid languages are "Japanese", - "ja","English","en" and "uni" - (UTF-8). mb_send_mail uses this setting to - encode e-mail. - - Language and its setting is ISO-2022-JP/Base64 for - Japanese, UTF-8/Base64 for uni, ISO-8859-1/quoted printable for - English. - - - Return Value: If language is set and - language is valid, it returns - &true;. Otherwise, it returns &false;. When - language is omitted, it returns language - name as string. If no language is set previously, it returns - &false;. - - - See also mb_send_mail. - - - + + + + mb_language + Set/Get current language + + + + &reftitle.description; + + mixedmb_language + stringlanguage + + + mb_language sets language. If + language is omitted, it returns current + language as string. + + + language setting is used for encoding + e-mail messages. Valid languages are "Japanese", + "ja","English","en" and "uni" + (UTF-8). mb_send_mail uses this setting to + encode e-mail. + + + Language and its setting is ISO-2022-JP/Base64 for + Japanese, UTF-8/Base64 for uni, ISO-8859-1/quoted printable for + English. + + + Return Value: If language is set and + language is valid, it returns + &true;. Otherwise, it returns &false;. When + language is omitted, it returns language + name as string. If no language is set previously, it returns + &false;. + + + See also mb_send_mail. + + + - - - - mb_output_handler - - Callback function converts character encoding in output buffer - - - - Description - - stringmb_output_handler - stringcontents - intstatus - - - mb_output_handler is - ob_start callback - function. mb_output_handler converts - characters in output buffer from internal character encoding to - HTTP output character encoding. - - - 4.1.0 or later version, this handler adds charset HTTP header - when following conditions are met: - - - - - Does not set Content-Type by - header() - - - Default MIME type begins with - text/ - - - http_output setting is other than - pass - - - - - contents : Output buffer contents - - - status : Output buffer status - - - Return Value: String converted - - - - <function>mb_output_handler</function> example - + + + + mb_output_handler + Callback function converts character encoding in output buffer + + + + &reftitle.description; + + stringmb_output_handler + stringcontents + intstatus + + + mb_output_handler is + ob_start callback + function. mb_output_handler converts + characters in output buffer from internal character encoding to + HTTP output character encoding. + + + 4.1.0 or later version, this handler adds charset HTTP header + when following conditions are met: + + + + + Does not set Content-Type by + header() + + + Default MIME type begins with + text/ + + + http_output setting is other than + pass + + + + + contents : Output buffer contents + + + status : Output buffer status + + + Return Value: String converted + + + + <function>mb_output_handler</function> example + ]]> - - - - - - If you want to output some binary data such as image from PHP - script with PHP 4.3.0 or later, Content-Type: header must be send - using header before any binary data was send - to client (e.g. header("Content-Type: image/png")). - If Content-Type: header was send, output character encoding - conversion will not be performed. - - - Note that if 'Content-Type: text/*' was send using - header, the sending data is regarded as text, - encoding conversion will be performed using character encoding - settings. - - - If you want to output some binary data such as image from PHP - script with PHP 4.2.x or earlier, you must set output encoding to - "pass" using mb_http_output. - - - - See also ob_start. - - - + + + + + + If you want to output some binary data such as image from PHP + script with PHP 4.3.0 or later, Content-Type: header must be send + using header before any binary data was send + to client (e.g. header("Content-Type: image/png")). + If Content-Type: header was send, output character encoding + conversion will not be performed. + + + Note that if 'Content-Type: text/*' was send using + header, the sending data is regarded as text, + encoding conversion will be performed using character encoding + settings. + + + If you want to output some binary data such as image from PHP + script with PHP 4.2.x or earlier, you must set output encoding to + "pass" using mb_http_output. + + + + See also ob_start. + + + - - - - mb_parse_str - - Parse GET/POST/COOKIE data and set global variable - - - - Description - - boolmb_parse_str - stringencoded_string - arrayresult - - - mb_parse_str parses GET/POST/COOKIE data and - sets global variables. Since PHP does not provide raw POST/COOKIE - data, it can only used for GET data for now. It preses URL - encoded data, detects encoding, converts coding to internal - encoding and set values to result array or - global variables. - - - encoded_string: URL encoded data. - - - result: Array contains decoded and - character encoding converted values. - - - Return Value: It returns &true; for success or &false; for failure. - - - See also mb_detect_order, - mb_internal_encoding. - - - + + + + mb_parse_str + Parse GET/POST/COOKIE data and set global variable + + + + &reftitle.description; + + boolmb_parse_str + stringencoded_string + arrayresult + + + mb_parse_str parses GET/POST/COOKIE data and + sets global variables. Since PHP does not provide raw POST/COOKIE + data, it can only used for GET data for now. It preses URL + encoded data, detects encoding, converts coding to internal + encoding and set values to result array or + global variables. + + + encoded_string: URL encoded data. + + + result: Array contains decoded and + character encoding converted values. + + + Return Value: It returns &true; for success or &false; for failure. + + + See also mb_detect_order, + mb_internal_encoding. + + + - - - - mb_preferred_mime_name - Get MIME charset string - - - Description - - stringmb_preferred_mime_name - stringencoding - - - mb_preferred_mime_name returns MIME - charset string for character encoding - encoding. It returns - charset string. - - - - <function>mb_preferred_mime_string</function> example - + + + + mb_preferred_mime_name + Get MIME charset string + + + + &reftitle.description; + + stringmb_preferred_mime_name + stringencoding + + + mb_preferred_mime_name returns MIME + charset string for character encoding + encoding. It returns + charset string. + + + + <function>mb_preferred_mime_string</function> example + ]]> - - - - - + + + + + - - - - mb_regex_encoding - - Returns current encoding for multibyte regex as string - - - - Description - - mixedmb_regex_encoding - stringencoding - - - mb_regex_encoding returns the character - encoding used by multibyte regex functions. - - - If the optional parameter encoding is - specified, it is set to the character encoding for multibyte - regex. The default value is the internal character encoding. - - - See also: mb_internal_encoding, - mb_ereg - - - + + + + mb_regex_encoding + Returns current encoding for multibyte regex as string + + + + &reftitle.description; + + mixedmb_regex_encoding + stringencoding + + + mb_regex_encoding returns the character + encoding used by multibyte regex functions. + + + If the optional parameter encoding is + specified, it is set to the character encoding for multibyte + regex. The default value is the internal character encoding. + + + See also: mb_internal_encoding, + mb_ereg + + + - - - - mb_regex_set_options - - Set/Get the default options for mbregex functions - - - - Description - - stringmb_regex_set_options - - stringoptions - - - - mb_regex_set_options sets the default options - described by options for multibyte regex functions. - - - Returns the previous options. If options is - omitted, it returns the string that describes the current options. - - - See also - mb_split, - mb_ereg and - mb_eregi - - - + + + + mb_regex_set_options + Set/Get the default options for mbregex functions + + + + &reftitle.description; + + stringmb_regex_set_options + + stringoptions + + + + mb_regex_set_options sets the default options + described by options for multibyte regex functions. + + + Returns the previous options. If options is + omitted, it returns the string that describes the current options. + + + See also + mb_split, + mb_ereg and + mb_eregi + + + - - - - mb_send_mail - - Send encoded mail - - - - Description - - boolmb_send_mail - stringto - stringsubject - stringmessage - stringadditional_headers - stringadditional_parameter - - - mb_send_mail sends email. Headers and - message are converted and encoded according to - mb_language setting. - mb_send_mail is wrapper - function of mail. See - mail for details. - - - to is mail addresses send to. Multiple - recipients can be specified by putting a comma between each - address in to. This parameter is not automatically encoded. - - - subject is subject of mail. - - - message is mail message. - - - additional_headers is inserted at - the end of the header. This is typically used to add extra - headers. Multiple extra headers are separated with a - newline ("\n"). - - - - Content-Type and - Content-Transfer-Encoding headers can be redefined as - of PHP 5.0.0. In PHP 4, values defined by - mb_language are always used. - - - - additional_parameter is a MTA command line - parameter. It is useful when setting the correct Return-Path - header when using sendmail. - - - &return.success; - - - See also mail, - mb_encode_mimeheader, and - mb_language. - - - + + + + mb_send_mail + Send encoded mail + + + + &reftitle.description; + + boolmb_send_mail + stringto + stringsubject + stringmessage + stringadditional_headers + stringadditional_parameter + + + mb_send_mail sends email. Headers and + message are converted and encoded according to + mb_language setting. + mb_send_mail is wrapper + function of mail. See + mail for details. + + + to is mail addresses send to. Multiple + recipients can be specified by putting a comma between each + address in to. This parameter is not automatically encoded. + + + subject is subject of mail. + + + message is mail message. + + + additional_headers is inserted at + the end of the header. This is typically used to add extra + headers. Multiple extra headers are separated with a + newline ("\n"). + + + + Content-Type and + Content-Transfer-Encoding headers can be redefined as + of PHP 5.0.0. In PHP 4, values defined by + mb_language are always used. + + + + additional_parameter is a MTA command line + parameter. It is useful when setting the correct Return-Path + header when using sendmail. + + + &return.success; + + + See also mail, + mb_encode_mimeheader, and + mb_language. + + + - - - - mb_split - Split multibyte string using regular expression - - - Description - - arraymb_split - stringpattern - stringstring - - intlimit - - - - mb_split split multibyte - string using regular expression - pattern and returns the result as an - array. - - - If optional parameter limit is specified, - it will be split in limit elements as - maximum. - - - The internal encoding or the character encoding specified in - mb_regex_encoding will be used as character - encoding. - - - See also: mb_regex_encoding, - mb_ereg. - - - + + + + mb_split + Split multibyte string using regular expression + + + + &reftitle.description; + + arraymb_split + stringpattern + stringstring + + intlimit + + + + mb_split split multibyte + string using regular expression + pattern and returns the result as an + array. + + + If optional parameter limit is specified, + it will be split in limit elements as + maximum. + + + The internal encoding or the character encoding specified in + mb_regex_encoding will be used as character + encoding. + + + See also: mb_regex_encoding, + mb_ereg. + + + - - - - mb_strcut - Get part of string - - - Description - - stringmb_strcut - stringstr - intstart - intlength - stringencoding - - - mb_strcut returns the portion of - str specified by the - start and - length parameters. - - - mb_strcut performs equivalent operation as - mb_substr with different method. If - start position is multi-byte character's - second byte or larger, it starts from first byte of multi-byte - character. - - - It subtracts string from str that is - shorter than length AND character that is - not part of multi-byte string or not being middle of shift - sequence. - - - encoding is character encoding. If it is - not set, internal character encoding is used. - - - See also mb_substr, - mb_internal_encoding. - - - + + + + mb_strcut + Get part of string + + + + &reftitle.description; + + stringmb_strcut + stringstr + intstart + intlength + stringencoding + + + mb_strcut returns the portion of + str specified by the + start and + length parameters. + + + mb_strcut performs equivalent operation as + mb_substr with different method. If + start position is multi-byte character's + second byte or larger, it starts from first byte of multi-byte + character. + + + It subtracts string from str that is + shorter than length AND character that is + not part of multi-byte string or not being middle of shift + sequence. + + + encoding is character encoding. If it is + not set, internal character encoding is used. + + + See also mb_substr, + mb_internal_encoding. + + + - - - - mb_strimwidth - Get truncated string with specified width - - - Description - - stringmb_strimwidth - stringstr - intstart - intwidth - stringtrimmarker - stringencoding - - - mb_strimwidth truncates string - str to specified - width. It returns truncated string. - - - If trimmarker is set, - trimmarker is appended to return value. - - - start is start position offset. Number of - characters from the beginning of string. (First character is 0) - - - trimmarker is string that is added to the - end of string when string is truncated. - - - encoding is character encoding. If it is - omitted, internal encoding is used. - - - - <function>mb_strimwidth</function> example - + + + + mb_strimwidth + Get truncated string with specified width + + + + &reftitle.description; + + stringmb_strimwidth + stringstr + intstart + intwidth + stringtrimmarker + stringencoding + + + mb_strimwidth truncates string + str to specified + width. It returns truncated string. + + + If trimmarker is set, + trimmarker is appended to return value. + + + start is start position offset. Number of + characters from the beginning of string. (First character is 0) + + + trimmarker is string that is added to the + end of string when string is truncated. + + + encoding is character encoding. If it is + omitted, internal encoding is used. + + + + <function>mb_strimwidth</function> example + "); ?> ]]> - - - - - See also mb_strwidth and - mb_internal_encoding. - - - + + + + + See also mb_strwidth and + mb_internal_encoding. + + + - - - - mb_strlen - Get string length - - - Description - - intmb_strlen - stringstr - stringencoding - - - mb_strlen returns number of characters in - string str having character encoding - encoding. A multi-byte character is - counted as 1. - - - encoding is character encoding for - str. If encoding is - omitted, internal character encoding is used. - - - See also mb_internal_encoding, - strlen. - - - + + + + mb_strlen + Get string length + + + + &reftitle.description; + + intmb_strlen + stringstr + stringencoding + + + mb_strlen returns number of characters in + string str having character encoding + encoding. A multi-byte character is + counted as 1. + + + encoding is character encoding for + str. If encoding is + omitted, internal character encoding is used. + + + See also mb_internal_encoding, + strlen. + + + - - - - mb_strpos - - Find position of first occurrence of string in a string - - - - Description - - intmb_strpos - stringhaystack - stringneedle - intoffset - stringencoding - - - mb_strpos returns the numeric position of - the first occurrence of needle in the - haystack string. If - needle is not found, it returns &false;. - - - mb_strpos performs multi-byte safe - strpos operation based on number of - characters. needle position is counted - from the beginning of the haystack. First - character's position is 0. Second character position is 1, and so - on. - - - If encoding is omitted, internal - character encoding is used. - - - offset is search offset. If it is not - specified, 0 is used. - - - encoding is character encoding name. If it - is omitted, internal character encoding is used. - - - See also mb_strrpos, - mb_internal_encoding, - strpos - - - + + + + mb_strpos + + Find position of first occurrence of string in a string + + + + + &reftitle.description; + + intmb_strpos + stringhaystack + stringneedle + intoffset + stringencoding + + + mb_strpos returns the numeric position of + the first occurrence of needle in the + haystack string. If + needle is not found, it returns &false;. + + + mb_strpos performs multi-byte safe + strpos operation based on number of + characters. needle position is counted + from the beginning of the haystack. First + character's position is 0. Second character position is 1, and so + on. + + + If encoding is omitted, internal + character encoding is used. + + + offset is search offset. If it is not + specified, 0 is used. + + + encoding is character encoding name. If it + is omitted, internal character encoding is used. + + + See also mb_strrpos, + mb_internal_encoding, + strpos + + + - - - mb_strtolower - Make a string lowercase - - - Description - - stringmb_strtolower - stringstr - stringencoding - - - mb_strtolower returns str - with all alphabetic characters converted to lowercase. - - - encoding specifies the encoding of - str; if omitted, the internal character encoding - value will be used. - - - For more information about the Unicode properties, please see &url.unicode.reports;. - - - By contrast to strtolower, 'alphabetic' is - determined by the Unicode character properties. Thus the behaviour - of this function is not affected by locale settings and it can convert - any characters that have 'alphabetic' property, such as A-umlaut (Ä). - - - - <function>mb_strtolower</function> example - + + + + mb_strtolower + Make a string lowercase + + + + &reftitle.description; + + stringmb_strtolower + stringstr + stringencoding + + + mb_strtolower returns str + with all alphabetic characters converted to lowercase. + + + encoding specifies the encoding of + str; if omitted, the internal character encoding + value will be used. + + + For more information about the Unicode properties, please see &url.unicode.reports;. + + + By contrast to strtolower, 'alphabetic' is + determined by the Unicode character properties. Thus the behaviour + of this function is not affected by locale settings and it can convert + any characters that have 'alphabetic' property, such as A-umlaut (Ä). + + + + <function>mb_strtolower</function> example + ]]> - - - - - See also strtolower, - mb_strtoupper and - mb_convert_case. - - - + + + + + See also strtolower, + mb_strtoupper and + mb_convert_case. + + + - - - mb_strtoupper - Make a string uppercase - - - Description - - stringmb_strtoupper - stringstr - stringencoding - - - mb_strtoupper returns str - with all alphabetic characters converted to uppercase. - - - encoding specifies the encoding of - str; if omitted, the internal character encoding - value will be used. - - - By contrast to strtoupper, 'alphabetic' is - determined by the Unicode character properties. Thus the behaviour of this - function is not affected by locale settings and it can convert any - characters that have 'alphabetic' property, such as a-umlaut (ä). - - - For more information about the Unicode properties, please see &url.unicode.reports;. - - - - <function>mb_strtoupper</function> example - + + + + mb_strtoupper + Make a string uppercase + + + + &reftitle.description; + + stringmb_strtoupper + stringstr + stringencoding + + + mb_strtoupper returns str + with all alphabetic characters converted to uppercase. + + + encoding specifies the encoding of + str; if omitted, the internal character encoding + value will be used. + + + By contrast to strtoupper, 'alphabetic' is + determined by the Unicode character properties. Thus the behaviour of this + function is not affected by locale settings and it can convert any + characters that have 'alphabetic' property, such as a-umlaut (ä). + + + For more information about the Unicode properties, please see &url.unicode.reports;. + + + + <function>mb_strtoupper</function> example + ]]> - - - - - See also strtoupper, - mb_strtolower and - mb_convert_case. - - - + + + + + See also strtoupper, + mb_strtolower and + mb_convert_case. + + + - - - - mb_strwidth - Return width of string - - - Description - - intmb_strwidth - stringstr - stringencoding - - - mb_strwidth returns width of string - str. - - - Multi-byte character usually twice of width compare to single - byte character. - - - - Characters width - - - - Chars - Width - - - - - U+0000 - U+0019 - 0 - - - U+0020 - U+1FFF - 1 - - - U+2000 - U+FF60 - 2 - - - U+FF61 - U+FF9F - 1 - - - U+FFA0 - - 2 - - - -
- - - encoding is character encoding. If it is - omitted, internal encoding is used. - - - See also: mb_strimwidth, - mb_internal_encoding. - - - + + + + mb_strwidth + Return width of string + + + + &reftitle.description; + + intmb_strwidth + stringstr + stringencoding + + + mb_strwidth returns width of string + str. + + + Multi-byte character usually twice of width compare to single + byte character. + + + + Characters width + + + + Chars + Width + + + + + U+0000 - U+0019 + 0 + + + U+0020 - U+1FFF + 1 + + + U+2000 - U+FF60 + 2 + + + U+FF61 - U+FF9F + 1 + + + U+FFA0 - + 2 + + + +
+ + + encoding is character encoding. If it is + omitted, internal encoding is used. + + + See also: mb_strimwidth, + mb_internal_encoding. + + + - - - - mb_substitute_character - Set/Get substitution character - - - Description - - mixedmb_substitute_character - mixedsubstrchar - - - mb_substitute_character specifies - substitution character when input character encoding is invalid - or character code is not exist in output character - encoding. Invalid characters may be substituted &null;(no output), - string or integer value (Unicode character code value). - - - This setting affects mb_convert_encoding, - mb_convert_variables, - mb_output_handler, - and mb_send_mail. - - - substchar : Specify Unicode value as - integer or specify as string as follows - - - - "none" : no output - - - - - "long" : Output character code value (Example: - U+3000,JIS+7E7E) - - - - - - Return Value: If substchar is set, it - returns &true; for success, otherwise returns - &false;. If substchar is - not set, it returns Unicode value or - "none"/"long". - - - - <function>mb_substitute_character</function> example - + + + + mb_substitute_character + Set/Get substitution character + + + + &reftitle.description; + + mixedmb_substitute_character + mixedsubstrchar + + + mb_substitute_character specifies + substitution character when input character encoding is invalid + or character code is not exist in output character + encoding. Invalid characters may be substituted &null;(no output), + string or integer value (Unicode character code value). + + + This setting affects mb_convert_encoding, + mb_convert_variables, + mb_output_handler, + and mb_send_mail. + + + substchar : Specify Unicode value as + integer or specify as string as follows + + + + "none" : no output + + + + + "long" : Output character code value (Example: + U+3000,JIS+7E7E) + + + + + + Return Value: If substchar is set, it + returns &true; for success, otherwise returns + &false;. If substchar is + not set, it returns Unicode value or + "none"/"long". + + + + <function>mb_substitute_character</function> example + ]]> - - - - - + + + + + - - - mb_substr_count - Count the number of substring occurrences - - - Description - - intmb_substr_count - stringhaystack - stringneedle - stringencoding - - - mb_substr_count returns the number of times the - needle substring occurs in the - haystack string. - - - encoding specifies the encoding for - needle and haystack. - If omitted, internal character encoding is used. - - - - <function>mb_substr_count</function> example - + + + + mb_substr_count + Count the number of substring occurrences + + + + &reftitle.description; + + intmb_substr_count + stringhaystack + stringneedle + stringencoding + + + mb_substr_count returns the number of times the + needle substring occurs in the + haystack string. + + + encoding specifies the encoding for + needle and haystack. + If omitted, internal character encoding is used. + + + + <function>mb_substr_count</function> example + ]]> - - - - - See also substr_count, - mb_strpos, mb_substr. - - - + + + + + See also substr_count, + mb_strpos, mb_substr. + + + - - - - mb_substr - Get part of string - - - Description - - stringmb_substr - stringstr - intstart - intlength - stringencoding - - - mb_substr returns the portion of - str specified by the - start and - length parameters. - - - mb_substr performs multi-byte safe - substr operation based on - number of characters. Position is - counted from the beginning of - str. First character's position is - 0. Second character position is 1, and so on. - - - If encoding is omitted, internal encoding - is assumed. - - - encoding is character encoding. If it is - omitted, internal character encoding is used. - - - See also mb_strcut, - mb_internal_encoding. - - - + + + + mb_substr + Get part of string + + + + &reftitle.description; + + stringmb_substr + stringstr + intstart + intlength + stringencoding + + + mb_substr returns the portion of + str specified by the + start and + length parameters. + + + mb_substr performs multi-byte safe + substr operation based on + number of characters. Position is + counted from the beginning of + str. First character's position is + 0. Second character position is 1, and so on. + + + If encoding is omitted, internal encoding + is assumed. + + + encoding is character encoding. If it is + omitted, internal character encoding is used. + + + See also mb_strcut, + mb_internal_encoding. + + +