cvs: phpdoc(REF_STRUCT_DEV) /en language-snippets.ent /en/reference/mbstring/functions mb-check-encoding.xml mb-convert-case.xml
mb-convert-encoding.xml mb-convert-kana.xml mb-convert-variables.xml mb-decode-mimeheader.xml mb-decode-numericentity.xml mb-detect-encoding.xml
mb-detect-order.xml mb-encode-mimeheader.xml mb-encode-numericentity.xml mb-ereg-match.xml mb-ereg-replace.xml mb-ereg-search-getpos.xml
mb-ereg-search-getregs.xml mb-ereg-search-init.xml mb-ereg-search-pos.xml mb-ereg-search-regs.xml mb-ereg-search-setpos.xml mb-ereg-search.xml
mb-ereg.xml mb-eregi-replace.xml mb-eregi.xml mb-get-info.xml mb-http-input.xml mb-http-output.xml mb-internal-encoding.xml mb-language.xml
mb-output-handler.xml mb-parse-str.xml mb-preferred-mime-name.xml mb-regex-encoding.xml mb-regex-set-options.xml mb-send-mail.xml mb-split.xml
mb-strcut.xml mb-strimwidth.xml mb-strlen.xml mb-strpos.xml mb-strrpos.xml mb-strtolower.xml mb-strtoupper.xml mb-strwidth.xml mb-substitute-c!
haracter.xml mb-substr-count.xml mb-substr.xml
| From: | Philip Olson | Date: | Sun, 02 Dec 2007 07:38:43 +0000 |
| Subject: | cvs: phpdoc(REF_STRUCT_DEV) /en language-snippets.ent /en/reference/mbstring/functions mb-check-encoding.xml mb-convert-case.xml mb-convert-encoding.xml mb-convert-kana.xml mb-convert-variables.xml mb-decode-mimeheader.xml mb-decode-numericentity.xml mb-detect-encoding.xml mb-detect-order.xml mb-encode-mimeheader.xml mb-encode-numericentity.xml mb-ereg-match.xml mb-ereg-replace.xml mb-ereg-search-getpos.xml mb-ereg-search-getregs.xml mb-ereg-search-init.xml mb-ereg-search-pos.xml mb-ereg-search-regs.xml mb-ereg-search-setpos.xml mb-ereg-search.xml mb-ereg.xml mb-eregi-replace.xml mb-eregi.xml mb-get-info.xml mb-http-input.xml mb-http-output.xml mb-internal-encoding.xml mb-language.xml mb-output-handler.xml mb-parse-str.xml mb-preferred-mime-name.xml mb-regex-encoding.xml mb-regex-set-options.xml mb-send-mail.xml mb-split.xml mb-strcut.xml mb-strimwidth.xml mb-strlen.xml mb-strpos.xml mb-strrpos.xml mb-strtolower.xml mb-strtoupper.xml mb-strwidth.xml mb-substitute-c! haracter.xml mb-substr-count.xml mb-substr.xml |
||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-503@lists.php.net to get a copy of this message | ||
philip Sun Dec 2 07:38:43 2007 UTC
Modified files: (Branch: REF_STRUCT_DEV)
/phpdoc/en language-snippets.ent
/phpdoc/en/reference/mbstring/functions mb-check-encoding.xml
mb-convert-case.xml
mb-convert-encoding.xml
mb-convert-kana.xml
mb-convert-variables.xml
mb-decode-mimeheader.xml
mb-decode-numericentity.xml
mb-detect-encoding.xml
mb-detect-order.xml
mb-encode-mimeheader.xml
mb-encode-numericentity.xml
mb-ereg-match.xml
mb-ereg-replace.xml
mb-ereg-search-getpos.xml
mb-ereg-search-getregs.xml
mb-ereg-search-init.xml
mb-ereg-search-pos.xml
mb-ereg-search-regs.xml
mb-ereg-search-setpos.xml
mb-ereg-search.xml
mb-ereg.xml
mb-eregi-replace.xml
mb-eregi.xml
mb-get-info.xml
mb-http-input.xml
mb-http-output.xml
mb-internal-encoding.xml
mb-language.xml
mb-output-handler.xml
mb-parse-str.xml
mb-preferred-mime-name.xml
mb-regex-encoding.xml
mb-regex-set-options.xml
mb-send-mail.xml
mb-split.xml mb-strcut.xml
mb-strimwidth.xml
mb-strlen.xml mb-strpos.xml
mb-strrpos.xml
mb-strtolower.xml
mb-strtoupper.xml
mb-strwidth.xml
mb-substitute-character.xml
mb-substr-count.xml
mb-substr.xml
Log:
ref.mbstring: Implemented the new doc style, new entities, and rewording where appropriate
http://cvs.php.net/viewvc.cgi/phpdoc/en/language-snippets.ent?r1=1.209.2.3&r2=1.209.2.4&diff_format=u Index: phpdoc/en/language-snippets.ent diff -u phpdoc/en/language-snippets.ent:1.209.2.3 phpdoc/en/language-snippets.ent:1.209.2.4 --- phpdoc/en/language-snippets.ent:1.209.2.3 Tue Nov 27 14:28:00 2007 +++ phpdoc/en/language-snippets.ent Sun Dec 2 07:38:42 2007 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.209.2.3 $ --> +<!-- $Revision: 1.209.2.4 $ --> <!-- Keep 'em sorted --> @@ -164,6 +164,8 @@ <!-- Misc --> +<!ENTITY no.function.parameters '<para>This function contains no parameters.</para>'> + <!ENTITY example.outputs '<para>The above example will output:</para>'> <!ENTITY example.outputs.similar '<para>The above example will output @@ -276,6 +278,16 @@ imap_stream</parameter></term><listitem><para>An IMAP stream returned by <function>imap_open</function>.</para></listitem></varlistentry>'> +<!-- mbstring notes --> + +<!ENTITY note.mbstring.encoding.internal '<note><para>The internal encoding or the +character encoding specified by <function>mb_regex_encoding</function> +will be used as the character encoding for this function.</para></note>'> + +<!ENTITY mbstring.encoding.parameter '<para>The <parameter>encoding</parameter> +parameter is the character encoding. If it is omitted, the internal character +encoding value will be used.</para>'> + <!-- MCVE notes --> <!ENTITY mcve.conn.description '<varlistentry><term><parameter> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-check-encoding.xml?r1=1.3.2.2&r2=1.3.2.3&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-check-encoding.xml diff -u phpdoc/en/reference/mbstring/functions/mb-check-encoding.xml:1.3.2.2 phpdoc/en/reference/mbstring/functions/mb-check-encoding.xml:1.3.2.3 --- phpdoc/en/reference/mbstring/functions/mb-check-encoding.xml:1.3.2.2 Wed Oct 3 11:41:12 2007 +++ phpdoc/en/reference/mbstring/functions/mb-check-encoding.xml Sun Dec 2 07:38:42 2007 @@ -1,10 +1,11 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3.2.2 $ --> -<refentry xml:id="function.mb-check-encoding" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.3.2.3 $ --> +<refentry xml:id="function.mb-check-encoding" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_check_encoding</refname> <refpurpose>Check if the string is valid for the specified encoding</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -13,13 +14,13 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_check_encoding</function> - checks if the specified byte stream is valid for the specified encoding. + Checks if the specified byte stream is valid for the specified encoding. It is useful to prevent so-called "Invalid Encoding Attack". </para> <para> </para> </refsect1> + <refsect1 role="parameters"> &reftitle.parameters; <para> @@ -28,7 +29,7 @@ <term><parameter>var</parameter></term> <listitem> <para> - byte stream to check. If it is omitted, this function checks + The byte stream to check. If it is omitted, this function checks all the input from the beginning of the request. </para> </listitem> @@ -37,13 +38,14 @@ <term><parameter>encoding</parameter></term> <listitem> <para> - Expected encoding. + The expected encoding. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> @@ -51,86 +53,6 @@ </para> </refsect1> - <!-- Use when ERRORS exist - <refsect1 role="errors"> - &reftitle.errors; - <para> - When does this function throw E_* level errors, or exceptions? - </para> - </refsect1> - --> - - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description;</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here</entry> - <entry>Description of change</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - --> - - - <!-- Use when examples exist - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <function>mb_check_encoding</function> example</title> - <para> - Any text that describes the purpose of the example, or - what goes on in the example should go here (inside the - <example> tag, not out - </para> - <programlisting role="php"> -<![CDATA[ -<?php -if ($anexample === true) { - echo 'Use the PEAR Coding Standards'; -} -?> -]]> - </programlisting> - &example.outputs; - <screen> -<![CDATA[ -Use the PEAR Coding Standards -]]> - </screen> - </example> - </para> - </refsect1> - --> - - - <!-- Use when adding See Also links - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> - </simplelist> - </para> - </refsect1> - --> - - </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-convert-case.xml?r1=1.8&r2=1.8.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-convert-case.xml diff -u phpdoc/en/reference/mbstring/functions/mb-convert-case.xml:1.8 phpdoc/en/reference/mbstring/functions/mb-convert-case.xml:1.8.2.1 --- phpdoc/en/reference/mbstring/functions/mb-convert-case.xml:1.8 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-convert-case.xml Sun Dec 2 07:38:42 2007 @@ -1,5 +1,5 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.8.2.1 $ --> <refentry xml:id="function.mb-convert-case" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_convert_case</refname> @@ -15,22 +15,54 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_convert_case</function> returns case folded version of - <parameter>string</parameter> converted in the way specified by + Performs case folding on a <type>string</type>, converted in the way specified by <parameter>mode</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>mode</parameter> can be one of MB_CASE_UPPER, MB_CASE_LOWER - or MB_CASE_TITLE. - </para> - <para> - <parameter>encoding</parameter> specifies the encoding of - <parameter>str</parameter>; if omitted, the internal character encoding - value will be used. + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The <type>string</type> being converted. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>mode</parameter></term> + <listitem> + <para> + The mode of the conversion. It can be one of + <constant>MB_CASE_UPPER</constant>, + <constant>MB_CASE_LOWER</constant>, or + <constant>MB_CASE_TITLE</constant>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + &mbstring.encoding.parameter; + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - The return value is str with the appropriate case folding applied. + A case folded version of <parameter>string</parameter> converted in the + way specified by <parameter>mode</parameter>. </para> + </refsect1> + + <refsect1 role="unicode"> + &reftitle.unicode; <para> By contrast to the standard case folding functions such as <function>strtolower</function> and <function>strtoupper</function>, @@ -43,6 +75,10 @@ For more information about the Unicode properties, please see <link xlink:href="&url.unicode.reports;">&url.unicode.reports;</link>. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>mb_convert_case</function> example</title> @@ -59,13 +95,19 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mb_strtolower</function>, - <function>mb_strtoupper</function>, - <function>strtolower</function>, - <function>strtoupper</function>, - <function>ucfirst</function>&listendand; - <function>ucwords</function> + <simplelist> + <member><function>mb_strtolower</function></member> + <member><function>mb_strtoupper</function></member> + <member><function>strtolower</function></member> + <member><function>strtoupper</function></member> + <member><function>ucfirst</function></member> + <member><function>ucwords</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-convert-encoding.xml?r1=1.6&r2=1.6.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-convert-encoding.xml diff -u phpdoc/en/reference/mbstring/functions/mb-convert-encoding.xml:1.6 phpdoc/en/reference/mbstring/functions/mb-convert-encoding.xml:1.6.2.1 --- phpdoc/en/reference/mbstring/functions/mb-convert-encoding.xml:1.6 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-convert-encoding.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<refentry xml:id="function.mb-convert-encoding" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.6.2.1 $ --> +<refentry xml:id="function.mb-convert-encoding" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_convert_encoding</refname> <refpurpose>Convert character encoding</refpurpose> @@ -15,20 +15,62 @@ <methodparam choice="opt"><type>mixed</type><parameter>from_encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_convert_encoding</function> converts - character encoding of string <parameter>str</parameter> from - <parameter>from_encoding</parameter> to - <parameter>to_encoding</parameter>. + Converts the character encoding of <type>string</type> <parameter>str</parameter> + to <parameter>to_encoding</parameter> + from optionally <parameter>from_encoding</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>str</parameter> : String to be converted. + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The <type>string</type> being encoded. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>to_encoding</parameter></term> + <listitem> + <para> + The type of encoding that <parameter>str</parameter> is being converted to. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>from_encoding</parameter></term> + <listitem> + <para> + Is specified by character code names before conversion. It is either + an <type>array</type>, or a comma separated enumerated list. + If <parameter>from_encoding</parameter> is not specified, the internal + encoding will be used. + <!-- link to internal encoding info --> + </para> + <para> + <!-- can the meaning of auto be altered? --> + "<literal>auto</literal>" may be used, which expands to + <emphasis>"ASCII,JIS,UTF-8,EUC-JP,SJIS"</emphasis>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>from_encoding</parameter> 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. + The encoded <type>string</type>. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>mb_convert_encoding</function> example</title> @@ -51,10 +93,17 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mb_detect_order</function>. + <simplelist> + <member><function>mb_detect_order</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-convert-kana.xml?r1=1.11&r2=1.11.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-convert-kana.xml diff -u phpdoc/en/reference/mbstring/functions/mb-convert-kana.xml:1.11 phpdoc/en/reference/mbstring/functions/mb-convert-kana.xml:1.11.2.1 --- phpdoc/en/reference/mbstring/functions/mb-convert-kana.xml:1.11 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-convert-kana.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.11 $ --> -<refentry xml:id="function.mb-convert-kana" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.11.2.1 $ --> +<refentry xml:id="function.mb-convert-kana" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_convert_kana</refname> <refpurpose>Convert "kana" one from another ("zen-kaku", "han-kaku" and more)</refpurpose> @@ -15,128 +15,159 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_convert_kana</function> performs "han-kaku" - - "zen-kaku" conversion for string <parameter>str</parameter>. It - returns converted string. This function is only useful for - Japanese. - </para> - <para> - <parameter>option</parameter> is conversion option. Default value - is <literal>"KV"</literal>. + Performs a "han-kaku" - "zen-kaku" conversion for <type>string</type> <parameter>str</parameter>. + This function is only useful for Japanese. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>encoding</parameter> is character encoding. If it is - omitted, internal character encoding is used. + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The <type>string</type> being converted. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>option</parameter></term> + <listitem> + <para> + The conversion option. The default value is <literal>"KV"</literal>. + </para> + <para> + Specify with a combination of following options. The default + value is <literal>KV</literal>. + <table> + <title>Applicable Conversion Options</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Option</entry> + <entry>Meaning</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>r</literal></entry> + <entry> + Convert "zen-kaku" alphabets to "han-kaku" + </entry> + </row> + <row> + <entry><literal>R</literal></entry> + <entry> + Convert "han-kaku" alphabets to "zen-kaku" + </entry> + </row> + <row> + <entry><literal>n</literal></entry> + <entry> + Convert "zen-kaku" numbers to "han-kaku" + </entry> + </row> + <row> + <entry><literal>N</literal></entry> + <entry> + Convert "han-kaku" numbers to "zen-kaku" + </entry> + </row> + <row> + <entry><literal>a</literal></entry> + <entry> + Convert "zen-kaku" alphabets and numbers to "han-kaku" + </entry> + </row> + <row> + <entry><literal>A</literal></entry> + <entry> + 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) + </entry> + </row> + <row> + <entry><literal>s</literal></entry> + <entry> + Convert "zen-kaku" space to "han-kaku" (U+3000 -> U+0020) + </entry> + </row> + <row> + <entry><literal>S</literal></entry> + <entry> + Convert "han-kaku" space to "zen-kaku" (U+0020 -> U+3000) + </entry> + </row> + <row> + <entry><literal>k</literal></entry> + <entry> + Convert "zen-kaku kata-kana" to "han-kaku kata-kana" + </entry> + </row> + <row> + <entry><literal>K</literal></entry> + <entry> + Convert "han-kaku kata-kana" to "zen-kaku kata-kana" + </entry> + </row> + <row> + <entry><literal>h</literal></entry> + <entry> + Convert "zen-kaku hira-gana" to "han-kaku kata-kana" + </entry> + </row> + <row> + <entry><literal>H</literal></entry> + <entry> + Convert "han-kaku kata-kana" to "zen-kaku hira-gana" + </entry> + </row> + <row> + <entry><literal>c</literal></entry> + <entry> + Convert "zen-kaku kata-kana" to "zen-kaku hira-gana" + </entry> + </row> + <row> + <entry><literal>C</literal></entry> + <entry> + Convert "zen-kaku hira-gana" to "zen-kaku kata-kana" + </entry> + </row> + <row> + <entry><literal>V</literal></entry> + <entry> + Collapse voiced sound notation and convert them into a character. Use with "K","H" + </entry> + </row> + </tbody> + </tgroup> + </table> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + &mbstring.encoding.parameter; + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - Specify with combination of following options. Default - value is <literal>KV</literal>. - <table> - <title>Applicable Conversion Options</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Option</entry> - <entry>Meaning</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>r</literal></entry> - <entry> - Convert "zen-kaku" alphabets to "han-kaku" - </entry> - </row> - <row> - <entry><literal>R</literal></entry> - <entry> - Convert "han-kaku" alphabets to "zen-kaku" - </entry> - </row> - <row> - <entry><literal>n</literal></entry> - <entry> - Convert "zen-kaku" numbers to "han-kaku" - </entry> - </row> - <row> - <entry><literal>N</literal></entry> - <entry> - Convert "han-kaku" numbers to "zen-kaku" - </entry> - </row> - <row> - <entry><literal>a</literal></entry> - <entry> - Convert "zen-kaku" alphabets and numbers to "han-kaku" - </entry> - </row> - <row> - <entry><literal>A</literal></entry> - <entry> - 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) - </entry> - </row> - <row> - <entry><literal>s</literal></entry> - <entry> - Convert "zen-kaku" space to "han-kaku" (U+3000 -> U+0020) - </entry> - </row> - <row> - <entry><literal>S</literal></entry> - <entry> - Convert "han-kaku" space to "zen-kaku" (U+0020 -> U+3000) - </entry> - </row> - <row> - <entry><literal>k</literal></entry> - <entry> - Convert "zen-kaku kata-kana" to "han-kaku kata-kana" - </entry> - </row> - <row> - <entry><literal>K</literal></entry> - <entry> - Convert "han-kaku kata-kana" to "zen-kaku kata-kana" - </entry> - </row> - <row> - <entry><literal>h</literal></entry> - <entry> - Convert "zen-kaku hira-gana" to "han-kaku kata-kana" - </entry> - </row> - <row> - <entry><literal>H</literal></entry> - <entry> - Convert "han-kaku kata-kana" to "zen-kaku hira-gana" - </entry> - </row> - <row> - <entry><literal>c</literal></entry> - <entry> - Convert "zen-kaku kata-kana" to "zen-kaku hira-gana" - </entry> - </row> - <row> - <entry><literal>C</literal></entry> - <entry> - Convert "zen-kaku hira-gana" to "zen-kaku kata-kana" - </entry> - </row> - <row> - <entry><literal>V</literal></entry> - <entry> - Collapse voiced sound notation and convert them into a character. Use with "K","H" - </entry> - </row> - </tbody> - </tgroup> - </table> + The converted <type>string</type>. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>mb_convert_kana</function> example</title> @@ -155,6 +186,7 @@ </example> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-convert-variables.xml?r1=1.9&r2=1.9.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-convert-variables.xml diff -u phpdoc/en/reference/mbstring/functions/mb-convert-variables.xml:1.9 phpdoc/en/reference/mbstring/functions/mb-convert-variables.xml:1.9.2.1 --- phpdoc/en/reference/mbstring/functions/mb-convert-variables.xml:1.9 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-convert-variables.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> -<refentry xml:id="function.mb-convert-variables" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.9.2.1 $ --> +<refentry xml:id="function.mb-convert-variables" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_convert_variables</refname> <refpurpose>Convert character code in variable(s)</refpurpose> @@ -16,11 +16,10 @@ <methodparam choice="opt"><type>mixed</type><parameter role="reference">...</parameter></methodparam> </methodsynopsis> <para> - <function>mb_convert_variables</function> convert + Converts character encoding of variables <parameter>vars</parameter> in encoding <parameter>from_encoding</parameter> to encoding - <parameter>to_encoding</parameter>. It returns character encoding - before conversion for success, &false; for failure. + <parameter>to_encoding</parameter>. </para> <para> <function>mb_convert_variables</function> join strings in Array @@ -28,19 +27,64 @@ fail for short strings. Therefore, it is impossible to mix encoding in single array or object. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - It <parameter>from_encoding</parameter> is specified by - array or comma separated string, it tries to detect encoding from - <parameter>from-coding</parameter>. When - <parameter>encoding</parameter> is omitted, - <literal>detect_order</literal> is used. + <variablelist> + <varlistentry> + <term><parameter>to_encoding</parameter></term> + <listitem> + <para> + The encoding that the <type>string</type> is being converted to. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>from_encoding</parameter></term> + <listitem> + <para> + <parameter>from_encoding</parameter> is specified as an <type>array</type> + or comma separated <type>string</type>, it tries to detect encoding from + <parameter>from-coding</parameter>. When <parameter>from_encoding</parameter> + is omitted, <literal>detect_order</literal> is used. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>vars</parameter></term> + <listitem> + <para> + <parameter>vars</parameter> is the reference to the + variable being converted. String, Array and Object are accepted. + <function>mb_convert_variables</function> assumes all parameters + have the same encoding. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>...</parameter></term> + <listitem> + <para> + Additional <parameter>vars</parameter>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>vars (3rd and larger)</parameter> is reference to - variable to be converted. String, Array and Object are accepted. - <function>mb_convert_variables</function> assumes all parameters - have the same encoding. + The character encoding before conversion for success, + or &false; for failure. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>mb_convert_variables</function> example</title> @@ -56,6 +100,7 @@ </example> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-decode-mimeheader.xml?r1=1.4&r2=1.4.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-decode-mimeheader.xml diff -u phpdoc/en/reference/mbstring/functions/mb-decode-mimeheader.xml:1.4 phpdoc/en/reference/mbstring/functions/mb-decode-mimeheader.xml:1.4.2.1 --- phpdoc/en/reference/mbstring/functions/mb-decode-mimeheader.xml:1.4 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-decode-mimeheader.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<refentry xml:id="function.mb-decode-mimeheader" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.4.2.1 $ --> +<refentry xml:id="function.mb-decode-mimeheader" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_decode_mimeheader</refname> <refpurpose>Decode string in MIME header field</refpurpose> @@ -13,16 +13,42 @@ <methodparam><type>string</type><parameter>str</parameter></methodparam> </methodsynopsis> <para> - <function>mb_decode_mimeheader</function> decodes encoded-word - string <parameter>str</parameter> in MIME header. + Decodes encoded-word <type>string</type> <parameter>str</parameter> in MIME header. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - It returns decoded string in internal character encoding. + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The <type>string</type> being decoded. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>mb_encode_mimeheader</function>. + The decoded <type>string</type> in internal character encoding. </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mb_encode_mimeheader</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-decode-numericentity.xml?r1=1.6&r2=1.6.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-decode-numericentity.xml diff -u phpdoc/en/reference/mbstring/functions/mb-decode-numericentity.xml:1.6 phpdoc/en/reference/mbstring/functions/mb-decode-numericentity.xml:1.6.2.1 --- phpdoc/en/reference/mbstring/functions/mb-decode-numericentity.xml:1.6 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-decode-numericentity.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<refentry xml:id="function.mb-decode-numericentity" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.6.2.1 $ --> +<refentry xml:id="function.mb-decode-numericentity" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_decode_numericentity</refname> <refpurpose>Decode HTML numeric string reference to character</refpurpose> @@ -15,18 +15,51 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - Convert numeric string reference of string - <parameter>str</parameter> in specified block to character. It - returns converted string. + Convert numeric string reference of <type>string</type> + <parameter>str</parameter> in a specified block to character. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>convmap</parameter> is array to specifies code area to - convert. + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The <type>string</type> being decoded. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>convmap</parameter></term> + <listitem> + <para> + <parameter>convmap</parameter> is an <type>array</type> that specifies + the code area to convert. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + &mbstring.encoding.parameter; + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>encoding</parameter> is character encoding. If it is - omitted, internal character encoding is used. + The converted <type>string</type>. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><parameter>convmap</parameter> example</title> @@ -44,10 +77,17 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mb_encode_numericentity</function>. + <simplelist> + <member><function>mb_encode_numericentity</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-detect-encoding.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-detect-encoding.xml diff -u phpdoc/en/reference/mbstring/functions/mb-detect-encoding.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-detect-encoding.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-detect-encoding.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-detect-encoding.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<refentry xml:id="function.mb-detect-encoding" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> +<refentry xml:id="function.mb-detect-encoding" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_detect_encoding</refname> <refpurpose>Detect character encoding</refpurpose> @@ -15,24 +15,59 @@ <methodparam choice="opt"><type>bool</type><parameter>strict</parameter></methodparam> </methodsynopsis> <para> - <function>mb_detect_encoding</function> detects character - encoding in string <parameter>str</parameter>. It returns - detected character encoding. - </para> - <para> - <parameter>encoding_list</parameter> is list of character - encoding. Encoding order may be specified by array or comma - separated list string. + Detects character encoding in <type>string</type> <parameter>str</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - If <parameter>encoding_list</parameter> is omitted, - detect_order is used. + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The <type>string</type> being detected. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding_list</parameter></term> + <listitem> + <para> + <parameter>encoding_list</parameter> is list of character + encoding. Encoding order may be specified by array or comma + separated list string. + </para> + <para> + If <parameter>encoding_list</parameter> is omitted, + detect_order is used. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>strict</parameter></term> + <listitem> + <para> + <parameter>strict</parameter> specifies whether to use + the strict encoding detection or not. + Default is &false;. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>strict</parameter> specifies whether to use - the strict encoding detection or not. - Default is &false;. + The detected character encoding. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>mb_detect_encoding</function> example</title> @@ -58,10 +93,17 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mb_detect_order</function>. + <simplelist> + <member><function>mb_detect_order</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-detect-order.xml?r1=1.8&r2=1.8.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-detect-order.xml diff -u phpdoc/en/reference/mbstring/functions/mb-detect-order.xml:1.8 phpdoc/en/reference/mbstring/functions/mb-detect-order.xml:1.8.2.1 --- phpdoc/en/reference/mbstring/functions/mb-detect-order.xml:1.8 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-detect-order.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> -<refentry xml:id="function.mb-detect-order" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.8.2.1 $ --> +<refentry xml:id="function.mb-detect-order" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_detect_order</refname> <refpurpose>Set/Get character encoding detection order</refpurpose> @@ -13,50 +13,56 @@ <methodparam choice="opt"><type>mixed</type><parameter>encoding_list</parameter></methodparam> </methodsynopsis> <para> - <function>mb_detect_order</function> sets automatic character + Sets the automatic character encoding detection order to <parameter>encoding_list</parameter>. - It returns &true; for success, - &false; for failure. - </para> - <para> - <parameter>encoding_list</parameter> is array or comma separated - list of character encoding. ("auto" is expanded to - "ASCII, JIS, UTF-8, EUC-JP, SJIS") - </para> - <para> - If <parameter>encoding_list</parameter> is omitted, it returns - current character encoding detection order as array. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - This setting affects <function>mb_detect_encoding</function> and - <function>mb_send_mail</function>. - </para> - <note> - <para> - <literal>mbstring</literal> currently implements following - encoding detection filters. If there is an invalid byte sequence - for following encoding, encoding detection will fail. - </para> - <simpara> - <literal>UTF-8</literal>, <literal>UTF-7</literal>, - <literal>ASCII</literal>, - <literal>EUC-JP</literal>,<literal>SJIS</literal>, - <literal>eucJP-win</literal>, <literal>SJIS-win</literal>, - <literal>JIS</literal>, <literal>ISO-2022-JP</literal> - </simpara> - <para> - For <literal>ISO-8859-*</literal>, <literal>mbstring</literal> - always detects as <literal>ISO-8859-*</literal>. - </para> - <para> - For <literal>UTF-16</literal>, <literal>UTF-32</literal>, - <literal>UCS2</literal> and <literal>UCS4</literal>, encoding - detection will fail always. - </para> - <para> - <example> - <title>Useless detect order example</title> - <programlisting> + <variablelist> + <varlistentry> + <term><parameter>encoding_list</parameter></term> + <listitem> + <para> + <parameter>encoding_list</parameter> is an <type>array</type> or + comma separated list of character encoding. ("auto" is expanded to + "ASCII, JIS, UTF-8, EUC-JP, SJIS") + </para> + <para> + If <parameter>encoding_list</parameter> is omitted, it returns + the current character encoding detection order as array. + </para> + <para> + This setting affects <function>mb_detect_encoding</function> and + <function>mb_send_mail</function>. + </para> + <para> + <literal>mbstring</literal> currently implements the following + encoding detection filters. If there is an invalid byte sequence + for the following encodings, encoding detection will fail. + </para> + <simpara> + <literal>UTF-8</literal>, <literal>UTF-7</literal>, + <literal>ASCII</literal>, + <literal>EUC-JP</literal>,<literal>SJIS</literal>, + <literal>eucJP-win</literal>, <literal>SJIS-win</literal>, + <literal>JIS</literal>, <literal>ISO-2022-JP</literal> + </simpara> + <para> + For <literal>ISO-8859-*</literal>, <literal>mbstring</literal> + always detects as <literal>ISO-8859-*</literal>. + </para> + <para> + For <literal>UTF-16</literal>, <literal>UTF-32</literal>, + <literal>UCS2</literal> and <literal>UCS4</literal>, encoding + detection will fail always. + </para> + <para> + <example> + <title>Useless detect order example</title> + <programlisting> <![CDATA[ ; Always detect as ISO-8859-1 detect_order = ISO-8859-1, UTF-8 @@ -65,10 +71,24 @@ ; valid for UTF-8 detect_order = UTF-8, ASCII, UTF-7 ]]> - </programlisting> - </example> - </para> - </note> + </programlisting> + </example> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>mb_detect_order</function> examples</title> @@ -91,13 +111,20 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mb_internal_encoding</function>, - <function>mb_http_input</function>, - <function>mb_http_output</function> and - <function>mb_send_mail</function>. + <simplelist> + <member><function>mb_internal_encoding</function></member> + <member><function>mb_http_input</function></member> + <member><function>mb_http_output</function></member> + <member><function>mb_send_mail</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-encode-mimeheader.xml?r1=1.11&r2=1.11.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-encode-mimeheader.xml diff -u phpdoc/en/reference/mbstring/functions/mb-encode-mimeheader.xml:1.11 phpdoc/en/reference/mbstring/functions/mb-encode-mimeheader.xml:1.11.2.1 --- phpdoc/en/reference/mbstring/functions/mb-encode-mimeheader.xml:1.11 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-encode-mimeheader.xml Sun Dec 2 07:38:42 2007 @@ -1,5 +1,5 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.11 $ --> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.11.2.1 $ --> <refentry xml:id="function.mb-encode-mimeheader" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_encode_mimeheader</refname> @@ -17,29 +17,102 @@ <methodparam choice="opt"><type>int</type><parameter>indent</parameter></methodparam> </methodsynopsis> <para> - <function>mb_encode_mimeheader</function> encodes a given string + Encodes a given <type>string</type> <parameter>str</parameter> by the MIME header encoding scheme. - Returns a converted version of the string represented in ASCII. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>charset</parameter> specifies the name of the character set - in which <parameter>str</parameter> is represented in. The default value - is determined by the current NLS setting (<literal>mbstring.language</literal>). + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The <type>string</type> being encoded. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>charset</parameter></term> + <listitem> + <para> + <parameter>charset</parameter> specifies the name of the character set + in which <parameter>str</parameter> is represented in. The default value + is determined by the current NLS setting (<literal>mbstring.language</literal>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>transfer_encoding</parameter></term> + <listitem> + <para> + <parameter>transfer_encoding</parameter> specifies the scheme of MIME + encoding. It should be either <literal>"B"</literal> (Base64) or + <literal>"Q"</literal> (Quoted-Printable). Falls back to + <literal>"B"</literal> if not given. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>linefeed</parameter></term> + <listitem> + <para> + <parameter>linefeed</parameter> specifies the EOL (end-of-line) marker + with which <function>mb_encode_mimeheader</function> performs + line-folding (a <link xlink:href="&url.rfc;2822">RFC</link> 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 <literal>"\r\n"</literal> (CRLF) if not given. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>indent</parameter></term> + <listitem> + <para> + + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>transfer_encoding</parameter> specifies the scheme of MIME - encoding. It should be either <literal>"B"</literal> (Base64) or - <literal>"Q"</literal> (Quoted-Printable). Falls back to - <literal>"B"</literal> if not given. + A converted version of the <type>string</type> represented in ASCII. </para> + </refsect1> + + <refsect1 role="changelog"> + &reftitle.changelog; <para> - <parameter>linefeed</parameter> specifies the EOL (end-of-line) marker - with which <function>mb_encode_mimeheader</function> performs - line-folding (a <link xlink:href="&url.rfc;2822">RFC</link> 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 <literal>"\r\n"</literal> (CRLF) if not given. + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>5.0.0</entry> + <entry> + The <parameter>indent</parameter> parameter was added. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>mb_encode_mimeheader</function> example</title> @@ -56,6 +129,10 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> This function isn't designed to break lines at higher-level @@ -63,13 +140,17 @@ This behaviour may clutter up the original string with unexpected spaces. </para> </note> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - The <parameter>indent</parameter> was added as of PHP 5. - </para> - <para> - See also <function>mb_decode_mimeheader</function>. + <simplelist> + <member><function>mb_decode_mimeheader</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-encode-numericentity.xml?r1=1.6&r2=1.6.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-encode-numericentity.xml diff -u phpdoc/en/reference/mbstring/functions/mb-encode-numericentity.xml:1.6 phpdoc/en/reference/mbstring/functions/mb-encode-numericentity.xml:1.6.2.1 --- phpdoc/en/reference/mbstring/functions/mb-encode-numericentity.xml:1.6 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-encode-numericentity.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<refentry xml:id="function.mb-encode-numericentity" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.6.2.1 $ --> +<refentry xml:id="function.mb-encode-numericentity" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_encode_numericentity</refname> <refpurpose>Encode character to HTML numeric string reference</refpurpose> @@ -15,18 +15,52 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_encode_numericentity</function> converts - specified character codes in string <parameter>str</parameter> - from HTML numeric character reference to character code. It - returns converted string. + Converts + specified character codes in <type>string</type> <parameter>str</parameter> + from HTML numeric character reference to character code. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>convmap</parameter> is array specifies code area to - convert. + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The <type>string</type> being encoded. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>convmap</parameter></term> + <listitem> + <para> + <parameter>convmap</parameter> is array specifies code area to + convert. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + &mbstring.encoding.parameter; + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>encoding</parameter> is character encoding. + The converted <type>string</type>. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><parameter>convmap</parameter> example</title> @@ -44,6 +78,10 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>mb_encode_numericentity</function> example</title> @@ -73,10 +111,17 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mb_decode_numericentity</function>. + <simplelist> + <member><function>mb_decode_numericentity</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-ereg-match.xml?r1=1.6&r2=1.6.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-ereg-match.xml diff -u phpdoc/en/reference/mbstring/functions/mb-ereg-match.xml:1.6 phpdoc/en/reference/mbstring/functions/mb-ereg-match.xml:1.6.2.1 --- phpdoc/en/reference/mbstring/functions/mb-ereg-match.xml:1.6 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-ereg-match.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<refentry xml:id="function.mb-ereg-match" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.6.2.1 $ --> +<refentry xml:id="function.mb-ereg-match" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_ereg_match</refname> <refpurpose>Regular expression match for multibyte string</refpurpose> @@ -12,25 +12,70 @@ <type>bool</type><methodname>mb_ereg_match</methodname> <methodparam><type>string</type><parameter>pattern</parameter></methodparam> <methodparam><type>string</type><parameter>string</parameter></methodparam> - <methodparam choice="opt"> - <type>string</type><parameter>option</parameter> - </methodparam> + <methodparam choice="opt"><type>string</type><parameter>option</parameter></methodparam> </methodsynopsis> + <para> + A regular expression match for a multibyte string + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>pattern</parameter></term> + <listitem> + <para> + The regular expression pattern. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>string</parameter></term> + <listitem> + <para> + The <type>string</type> being evaluated. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>option</parameter></term> + <listitem> + <para> + + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <simpara> - <function>mb_ereg_match</function> returns &true; if - <parameter>string</parameter> matches regular expression + Returns &true; if + <parameter>string</parameter> matches the regular expression <parameter>pattern</parameter>, &false; if not. </simpara> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + + ¬e.mbstring.encoding.internal; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - The internal encoding or the character encoding specified in - <function>mb_regex_encoding</function> will be used as character - encoding. - </para> - <para> - See also: <function>mb_regex_encoding</function>, - <function>mb_ereg</function>. + <simplelist> + <member><function>mb_regex_encoding</function></member> + <member><function>mb_ereg</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-ereg-replace.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-ereg-replace.xml diff -u phpdoc/en/reference/mbstring/functions/mb-ereg-replace.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-ereg-replace.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-ereg-replace.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-ereg-replace.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<refentry xml:id="function.mb-ereg-replace" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> +<refentry xml:id="function.mb-ereg-replace" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_ereg_replace</refname> <refpurpose>Replace regular expression with multibyte support</refpurpose> @@ -16,35 +16,87 @@ <methodparam choice="opt"><type>string</type><parameter>option</parameter></methodparam> </methodsynopsis> <simpara> - <function>mb_ereg_replace</function> scans - <parameter>string</parameter> for matches to + Scans <parameter>string</parameter> for matches to <parameter>pattern</parameter>, then replaces the matched text - with <parameter>replacement</parameter> and returns the result - string or &false; on error. Multibyte character can be used in - <parameter>pattern</parameter>. - </simpara> - <simpara> - Matching condition can be set by <parameter>option</parameter> - parameter. If <literal>i</literal> is specified for this - parameter, the case will be ignored. If <literal>x</literal> is - specified, white space will be ignored. If <literal>m</literal> - is specified, match will be executed in multiline mode and line - break will be included in '.'. If <literal>p</literal> is - specified, match will be executed in POSIX mode, line break - will be considered as normal character. If <literal>e</literal> - is specified, <parameter>replacement</parameter> string will be - evaluated as PHP expression. + with <parameter>replacement</parameter> </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>pattern</parameter></term> + <listitem> + <para> + The regular expression pattern. + </para> + <para> + Multibyte characters may be used in <parameter>pattern</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>replacement</parameter></term> + <listitem> + <para> + The replacement text. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>string</parameter></term> + <listitem> + <para> + The <type>string</type> being checked. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>option</parameter></term> + <listitem> + <simpara> + Matching condition can be set by <parameter>option</parameter> + parameter. If <literal>i</literal> is specified for this + parameter, the case will be ignored. If <literal>x</literal> is + specified, white space will be ignored. If <literal>m</literal> + is specified, match will be executed in multiline mode and line + break will be included in '.'. If <literal>p</literal> is + specified, match will be executed in POSIX mode, line break + will be considered as normal character. If <literal>e</literal> + is specified, <parameter>replacement</parameter> string will be + evaluated as PHP expression. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - The internal encoding or the character encoding specified in - <function>mb_regex_encoding</function> will be used as character - encoding. + The resultant <type>string</type> on success, or &false; on error. </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + + ¬e.mbstring.encoding.internal; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>mb_regex_encoding</function>, - <function>mb_eregi_replace</function>. + <simplelist> + <member><function>mb_regex_encoding</function></member> + <member><function>mb_eregi_replace</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-ereg-search-getpos.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-ereg-search-getpos.xml diff -u phpdoc/en/reference/mbstring/functions/mb-ereg-search-getpos.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-ereg-search-getpos.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-ereg-search-getpos.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-ereg-search-getpos.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<refentry xml:id="function.mb-ereg-search-getpos" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> +<refentry xml:id="function.mb-ereg-search-getpos" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_ereg_search_getpos</refname> <refpurpose>Returns start point for next regular expression match</refpurpose> @@ -13,6 +13,18 @@ <void/> </methodsynopsis> <simpara> + Returns the start point for the next regular expression match. + </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <simpara> <function>mb_ereg_search_getpos</function> returns the point to start regular expression match for <function>mb_ereg_search</function>, @@ -20,16 +32,24 @@ <function>mb_ereg_search_regs</function>. The position is represented by bytes from the head of string. </simpara> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + + ¬e.mbstring.encoding.internal; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - The internal encoding or the character encoding specified in - <function>mb_regex_encoding</function> will be used as character - encoding. - </para> - <para> - See also: <function>mb_regex_encoding</function>, - <function>mb_ereg_search_setpos</function>. + <simplelist> + <member><function>mb_regex_encoding</function></member> + <member><function>mb_ereg_search_setpos</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-ereg-search-getregs.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-ereg-search-getregs.xml diff -u phpdoc/en/reference/mbstring/functions/mb-ereg-search-getregs.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-ereg-search-getregs.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-ereg-search-getregs.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-ereg-search-getregs.xml Sun Dec 2 07:38:42 2007 @@ -1,10 +1,9 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<refentry xml:id="function.mb-ereg-search-getregs" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> +<refentry xml:id="function.mb-ereg-search-getregs" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_ereg_search_getregs</refname> - <refpurpose>Retrieve the result from the last multibyte regular expression match - </refpurpose> + <refpurpose>Retrieve the result from the last multibyte regular expression match</refpurpose> </refnamediv> <refsect1 role="description"> @@ -14,7 +13,19 @@ <void/> </methodsynopsis> <simpara> - <function>mb_ereg_search_getregs</function> returns an array + Retrieve the result from the last multibyte regular expression match + </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <simpara> + An <type>array</type> including the sub-string of matched part by last <function>mb_ereg_search</function>, <function>mb_ereg_search_pos</function>, @@ -24,16 +35,24 @@ the third element will have the second part grouped with brackets, and so on. It returns &false; on error; </simpara> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + + ¬e.mbstring.encoding.internal; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - The internal encoding or the character encoding specified in - <function>mb_regex_encoding</function> will be used as character - encoding. - </para> - <para> - See also: <function>mb_regex_encoding</function>, - <function>mb_ereg_search_init</function>. + <simplelist> + <member><function>mb_regex_encoding</function></member> + <member><function>mb_ereg_search_init</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-ereg-search-init.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-ereg-search-init.xml diff -u phpdoc/en/reference/mbstring/functions/mb-ereg-search-init.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-ereg-search-init.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-ereg-search-init.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-ereg-search-init.xml Sun Dec 2 07:38:42 2007 @@ -1,9 +1,9 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<refentry xml:id="function.mb-ereg-search-init" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> +<refentry xml:id="function.mb-ereg-search-init" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_ereg_search_init</refname> - <refpurpose>Setup string and regular expression for multibyte regularexpression match</refpurpose> + <refpurpose>Setup string and regular expression for a multibyte regular expression match</refpurpose> </refnamediv> <refsect1 role="description"> @@ -14,25 +14,44 @@ <methodparam choice="opt"><type>string</type><parameter>pattern</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>option</parameter></methodparam> </methodsynopsis> - <simpara> + <para> <function>mb_ereg_search_init</function> sets <parameter>string</parameter> and <parameter>pattern</parameter> - for multibyte regular expression. These values are used for + for a multibyte regular expression. These values are used for <function>mb_ereg_search</function>, - <function>mb_ereg_search_pos</function>, - <function>mb_ereg_search_regs</function>. It returns &true; for - success, &false; for error. - </simpara> - <para> - The internal encoding or the character encoding specified in - <function>mb_regex_encoding</function> will be used as character - encoding. + <function>mb_ereg_search_pos</function>, and + <function>mb_ereg_search_regs</function>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <simpara> + &return.success; + </simpara> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + + ¬e.mbstring.encoding.internal; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>mb_regex_encoding</function>, - <function>mb_ereg_search_regs</function>. + <simplelist> + <member><function>mb_regex_encoding</function></member> + <member><function>mb_ereg_search_regs</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-ereg-search-pos.xml?r1=1.9&r2=1.9.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-ereg-search-pos.xml diff -u phpdoc/en/reference/mbstring/functions/mb-ereg-search-pos.xml:1.9 phpdoc/en/reference/mbstring/functions/mb-ereg-search-pos.xml:1.9.2.1 --- phpdoc/en/reference/mbstring/functions/mb-ereg-search-pos.xml:1.9 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-ereg-search-pos.xml Sun Dec 2 07:38:42 2007 @@ -1,9 +1,9 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> -<refentry xml:id="function.mb-ereg-search-pos" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.9.2.1 $ --> +<refentry xml:id="function.mb-ereg-search-pos" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_ereg_search_pos</refname> - <refpurpose>Return position and length of matched part of multibyte regular expression for predefined multibyte string</refpurpose> + <refpurpose>Returns position and length of a matched part of the multibyte regular expression for a predefined multibyte string</refpurpose> </refnamediv> <refsect1 role="description"> @@ -13,28 +13,68 @@ <methodparam choice="opt"><type>string</type><parameter>pattern</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>option</parameter></methodparam> </methodsynopsis> - <simpara> - <function>mb_ereg_search_pos</function> 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. - </simpara> + <para> + Returns position and length of a matched part of the multibyte regular expression + for a predefined multibyte string + </para> <para> The string for match is specified by <function>mb_ereg_search_init</function>. If it is not specified, the previous one will be used. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The internal encoding or the character encoding specified in - <function>mb_regex_encoding</function> will be used as character - encoding. + <variablelist> + <varlistentry> + <term><parameter>pattern</parameter></term> + <listitem> + <para> + The search pattern. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>option</parameter></term> + <listitem> + <para> + The search option. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <simpara> + An <type>array</type> including + the position of a matched part for a 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. + </simpara> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + + ¬e.mbstring.encoding.internal; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>mb_regex_encoding</function>, - <function>mb_ereg_search_init</function>. + <simplelist> + <member><function>mb_regex_encoding</function></member> + <member><function>mb_ereg_search_init</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-ereg-search-regs.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-ereg-search-regs.xml diff -u phpdoc/en/reference/mbstring/functions/mb-ereg-search-regs.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-ereg-search-regs.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-ereg-search-regs.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-ereg-search-regs.xml Sun Dec 2 07:38:42 2007 @@ -1,9 +1,9 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<refentry xml:id="function.mb-ereg-search-regs" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> +<refentry xml:id="function.mb-ereg-search-regs" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_ereg_search_regs</refname> - <refpurpose>Returns the matched part of multibyte regular expression</refpurpose> + <refpurpose>Returns the matched part of a multibyte regular expression</refpurpose> </refnamediv> <refsect1 role="description"> @@ -13,24 +13,63 @@ <methodparam choice="opt"><type>string</type><parameter>pattern</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>option</parameter></methodparam> </methodsynopsis> + <para> + Returns the matched part of a multibyte regular expression. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>pattern</parameter></term> + <listitem> + <para> + The search pattern. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>option</parameter></term> + <listitem> + <para> + The search option. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <simpara> <function>mb_ereg_search_regs</function> executes the multibyte regular expression match, and if there are some matched part, it - returns an array including substring of matched part as first + returns an <type>array</type> 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 second grouped part as third element, and so on. + It returns &false; on error. </simpara> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + + ¬e.mbstring.encoding.internal; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - The internal encoding or the character encoding specified in - <function>mb_regex_encoding</function> will be used as character - encoding. - </para> - <para> - See also: <function>mb_regex_encoding</function>, - <function>mb_ereg_search_init</function>. + <simplelist> + <member><function>mb_regex_encoding</function></member> + <member><function>mb_ereg_search_init</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-ereg-search-setpos.xml?r1=1.8&r2=1.8.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-ereg-search-setpos.xml diff -u phpdoc/en/reference/mbstring/functions/mb-ereg-search-setpos.xml:1.8 phpdoc/en/reference/mbstring/functions/mb-ereg-search-setpos.xml:1.8.2.1 --- phpdoc/en/reference/mbstring/functions/mb-ereg-search-setpos.xml:1.8 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-ereg-search-setpos.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> -<refentry xml:id="function.mb-ereg-search-setpos" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.8.2.1 $ --> +<refentry xml:id="function.mb-ereg-search-setpos" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_ereg_search_setpos</refname> <refpurpose>Set start point of next regular expression match</refpurpose> @@ -14,18 +14,49 @@ </methodsynopsis> <simpara> <function>mb_ereg_search_setpos</function> sets the starting - point of match for <function>mb_ereg_search</function>. + point of a match for <function>mb_ereg_search</function>. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The internal encoding or the character encoding specified in - <function>mb_regex_encoding</function> will be used as character - encoding. + <variablelist> + <varlistentry> + <term><parameter>position</parameter></term> + <listitem> + <para> + The position to set. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <simpara> + &return.success; + </simpara> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + + ¬e.mbstring.encoding.internal; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>mb_regex_encoding</function>, - <function>mb_ereg_search_init</function>. + <simplelist> + <member><function>mb_regex_encoding</function></member> + <member><function>mb_ereg_search_init</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-ereg-search.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-ereg-search.xml diff -u phpdoc/en/reference/mbstring/functions/mb-ereg-search.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-ereg-search.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-ereg-search.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-ereg-search.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<refentry xml:id="function.mb-ereg-search" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> +<refentry xml:id="function.mb-ereg-search" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_ereg_search</refname> <refpurpose>Multibyte regular expression match for predefined multibyte string</refpurpose> @@ -13,24 +13,63 @@ <methodparam choice="opt"><type>string</type><parameter>pattern</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>option</parameter></methodparam> </methodsynopsis> + <para> + Performs a multibyte regular expression match for a predefined multibyte string. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>pattern</parameter></term> + <listitem> + <para> + The search pattern. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>option</parameter></term> + <listitem> + <para> + The search option. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <simpara> <function>mb_ereg_search</function> returns &true; if the - multibyte string matches with the regular expression, &false; for - otherwise. The string for matching is set by + multibyte string matches with the regular expression, or &false; + otherwise. The <type>string</type> for matching is set by <function>mb_ereg_search_init</function>. If <parameter>pattern</parameter> is not specified, the previous one is used. </simpara> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + + ¬e.mbstring.encoding.internal; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - The internal encoding or the character encoding specified in - <function>mb_regex_encoding</function> will be used as character - encoding. - </para> - <para> - See also: <function>mb_regex_encoding</function>, - <function>mb_ereg_search_init</function>. + <simplelist> + <member><function>mb_regex_encoding</function></member> + <member><function>mb_ereg_search_init</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-ereg.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-ereg.xml diff -u phpdoc/en/reference/mbstring/functions/mb-ereg.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-ereg.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-ereg.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-ereg.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<refentry xml:id="function.mb-ereg" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> +<refentry xml:id="function.mb-ereg" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_ereg</refname> <refpurpose>Regular expression match with multibyte support</refpurpose> @@ -12,30 +12,75 @@ <type>int</type><methodname>mb_ereg</methodname> <methodparam><type>string</type><parameter>pattern</parameter></methodparam> <methodparam><type>string</type><parameter>string</parameter></methodparam> - <methodparam choice="opt"> - <type>array</type><parameter>regs</parameter> - </methodparam> + <methodparam choice="opt"><type>array</type><parameter>regs</parameter></methodparam> </methodsynopsis> <simpara> - <function>mb_ereg</function> 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 - <parameter>regs</parameter> 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. + Executes the regular expression match with multibyte support. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The internal encoding or the character encoding specified in - <function>mb_regex_encoding</function> will be used as character - encoding. + <variablelist> + <varlistentry> + <term><parameter>pattern</parameter></term> + <listitem> + <para> + The search pattern. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>string</parameter></term> + <listitem> + <para> + The search <type>string</type>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>regs</parameter></term> + <listitem> + <para> + Contains a substring of the matched <type>string</type>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <simpara> + Executes the regular expression + match with multibyte support, and returns <literal>1</literal> if matches are found. + If the optional <parameter>regs</parameter> parameter was specified, the function + returns the byte length of matched part, and the <type>array</type> + <parameter>regs</parameter> will contain the substring of matched + string. The function returns <literal>1</literal> if it matches with the empty + string. If no matches are found or an error happens, &false; will be + returned. + </simpara> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + + ¬e.mbstring.encoding.internal; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>mb_regex_encoding</function>, - <function>mb_eregi</function> + <simplelist> + <member><function>mb_regex_encoding</function></member> + <member><function>mb_eregi</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-eregi-replace.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-eregi-replace.xml diff -u phpdoc/en/reference/mbstring/functions/mb-eregi-replace.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-eregi-replace.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-eregi-replace.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-eregi-replace.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<refentry xml:id="function.mb-eregi-replace" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> +<refentry xml:id="function.mb-eregi-replace" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_eregi_replace</refname> <refpurpose>Replace regular expression with multibyte support ignoring case</refpurpose> @@ -16,25 +16,76 @@ <methodparam choice="opt"><type>string</type><parameter>option</parameter></methodparam> </methodsynopsis> <simpara> - <function>mb_ereg_replace</function> scans - <parameter>string</parameter> for matches to + Scans <parameter>string</parameter> for matches to <parameter>pattern</parameter>, then replaces the matched text - with <parameter>replacement</parameter> and returns the result - string or &false; on error. Multibyte character can be used in - <parameter>pattern</parameter>. The case will be ignored. - <parameter>option</parameter> has the same meaning as in - <function>mb_ereg_replace</function>. + with <parameter>replacement</parameter>. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>pattern</parameter></term> + <listitem> + <para> + The regular expression pattern. Multibyte characters may be used. The case will be ignored. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>replace</parameter></term> + <listitem> + <para> + The replacement text. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>string</parameter></term> + <listitem> + <para> + The searched <type>string</type>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>option</parameter></term> + <listitem> + <simpara> + <parameter>option</parameter> has the same meaning as in + <function>mb_ereg_replace</function>. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - The internal encoding or the character encoding specified in - <function>mb_regex_encoding</function> will be used as character - encoding. + The resultant <type>string</type> or &false; on error. </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + + ¬e.mbstring.encoding.internal; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>mb_regex_encoding</function>, - <function>mb_ereg_replace</function>. + <simplelist> + <member><function>mb_regex_encoding</function></member> + <member><function>mb_ereg_replace</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-eregi.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-eregi.xml diff -u phpdoc/en/reference/mbstring/functions/mb-eregi.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-eregi.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-eregi.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-eregi.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<refentry xml:id="function.mb-eregi" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> +<refentry xml:id="function.mb-eregi" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_eregi</refname> <refpurpose>Regular expression match ignoring case with multibyte support</refpurpose> @@ -12,31 +12,75 @@ <type>int</type><methodname>mb_eregi</methodname> <methodparam><type>string</type><parameter>pattern</parameter></methodparam> <methodparam><type>string</type><parameter>string</parameter></methodparam> - <methodparam choice="opt"> - <type>array</type><parameter>regs</parameter> - </methodparam> + <methodparam choice="opt"><type>array</type><parameter>regs</parameter></methodparam> </methodsynopsis> <simpara> - <function>mb_eregi</function> 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 - <parameter>regs</parameter> 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. + Executes the case insensitive regular expression match with multibyte support. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The internal encoding or the character encoding specified in - <function>mb_regex_encoding</function> will be used as character - encoding. + <variablelist> + <varlistentry> + <term><parameter>pattern</parameter></term> + <listitem> + <para> + The regular expression pattern. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>string</parameter></term> + <listitem> + <para> + The <type>string</type> being searched. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>regs</parameter></term> + <listitem> + <para> + Contains a substring of the matched <type>string</type>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <simpara> + Executes the regular expression + match with multibyte support, and returns <literal>1</literal> if matches are found. + If the optional <parameter>regs</parameter> parameter was specified, the function + returns the byte length of matched part, and the <type>array</type> + <parameter>regs</parameter> will contain the substring of matched + string. The function returns <literal>1</literal> if it matches with the empty + string. If no matches are found or an error happens, &false; will be + returned. + </simpara> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + + ¬e.mbstring.encoding.internal; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>mb_regex_encoding</function>, - <function>mb_ereg</function>. + <simplelist> + <member><function>mb_regex_encoding</function></member> + <member><function>mb_ereg</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-get-info.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-get-info.xml diff -u phpdoc/en/reference/mbstring/functions/mb-get-info.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-get-info.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-get-info.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-get-info.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<refentry xml:id="function.mb-get-info" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> +<refentry xml:id="function.mb-get-info" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_get_info</refname> <refpurpose>Get internal settings of mbstring</refpurpose> @@ -13,26 +13,77 @@ <methodparam choice="opt"><type>string</type><parameter>type</parameter></methodparam> </methodsynopsis> <simpara> - <function>mb_get_info</function> returns internal setting - parameter of mbstring. + <function>mb_get_info</function> returns the internal setting parameters of mbstring. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>type</parameter></term> + <listitem> + <para> + If <parameter>type</parameter> isn't specified or is specified to + "all", an <type>array</type> having the elements "internal_encoding", + "http_output", "http_input", "func_overload", "mail_charset", + "mail_header_encoding", "mail_body_encoding" will be returned. + </para> + <para> + If <parameter>type</parameter> is specified as "http_output", + "http_input", "internal_encoding", "func_overload", + the specified setting parameter will be returned. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - If <parameter>type</parameter> 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. + An <type>array</type> of type information if <parameter>type</parameter> + is not specified, otherwise a specific <parameter>type</parameter>. </para> + </refsect1> + + <refsect1 role="changelog"> + &reftitle.changelog; <para> - If <parameter>type</parameter> is specified for "http_output", - "http_input", "internal_encoding", "func_overload", - the specified setting parameter will be returned. + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>5.1.3</entry> + <entry> + The element types "mail_charset", "mail_header_encoding", and + "mail_body_encoding" were made available. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mb_internal_encoding</function>, - <function>mb_http_output</function>. + <simplelist> + <member><function>mb_regex_encoding</function></member> + <member><function>mb_http_output</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-http-input.xml?r1=1.5&r2=1.5.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-http-input.xml diff -u phpdoc/en/reference/mbstring/functions/mb-http-input.xml:1.5 phpdoc/en/reference/mbstring/functions/mb-http-input.xml:1.5.2.1 --- phpdoc/en/reference/mbstring/functions/mb-http-input.xml:1.5 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-http-input.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<refentry xml:id="function.mb-http-input" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.5.2.1 $ --> +<refentry xml:id="function.mb-http-input" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_http_input</refname> <refpurpose>Detect HTTP input character encoding</refpurpose> @@ -13,27 +13,49 @@ <methodparam choice="opt"><type>string</type><parameter>type</parameter></methodparam> </methodsynopsis> <simpara> - <function>mb_http_input</function> returns result of HTTP input - character encoding detection. + Detects the HTTP input character encoding. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>type</parameter>: 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 <type>array</type>). If type is omitted, it returns last - input type processed. + <variablelist> + <varlistentry> + <term><parameter>type</parameter></term> + <listitem> + <para> + Input string specifies the input type. + "G" for GET, "P" for POST, "C" for COOKIE, "S" for string, "L" for list, and + "I" for the whole list (will return <type>array</type>). + If type is omitted, it returns the last input type processed. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - Return Value: Character encoding name. + The character encoding name, as per the <parameter>type</parameter>. If <function>mb_http_input</function> does not process specified HTTP input, it returns &false;. </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mb_internal_encoding</function>, - <function>mb_http_output</function>, - <function>mb_detect_order</function>. + <simplelist> + <member><function>mb_internal_encoding</function></member> + <member><function>mb_http_output</function></member> + <member><function>mb_detect_order</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-http-output.xml?r1=1.5&r2=1.5.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-http-output.xml diff -u phpdoc/en/reference/mbstring/functions/mb-http-output.xml:1.5 phpdoc/en/reference/mbstring/functions/mb-http-output.xml:1.5.2.1 --- phpdoc/en/reference/mbstring/functions/mb-http-output.xml:1.5 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-http-output.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<refentry xml:id="function.mb-http-output" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.5.2.1 $ --> +<refentry xml:id="function.mb-http-output" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_http_output</refname> <refpurpose>Set/Get HTTP output character encoding</refpurpose> @@ -13,25 +13,55 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - If <parameter>encoding</parameter> is set, - <function>mb_http_output</function> sets HTTP output character - encoding to <parameter>encoding</parameter>. Output after this - function is converted to <parameter>encoding</parameter>. - <function>mb_http_output</function> returns - &true; for success and &false; - for failure. + Set/Get the HTTP output character encoding. + Output after this function is converted to <parameter>encoding</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + <para> + If <parameter>encoding</parameter> is set, + <function>mb_http_output</function> sets the HTTP output character + encoding to <parameter>encoding</parameter>. + </para> + <para> + If <parameter>encoding</parameter> is omitted, + <function>mb_http_output</function> returns the current HTTP output + character encoding. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> If <parameter>encoding</parameter> is omitted, - <function>mb_http_output</function> returns current HTTP output - character encoding. + <function>mb_http_output</function> returns the current HTTP output + character encoding. Otherwise, + &return.success; </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mb_internal_encoding</function>, - <function>mb_http_input</function>, - <function>mb_detect_order</function>. + <simplelist> + <member><function>mb_internal_encoding</function></member> + <member><function>mb_http_input</function></member> + <member><function>mb_detect_order</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-internal-encoding.xml?r1=1.6&r2=1.6.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-internal-encoding.xml diff -u phpdoc/en/reference/mbstring/functions/mb-internal-encoding.xml:1.6 phpdoc/en/reference/mbstring/functions/mb-internal-encoding.xml:1.6.2.1 --- phpdoc/en/reference/mbstring/functions/mb-internal-encoding.xml:1.6 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-internal-encoding.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<refentry xml:id="function.mb-internal-encoding" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.6.2.1 $ --> +<refentry xml:id="function.mb-internal-encoding" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_internal_encoding</refname> <refpurpose>Set/Get internal character encoding</refpurpose> @@ -13,26 +13,41 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_internal_encoding</function> sets internal character - encoding to <parameter>encoding</parameter> If parameter is - omitted, it returns current internal encoding. - </para> - <para> - <parameter>encoding</parameter> is used for HTTP input character - encoding conversion, HTTP output character encoding conversion - and default character encoding for string functions defined by - mbstring module. + Set/Get the internal character encoding </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>encoding</parameter>: Character encoding name + <variablelist> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + <para> + <parameter>encoding</parameter> is the character encoding name + used for the HTTP input character encoding conversion, HTTP output + character encoding conversion, and the default character encoding + for string functions defined by the mbstring module. + </para> + </listitem> + </varlistentry> + </variablelist> </para> - <para> - Return Value: If <parameter>encoding</parameter> is - set,<function>mb_internal_encoding</function> returns - &true; for success, otherwise returns - &false;. If <parameter>encoding</parameter> is - omitted, it returns current character encoding name. + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + If <parameter>encoding</parameter> is set, then + &return.success; + If <parameter>encoding</parameter> is omitted, then + the current character encoding name is returned. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>mb_internal_encoding</function> example</title> @@ -49,12 +64,25 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + + ¬e.mbstring.encoding.internal; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mb_http_input</function>, - <function>mb_http_output</function> and - <function>mb_detect_order</function>. + <simplelist> + <member><function>mb_http_input</function></member> + <member><function>mb_http_output</function></member> + <member><function>mb_detect_order</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-language.xml?r1=1.5&r2=1.5.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-language.xml diff -u phpdoc/en/reference/mbstring/functions/mb-language.xml:1.5 phpdoc/en/reference/mbstring/functions/mb-language.xml:1.5.2.1 --- phpdoc/en/reference/mbstring/functions/mb-language.xml:1.5 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-language.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<refentry xml:id="function.mb-language" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.5.2.1 $ --> +<refentry xml:id="function.mb-language" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_language</refname> <refpurpose>Set/Get current language</refpurpose> @@ -13,34 +13,56 @@ <methodparam choice="opt"><type>string</type><parameter>language</parameter></methodparam> </methodsynopsis> <para> - <function>mb_language</function> sets language. If - <parameter>language</parameter> is omitted, it returns current - language as string. + Set/Get the current language. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>language</parameter> setting is used for encoding - e-mail messages. Valid languages are "Japanese", - "ja","English","en" and "uni" - (UTF-8). <function>mb_send_mail</function> uses this setting to - encode e-mail. - </para> - <para> - Language and its setting is ISO-2022-JP/Base64 for - Japanese, UTF-8/Base64 for uni, ISO-8859-1/quoted printable for - English. + <variablelist> + <varlistentry> + <term><parameter>language</parameter></term> + <listitem> + <para> + Used for encoding + e-mail messages. Valid languages are "Japanese", + "ja","English","en" and "uni" + (UTF-8). <function>mb_send_mail</function> uses this setting to + encode e-mail. + </para> + <para> + Language and its setting is ISO-2022-JP/Base64 for + Japanese, UTF-8/Base64 for uni, ISO-8859-1/quoted printable for + English. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - Return Value: If <parameter>language</parameter> is set and + If <parameter>language</parameter> is set and <parameter>language</parameter> is valid, it returns - &true;. Otherwise, it returns &false;. When - <parameter>language</parameter> is omitted, it returns language - name as string. If no language is set previously, it returns + &true;. Otherwise, it returns &false;. + When <parameter>language</parameter> is omitted, it returns the language + name as a <type>string</type>. If no language is set previously, it then returns &false;. </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mb_send_mail</function>. + <simplelist> + <member><function>mb_send_mail</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-output-handler.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-output-handler.xml diff -u phpdoc/en/reference/mbstring/functions/mb-output-handler.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-output-handler.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-output-handler.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-output-handler.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<refentry xml:id="function.mb-output-handler" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> +<refentry xml:id="function.mb-output-handler" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_output_handler</refname> <refpurpose>Callback function converts character encoding in output buffer</refpurpose> @@ -17,38 +17,90 @@ <function>mb_output_handler</function> is <function>ob_start</function> callback function. <function>mb_output_handler</function> converts - characters in output buffer from internal character encoding to + characters in the output buffer from internal character encoding to HTTP output character encoding. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - 4.1.0 or later version, this handler adds charset HTTP header - when following conditions are met: - </para> - <para> - <itemizedlist> - <listitem> - <simpara>Does not set <literal>Content-Type</literal> by - header()</simpara> - </listitem> - <listitem> - <simpara>Default MIME type begins with - <literal>text/</literal></simpara> - </listitem> - <listitem> - <simpara><literal>http_output</literal> setting is other than - pass</simpara> - </listitem> - </itemizedlist> - </para> - <para> - <parameter>contents</parameter> : Output buffer contents + <variablelist> + <varlistentry> + <term><parameter>contents</parameter></term> + <listitem> + <para> + The contents of the output buffer. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>status</parameter></term> + <listitem> + <para> + The status of the output buffer. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>status</parameter> : Output buffer status + The converted <type>string</type>. </para> + </refsect1> + + <refsect1 role="changelog"> + &reftitle.changelog; <para> - Return Value: String converted + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>4.1.0</entry> + <entry> + <para> + This handler now adds the charset HTTP header when the following conditions are met: + </para> + <para> + <itemizedlist> + <listitem> + <simpara> + Does not set <literal>Content-Type</literal>, using <function>header</function>. + </simpara> + </listitem> + <listitem> + <simpara> + The default MIME type begins with <literal>text/</literal>. + </simpara> + </listitem> + <listitem> + <simpara> + The <link linkend="ini.mbstring.http-input">mbstring.http_input</link> + setting is something other than <literal>pass</literal>. + </simpara> + </listitem> + </itemizedlist> + </para> + </entry> + </row> + </tbody> + </tgroup> + </informaltable> </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>mb_output_handler</function> example</title> @@ -62,6 +114,10 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> If you want to output some binary data such as image from PHP @@ -83,10 +139,17 @@ "pass" using <function>mb_http_output</function>. </para> </note> - <para> - See also <function>ob_start</function>. + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>ob_start</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-parse-str.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-parse-str.xml diff -u phpdoc/en/reference/mbstring/functions/mb-parse-str.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-parse-str.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-parse-str.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-parse-str.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<refentry xml:id="function.mb-parse-str" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> +<refentry xml:id="function.mb-parse-str" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_parse_str</refname> <refpurpose>Parse GET/POST/COOKIE data and set global variable</refpurpose> @@ -14,28 +14,56 @@ <methodparam choice="opt"><type>array</type><parameter role="reference">result</parameter></methodparam> </methodsynopsis> <para> - <function>mb_parse_str</function> parses GET/POST/COOKIE data and + 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 + data, it can only be used for GET data for now. It parses URL encoded data, detects encoding, converts coding to internal - encoding and set values to <parameter>result</parameter> array or + encoding and set values to the <parameter>result</parameter> <type>array</type> or global variables. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>encoded_string</parameter>: URL encoded data. - </para> - <para> - <parameter>result</parameter>: Array contains decoded and - character encoding converted values. + <variablelist> + <varlistentry> + <term><parameter>encoded_string</parameter></term> + <listitem> + <para> + The URL encoded data. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>result</parameter></term> + <listitem> + <para> + An <type>array</type> containing decoded and character encoded converted values. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - Return Value: It returns &true; for success or &false; for failure. + &return.success; </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mb_detect_order</function>, - <function>mb_internal_encoding</function>. + <simplelist> + <member><function>mb_detect_order</function></member> + <member><function>mb_internal_encoding</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-preferred-mime-name.xml?r1=1.5&r2=1.5.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-preferred-mime-name.xml diff -u phpdoc/en/reference/mbstring/functions/mb-preferred-mime-name.xml:1.5 phpdoc/en/reference/mbstring/functions/mb-preferred-mime-name.xml:1.5.2.1 --- phpdoc/en/reference/mbstring/functions/mb-preferred-mime-name.xml:1.5 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-preferred-mime-name.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<refentry xml:id="function.mb-preferred-mime-name" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.5.2.1 $ --> +<refentry xml:id="function.mb-preferred-mime-name" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_preferred_mime_name</refname> <refpurpose>Get MIME charset string</refpurpose> @@ -13,11 +13,36 @@ <methodparam><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_preferred_mime_name</function> returns MIME - <literal>charset</literal> string for character encoding - <parameter>encoding</parameter>. It returns - <literal>charset</literal> string. + Get a MIME charset <type>string</type> for a specific encoding. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + <para> + The encoding being checked. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The MIME <literal>charset</literal> <type>string</type> for character encoding + <parameter>encoding</parameter>. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>mb_preferred_mime_string</function> example</title> @@ -34,6 +59,7 @@ </example> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-regex-encoding.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-regex-encoding.xml diff -u phpdoc/en/reference/mbstring/functions/mb-regex-encoding.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-regex-encoding.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-regex-encoding.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-regex-encoding.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<refentry xml:id="function.mb-regex-encoding" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> +<refentry xml:id="function.mb-regex-encoding" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_regex_encoding</refname> <refpurpose>Returns current encoding for multibyte regex as string</refpurpose> @@ -12,20 +12,42 @@ <type>mixed</type><methodname>mb_regex_encoding</methodname> <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> - <simpara> - <function>mb_regex_encoding</function> returns the character - encoding used by multibyte regex functions. - </simpara> <para> - If the optional parameter <parameter>encoding</parameter> is - specified, it is set to the character encoding for multibyte - regex. The default value is the internal character encoding. + Returns the current encoding for a multibyte regex as a <type>string</type>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - See also: <function>mb_internal_encoding</function>, - <function>mb_ereg</function> + <variablelist> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + &mbstring.encoding.parameter; + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <simpara> + Returns the character encoding used by multibyte regex functions. + </simpara> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mb_internal_encoding</function></member> + <member><function>mb_ereg</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-regex-set-options.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-regex-set-options.xml diff -u phpdoc/en/reference/mbstring/functions/mb-regex-set-options.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-regex-set-options.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-regex-set-options.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-regex-set-options.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<refentry xml:id="function.mb-regex-set-options" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> +<refentry xml:id="function.mb-regex-set-options" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_regex_set_options</refname> <refpurpose>Set/Get the default options for mbregex functions</refpurpose> @@ -10,25 +10,49 @@ &reftitle.description; <methodsynopsis> <type>string</type><methodname>mb_regex_set_options</methodname> - <methodparam choice="opt"> - <type>string</type><parameter>options</parameter> - </methodparam> + <methodparam choice="opt"><type>string</type><parameter>options</parameter></methodparam> </methodsynopsis> <simpara> - <function>mb_regex_set_options</function> sets the default options - described by <parameter>options</parameter> for multibyte regex functions. + Sets the default options described by <parameter>options</parameter> + for multibyte regex functions. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - Returns the previous options. If <parameter>options</parameter> is - omitted, it returns the string that describes the current options. + <variablelist> + <varlistentry> + <term><parameter>options</parameter></term> + <listitem> + <para> + The options to set. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also - <function>mb_split</function>, - <function>mb_ereg</function> and - <function>mb_eregi</function> + The previous options. If <parameter>options</parameter> is omitted, + it returns the <type>string</type> that describes the current options. </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mb_split</function></member> + <member><function>mb_ereg</function></member> + <member><function>mb_eregi</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-send-mail.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-send-mail.xml diff -u phpdoc/en/reference/mbstring/functions/mb-send-mail.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-send-mail.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-send-mail.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-send-mail.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<refentry xml:id="function.mb-send-mail" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> +<refentry xml:id="function.mb-send-mail" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_send_mail</refname> <refpurpose>Send encoded mail</refpurpose> @@ -17,52 +17,112 @@ <methodparam choice="opt"><type>string</type><parameter>additional_parameter</parameter></methodparam> </methodsynopsis> <para> - <function>mb_send_mail</function> sends email. Headers and - message are converted and encoded according to - <function>mb_language</function> setting. - <function>mb_send_mail</function> is wrapper - function of <function>mail</function>. See - <function>mail</function> for details. - </para> - <para> - <parameter>to</parameter> 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. - </para> - <para> - <parameter>subject</parameter> is subject of mail. - </para> - <para> - <parameter>message</parameter> is mail message. + Sends email. Headers and messages are converted and encoded according + to the <function>mb_language</function> setting. It's a wrapper function + for <function>mail</function>, so see also <function>mail</function> for details. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>additional_headers</parameter> 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"). + <variablelist> + <varlistentry> + <term><parameter>to</parameter></term> + <listitem> + <para> + The mail addresses being sent to. Multiple + recipients may be specified by putting a comma between each + address in <parameter>to</parameter>. + This parameter is not automatically encoded. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>subject</parameter></term> + <listitem> + <para> + The subject of the mail. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>message</parameter></term> + <listitem> + <para> + The message of the mail. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>additional_headers</parameter></term> + <listitem> + <para> + <parameter>additional_headers</parameter> 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"). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>additional_parameter</parameter></term> + <listitem> + <para> + <parameter>additional_parameter</parameter> is a MTA command line + parameter. It is useful when setting the correct Return-Path + header when using sendmail. + </para> + </listitem> + </varlistentry> + </variablelist> </para> - <note> - <para> - <literal>Content-Type</literal> and - <literal>Content-Transfer-Encoding</literal> headers can be redefined as - of PHP 5.0.0. In PHP 4, values defined by - <function>mb_language</function> are always used. - </para> - </note> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>additional_parameter</parameter> is a MTA command line - parameter. It is useful when setting the correct Return-Path - header when using sendmail. + &return.success; </para> + </refsect1> + + <refsect1 role="changelog"> + &reftitle.changelog; <para> - &return.success; + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>5.0.0</entry> + <entry> + The <literal>Content-Type</literal> and <literal>Content-Transfer-Encoding</literal> + headers may be redefined as of PHP 5.0.0. Before this time, the values defined by + <function>mb_language</function> are always used. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mail</function>, - <function>mb_encode_mimeheader</function>, and - <function>mb_language</function>. + <simplelist> + <member><function>mail</function></member> + <member><function>mb_encode_mimeheade</function></member> + <member><function>mb_language</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-split.xml?r1=1.6&r2=1.6.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-split.xml diff -u phpdoc/en/reference/mbstring/functions/mb-split.xml:1.6 phpdoc/en/reference/mbstring/functions/mb-split.xml:1.6.2.1 --- phpdoc/en/reference/mbstring/functions/mb-split.xml:1.6 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-split.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<refentry xml:id="function.mb-split" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.6.2.1 $ --> +<refentry xml:id="function.mb-split" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_split</refname> <refpurpose>Split multibyte string using regular expression</refpurpose> @@ -12,31 +12,73 @@ <type>array</type><methodname>mb_split</methodname> <methodparam><type>string</type><parameter>pattern</parameter></methodparam> <methodparam><type>string</type><parameter>string</parameter></methodparam> - <methodparam choice="opt"> - <type>int</type><parameter>limit</parameter> - </methodparam> + <methodparam choice="opt"><type>int</type><parameter>limit</parameter></methodparam> </methodsynopsis> <simpara> - <function>mb_split</function> split multibyte + Split a multibyte <parameter>string</parameter> using regular expression <parameter>pattern</parameter> and returns the result as an - array. - </simpara> - <simpara> - If optional parameter <parameter>limit</parameter> is specified, - it will be split in <parameter>limit</parameter> elements as - maximum. + <type>array</type>. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The internal encoding or the character encoding specified in - <function>mb_regex_encoding</function> will be used as character - encoding. + <variablelist> + <varlistentry> + <term><parameter>pattern</parameter></term> + <listitem> + <para> + The regular expression pattern. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>string</parameter></term> + <listitem> + <para> + The <type>string</type> being split. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>limit</parameter></term> + <listitem> + <simpara> + If optional parameter <parameter>limit</parameter> is specified, + it will be split in <parameter>limit</parameter> elements as + maximum. + </simpara> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also: <function>mb_regex_encoding</function>, - <function>mb_ereg</function>. + The result as an <type>array</type>. </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + + ¬e.mbstring.encoding.internal; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mb_regex_encoding</function></member> + <member><function>mb_ereg</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-strcut.xml?r1=1.4&r2=1.4.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-strcut.xml diff -u phpdoc/en/reference/mbstring/functions/mb-strcut.xml:1.4 phpdoc/en/reference/mbstring/functions/mb-strcut.xml:1.4.2.1 --- phpdoc/en/reference/mbstring/functions/mb-strcut.xml:1.4 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-strcut.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<refentry xml:id="function.mb-strcut" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.4.2.1 $ --> +<refentry xml:id="function.mb-strcut" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_strcut</refname> <refpurpose>Get part of string</refpurpose> @@ -16,12 +16,6 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_strcut</function> returns the portion of - <parameter>str</parameter> specified by the - <parameter>start</parameter> and - <parameter>length</parameter> parameters. - </para> - <para> <function>mb_strcut</function> performs equivalent operation as <function>mb_substr</function> with different method. If <parameter>start</parameter> position is multi-byte character's @@ -34,15 +28,66 @@ not part of multi-byte string or not being middle of shift sequence. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>encoding</parameter> is character encoding. If it is - not set, internal character encoding is used. + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The <type>string</type> being cut. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>start</parameter></term> + <listitem> + <para> + The position that begins the cut. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>length</parameter></term> + <listitem> + <para> + The <type>string</type> being decoded. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + &mbstring.encoding.parameter; + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>mb_substr</function>, - <function>mb_internal_encoding</function>. + <function>mb_strcut</function> returns the portion of + <parameter>str</parameter> specified by the + <parameter>start</parameter> and + <parameter>length</parameter> parameters. </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mb_substr</function></member> + <member><function>mb_internal_encoding</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-strimwidth.xml?r1=1.6&r2=1.6.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-strimwidth.xml diff -u phpdoc/en/reference/mbstring/functions/mb-strimwidth.xml:1.6 phpdoc/en/reference/mbstring/functions/mb-strimwidth.xml:1.6.2.1 --- phpdoc/en/reference/mbstring/functions/mb-strimwidth.xml:1.6 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-strimwidth.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<refentry xml:id="function.mb-strimwidth" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.6.2.1 $ --> +<refentry xml:id="function.mb-strimwidth" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_strimwidth</refname> <refpurpose>Get truncated string with specified width</refpurpose> @@ -17,26 +17,68 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_strimwidth</function> truncates string - <parameter>str</parameter> to specified - <parameter>width</parameter>. It returns truncated string. - </para> - <para> - If <parameter>trimmarker</parameter> is set, - <parameter>trimmarker</parameter> is appended to return value. - </para> - <para> - <parameter>start</parameter> is start position offset. Number of - characters from the beginning of string. (First character is 0) + Truncates <type>string</type> <parameter>str</parameter> to specified <parameter>width</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>trimmarker</parameter> is string that is added to the - end of string when string is truncated. + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The <type>string</type> being decoded. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>start</parameter></term> + <listitem> + <para> + The start position offset. Number of + characters from the beginning of string. (First character is 0) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>width</parameter></term> + <listitem> + <para> + The width of the desired trim. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>trimmarker</parameter></term> + <listitem> + <para> + A string that is added to the end of string + when string is truncated. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + &mbstring.encoding.parameter; + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>encoding</parameter> is character encoding. If it is - omitted, internal encoding is used. + The truncated <type>string</type>. If <parameter>trimmarker</parameter> is set, + <parameter>trimmarker</parameter> is appended to the return value. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>mb_strimwidth</function> example</title> @@ -49,11 +91,18 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mb_strwidth</function> and - <function>mb_internal_encoding</function>. + <simplelist> + <member><function>mb_strwidth</function></member> + <member><function>mb_internal_encoding</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-strlen.xml?r1=1.5&r2=1.5.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-strlen.xml diff -u phpdoc/en/reference/mbstring/functions/mb-strlen.xml:1.5 phpdoc/en/reference/mbstring/functions/mb-strlen.xml:1.5.2.1 --- phpdoc/en/reference/mbstring/functions/mb-strlen.xml:1.5 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-strlen.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<refentry xml:id="function.mb-strlen" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.5.2.1 $ --> +<refentry xml:id="function.mb-strlen" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_strlen</refname> <refpurpose>Get string length</refpurpose> @@ -14,21 +14,52 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_strlen</function> returns number of characters in - string <parameter>str</parameter> having character encoding - <parameter>encoding</parameter>. A multi-byte character is - counted as 1. + Gets the length of a <type>string</type>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>encoding</parameter> is character encoding for - <parameter>str</parameter>. If <parameter>encoding</parameter> is - omitted, internal character encoding is used. + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The <type>string</type> being checked for length. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + &mbstring.encoding.parameter; + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>mb_internal_encoding</function>, - <function>strlen</function>. + Returns the number of characters in + <type>string</type> <parameter>str</parameter> having character encoding + <parameter>encoding</parameter>. A multi-byte character is + counted as 1. + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mb_internal_encoding</function></member> + <member><function>strlen</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-strpos.xml?r1=1.6&r2=1.6.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-strpos.xml diff -u phpdoc/en/reference/mbstring/functions/mb-strpos.xml:1.6 phpdoc/en/reference/mbstring/functions/mb-strpos.xml:1.6.2.1 --- phpdoc/en/reference/mbstring/functions/mb-strpos.xml:1.6 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-strpos.xml Sun Dec 2 07:38:42 2007 @@ -1,11 +1,9 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<refentry xml:id="function.mb-strpos" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.6.2.1 $ --> +<refentry xml:id="function.mb-strpos" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_strpos</refname> - <refpurpose> - Find position of first occurrence of string in a string - </refpurpose> + <refpurpose>Find position of first occurrence of string in a string</refpurpose> </refnamediv> <refsect1 role="description"> @@ -18,37 +16,75 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_strpos</function> returns the numeric position of - the first occurrence of <parameter>needle</parameter> in the - <parameter>haystack</parameter> string. If - <parameter>needle</parameter> is not found, it returns &false;. + Finds position of the first occurrence of a <type>string</type> in a <type>string</type>. </para> <para> - <function>mb_strpos</function> performs multi-byte safe + Performs a multi-byte safe <function>strpos</function> operation based on number of - characters. <parameter>needle</parameter> position is counted - from the beginning of the <parameter>haystack</parameter>. First - character's position is 0. Second character position is 1, and so - on. - </para> - <para> - If <parameter>encoding</parameter> is omitted, internal - character encoding is used. + characters. The first character's position is 0, the second character + position is 1, and so on. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>offset</parameter> is search offset. If it is not - specified, 0 is used. + <variablelist> + <varlistentry> + <term><parameter>haystack</parameter></term> + <listitem> + <para> + The <type>string</type> being checked. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>needle</parameter></term> + <listitem> + <para> + The position counted from the beginning of <parameter>haystack</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>offset</parameter></term> + <listitem> + <para> + The search offset. If it is not specified, 0 is used. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + &mbstring.encoding.parameter; + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>encoding</parameter> is character encoding name. If it - is omitted, internal character encoding is used. + Returns the numeric position of + the first occurrence of <parameter>needle</parameter> in the + <parameter>haystack</parameter> <type>string</type>. If + <parameter>needle</parameter> is not found, it returns &false;. </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mb_strrpos</function>, - <function>mb_internal_encoding</function>, - <function>strpos</function> + <simplelist> + <member><function>mb_</function></member> + <member><function>mb_internal_encoding</function></member> + <member><function>strpos</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-strrpos.xml?r1=1.7.2.1&r2=1.7.2.2&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-strrpos.xml diff -u phpdoc/en/reference/mbstring/functions/mb-strrpos.xml:1.7.2.1 phpdoc/en/reference/mbstring/functions/mb-strrpos.xml:1.7.2.2 --- phpdoc/en/reference/mbstring/functions/mb-strrpos.xml:1.7.2.1 Fri Nov 30 18:29:51 2007 +++ phpdoc/en/reference/mbstring/functions/mb-strrpos.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7.2.1 $ --> -<refentry xml:id="function.mb-strrpos" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.2 $ --> +<refentry xml:id="function.mb-strrpos" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_strrpos</refname> <refpurpose>Find position of last occurrence of a string in a string</refpurpose> @@ -16,44 +16,64 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_strrpos</function> returns the numeric position of - the last occurrence of <parameter>needle</parameter> in the - <parameter>haystack</parameter> string. If - <parameter>needle</parameter> is not found, it returns &false;. - </para> - <para> - <function>mb_strrpos</function> performs multi-byte safe - <function>strrpos</function> operation based on + Performs a multibyte safe + <function>strrpos</function> operation based on the number of characters. <parameter>needle</parameter> position is counted from the beginning of <parameter>haystack</parameter>. First character's position is 0. Second character position is 1. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - If <parameter>encoding</parameter> is omitted, internal encoding - is assumed. + <variablelist> + <varlistentry> + <term><parameter>haystack</parameter></term> + <listitem> + <para> + The <type>string</type> being checked, for the last occurrence + of <parameter>needle</parameter> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>needle</parameter></term> + <listitem> + <para> + The <type>string</type> to find in <parameter>haystack</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>offset</parameter></term> + <listitem> + <simpara> + May be specified to begin searching an arbitrary number of characters into + the <type>string</type>. Negative values will stop searching at an arbitrary point + prior to the end of the <type>string</type>. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + &mbstring.encoding.parameter; + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>encoding</parameter> is character encoding. If it is - not specified, internal character encoding is used. + Returns the numeric position of + the last occurrence of <parameter>needle</parameter> in the + <parameter>haystack</parameter> <type>string</type>. If + <parameter>needle</parameter> is not found, it returns &false;. </para> - <note> - <simpara> - As of PHP 5.2.0 <parameter>offset</parameter> may - be specified to begin searching an arbitrary number of characters into - the string. Negative values will stop searching at an arbitrary point - prior to the end of the string. - </simpara> - </note> - <note> - <simpara> - The <parameter>encoding</parameter> parameter was moved from - the third position to the fourth in PHP 5.2.0. For backward - compatibility, <parameter>encoding</parameter> can be specified - as the third parameter, but doing so is deprecated and will be - removed in the future. - </simpara> - </note> </refsect1> <refsect1 role="changelog"> @@ -78,6 +98,20 @@ </para> </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + <note> + <simpara> + The <parameter>encoding</parameter> parameter was moved from + the third position to the fourth in PHP 5.2.0. For backward + compatibility, <parameter>encoding</parameter> can be specified + as the third parameter, but doing so is deprecated and will be + removed in the future. + </simpara> + </note> + ¬e.mbstring.encoding.internal; + </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-strtolower.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-strtolower.xml diff -u phpdoc/en/reference/mbstring/functions/mb-strtolower.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-strtolower.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-strtolower.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-strtolower.xml Sun Dec 2 07:38:42 2007 @@ -1,5 +1,5 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> <refentry xml:id="function.mb-strtolower" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_strtolower</refname> @@ -14,14 +14,42 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_strtolower</function> returns <parameter>str</parameter> + Returns <parameter>str</parameter> with all alphabetic characters converted to lowercase. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The <type>string</type> being lowercased. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + &mbstring.encoding.parameter; + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>encoding</parameter> specifies the encoding of - <parameter>str</parameter>; if omitted, the internal character encoding - value will be used. + <parameter>str</parameter> with all alphabetic characters converted to lowercase. </para> + </refsect1> + + <refsect1 role="unicode"> + &reftitle.unicode; <para> For more information about the Unicode properties, please see <link xlink:href="&url.unicode.reports;">&url.unicode.reports;</link>. @@ -32,6 +60,10 @@ of this function is not affected by locale settings and it can convert any characters that have 'alphabetic' property, such as A-umlaut (Ä). </para> +</refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>mb_strtolower</function> example</title> @@ -46,12 +78,19 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>strtolower</function>, - <function>mb_strtoupper</function> and - <function>mb_convert_case</function>. + <simplelist> + <member><function>mb_strtoupper</function></member> + <member><function>mb_convert_case</function></member> + <member><function>strtolower</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-strtoupper.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-strtoupper.xml diff -u phpdoc/en/reference/mbstring/functions/mb-strtoupper.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-strtoupper.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-strtoupper.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-strtoupper.xml Sun Dec 2 07:38:42 2007 @@ -1,5 +1,5 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> <refentry xml:id="function.mb-strtoupper" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_strtoupper</refname> @@ -14,25 +14,57 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_strtoupper</function> returns <parameter>str</parameter> + Returns <parameter>str</parameter> with all alphabetic characters converted to uppercase. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>encoding</parameter> specifies the encoding of - <parameter>str</parameter>; if omitted, the internal character encoding - value will be used. + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The <type>string</type> being lowercased. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + &mbstring.encoding.parameter; + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - By contrast to <function>strtoupper</function>, '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 (ä). + <parameter>str</parameter> with all alphabetic characters converted to uppercase. </para> + </refsect1> + + <refsect1 role="unicode"> + &reftitle.unicode; <para> For more information about the Unicode properties, please see <link xlink:href="&url.unicode.reports;">&url.unicode.reports;</link>. </para> <para> + By contrast to <function>strtoupper</function>, '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 (ä). + </para> +</refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> <example> <title><function>mb_strtoupper</function> example</title> <programlisting role="php"> @@ -46,12 +78,19 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>strtoupper</function>, - <function>mb_strtolower</function> and - <function>mb_convert_case</function>. + <simplelist> + <member><function>mb_strtolower</function></member> + <member><function>mb_convert_case</function></member> + <member><function>strtoupper</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-strwidth.xml?r1=1.5&r2=1.5.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-strwidth.xml diff -u phpdoc/en/reference/mbstring/functions/mb-strwidth.xml:1.5 phpdoc/en/reference/mbstring/functions/mb-strwidth.xml:1.5.2.1 --- phpdoc/en/reference/mbstring/functions/mb-strwidth.xml:1.5 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-strwidth.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<refentry xml:id="function.mb-strwidth" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.5.2.1 $ --> +<refentry xml:id="function.mb-strwidth" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_strwidth</refname> <refpurpose>Return width of string</refpurpose> @@ -14,12 +14,10 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_strwidth</function> returns width of string - <parameter>str</parameter>. + Returns the width of <type>string</type> <parameter>str</parameter>. </para> <para> - Multi-byte character usually twice of width compare to single - byte character. + Multi-byte characters are usually twice the width of single byte characters. </para> <para> <table> @@ -56,15 +54,47 @@ </tgroup> </table> </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>encoding</parameter> is character encoding. If it is - omitted, internal encoding is used. + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The <type>string</type> being decoded. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + &mbstring.encoding.parameter; + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also: <function>mb_strimwidth</function>, - <function>mb_internal_encoding</function>. + The width of <type>string</type> <parameter>str</parameter>. </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mb_strimwidth</function></member> + <member><function>mb_internal_encoding</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-substitute-character.xml?r1=1.6&r2=1.6.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-substitute-character.xml diff -u phpdoc/en/reference/mbstring/functions/mb-substitute-character.xml:1.6 phpdoc/en/reference/mbstring/functions/mb-substitute-character.xml:1.6.2.1 --- phpdoc/en/reference/mbstring/functions/mb-substitute-character.xml:1.6 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-substitute-character.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<refentry xml:id="function.mb-substitute-character" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.6.2.1 $ --> +<refentry xml:id="function.mb-substitute-character" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_substitute_character</refname> <refpurpose>Set/Get substitution character</refpurpose> @@ -13,11 +13,10 @@ <methodparam choice="opt"><type>mixed</type><parameter>substrchar</parameter></methodparam> </methodsynopsis> <para> - <function>mb_substitute_character</function> 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). + Specifies a substitution character when input character encoding is invalid + or character code does not exist in output character + encoding. Invalid characters may be substituted &null; (no output), + <type>string</type> or <type>integer</type> value (Unicode character code value). </para> <para> This setting affects <function>mb_convert_encoding</function>, @@ -25,30 +24,49 @@ <function>mb_output_handler</function>, and <function>mb_send_mail</function>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>substchar</parameter> : Specify Unicode value as - integer or specify as string as follows - <itemizedlist> - <listitem> - <simpara> - "none" : no output - </simpara> - </listitem> - <listitem> - <simpara> - "long" : Output character code value (Example: - U+3000,JIS+7E7E) - </simpara> - </listitem> - </itemizedlist> + <variablelist> + <varlistentry> + <term><parameter>substrchar</parameter></term> + <listitem> + <para> + Specify the Unicode value as an <type>integer</type>, + or as one of the following <type>string</type>s: + <itemizedlist> + <listitem> + <simpara> + "none" : no output + </simpara> + </listitem> + <listitem> + <simpara> + "long" : Output character code value (Example: U+3000,JIS+7E7E) + </simpara> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - Return Value: If <parameter>substchar</parameter> is set, it - returns &true; for success, otherwise returns - &false;. If <parameter>substchar</parameter> is - not set, it returns Unicode value or - "<literal>none</literal>"/"<literal>long</literal>". + If <parameter>substchar</parameter> is set, it returns &true; for success, + otherwise returns &false;. + If <parameter>substchar</parameter> is not set, it returns the Unicode value, + or "<literal>none</literal>" or "<literal>long</literal>". </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>mb_substitute_character</function> example</title> @@ -69,6 +87,7 @@ </example> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-substr-count.xml?r1=1.4&r2=1.4.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-substr-count.xml diff -u phpdoc/en/reference/mbstring/functions/mb-substr-count.xml:1.4 phpdoc/en/reference/mbstring/functions/mb-substr-count.xml:1.4.2.1 --- phpdoc/en/reference/mbstring/functions/mb-substr-count.xml:1.4 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-substr-count.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<refentry xml:id="function.mb-substr-count" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.4.2.1 $ --> +<refentry xml:id="function.mb-substr-count" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_substr_count</refname> <refpurpose>Count the number of substring occurrences</refpurpose> @@ -15,15 +15,53 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_substr_count</function> returns the number of times the + Counts the number of times the <parameter>needle</parameter> substring occurs in the - <parameter>haystack</parameter> string. + <parameter>haystack</parameter> <type>string</type>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>encoding</parameter> specifies the encoding for - <parameter>needle</parameter> and <parameter>haystack</parameter>. - If omitted, internal character encoding is used. + <variablelist> + <varlistentry> + <term><parameter>haystack</parameter></term> + <listitem> + <para> + The <type>string</type> being checked. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>needle</parameter></term> + <listitem> + <para> + The <type>string</type> being found. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + &mbstring.encoding.parameter; + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The number of times the + <parameter>needle</parameter> substring occurs in the + <parameter>haystack</parameter> <type>string</type>. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>mb_substr_count</function> example</title> @@ -36,11 +74,19 @@ </programlisting> </example> </para> - <simpara> - See also <function>substr_count</function>, - <function>mb_strpos</function>, <function>mb_substr</function>. - </simpara> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mb_strpos</function></member> + <member><function>mb_substr</function></member> + <member><function>substr_count</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-substr.xml?r1=1.4&r2=1.4.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-substr.xml diff -u phpdoc/en/reference/mbstring/functions/mb-substr.xml:1.4 phpdoc/en/reference/mbstring/functions/mb-substr.xml:1.4.2.1 --- phpdoc/en/reference/mbstring/functions/mb-substr.xml:1.4 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-substr.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<refentry xml:id="function.mb-substr" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.4.2.1 $ --> +<refentry xml:id="function.mb-substr" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_substr</refname> <refpurpose>Get part of string</refpurpose> @@ -16,32 +16,73 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_substr</function> returns the portion of - <parameter>str</parameter> specified by the - <parameter>start</parameter> and - <parameter>length</parameter> parameters. - </para> - <para> - <function>mb_substr</function> performs multi-byte safe + Performs a multi-byte safe <function>substr</function> operation based on number of characters. Position is counted from the beginning of <parameter>str</parameter>. First character's position is 0. Second character position is 1, and so on. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - If <parameter>encoding</parameter> is omitted, internal encoding - is assumed. + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The <type>string</type> being checked. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>start</parameter></term> + <listitem> + <para> + The first position used in <parameter>str</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>length</parameter></term> + <listitem> + <para> + The maximum length of the returned <type>string</type>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + &mbstring.encoding.parameter; + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>encoding</parameter> is character encoding. If it is - omitted, internal character encoding is used. + <function>mb_substr</function> returns the portion of + <parameter>str</parameter> specified by the + <parameter>start</parameter> and + <parameter>length</parameter> parameters. </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mb_strcut</function>, - <function>mb_internal_encoding</function>. + <simplelist> + <member><function>mb_strcut</function></member> + <member><function>mb_internal_encoding</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/language-snippets.ent?r1=1.209.2.3&r2=1.209.2.4&diff_format=u Index: phpdoc/en/language-snippets.ent diff -u phpdoc/en/language-snippets.ent:1.209.2.3 phpdoc/en/language-snippets.ent:1.209.2.4 --- phpdoc/en/language-snippets.ent:1.209.2.3 Tue Nov 27 14:28:00 2007 +++ phpdoc/en/language-snippets.ent Sun Dec 2 07:38:42 2007 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.209.2.3 $ --> +<!-- $Revision: 1.209.2.4 $ --> <!-- Keep 'em sorted --> @@ -164,6 +164,8 @@ <!-- Misc --> +<!ENTITY no.function.parameters '<para>This function contains no parameters.</para>'> + <!ENTITY example.outputs '<para>The above example will output:</para>'> <!ENTITY example.outputs.similar '<para>The above example will output @@ -276,6 +278,16 @@ imap_stream</parameter></term><listitem><para>An IMAP stream returned by <function>imap_open</function>.</para></listitem></varlistentry>'> +<!-- mbstring notes --> + +<!ENTITY note.mbstring.encoding.internal '<note><para>The internal encoding or the +character encoding specified by <function>mb_regex_encoding</function> +will be used as the character encoding for this function.</para></note>'> + +<!ENTITY mbstring.encoding.parameter '<para>The <parameter>encoding</parameter> +parameter is the character encoding. If it is omitted, the internal character +encoding value will be used.</para>'> + <!-- MCVE notes --> <!ENTITY mcve.conn.description '<varlistentry><term><parameter> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-check-encoding.xml?r1=1.3.2.2&r2=1.3.2.3&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-check-encoding.xml diff -u phpdoc/en/reference/mbstring/functions/mb-check-encoding.xml:1.3.2.2 phpdoc/en/reference/mbstring/functions/mb-check-encoding.xml:1.3.2.3 --- phpdoc/en/reference/mbstring/functions/mb-check-encoding.xml:1.3.2.2 Wed Oct 3 11:41:12 2007 +++ phpdoc/en/reference/mbstring/functions/mb-check-encoding.xml Sun Dec 2 07:38:42 2007 @@ -1,10 +1,11 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3.2.2 $ --> -<refentry xml:id="function.mb-check-encoding" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.3.2.3 $ --> +<refentry xml:id="function.mb-check-encoding" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_check_encoding</refname> <refpurpose>Check if the string is valid for the specified encoding</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -13,13 +14,13 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_check_encoding</function> - checks if the specified byte stream is valid for the specified encoding. + Checks if the specified byte stream is valid for the specified encoding. It is useful to prevent so-called "Invalid Encoding Attack". </para> <para> </para> </refsect1> + <refsect1 role="parameters"> &reftitle.parameters; <para> @@ -28,7 +29,7 @@ <term><parameter>var</parameter></term> <listitem> <para> - byte stream to check. If it is omitted, this function checks + The byte stream to check. If it is omitted, this function checks all the input from the beginning of the request. </para> </listitem> @@ -37,13 +38,14 @@ <term><parameter>encoding</parameter></term> <listitem> <para> - Expected encoding. + The expected encoding. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> @@ -51,86 +53,6 @@ </para> </refsect1> - <!-- Use when ERRORS exist - <refsect1 role="errors"> - &reftitle.errors; - <para> - When does this function throw E_* level errors, or exceptions? - </para> - </refsect1> - --> - - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description;</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here</entry> - <entry>Description of change</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - --> - - - <!-- Use when examples exist - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <function>mb_check_encoding</function> example</title> - <para> - Any text that describes the purpose of the example, or - what goes on in the example should go here (inside the - <example> tag, not out - </para> - <programlisting role="php"> -<![CDATA[ -<?php -if ($anexample === true) { - echo 'Use the PEAR Coding Standards'; -} -?> -]]> - </programlisting> - &example.outputs; - <screen> -<![CDATA[ -Use the PEAR Coding Standards -]]> - </screen> - </example> - </para> - </refsect1> - --> - - - <!-- Use when adding See Also links - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> - </simplelist> - </para> - </refsect1> - --> - - </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-convert-case.xml?r1=1.8&r2=1.8.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-convert-case.xml diff -u phpdoc/en/reference/mbstring/functions/mb-convert-case.xml:1.8 phpdoc/en/reference/mbstring/functions/mb-convert-case.xml:1.8.2.1 --- phpdoc/en/reference/mbstring/functions/mb-convert-case.xml:1.8 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-convert-case.xml Sun Dec 2 07:38:42 2007 @@ -1,5 +1,5 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.8.2.1 $ --> <refentry xml:id="function.mb-convert-case" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_convert_case</refname> @@ -15,22 +15,54 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_convert_case</function> returns case folded version of - <parameter>string</parameter> converted in the way specified by + Performs case folding on a <type>string</type>, converted in the way specified by <parameter>mode</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>mode</parameter> can be one of MB_CASE_UPPER, MB_CASE_LOWER - or MB_CASE_TITLE. - </para> - <para> - <parameter>encoding</parameter> specifies the encoding of - <parameter>str</parameter>; if omitted, the internal character encoding - value will be used. + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The <type>string</type> being converted. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>mode</parameter></term> + <listitem> + <para> + The mode of the conversion. It can be one of + <constant>MB_CASE_UPPER</constant>, + <constant>MB_CASE_LOWER</constant>, or + <constant>MB_CASE_TITLE</constant>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + &mbstring.encoding.parameter; + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - The return value is str with the appropriate case folding applied. + A case folded version of <parameter>string</parameter> converted in the + way specified by <parameter>mode</parameter>. </para> + </refsect1> + + <refsect1 role="unicode"> + &reftitle.unicode; <para> By contrast to the standard case folding functions such as <function>strtolower</function> and <function>strtoupper</function>, @@ -43,6 +75,10 @@ For more information about the Unicode properties, please see <link xlink:href="&url.unicode.reports;">&url.unicode.reports;</link>. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>mb_convert_case</function> example</title> @@ -59,13 +95,19 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mb_strtolower</function>, - <function>mb_strtoupper</function>, - <function>strtolower</function>, - <function>strtoupper</function>, - <function>ucfirst</function>&listendand; - <function>ucwords</function> + <simplelist> + <member><function>mb_strtolower</function></member> + <member><function>mb_strtoupper</function></member> + <member><function>strtolower</function></member> + <member><function>strtoupper</function></member> + <member><function>ucfirst</function></member> + <member><function>ucwords</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-convert-encoding.xml?r1=1.6&r2=1.6.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-convert-encoding.xml diff -u phpdoc/en/reference/mbstring/functions/mb-convert-encoding.xml:1.6 phpdoc/en/reference/mbstring/functions/mb-convert-encoding.xml:1.6.2.1 --- phpdoc/en/reference/mbstring/functions/mb-convert-encoding.xml:1.6 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-convert-encoding.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<refentry xml:id="function.mb-convert-encoding" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.6.2.1 $ --> +<refentry xml:id="function.mb-convert-encoding" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_convert_encoding</refname> <refpurpose>Convert character encoding</refpurpose> @@ -15,20 +15,62 @@ <methodparam choice="opt"><type>mixed</type><parameter>from_encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_convert_encoding</function> converts - character encoding of string <parameter>str</parameter> from - <parameter>from_encoding</parameter> to - <parameter>to_encoding</parameter>. + Converts the character encoding of <type>string</type> <parameter>str</parameter> + to <parameter>to_encoding</parameter> + from optionally <parameter>from_encoding</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>str</parameter> : String to be converted. + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The <type>string</type> being encoded. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>to_encoding</parameter></term> + <listitem> + <para> + The type of encoding that <parameter>str</parameter> is being converted to. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>from_encoding</parameter></term> + <listitem> + <para> + Is specified by character code names before conversion. It is either + an <type>array</type>, or a comma separated enumerated list. + If <parameter>from_encoding</parameter> is not specified, the internal + encoding will be used. + <!-- link to internal encoding info --> + </para> + <para> + <!-- can the meaning of auto be altered? --> + "<literal>auto</literal>" may be used, which expands to + <emphasis>"ASCII,JIS,UTF-8,EUC-JP,SJIS"</emphasis>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>from_encoding</parameter> 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. + The encoded <type>string</type>. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>mb_convert_encoding</function> example</title> @@ -51,10 +93,17 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mb_detect_order</function>. + <simplelist> + <member><function>mb_detect_order</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-convert-kana.xml?r1=1.11&r2=1.11.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-convert-kana.xml diff -u phpdoc/en/reference/mbstring/functions/mb-convert-kana.xml:1.11 phpdoc/en/reference/mbstring/functions/mb-convert-kana.xml:1.11.2.1 --- phpdoc/en/reference/mbstring/functions/mb-convert-kana.xml:1.11 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-convert-kana.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.11 $ --> -<refentry xml:id="function.mb-convert-kana" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.11.2.1 $ --> +<refentry xml:id="function.mb-convert-kana" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_convert_kana</refname> <refpurpose>Convert "kana" one from another ("zen-kaku", "han-kaku" and more)</refpurpose> @@ -15,128 +15,159 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_convert_kana</function> performs "han-kaku" - - "zen-kaku" conversion for string <parameter>str</parameter>. It - returns converted string. This function is only useful for - Japanese. - </para> - <para> - <parameter>option</parameter> is conversion option. Default value - is <literal>"KV"</literal>. + Performs a "han-kaku" - "zen-kaku" conversion for <type>string</type> <parameter>str</parameter>. + This function is only useful for Japanese. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>encoding</parameter> is character encoding. If it is - omitted, internal character encoding is used. + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The <type>string</type> being converted. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>option</parameter></term> + <listitem> + <para> + The conversion option. The default value is <literal>"KV"</literal>. + </para> + <para> + Specify with a combination of following options. The default + value is <literal>KV</literal>. + <table> + <title>Applicable Conversion Options</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Option</entry> + <entry>Meaning</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>r</literal></entry> + <entry> + Convert "zen-kaku" alphabets to "han-kaku" + </entry> + </row> + <row> + <entry><literal>R</literal></entry> + <entry> + Convert "han-kaku" alphabets to "zen-kaku" + </entry> + </row> + <row> + <entry><literal>n</literal></entry> + <entry> + Convert "zen-kaku" numbers to "han-kaku" + </entry> + </row> + <row> + <entry><literal>N</literal></entry> + <entry> + Convert "han-kaku" numbers to "zen-kaku" + </entry> + </row> + <row> + <entry><literal>a</literal></entry> + <entry> + Convert "zen-kaku" alphabets and numbers to "han-kaku" + </entry> + </row> + <row> + <entry><literal>A</literal></entry> + <entry> + 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) + </entry> + </row> + <row> + <entry><literal>s</literal></entry> + <entry> + Convert "zen-kaku" space to "han-kaku" (U+3000 -> U+0020) + </entry> + </row> + <row> + <entry><literal>S</literal></entry> + <entry> + Convert "han-kaku" space to "zen-kaku" (U+0020 -> U+3000) + </entry> + </row> + <row> + <entry><literal>k</literal></entry> + <entry> + Convert "zen-kaku kata-kana" to "han-kaku kata-kana" + </entry> + </row> + <row> + <entry><literal>K</literal></entry> + <entry> + Convert "han-kaku kata-kana" to "zen-kaku kata-kana" + </entry> + </row> + <row> + <entry><literal>h</literal></entry> + <entry> + Convert "zen-kaku hira-gana" to "han-kaku kata-kana" + </entry> + </row> + <row> + <entry><literal>H</literal></entry> + <entry> + Convert "han-kaku kata-kana" to "zen-kaku hira-gana" + </entry> + </row> + <row> + <entry><literal>c</literal></entry> + <entry> + Convert "zen-kaku kata-kana" to "zen-kaku hira-gana" + </entry> + </row> + <row> + <entry><literal>C</literal></entry> + <entry> + Convert "zen-kaku hira-gana" to "zen-kaku kata-kana" + </entry> + </row> + <row> + <entry><literal>V</literal></entry> + <entry> + Collapse voiced sound notation and convert them into a character. Use with "K","H" + </entry> + </row> + </tbody> + </tgroup> + </table> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + &mbstring.encoding.parameter; + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - Specify with combination of following options. Default - value is <literal>KV</literal>. - <table> - <title>Applicable Conversion Options</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Option</entry> - <entry>Meaning</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>r</literal></entry> - <entry> - Convert "zen-kaku" alphabets to "han-kaku" - </entry> - </row> - <row> - <entry><literal>R</literal></entry> - <entry> - Convert "han-kaku" alphabets to "zen-kaku" - </entry> - </row> - <row> - <entry><literal>n</literal></entry> - <entry> - Convert "zen-kaku" numbers to "han-kaku" - </entry> - </row> - <row> - <entry><literal>N</literal></entry> - <entry> - Convert "han-kaku" numbers to "zen-kaku" - </entry> - </row> - <row> - <entry><literal>a</literal></entry> - <entry> - Convert "zen-kaku" alphabets and numbers to "han-kaku" - </entry> - </row> - <row> - <entry><literal>A</literal></entry> - <entry> - 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) - </entry> - </row> - <row> - <entry><literal>s</literal></entry> - <entry> - Convert "zen-kaku" space to "han-kaku" (U+3000 -> U+0020) - </entry> - </row> - <row> - <entry><literal>S</literal></entry> - <entry> - Convert "han-kaku" space to "zen-kaku" (U+0020 -> U+3000) - </entry> - </row> - <row> - <entry><literal>k</literal></entry> - <entry> - Convert "zen-kaku kata-kana" to "han-kaku kata-kana" - </entry> - </row> - <row> - <entry><literal>K</literal></entry> - <entry> - Convert "han-kaku kata-kana" to "zen-kaku kata-kana" - </entry> - </row> - <row> - <entry><literal>h</literal></entry> - <entry> - Convert "zen-kaku hira-gana" to "han-kaku kata-kana" - </entry> - </row> - <row> - <entry><literal>H</literal></entry> - <entry> - Convert "han-kaku kata-kana" to "zen-kaku hira-gana" - </entry> - </row> - <row> - <entry><literal>c</literal></entry> - <entry> - Convert "zen-kaku kata-kana" to "zen-kaku hira-gana" - </entry> - </row> - <row> - <entry><literal>C</literal></entry> - <entry> - Convert "zen-kaku hira-gana" to "zen-kaku kata-kana" - </entry> - </row> - <row> - <entry><literal>V</literal></entry> - <entry> - Collapse voiced sound notation and convert them into a character. Use with "K","H" - </entry> - </row> - </tbody> - </tgroup> - </table> + The converted <type>string</type>. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>mb_convert_kana</function> example</title> @@ -155,6 +186,7 @@ </example> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-convert-variables.xml?r1=1.9&r2=1.9.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-convert-variables.xml diff -u phpdoc/en/reference/mbstring/functions/mb-convert-variables.xml:1.9 phpdoc/en/reference/mbstring/functions/mb-convert-variables.xml:1.9.2.1 --- phpdoc/en/reference/mbstring/functions/mb-convert-variables.xml:1.9 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-convert-variables.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> -<refentry xml:id="function.mb-convert-variables" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.9.2.1 $ --> +<refentry xml:id="function.mb-convert-variables" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_convert_variables</refname> <refpurpose>Convert character code in variable(s)</refpurpose> @@ -16,11 +16,10 @@ <methodparam choice="opt"><type>mixed</type><parameter role="reference">...</parameter></methodparam> </methodsynopsis> <para> - <function>mb_convert_variables</function> convert + Converts character encoding of variables <parameter>vars</parameter> in encoding <parameter>from_encoding</parameter> to encoding - <parameter>to_encoding</parameter>. It returns character encoding - before conversion for success, &false; for failure. + <parameter>to_encoding</parameter>. </para> <para> <function>mb_convert_variables</function> join strings in Array @@ -28,19 +27,64 @@ fail for short strings. Therefore, it is impossible to mix encoding in single array or object. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - It <parameter>from_encoding</parameter> is specified by - array or comma separated string, it tries to detect encoding from - <parameter>from-coding</parameter>. When - <parameter>encoding</parameter> is omitted, - <literal>detect_order</literal> is used. + <variablelist> + <varlistentry> + <term><parameter>to_encoding</parameter></term> + <listitem> + <para> + The encoding that the <type>string</type> is being converted to. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>from_encoding</parameter></term> + <listitem> + <para> + <parameter>from_encoding</parameter> is specified as an <type>array</type> + or comma separated <type>string</type>, it tries to detect encoding from + <parameter>from-coding</parameter>. When <parameter>from_encoding</parameter> + is omitted, <literal>detect_order</literal> is used. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>vars</parameter></term> + <listitem> + <para> + <parameter>vars</parameter> is the reference to the + variable being converted. String, Array and Object are accepted. + <function>mb_convert_variables</function> assumes all parameters + have the same encoding. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>...</parameter></term> + <listitem> + <para> + Additional <parameter>vars</parameter>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>vars (3rd and larger)</parameter> is reference to - variable to be converted. String, Array and Object are accepted. - <function>mb_convert_variables</function> assumes all parameters - have the same encoding. + The character encoding before conversion for success, + or &false; for failure. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>mb_convert_variables</function> example</title> @@ -56,6 +100,7 @@ </example> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-decode-mimeheader.xml?r1=1.4&r2=1.4.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-decode-mimeheader.xml diff -u phpdoc/en/reference/mbstring/functions/mb-decode-mimeheader.xml:1.4 phpdoc/en/reference/mbstring/functions/mb-decode-mimeheader.xml:1.4.2.1 --- phpdoc/en/reference/mbstring/functions/mb-decode-mimeheader.xml:1.4 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-decode-mimeheader.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<refentry xml:id="function.mb-decode-mimeheader" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.4.2.1 $ --> +<refentry xml:id="function.mb-decode-mimeheader" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_decode_mimeheader</refname> <refpurpose>Decode string in MIME header field</refpurpose> @@ -13,16 +13,42 @@ <methodparam><type>string</type><parameter>str</parameter></methodparam> </methodsynopsis> <para> - <function>mb_decode_mimeheader</function> decodes encoded-word - string <parameter>str</parameter> in MIME header. + Decodes encoded-word <type>string</type> <parameter>str</parameter> in MIME header. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - It returns decoded string in internal character encoding. + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The <type>string</type> being decoded. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>mb_encode_mimeheader</function>. + The decoded <type>string</type> in internal character encoding. </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mb_encode_mimeheader</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-decode-numericentity.xml?r1=1.6&r2=1.6.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-decode-numericentity.xml diff -u phpdoc/en/reference/mbstring/functions/mb-decode-numericentity.xml:1.6 phpdoc/en/reference/mbstring/functions/mb-decode-numericentity.xml:1.6.2.1 --- phpdoc/en/reference/mbstring/functions/mb-decode-numericentity.xml:1.6 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-decode-numericentity.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<refentry xml:id="function.mb-decode-numericentity" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.6.2.1 $ --> +<refentry xml:id="function.mb-decode-numericentity" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_decode_numericentity</refname> <refpurpose>Decode HTML numeric string reference to character</refpurpose> @@ -15,18 +15,51 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - Convert numeric string reference of string - <parameter>str</parameter> in specified block to character. It - returns converted string. + Convert numeric string reference of <type>string</type> + <parameter>str</parameter> in a specified block to character. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>convmap</parameter> is array to specifies code area to - convert. + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The <type>string</type> being decoded. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>convmap</parameter></term> + <listitem> + <para> + <parameter>convmap</parameter> is an <type>array</type> that specifies + the code area to convert. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + &mbstring.encoding.parameter; + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>encoding</parameter> is character encoding. If it is - omitted, internal character encoding is used. + The converted <type>string</type>. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><parameter>convmap</parameter> example</title> @@ -44,10 +77,17 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mb_encode_numericentity</function>. + <simplelist> + <member><function>mb_encode_numericentity</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-detect-encoding.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-detect-encoding.xml diff -u phpdoc/en/reference/mbstring/functions/mb-detect-encoding.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-detect-encoding.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-detect-encoding.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-detect-encoding.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<refentry xml:id="function.mb-detect-encoding" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> +<refentry xml:id="function.mb-detect-encoding" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_detect_encoding</refname> <refpurpose>Detect character encoding</refpurpose> @@ -15,24 +15,59 @@ <methodparam choice="opt"><type>bool</type><parameter>strict</parameter></methodparam> </methodsynopsis> <para> - <function>mb_detect_encoding</function> detects character - encoding in string <parameter>str</parameter>. It returns - detected character encoding. - </para> - <para> - <parameter>encoding_list</parameter> is list of character - encoding. Encoding order may be specified by array or comma - separated list string. + Detects character encoding in <type>string</type> <parameter>str</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - If <parameter>encoding_list</parameter> is omitted, - detect_order is used. + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The <type>string</type> being detected. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding_list</parameter></term> + <listitem> + <para> + <parameter>encoding_list</parameter> is list of character + encoding. Encoding order may be specified by array or comma + separated list string. + </para> + <para> + If <parameter>encoding_list</parameter> is omitted, + detect_order is used. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>strict</parameter></term> + <listitem> + <para> + <parameter>strict</parameter> specifies whether to use + the strict encoding detection or not. + Default is &false;. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>strict</parameter> specifies whether to use - the strict encoding detection or not. - Default is &false;. + The detected character encoding. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>mb_detect_encoding</function> example</title> @@ -58,10 +93,17 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mb_detect_order</function>. + <simplelist> + <member><function>mb_detect_order</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-detect-order.xml?r1=1.8&r2=1.8.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-detect-order.xml diff -u phpdoc/en/reference/mbstring/functions/mb-detect-order.xml:1.8 phpdoc/en/reference/mbstring/functions/mb-detect-order.xml:1.8.2.1 --- phpdoc/en/reference/mbstring/functions/mb-detect-order.xml:1.8 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-detect-order.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> -<refentry xml:id="function.mb-detect-order" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.8.2.1 $ --> +<refentry xml:id="function.mb-detect-order" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_detect_order</refname> <refpurpose>Set/Get character encoding detection order</refpurpose> @@ -13,50 +13,56 @@ <methodparam choice="opt"><type>mixed</type><parameter>encoding_list</parameter></methodparam> </methodsynopsis> <para> - <function>mb_detect_order</function> sets automatic character + Sets the automatic character encoding detection order to <parameter>encoding_list</parameter>. - It returns &true; for success, - &false; for failure. - </para> - <para> - <parameter>encoding_list</parameter> is array or comma separated - list of character encoding. ("auto" is expanded to - "ASCII, JIS, UTF-8, EUC-JP, SJIS") - </para> - <para> - If <parameter>encoding_list</parameter> is omitted, it returns - current character encoding detection order as array. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - This setting affects <function>mb_detect_encoding</function> and - <function>mb_send_mail</function>. - </para> - <note> - <para> - <literal>mbstring</literal> currently implements following - encoding detection filters. If there is an invalid byte sequence - for following encoding, encoding detection will fail. - </para> - <simpara> - <literal>UTF-8</literal>, <literal>UTF-7</literal>, - <literal>ASCII</literal>, - <literal>EUC-JP</literal>,<literal>SJIS</literal>, - <literal>eucJP-win</literal>, <literal>SJIS-win</literal>, - <literal>JIS</literal>, <literal>ISO-2022-JP</literal> - </simpara> - <para> - For <literal>ISO-8859-*</literal>, <literal>mbstring</literal> - always detects as <literal>ISO-8859-*</literal>. - </para> - <para> - For <literal>UTF-16</literal>, <literal>UTF-32</literal>, - <literal>UCS2</literal> and <literal>UCS4</literal>, encoding - detection will fail always. - </para> - <para> - <example> - <title>Useless detect order example</title> - <programlisting> + <variablelist> + <varlistentry> + <term><parameter>encoding_list</parameter></term> + <listitem> + <para> + <parameter>encoding_list</parameter> is an <type>array</type> or + comma separated list of character encoding. ("auto" is expanded to + "ASCII, JIS, UTF-8, EUC-JP, SJIS") + </para> + <para> + If <parameter>encoding_list</parameter> is omitted, it returns + the current character encoding detection order as array. + </para> + <para> + This setting affects <function>mb_detect_encoding</function> and + <function>mb_send_mail</function>. + </para> + <para> + <literal>mbstring</literal> currently implements the following + encoding detection filters. If there is an invalid byte sequence + for the following encodings, encoding detection will fail. + </para> + <simpara> + <literal>UTF-8</literal>, <literal>UTF-7</literal>, + <literal>ASCII</literal>, + <literal>EUC-JP</literal>,<literal>SJIS</literal>, + <literal>eucJP-win</literal>, <literal>SJIS-win</literal>, + <literal>JIS</literal>, <literal>ISO-2022-JP</literal> + </simpara> + <para> + For <literal>ISO-8859-*</literal>, <literal>mbstring</literal> + always detects as <literal>ISO-8859-*</literal>. + </para> + <para> + For <literal>UTF-16</literal>, <literal>UTF-32</literal>, + <literal>UCS2</literal> and <literal>UCS4</literal>, encoding + detection will fail always. + </para> + <para> + <example> + <title>Useless detect order example</title> + <programlisting> <![CDATA[ ; Always detect as ISO-8859-1 detect_order = ISO-8859-1, UTF-8 @@ -65,10 +71,24 @@ ; valid for UTF-8 detect_order = UTF-8, ASCII, UTF-7 ]]> - </programlisting> - </example> - </para> - </note> + </programlisting> + </example> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>mb_detect_order</function> examples</title> @@ -91,13 +111,20 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mb_internal_encoding</function>, - <function>mb_http_input</function>, - <function>mb_http_output</function> and - <function>mb_send_mail</function>. + <simplelist> + <member><function>mb_internal_encoding</function></member> + <member><function>mb_http_input</function></member> + <member><function>mb_http_output</function></member> + <member><function>mb_send_mail</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-encode-mimeheader.xml?r1=1.11&r2=1.11.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-encode-mimeheader.xml diff -u phpdoc/en/reference/mbstring/functions/mb-encode-mimeheader.xml:1.11 phpdoc/en/reference/mbstring/functions/mb-encode-mimeheader.xml:1.11.2.1 --- phpdoc/en/reference/mbstring/functions/mb-encode-mimeheader.xml:1.11 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-encode-mimeheader.xml Sun Dec 2 07:38:42 2007 @@ -1,5 +1,5 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.11 $ --> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.11.2.1 $ --> <refentry xml:id="function.mb-encode-mimeheader" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_encode_mimeheader</refname> @@ -17,29 +17,102 @@ <methodparam choice="opt"><type>int</type><parameter>indent</parameter></methodparam> </methodsynopsis> <para> - <function>mb_encode_mimeheader</function> encodes a given string + Encodes a given <type>string</type> <parameter>str</parameter> by the MIME header encoding scheme. - Returns a converted version of the string represented in ASCII. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>charset</parameter> specifies the name of the character set - in which <parameter>str</parameter> is represented in. The default value - is determined by the current NLS setting (<literal>mbstring.language</literal>). + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The <type>string</type> being encoded. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>charset</parameter></term> + <listitem> + <para> + <parameter>charset</parameter> specifies the name of the character set + in which <parameter>str</parameter> is represented in. The default value + is determined by the current NLS setting (<literal>mbstring.language</literal>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>transfer_encoding</parameter></term> + <listitem> + <para> + <parameter>transfer_encoding</parameter> specifies the scheme of MIME + encoding. It should be either <literal>"B"</literal> (Base64) or + <literal>"Q"</literal> (Quoted-Printable). Falls back to + <literal>"B"</literal> if not given. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>linefeed</parameter></term> + <listitem> + <para> + <parameter>linefeed</parameter> specifies the EOL (end-of-line) marker + with which <function>mb_encode_mimeheader</function> performs + line-folding (a <link xlink:href="&url.rfc;2822">RFC</link> 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 <literal>"\r\n"</literal> (CRLF) if not given. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>indent</parameter></term> + <listitem> + <para> + + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>transfer_encoding</parameter> specifies the scheme of MIME - encoding. It should be either <literal>"B"</literal> (Base64) or - <literal>"Q"</literal> (Quoted-Printable). Falls back to - <literal>"B"</literal> if not given. + A converted version of the <type>string</type> represented in ASCII. </para> + </refsect1> + + <refsect1 role="changelog"> + &reftitle.changelog; <para> - <parameter>linefeed</parameter> specifies the EOL (end-of-line) marker - with which <function>mb_encode_mimeheader</function> performs - line-folding (a <link xlink:href="&url.rfc;2822">RFC</link> 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 <literal>"\r\n"</literal> (CRLF) if not given. + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>5.0.0</entry> + <entry> + The <parameter>indent</parameter> parameter was added. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>mb_encode_mimeheader</function> example</title> @@ -56,6 +129,10 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> This function isn't designed to break lines at higher-level @@ -63,13 +140,17 @@ This behaviour may clutter up the original string with unexpected spaces. </para> </note> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - The <parameter>indent</parameter> was added as of PHP 5. - </para> - <para> - See also <function>mb_decode_mimeheader</function>. + <simplelist> + <member><function>mb_decode_mimeheader</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-encode-numericentity.xml?r1=1.6&r2=1.6.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-encode-numericentity.xml diff -u phpdoc/en/reference/mbstring/functions/mb-encode-numericentity.xml:1.6 phpdoc/en/reference/mbstring/functions/mb-encode-numericentity.xml:1.6.2.1 --- phpdoc/en/reference/mbstring/functions/mb-encode-numericentity.xml:1.6 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-encode-numericentity.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<refentry xml:id="function.mb-encode-numericentity" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.6.2.1 $ --> +<refentry xml:id="function.mb-encode-numericentity" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_encode_numericentity</refname> <refpurpose>Encode character to HTML numeric string reference</refpurpose> @@ -15,18 +15,52 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_encode_numericentity</function> converts - specified character codes in string <parameter>str</parameter> - from HTML numeric character reference to character code. It - returns converted string. + Converts + specified character codes in <type>string</type> <parameter>str</parameter> + from HTML numeric character reference to character code. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>convmap</parameter> is array specifies code area to - convert. + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The <type>string</type> being encoded. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>convmap</parameter></term> + <listitem> + <para> + <parameter>convmap</parameter> is array specifies code area to + convert. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + &mbstring.encoding.parameter; + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>encoding</parameter> is character encoding. + The converted <type>string</type>. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><parameter>convmap</parameter> example</title> @@ -44,6 +78,10 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>mb_encode_numericentity</function> example</title> @@ -73,10 +111,17 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mb_decode_numericentity</function>. + <simplelist> + <member><function>mb_decode_numericentity</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-ereg-match.xml?r1=1.6&r2=1.6.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-ereg-match.xml diff -u phpdoc/en/reference/mbstring/functions/mb-ereg-match.xml:1.6 phpdoc/en/reference/mbstring/functions/mb-ereg-match.xml:1.6.2.1 --- phpdoc/en/reference/mbstring/functions/mb-ereg-match.xml:1.6 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-ereg-match.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<refentry xml:id="function.mb-ereg-match" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.6.2.1 $ --> +<refentry xml:id="function.mb-ereg-match" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_ereg_match</refname> <refpurpose>Regular expression match for multibyte string</refpurpose> @@ -12,25 +12,70 @@ <type>bool</type><methodname>mb_ereg_match</methodname> <methodparam><type>string</type><parameter>pattern</parameter></methodparam> <methodparam><type>string</type><parameter>string</parameter></methodparam> - <methodparam choice="opt"> - <type>string</type><parameter>option</parameter> - </methodparam> + <methodparam choice="opt"><type>string</type><parameter>option</parameter></methodparam> </methodsynopsis> + <para> + A regular expression match for a multibyte string + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>pattern</parameter></term> + <listitem> + <para> + The regular expression pattern. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>string</parameter></term> + <listitem> + <para> + The <type>string</type> being evaluated. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>option</parameter></term> + <listitem> + <para> + + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <simpara> - <function>mb_ereg_match</function> returns &true; if - <parameter>string</parameter> matches regular expression + Returns &true; if + <parameter>string</parameter> matches the regular expression <parameter>pattern</parameter>, &false; if not. </simpara> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + + ¬e.mbstring.encoding.internal; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - The internal encoding or the character encoding specified in - <function>mb_regex_encoding</function> will be used as character - encoding. - </para> - <para> - See also: <function>mb_regex_encoding</function>, - <function>mb_ereg</function>. + <simplelist> + <member><function>mb_regex_encoding</function></member> + <member><function>mb_ereg</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-ereg-replace.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-ereg-replace.xml diff -u phpdoc/en/reference/mbstring/functions/mb-ereg-replace.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-ereg-replace.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-ereg-replace.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-ereg-replace.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<refentry xml:id="function.mb-ereg-replace" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> +<refentry xml:id="function.mb-ereg-replace" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_ereg_replace</refname> <refpurpose>Replace regular expression with multibyte support</refpurpose> @@ -16,35 +16,87 @@ <methodparam choice="opt"><type>string</type><parameter>option</parameter></methodparam> </methodsynopsis> <simpara> - <function>mb_ereg_replace</function> scans - <parameter>string</parameter> for matches to + Scans <parameter>string</parameter> for matches to <parameter>pattern</parameter>, then replaces the matched text - with <parameter>replacement</parameter> and returns the result - string or &false; on error. Multibyte character can be used in - <parameter>pattern</parameter>. - </simpara> - <simpara> - Matching condition can be set by <parameter>option</parameter> - parameter. If <literal>i</literal> is specified for this - parameter, the case will be ignored. If <literal>x</literal> is - specified, white space will be ignored. If <literal>m</literal> - is specified, match will be executed in multiline mode and line - break will be included in '.'. If <literal>p</literal> is - specified, match will be executed in POSIX mode, line break - will be considered as normal character. If <literal>e</literal> - is specified, <parameter>replacement</parameter> string will be - evaluated as PHP expression. + with <parameter>replacement</parameter> </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>pattern</parameter></term> + <listitem> + <para> + The regular expression pattern. + </para> + <para> + Multibyte characters may be used in <parameter>pattern</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>replacement</parameter></term> + <listitem> + <para> + The replacement text. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>string</parameter></term> + <listitem> + <para> + The <type>string</type> being checked. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>option</parameter></term> + <listitem> + <simpara> + Matching condition can be set by <parameter>option</parameter> + parameter. If <literal>i</literal> is specified for this + parameter, the case will be ignored. If <literal>x</literal> is + specified, white space will be ignored. If <literal>m</literal> + is specified, match will be executed in multiline mode and line + break will be included in '.'. If <literal>p</literal> is + specified, match will be executed in POSIX mode, line break + will be considered as normal character. If <literal>e</literal> + is specified, <parameter>replacement</parameter> string will be + evaluated as PHP expression. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - The internal encoding or the character encoding specified in - <function>mb_regex_encoding</function> will be used as character - encoding. + The resultant <type>string</type> on success, or &false; on error. </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + + ¬e.mbstring.encoding.internal; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>mb_regex_encoding</function>, - <function>mb_eregi_replace</function>. + <simplelist> + <member><function>mb_regex_encoding</function></member> + <member><function>mb_eregi_replace</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-ereg-search-getpos.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-ereg-search-getpos.xml diff -u phpdoc/en/reference/mbstring/functions/mb-ereg-search-getpos.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-ereg-search-getpos.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-ereg-search-getpos.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-ereg-search-getpos.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<refentry xml:id="function.mb-ereg-search-getpos" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> +<refentry xml:id="function.mb-ereg-search-getpos" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_ereg_search_getpos</refname> <refpurpose>Returns start point for next regular expression match</refpurpose> @@ -13,6 +13,18 @@ <void/> </methodsynopsis> <simpara> + Returns the start point for the next regular expression match. + </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <simpara> <function>mb_ereg_search_getpos</function> returns the point to start regular expression match for <function>mb_ereg_search</function>, @@ -20,16 +32,24 @@ <function>mb_ereg_search_regs</function>. The position is represented by bytes from the head of string. </simpara> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + + ¬e.mbstring.encoding.internal; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - The internal encoding or the character encoding specified in - <function>mb_regex_encoding</function> will be used as character - encoding. - </para> - <para> - See also: <function>mb_regex_encoding</function>, - <function>mb_ereg_search_setpos</function>. + <simplelist> + <member><function>mb_regex_encoding</function></member> + <member><function>mb_ereg_search_setpos</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-ereg-search-getregs.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-ereg-search-getregs.xml diff -u phpdoc/en/reference/mbstring/functions/mb-ereg-search-getregs.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-ereg-search-getregs.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-ereg-search-getregs.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-ereg-search-getregs.xml Sun Dec 2 07:38:42 2007 @@ -1,10 +1,9 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<refentry xml:id="function.mb-ereg-search-getregs" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> +<refentry xml:id="function.mb-ereg-search-getregs" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_ereg_search_getregs</refname> - <refpurpose>Retrieve the result from the last multibyte regular expression match - </refpurpose> + <refpurpose>Retrieve the result from the last multibyte regular expression match</refpurpose> </refnamediv> <refsect1 role="description"> @@ -14,7 +13,19 @@ <void/> </methodsynopsis> <simpara> - <function>mb_ereg_search_getregs</function> returns an array + Retrieve the result from the last multibyte regular expression match + </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <simpara> + An <type>array</type> including the sub-string of matched part by last <function>mb_ereg_search</function>, <function>mb_ereg_search_pos</function>, @@ -24,16 +35,24 @@ the third element will have the second part grouped with brackets, and so on. It returns &false; on error; </simpara> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + + ¬e.mbstring.encoding.internal; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - The internal encoding or the character encoding specified in - <function>mb_regex_encoding</function> will be used as character - encoding. - </para> - <para> - See also: <function>mb_regex_encoding</function>, - <function>mb_ereg_search_init</function>. + <simplelist> + <member><function>mb_regex_encoding</function></member> + <member><function>mb_ereg_search_init</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-ereg-search-init.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-ereg-search-init.xml diff -u phpdoc/en/reference/mbstring/functions/mb-ereg-search-init.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-ereg-search-init.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-ereg-search-init.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-ereg-search-init.xml Sun Dec 2 07:38:42 2007 @@ -1,9 +1,9 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<refentry xml:id="function.mb-ereg-search-init" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> +<refentry xml:id="function.mb-ereg-search-init" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_ereg_search_init</refname> - <refpurpose>Setup string and regular expression for multibyte regularexpression match</refpurpose> + <refpurpose>Setup string and regular expression for a multibyte regular expression match</refpurpose> </refnamediv> <refsect1 role="description"> @@ -14,25 +14,44 @@ <methodparam choice="opt"><type>string</type><parameter>pattern</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>option</parameter></methodparam> </methodsynopsis> - <simpara> + <para> <function>mb_ereg_search_init</function> sets <parameter>string</parameter> and <parameter>pattern</parameter> - for multibyte regular expression. These values are used for + for a multibyte regular expression. These values are used for <function>mb_ereg_search</function>, - <function>mb_ereg_search_pos</function>, - <function>mb_ereg_search_regs</function>. It returns &true; for - success, &false; for error. - </simpara> - <para> - The internal encoding or the character encoding specified in - <function>mb_regex_encoding</function> will be used as character - encoding. + <function>mb_ereg_search_pos</function>, and + <function>mb_ereg_search_regs</function>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <simpara> + &return.success; + </simpara> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + + ¬e.mbstring.encoding.internal; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>mb_regex_encoding</function>, - <function>mb_ereg_search_regs</function>. + <simplelist> + <member><function>mb_regex_encoding</function></member> + <member><function>mb_ereg_search_regs</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-ereg-search-pos.xml?r1=1.9&r2=1.9.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-ereg-search-pos.xml diff -u phpdoc/en/reference/mbstring/functions/mb-ereg-search-pos.xml:1.9 phpdoc/en/reference/mbstring/functions/mb-ereg-search-pos.xml:1.9.2.1 --- phpdoc/en/reference/mbstring/functions/mb-ereg-search-pos.xml:1.9 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-ereg-search-pos.xml Sun Dec 2 07:38:42 2007 @@ -1,9 +1,9 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> -<refentry xml:id="function.mb-ereg-search-pos" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.9.2.1 $ --> +<refentry xml:id="function.mb-ereg-search-pos" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_ereg_search_pos</refname> - <refpurpose>Return position and length of matched part of multibyte regular expression for predefined multibyte string</refpurpose> + <refpurpose>Returns position and length of a matched part of the multibyte regular expression for a predefined multibyte string</refpurpose> </refnamediv> <refsect1 role="description"> @@ -13,28 +13,68 @@ <methodparam choice="opt"><type>string</type><parameter>pattern</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>option</parameter></methodparam> </methodsynopsis> - <simpara> - <function>mb_ereg_search_pos</function> 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. - </simpara> + <para> + Returns position and length of a matched part of the multibyte regular expression + for a predefined multibyte string + </para> <para> The string for match is specified by <function>mb_ereg_search_init</function>. If it is not specified, the previous one will be used. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The internal encoding or the character encoding specified in - <function>mb_regex_encoding</function> will be used as character - encoding. + <variablelist> + <varlistentry> + <term><parameter>pattern</parameter></term> + <listitem> + <para> + The search pattern. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>option</parameter></term> + <listitem> + <para> + The search option. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <simpara> + An <type>array</type> including + the position of a matched part for a 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. + </simpara> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + + ¬e.mbstring.encoding.internal; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>mb_regex_encoding</function>, - <function>mb_ereg_search_init</function>. + <simplelist> + <member><function>mb_regex_encoding</function></member> + <member><function>mb_ereg_search_init</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-ereg-search-regs.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-ereg-search-regs.xml diff -u phpdoc/en/reference/mbstring/functions/mb-ereg-search-regs.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-ereg-search-regs.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-ereg-search-regs.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-ereg-search-regs.xml Sun Dec 2 07:38:42 2007 @@ -1,9 +1,9 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<refentry xml:id="function.mb-ereg-search-regs" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> +<refentry xml:id="function.mb-ereg-search-regs" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_ereg_search_regs</refname> - <refpurpose>Returns the matched part of multibyte regular expression</refpurpose> + <refpurpose>Returns the matched part of a multibyte regular expression</refpurpose> </refnamediv> <refsect1 role="description"> @@ -13,24 +13,63 @@ <methodparam choice="opt"><type>string</type><parameter>pattern</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>option</parameter></methodparam> </methodsynopsis> + <para> + Returns the matched part of a multibyte regular expression. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>pattern</parameter></term> + <listitem> + <para> + The search pattern. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>option</parameter></term> + <listitem> + <para> + The search option. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <simpara> <function>mb_ereg_search_regs</function> executes the multibyte regular expression match, and if there are some matched part, it - returns an array including substring of matched part as first + returns an <type>array</type> 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 second grouped part as third element, and so on. + It returns &false; on error. </simpara> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + + ¬e.mbstring.encoding.internal; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - The internal encoding or the character encoding specified in - <function>mb_regex_encoding</function> will be used as character - encoding. - </para> - <para> - See also: <function>mb_regex_encoding</function>, - <function>mb_ereg_search_init</function>. + <simplelist> + <member><function>mb_regex_encoding</function></member> + <member><function>mb_ereg_search_init</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-ereg-search-setpos.xml?r1=1.8&r2=1.8.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-ereg-search-setpos.xml diff -u phpdoc/en/reference/mbstring/functions/mb-ereg-search-setpos.xml:1.8 phpdoc/en/reference/mbstring/functions/mb-ereg-search-setpos.xml:1.8.2.1 --- phpdoc/en/reference/mbstring/functions/mb-ereg-search-setpos.xml:1.8 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-ereg-search-setpos.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> -<refentry xml:id="function.mb-ereg-search-setpos" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.8.2.1 $ --> +<refentry xml:id="function.mb-ereg-search-setpos" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_ereg_search_setpos</refname> <refpurpose>Set start point of next regular expression match</refpurpose> @@ -14,18 +14,49 @@ </methodsynopsis> <simpara> <function>mb_ereg_search_setpos</function> sets the starting - point of match for <function>mb_ereg_search</function>. + point of a match for <function>mb_ereg_search</function>. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The internal encoding or the character encoding specified in - <function>mb_regex_encoding</function> will be used as character - encoding. + <variablelist> + <varlistentry> + <term><parameter>position</parameter></term> + <listitem> + <para> + The position to set. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <simpara> + &return.success; + </simpara> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + + ¬e.mbstring.encoding.internal; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>mb_regex_encoding</function>, - <function>mb_ereg_search_init</function>. + <simplelist> + <member><function>mb_regex_encoding</function></member> + <member><function>mb_ereg_search_init</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-ereg-search.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-ereg-search.xml diff -u phpdoc/en/reference/mbstring/functions/mb-ereg-search.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-ereg-search.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-ereg-search.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-ereg-search.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<refentry xml:id="function.mb-ereg-search" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> +<refentry xml:id="function.mb-ereg-search" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_ereg_search</refname> <refpurpose>Multibyte regular expression match for predefined multibyte string</refpurpose> @@ -13,24 +13,63 @@ <methodparam choice="opt"><type>string</type><parameter>pattern</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>option</parameter></methodparam> </methodsynopsis> + <para> + Performs a multibyte regular expression match for a predefined multibyte string. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>pattern</parameter></term> + <listitem> + <para> + The search pattern. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>option</parameter></term> + <listitem> + <para> + The search option. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <simpara> <function>mb_ereg_search</function> returns &true; if the - multibyte string matches with the regular expression, &false; for - otherwise. The string for matching is set by + multibyte string matches with the regular expression, or &false; + otherwise. The <type>string</type> for matching is set by <function>mb_ereg_search_init</function>. If <parameter>pattern</parameter> is not specified, the previous one is used. </simpara> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + + ¬e.mbstring.encoding.internal; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - The internal encoding or the character encoding specified in - <function>mb_regex_encoding</function> will be used as character - encoding. - </para> - <para> - See also: <function>mb_regex_encoding</function>, - <function>mb_ereg_search_init</function>. + <simplelist> + <member><function>mb_regex_encoding</function></member> + <member><function>mb_ereg_search_init</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-ereg.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-ereg.xml diff -u phpdoc/en/reference/mbstring/functions/mb-ereg.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-ereg.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-ereg.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-ereg.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<refentry xml:id="function.mb-ereg" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> +<refentry xml:id="function.mb-ereg" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_ereg</refname> <refpurpose>Regular expression match with multibyte support</refpurpose> @@ -12,30 +12,75 @@ <type>int</type><methodname>mb_ereg</methodname> <methodparam><type>string</type><parameter>pattern</parameter></methodparam> <methodparam><type>string</type><parameter>string</parameter></methodparam> - <methodparam choice="opt"> - <type>array</type><parameter>regs</parameter> - </methodparam> + <methodparam choice="opt"><type>array</type><parameter>regs</parameter></methodparam> </methodsynopsis> <simpara> - <function>mb_ereg</function> 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 - <parameter>regs</parameter> 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. + Executes the regular expression match with multibyte support. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The internal encoding or the character encoding specified in - <function>mb_regex_encoding</function> will be used as character - encoding. + <variablelist> + <varlistentry> + <term><parameter>pattern</parameter></term> + <listitem> + <para> + The search pattern. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>string</parameter></term> + <listitem> + <para> + The search <type>string</type>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>regs</parameter></term> + <listitem> + <para> + Contains a substring of the matched <type>string</type>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <simpara> + Executes the regular expression + match with multibyte support, and returns <literal>1</literal> if matches are found. + If the optional <parameter>regs</parameter> parameter was specified, the function + returns the byte length of matched part, and the <type>array</type> + <parameter>regs</parameter> will contain the substring of matched + string. The function returns <literal>1</literal> if it matches with the empty + string. If no matches are found or an error happens, &false; will be + returned. + </simpara> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + + ¬e.mbstring.encoding.internal; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>mb_regex_encoding</function>, - <function>mb_eregi</function> + <simplelist> + <member><function>mb_regex_encoding</function></member> + <member><function>mb_eregi</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-eregi-replace.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-eregi-replace.xml diff -u phpdoc/en/reference/mbstring/functions/mb-eregi-replace.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-eregi-replace.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-eregi-replace.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-eregi-replace.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<refentry xml:id="function.mb-eregi-replace" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> +<refentry xml:id="function.mb-eregi-replace" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_eregi_replace</refname> <refpurpose>Replace regular expression with multibyte support ignoring case</refpurpose> @@ -16,25 +16,76 @@ <methodparam choice="opt"><type>string</type><parameter>option</parameter></methodparam> </methodsynopsis> <simpara> - <function>mb_ereg_replace</function> scans - <parameter>string</parameter> for matches to + Scans <parameter>string</parameter> for matches to <parameter>pattern</parameter>, then replaces the matched text - with <parameter>replacement</parameter> and returns the result - string or &false; on error. Multibyte character can be used in - <parameter>pattern</parameter>. The case will be ignored. - <parameter>option</parameter> has the same meaning as in - <function>mb_ereg_replace</function>. + with <parameter>replacement</parameter>. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>pattern</parameter></term> + <listitem> + <para> + The regular expression pattern. Multibyte characters may be used. The case will be ignored. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>replace</parameter></term> + <listitem> + <para> + The replacement text. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>string</parameter></term> + <listitem> + <para> + The searched <type>string</type>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>option</parameter></term> + <listitem> + <simpara> + <parameter>option</parameter> has the same meaning as in + <function>mb_ereg_replace</function>. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - The internal encoding or the character encoding specified in - <function>mb_regex_encoding</function> will be used as character - encoding. + The resultant <type>string</type> or &false; on error. </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + + ¬e.mbstring.encoding.internal; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>mb_regex_encoding</function>, - <function>mb_ereg_replace</function>. + <simplelist> + <member><function>mb_regex_encoding</function></member> + <member><function>mb_ereg_replace</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-eregi.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-eregi.xml diff -u phpdoc/en/reference/mbstring/functions/mb-eregi.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-eregi.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-eregi.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-eregi.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<refentry xml:id="function.mb-eregi" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> +<refentry xml:id="function.mb-eregi" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_eregi</refname> <refpurpose>Regular expression match ignoring case with multibyte support</refpurpose> @@ -12,31 +12,75 @@ <type>int</type><methodname>mb_eregi</methodname> <methodparam><type>string</type><parameter>pattern</parameter></methodparam> <methodparam><type>string</type><parameter>string</parameter></methodparam> - <methodparam choice="opt"> - <type>array</type><parameter>regs</parameter> - </methodparam> + <methodparam choice="opt"><type>array</type><parameter>regs</parameter></methodparam> </methodsynopsis> <simpara> - <function>mb_eregi</function> 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 - <parameter>regs</parameter> 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. + Executes the case insensitive regular expression match with multibyte support. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The internal encoding or the character encoding specified in - <function>mb_regex_encoding</function> will be used as character - encoding. + <variablelist> + <varlistentry> + <term><parameter>pattern</parameter></term> + <listitem> + <para> + The regular expression pattern. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>string</parameter></term> + <listitem> + <para> + The <type>string</type> being searched. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>regs</parameter></term> + <listitem> + <para> + Contains a substring of the matched <type>string</type>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <simpara> + Executes the regular expression + match with multibyte support, and returns <literal>1</literal> if matches are found. + If the optional <parameter>regs</parameter> parameter was specified, the function + returns the byte length of matched part, and the <type>array</type> + <parameter>regs</parameter> will contain the substring of matched + string. The function returns <literal>1</literal> if it matches with the empty + string. If no matches are found or an error happens, &false; will be + returned. + </simpara> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + + ¬e.mbstring.encoding.internal; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>mb_regex_encoding</function>, - <function>mb_ereg</function>. + <simplelist> + <member><function>mb_regex_encoding</function></member> + <member><function>mb_ereg</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-get-info.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-get-info.xml diff -u phpdoc/en/reference/mbstring/functions/mb-get-info.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-get-info.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-get-info.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-get-info.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<refentry xml:id="function.mb-get-info" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> +<refentry xml:id="function.mb-get-info" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_get_info</refname> <refpurpose>Get internal settings of mbstring</refpurpose> @@ -13,26 +13,77 @@ <methodparam choice="opt"><type>string</type><parameter>type</parameter></methodparam> </methodsynopsis> <simpara> - <function>mb_get_info</function> returns internal setting - parameter of mbstring. + <function>mb_get_info</function> returns the internal setting parameters of mbstring. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>type</parameter></term> + <listitem> + <para> + If <parameter>type</parameter> isn't specified or is specified to + "all", an <type>array</type> having the elements "internal_encoding", + "http_output", "http_input", "func_overload", "mail_charset", + "mail_header_encoding", "mail_body_encoding" will be returned. + </para> + <para> + If <parameter>type</parameter> is specified as "http_output", + "http_input", "internal_encoding", "func_overload", + the specified setting parameter will be returned. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - If <parameter>type</parameter> 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. + An <type>array</type> of type information if <parameter>type</parameter> + is not specified, otherwise a specific <parameter>type</parameter>. </para> + </refsect1> + + <refsect1 role="changelog"> + &reftitle.changelog; <para> - If <parameter>type</parameter> is specified for "http_output", - "http_input", "internal_encoding", "func_overload", - the specified setting parameter will be returned. + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>5.1.3</entry> + <entry> + The element types "mail_charset", "mail_header_encoding", and + "mail_body_encoding" were made available. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mb_internal_encoding</function>, - <function>mb_http_output</function>. + <simplelist> + <member><function>mb_regex_encoding</function></member> + <member><function>mb_http_output</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-http-input.xml?r1=1.5&r2=1.5.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-http-input.xml diff -u phpdoc/en/reference/mbstring/functions/mb-http-input.xml:1.5 phpdoc/en/reference/mbstring/functions/mb-http-input.xml:1.5.2.1 --- phpdoc/en/reference/mbstring/functions/mb-http-input.xml:1.5 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-http-input.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<refentry xml:id="function.mb-http-input" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.5.2.1 $ --> +<refentry xml:id="function.mb-http-input" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_http_input</refname> <refpurpose>Detect HTTP input character encoding</refpurpose> @@ -13,27 +13,49 @@ <methodparam choice="opt"><type>string</type><parameter>type</parameter></methodparam> </methodsynopsis> <simpara> - <function>mb_http_input</function> returns result of HTTP input - character encoding detection. + Detects the HTTP input character encoding. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>type</parameter>: 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 <type>array</type>). If type is omitted, it returns last - input type processed. + <variablelist> + <varlistentry> + <term><parameter>type</parameter></term> + <listitem> + <para> + Input string specifies the input type. + "G" for GET, "P" for POST, "C" for COOKIE, "S" for string, "L" for list, and + "I" for the whole list (will return <type>array</type>). + If type is omitted, it returns the last input type processed. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - Return Value: Character encoding name. + The character encoding name, as per the <parameter>type</parameter>. If <function>mb_http_input</function> does not process specified HTTP input, it returns &false;. </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mb_internal_encoding</function>, - <function>mb_http_output</function>, - <function>mb_detect_order</function>. + <simplelist> + <member><function>mb_internal_encoding</function></member> + <member><function>mb_http_output</function></member> + <member><function>mb_detect_order</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-http-output.xml?r1=1.5&r2=1.5.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-http-output.xml diff -u phpdoc/en/reference/mbstring/functions/mb-http-output.xml:1.5 phpdoc/en/reference/mbstring/functions/mb-http-output.xml:1.5.2.1 --- phpdoc/en/reference/mbstring/functions/mb-http-output.xml:1.5 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-http-output.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<refentry xml:id="function.mb-http-output" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.5.2.1 $ --> +<refentry xml:id="function.mb-http-output" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_http_output</refname> <refpurpose>Set/Get HTTP output character encoding</refpurpose> @@ -13,25 +13,55 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - If <parameter>encoding</parameter> is set, - <function>mb_http_output</function> sets HTTP output character - encoding to <parameter>encoding</parameter>. Output after this - function is converted to <parameter>encoding</parameter>. - <function>mb_http_output</function> returns - &true; for success and &false; - for failure. + Set/Get the HTTP output character encoding. + Output after this function is converted to <parameter>encoding</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + <para> + If <parameter>encoding</parameter> is set, + <function>mb_http_output</function> sets the HTTP output character + encoding to <parameter>encoding</parameter>. + </para> + <para> + If <parameter>encoding</parameter> is omitted, + <function>mb_http_output</function> returns the current HTTP output + character encoding. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> If <parameter>encoding</parameter> is omitted, - <function>mb_http_output</function> returns current HTTP output - character encoding. + <function>mb_http_output</function> returns the current HTTP output + character encoding. Otherwise, + &return.success; </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mb_internal_encoding</function>, - <function>mb_http_input</function>, - <function>mb_detect_order</function>. + <simplelist> + <member><function>mb_internal_encoding</function></member> + <member><function>mb_http_input</function></member> + <member><function>mb_detect_order</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-internal-encoding.xml?r1=1.6&r2=1.6.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-internal-encoding.xml diff -u phpdoc/en/reference/mbstring/functions/mb-internal-encoding.xml:1.6 phpdoc/en/reference/mbstring/functions/mb-internal-encoding.xml:1.6.2.1 --- phpdoc/en/reference/mbstring/functions/mb-internal-encoding.xml:1.6 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-internal-encoding.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<refentry xml:id="function.mb-internal-encoding" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.6.2.1 $ --> +<refentry xml:id="function.mb-internal-encoding" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_internal_encoding</refname> <refpurpose>Set/Get internal character encoding</refpurpose> @@ -13,26 +13,41 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_internal_encoding</function> sets internal character - encoding to <parameter>encoding</parameter> If parameter is - omitted, it returns current internal encoding. - </para> - <para> - <parameter>encoding</parameter> is used for HTTP input character - encoding conversion, HTTP output character encoding conversion - and default character encoding for string functions defined by - mbstring module. + Set/Get the internal character encoding </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>encoding</parameter>: Character encoding name + <variablelist> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + <para> + <parameter>encoding</parameter> is the character encoding name + used for the HTTP input character encoding conversion, HTTP output + character encoding conversion, and the default character encoding + for string functions defined by the mbstring module. + </para> + </listitem> + </varlistentry> + </variablelist> </para> - <para> - Return Value: If <parameter>encoding</parameter> is - set,<function>mb_internal_encoding</function> returns - &true; for success, otherwise returns - &false;. If <parameter>encoding</parameter> is - omitted, it returns current character encoding name. + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + If <parameter>encoding</parameter> is set, then + &return.success; + If <parameter>encoding</parameter> is omitted, then + the current character encoding name is returned. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>mb_internal_encoding</function> example</title> @@ -49,12 +64,25 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + + ¬e.mbstring.encoding.internal; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mb_http_input</function>, - <function>mb_http_output</function> and - <function>mb_detect_order</function>. + <simplelist> + <member><function>mb_http_input</function></member> + <member><function>mb_http_output</function></member> + <member><function>mb_detect_order</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-language.xml?r1=1.5&r2=1.5.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-language.xml diff -u phpdoc/en/reference/mbstring/functions/mb-language.xml:1.5 phpdoc/en/reference/mbstring/functions/mb-language.xml:1.5.2.1 --- phpdoc/en/reference/mbstring/functions/mb-language.xml:1.5 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-language.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<refentry xml:id="function.mb-language" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.5.2.1 $ --> +<refentry xml:id="function.mb-language" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_language</refname> <refpurpose>Set/Get current language</refpurpose> @@ -13,34 +13,56 @@ <methodparam choice="opt"><type>string</type><parameter>language</parameter></methodparam> </methodsynopsis> <para> - <function>mb_language</function> sets language. If - <parameter>language</parameter> is omitted, it returns current - language as string. + Set/Get the current language. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>language</parameter> setting is used for encoding - e-mail messages. Valid languages are "Japanese", - "ja","English","en" and "uni" - (UTF-8). <function>mb_send_mail</function> uses this setting to - encode e-mail. - </para> - <para> - Language and its setting is ISO-2022-JP/Base64 for - Japanese, UTF-8/Base64 for uni, ISO-8859-1/quoted printable for - English. + <variablelist> + <varlistentry> + <term><parameter>language</parameter></term> + <listitem> + <para> + Used for encoding + e-mail messages. Valid languages are "Japanese", + "ja","English","en" and "uni" + (UTF-8). <function>mb_send_mail</function> uses this setting to + encode e-mail. + </para> + <para> + Language and its setting is ISO-2022-JP/Base64 for + Japanese, UTF-8/Base64 for uni, ISO-8859-1/quoted printable for + English. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - Return Value: If <parameter>language</parameter> is set and + If <parameter>language</parameter> is set and <parameter>language</parameter> is valid, it returns - &true;. Otherwise, it returns &false;. When - <parameter>language</parameter> is omitted, it returns language - name as string. If no language is set previously, it returns + &true;. Otherwise, it returns &false;. + When <parameter>language</parameter> is omitted, it returns the language + name as a <type>string</type>. If no language is set previously, it then returns &false;. </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mb_send_mail</function>. + <simplelist> + <member><function>mb_send_mail</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-output-handler.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-output-handler.xml diff -u phpdoc/en/reference/mbstring/functions/mb-output-handler.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-output-handler.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-output-handler.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-output-handler.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<refentry xml:id="function.mb-output-handler" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> +<refentry xml:id="function.mb-output-handler" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_output_handler</refname> <refpurpose>Callback function converts character encoding in output buffer</refpurpose> @@ -17,38 +17,90 @@ <function>mb_output_handler</function> is <function>ob_start</function> callback function. <function>mb_output_handler</function> converts - characters in output buffer from internal character encoding to + characters in the output buffer from internal character encoding to HTTP output character encoding. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - 4.1.0 or later version, this handler adds charset HTTP header - when following conditions are met: - </para> - <para> - <itemizedlist> - <listitem> - <simpara>Does not set <literal>Content-Type</literal> by - header()</simpara> - </listitem> - <listitem> - <simpara>Default MIME type begins with - <literal>text/</literal></simpara> - </listitem> - <listitem> - <simpara><literal>http_output</literal> setting is other than - pass</simpara> - </listitem> - </itemizedlist> - </para> - <para> - <parameter>contents</parameter> : Output buffer contents + <variablelist> + <varlistentry> + <term><parameter>contents</parameter></term> + <listitem> + <para> + The contents of the output buffer. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>status</parameter></term> + <listitem> + <para> + The status of the output buffer. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>status</parameter> : Output buffer status + The converted <type>string</type>. </para> + </refsect1> + + <refsect1 role="changelog"> + &reftitle.changelog; <para> - Return Value: String converted + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>4.1.0</entry> + <entry> + <para> + This handler now adds the charset HTTP header when the following conditions are met: + </para> + <para> + <itemizedlist> + <listitem> + <simpara> + Does not set <literal>Content-Type</literal>, using <function>header</function>. + </simpara> + </listitem> + <listitem> + <simpara> + The default MIME type begins with <literal>text/</literal>. + </simpara> + </listitem> + <listitem> + <simpara> + The <link linkend="ini.mbstring.http-input">mbstring.http_input</link> + setting is something other than <literal>pass</literal>. + </simpara> + </listitem> + </itemizedlist> + </para> + </entry> + </row> + </tbody> + </tgroup> + </informaltable> </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>mb_output_handler</function> example</title> @@ -62,6 +114,10 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> If you want to output some binary data such as image from PHP @@ -83,10 +139,17 @@ "pass" using <function>mb_http_output</function>. </para> </note> - <para> - See also <function>ob_start</function>. + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>ob_start</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-parse-str.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-parse-str.xml diff -u phpdoc/en/reference/mbstring/functions/mb-parse-str.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-parse-str.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-parse-str.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-parse-str.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<refentry xml:id="function.mb-parse-str" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> +<refentry xml:id="function.mb-parse-str" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_parse_str</refname> <refpurpose>Parse GET/POST/COOKIE data and set global variable</refpurpose> @@ -14,28 +14,56 @@ <methodparam choice="opt"><type>array</type><parameter role="reference">result</parameter></methodparam> </methodsynopsis> <para> - <function>mb_parse_str</function> parses GET/POST/COOKIE data and + 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 + data, it can only be used for GET data for now. It parses URL encoded data, detects encoding, converts coding to internal - encoding and set values to <parameter>result</parameter> array or + encoding and set values to the <parameter>result</parameter> <type>array</type> or global variables. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>encoded_string</parameter>: URL encoded data. - </para> - <para> - <parameter>result</parameter>: Array contains decoded and - character encoding converted values. + <variablelist> + <varlistentry> + <term><parameter>encoded_string</parameter></term> + <listitem> + <para> + The URL encoded data. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>result</parameter></term> + <listitem> + <para> + An <type>array</type> containing decoded and character encoded converted values. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - Return Value: It returns &true; for success or &false; for failure. + &return.success; </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mb_detect_order</function>, - <function>mb_internal_encoding</function>. + <simplelist> + <member><function>mb_detect_order</function></member> + <member><function>mb_internal_encoding</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-preferred-mime-name.xml?r1=1.5&r2=1.5.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-preferred-mime-name.xml diff -u phpdoc/en/reference/mbstring/functions/mb-preferred-mime-name.xml:1.5 phpdoc/en/reference/mbstring/functions/mb-preferred-mime-name.xml:1.5.2.1 --- phpdoc/en/reference/mbstring/functions/mb-preferred-mime-name.xml:1.5 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-preferred-mime-name.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<refentry xml:id="function.mb-preferred-mime-name" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.5.2.1 $ --> +<refentry xml:id="function.mb-preferred-mime-name" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_preferred_mime_name</refname> <refpurpose>Get MIME charset string</refpurpose> @@ -13,11 +13,36 @@ <methodparam><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_preferred_mime_name</function> returns MIME - <literal>charset</literal> string for character encoding - <parameter>encoding</parameter>. It returns - <literal>charset</literal> string. + Get a MIME charset <type>string</type> for a specific encoding. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + <para> + The encoding being checked. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The MIME <literal>charset</literal> <type>string</type> for character encoding + <parameter>encoding</parameter>. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>mb_preferred_mime_string</function> example</title> @@ -34,6 +59,7 @@ </example> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-regex-encoding.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-regex-encoding.xml diff -u phpdoc/en/reference/mbstring/functions/mb-regex-encoding.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-regex-encoding.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-regex-encoding.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-regex-encoding.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<refentry xml:id="function.mb-regex-encoding" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> +<refentry xml:id="function.mb-regex-encoding" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_regex_encoding</refname> <refpurpose>Returns current encoding for multibyte regex as string</refpurpose> @@ -12,20 +12,42 @@ <type>mixed</type><methodname>mb_regex_encoding</methodname> <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> - <simpara> - <function>mb_regex_encoding</function> returns the character - encoding used by multibyte regex functions. - </simpara> <para> - If the optional parameter <parameter>encoding</parameter> is - specified, it is set to the character encoding for multibyte - regex. The default value is the internal character encoding. + Returns the current encoding for a multibyte regex as a <type>string</type>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - See also: <function>mb_internal_encoding</function>, - <function>mb_ereg</function> + <variablelist> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + &mbstring.encoding.parameter; + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <simpara> + Returns the character encoding used by multibyte regex functions. + </simpara> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mb_internal_encoding</function></member> + <member><function>mb_ereg</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-regex-set-options.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-regex-set-options.xml diff -u phpdoc/en/reference/mbstring/functions/mb-regex-set-options.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-regex-set-options.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-regex-set-options.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-regex-set-options.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<refentry xml:id="function.mb-regex-set-options" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> +<refentry xml:id="function.mb-regex-set-options" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_regex_set_options</refname> <refpurpose>Set/Get the default options for mbregex functions</refpurpose> @@ -10,25 +10,49 @@ &reftitle.description; <methodsynopsis> <type>string</type><methodname>mb_regex_set_options</methodname> - <methodparam choice="opt"> - <type>string</type><parameter>options</parameter> - </methodparam> + <methodparam choice="opt"><type>string</type><parameter>options</parameter></methodparam> </methodsynopsis> <simpara> - <function>mb_regex_set_options</function> sets the default options - described by <parameter>options</parameter> for multibyte regex functions. + Sets the default options described by <parameter>options</parameter> + for multibyte regex functions. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - Returns the previous options. If <parameter>options</parameter> is - omitted, it returns the string that describes the current options. + <variablelist> + <varlistentry> + <term><parameter>options</parameter></term> + <listitem> + <para> + The options to set. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also - <function>mb_split</function>, - <function>mb_ereg</function> and - <function>mb_eregi</function> + The previous options. If <parameter>options</parameter> is omitted, + it returns the <type>string</type> that describes the current options. </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mb_split</function></member> + <member><function>mb_ereg</function></member> + <member><function>mb_eregi</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-send-mail.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-send-mail.xml diff -u phpdoc/en/reference/mbstring/functions/mb-send-mail.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-send-mail.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-send-mail.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-send-mail.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<refentry xml:id="function.mb-send-mail" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> +<refentry xml:id="function.mb-send-mail" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_send_mail</refname> <refpurpose>Send encoded mail</refpurpose> @@ -17,52 +17,112 @@ <methodparam choice="opt"><type>string</type><parameter>additional_parameter</parameter></methodparam> </methodsynopsis> <para> - <function>mb_send_mail</function> sends email. Headers and - message are converted and encoded according to - <function>mb_language</function> setting. - <function>mb_send_mail</function> is wrapper - function of <function>mail</function>. See - <function>mail</function> for details. - </para> - <para> - <parameter>to</parameter> 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. - </para> - <para> - <parameter>subject</parameter> is subject of mail. - </para> - <para> - <parameter>message</parameter> is mail message. + Sends email. Headers and messages are converted and encoded according + to the <function>mb_language</function> setting. It's a wrapper function + for <function>mail</function>, so see also <function>mail</function> for details. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>additional_headers</parameter> 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"). + <variablelist> + <varlistentry> + <term><parameter>to</parameter></term> + <listitem> + <para> + The mail addresses being sent to. Multiple + recipients may be specified by putting a comma between each + address in <parameter>to</parameter>. + This parameter is not automatically encoded. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>subject</parameter></term> + <listitem> + <para> + The subject of the mail. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>message</parameter></term> + <listitem> + <para> + The message of the mail. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>additional_headers</parameter></term> + <listitem> + <para> + <parameter>additional_headers</parameter> 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"). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>additional_parameter</parameter></term> + <listitem> + <para> + <parameter>additional_parameter</parameter> is a MTA command line + parameter. It is useful when setting the correct Return-Path + header when using sendmail. + </para> + </listitem> + </varlistentry> + </variablelist> </para> - <note> - <para> - <literal>Content-Type</literal> and - <literal>Content-Transfer-Encoding</literal> headers can be redefined as - of PHP 5.0.0. In PHP 4, values defined by - <function>mb_language</function> are always used. - </para> - </note> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>additional_parameter</parameter> is a MTA command line - parameter. It is useful when setting the correct Return-Path - header when using sendmail. + &return.success; </para> + </refsect1> + + <refsect1 role="changelog"> + &reftitle.changelog; <para> - &return.success; + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>5.0.0</entry> + <entry> + The <literal>Content-Type</literal> and <literal>Content-Transfer-Encoding</literal> + headers may be redefined as of PHP 5.0.0. Before this time, the values defined by + <function>mb_language</function> are always used. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mail</function>, - <function>mb_encode_mimeheader</function>, and - <function>mb_language</function>. + <simplelist> + <member><function>mail</function></member> + <member><function>mb_encode_mimeheade</function></member> + <member><function>mb_language</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-split.xml?r1=1.6&r2=1.6.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-split.xml diff -u phpdoc/en/reference/mbstring/functions/mb-split.xml:1.6 phpdoc/en/reference/mbstring/functions/mb-split.xml:1.6.2.1 --- phpdoc/en/reference/mbstring/functions/mb-split.xml:1.6 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-split.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<refentry xml:id="function.mb-split" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.6.2.1 $ --> +<refentry xml:id="function.mb-split" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_split</refname> <refpurpose>Split multibyte string using regular expression</refpurpose> @@ -12,31 +12,73 @@ <type>array</type><methodname>mb_split</methodname> <methodparam><type>string</type><parameter>pattern</parameter></methodparam> <methodparam><type>string</type><parameter>string</parameter></methodparam> - <methodparam choice="opt"> - <type>int</type><parameter>limit</parameter> - </methodparam> + <methodparam choice="opt"><type>int</type><parameter>limit</parameter></methodparam> </methodsynopsis> <simpara> - <function>mb_split</function> split multibyte + Split a multibyte <parameter>string</parameter> using regular expression <parameter>pattern</parameter> and returns the result as an - array. - </simpara> - <simpara> - If optional parameter <parameter>limit</parameter> is specified, - it will be split in <parameter>limit</parameter> elements as - maximum. + <type>array</type>. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The internal encoding or the character encoding specified in - <function>mb_regex_encoding</function> will be used as character - encoding. + <variablelist> + <varlistentry> + <term><parameter>pattern</parameter></term> + <listitem> + <para> + The regular expression pattern. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>string</parameter></term> + <listitem> + <para> + The <type>string</type> being split. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>limit</parameter></term> + <listitem> + <simpara> + If optional parameter <parameter>limit</parameter> is specified, + it will be split in <parameter>limit</parameter> elements as + maximum. + </simpara> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also: <function>mb_regex_encoding</function>, - <function>mb_ereg</function>. + The result as an <type>array</type>. </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + + ¬e.mbstring.encoding.internal; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mb_regex_encoding</function></member> + <member><function>mb_ereg</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-strcut.xml?r1=1.4&r2=1.4.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-strcut.xml diff -u phpdoc/en/reference/mbstring/functions/mb-strcut.xml:1.4 phpdoc/en/reference/mbstring/functions/mb-strcut.xml:1.4.2.1 --- phpdoc/en/reference/mbstring/functions/mb-strcut.xml:1.4 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-strcut.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<refentry xml:id="function.mb-strcut" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.4.2.1 $ --> +<refentry xml:id="function.mb-strcut" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_strcut</refname> <refpurpose>Get part of string</refpurpose> @@ -16,12 +16,6 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_strcut</function> returns the portion of - <parameter>str</parameter> specified by the - <parameter>start</parameter> and - <parameter>length</parameter> parameters. - </para> - <para> <function>mb_strcut</function> performs equivalent operation as <function>mb_substr</function> with different method. If <parameter>start</parameter> position is multi-byte character's @@ -34,15 +28,66 @@ not part of multi-byte string or not being middle of shift sequence. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>encoding</parameter> is character encoding. If it is - not set, internal character encoding is used. + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The <type>string</type> being cut. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>start</parameter></term> + <listitem> + <para> + The position that begins the cut. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>length</parameter></term> + <listitem> + <para> + The <type>string</type> being decoded. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + &mbstring.encoding.parameter; + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>mb_substr</function>, - <function>mb_internal_encoding</function>. + <function>mb_strcut</function> returns the portion of + <parameter>str</parameter> specified by the + <parameter>start</parameter> and + <parameter>length</parameter> parameters. </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mb_substr</function></member> + <member><function>mb_internal_encoding</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-strimwidth.xml?r1=1.6&r2=1.6.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-strimwidth.xml diff -u phpdoc/en/reference/mbstring/functions/mb-strimwidth.xml:1.6 phpdoc/en/reference/mbstring/functions/mb-strimwidth.xml:1.6.2.1 --- phpdoc/en/reference/mbstring/functions/mb-strimwidth.xml:1.6 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-strimwidth.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<refentry xml:id="function.mb-strimwidth" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.6.2.1 $ --> +<refentry xml:id="function.mb-strimwidth" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_strimwidth</refname> <refpurpose>Get truncated string with specified width</refpurpose> @@ -17,26 +17,68 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_strimwidth</function> truncates string - <parameter>str</parameter> to specified - <parameter>width</parameter>. It returns truncated string. - </para> - <para> - If <parameter>trimmarker</parameter> is set, - <parameter>trimmarker</parameter> is appended to return value. - </para> - <para> - <parameter>start</parameter> is start position offset. Number of - characters from the beginning of string. (First character is 0) + Truncates <type>string</type> <parameter>str</parameter> to specified <parameter>width</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>trimmarker</parameter> is string that is added to the - end of string when string is truncated. + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The <type>string</type> being decoded. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>start</parameter></term> + <listitem> + <para> + The start position offset. Number of + characters from the beginning of string. (First character is 0) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>width</parameter></term> + <listitem> + <para> + The width of the desired trim. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>trimmarker</parameter></term> + <listitem> + <para> + A string that is added to the end of string + when string is truncated. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + &mbstring.encoding.parameter; + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>encoding</parameter> is character encoding. If it is - omitted, internal encoding is used. + The truncated <type>string</type>. If <parameter>trimmarker</parameter> is set, + <parameter>trimmarker</parameter> is appended to the return value. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>mb_strimwidth</function> example</title> @@ -49,11 +91,18 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mb_strwidth</function> and - <function>mb_internal_encoding</function>. + <simplelist> + <member><function>mb_strwidth</function></member> + <member><function>mb_internal_encoding</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-strlen.xml?r1=1.5&r2=1.5.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-strlen.xml diff -u phpdoc/en/reference/mbstring/functions/mb-strlen.xml:1.5 phpdoc/en/reference/mbstring/functions/mb-strlen.xml:1.5.2.1 --- phpdoc/en/reference/mbstring/functions/mb-strlen.xml:1.5 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-strlen.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<refentry xml:id="function.mb-strlen" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.5.2.1 $ --> +<refentry xml:id="function.mb-strlen" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_strlen</refname> <refpurpose>Get string length</refpurpose> @@ -14,21 +14,52 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_strlen</function> returns number of characters in - string <parameter>str</parameter> having character encoding - <parameter>encoding</parameter>. A multi-byte character is - counted as 1. + Gets the length of a <type>string</type>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>encoding</parameter> is character encoding for - <parameter>str</parameter>. If <parameter>encoding</parameter> is - omitted, internal character encoding is used. + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The <type>string</type> being checked for length. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + &mbstring.encoding.parameter; + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>mb_internal_encoding</function>, - <function>strlen</function>. + Returns the number of characters in + <type>string</type> <parameter>str</parameter> having character encoding + <parameter>encoding</parameter>. A multi-byte character is + counted as 1. + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mb_internal_encoding</function></member> + <member><function>strlen</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-strpos.xml?r1=1.6&r2=1.6.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-strpos.xml diff -u phpdoc/en/reference/mbstring/functions/mb-strpos.xml:1.6 phpdoc/en/reference/mbstring/functions/mb-strpos.xml:1.6.2.1 --- phpdoc/en/reference/mbstring/functions/mb-strpos.xml:1.6 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-strpos.xml Sun Dec 2 07:38:42 2007 @@ -1,11 +1,9 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<refentry xml:id="function.mb-strpos" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.6.2.1 $ --> +<refentry xml:id="function.mb-strpos" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_strpos</refname> - <refpurpose> - Find position of first occurrence of string in a string - </refpurpose> + <refpurpose>Find position of first occurrence of string in a string</refpurpose> </refnamediv> <refsect1 role="description"> @@ -18,37 +16,75 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_strpos</function> returns the numeric position of - the first occurrence of <parameter>needle</parameter> in the - <parameter>haystack</parameter> string. If - <parameter>needle</parameter> is not found, it returns &false;. + Finds position of the first occurrence of a <type>string</type> in a <type>string</type>. </para> <para> - <function>mb_strpos</function> performs multi-byte safe + Performs a multi-byte safe <function>strpos</function> operation based on number of - characters. <parameter>needle</parameter> position is counted - from the beginning of the <parameter>haystack</parameter>. First - character's position is 0. Second character position is 1, and so - on. - </para> - <para> - If <parameter>encoding</parameter> is omitted, internal - character encoding is used. + characters. The first character's position is 0, the second character + position is 1, and so on. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>offset</parameter> is search offset. If it is not - specified, 0 is used. + <variablelist> + <varlistentry> + <term><parameter>haystack</parameter></term> + <listitem> + <para> + The <type>string</type> being checked. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>needle</parameter></term> + <listitem> + <para> + The position counted from the beginning of <parameter>haystack</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>offset</parameter></term> + <listitem> + <para> + The search offset. If it is not specified, 0 is used. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + &mbstring.encoding.parameter; + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>encoding</parameter> is character encoding name. If it - is omitted, internal character encoding is used. + Returns the numeric position of + the first occurrence of <parameter>needle</parameter> in the + <parameter>haystack</parameter> <type>string</type>. If + <parameter>needle</parameter> is not found, it returns &false;. </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mb_strrpos</function>, - <function>mb_internal_encoding</function>, - <function>strpos</function> + <simplelist> + <member><function>mb_</function></member> + <member><function>mb_internal_encoding</function></member> + <member><function>strpos</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-strrpos.xml?r1=1.7.2.1&r2=1.7.2.2&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-strrpos.xml diff -u phpdoc/en/reference/mbstring/functions/mb-strrpos.xml:1.7.2.1 phpdoc/en/reference/mbstring/functions/mb-strrpos.xml:1.7.2.2 --- phpdoc/en/reference/mbstring/functions/mb-strrpos.xml:1.7.2.1 Fri Nov 30 18:29:51 2007 +++ phpdoc/en/reference/mbstring/functions/mb-strrpos.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7.2.1 $ --> -<refentry xml:id="function.mb-strrpos" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.2 $ --> +<refentry xml:id="function.mb-strrpos" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_strrpos</refname> <refpurpose>Find position of last occurrence of a string in a string</refpurpose> @@ -16,44 +16,64 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_strrpos</function> returns the numeric position of - the last occurrence of <parameter>needle</parameter> in the - <parameter>haystack</parameter> string. If - <parameter>needle</parameter> is not found, it returns &false;. - </para> - <para> - <function>mb_strrpos</function> performs multi-byte safe - <function>strrpos</function> operation based on + Performs a multibyte safe + <function>strrpos</function> operation based on the number of characters. <parameter>needle</parameter> position is counted from the beginning of <parameter>haystack</parameter>. First character's position is 0. Second character position is 1. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - If <parameter>encoding</parameter> is omitted, internal encoding - is assumed. + <variablelist> + <varlistentry> + <term><parameter>haystack</parameter></term> + <listitem> + <para> + The <type>string</type> being checked, for the last occurrence + of <parameter>needle</parameter> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>needle</parameter></term> + <listitem> + <para> + The <type>string</type> to find in <parameter>haystack</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>offset</parameter></term> + <listitem> + <simpara> + May be specified to begin searching an arbitrary number of characters into + the <type>string</type>. Negative values will stop searching at an arbitrary point + prior to the end of the <type>string</type>. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + &mbstring.encoding.parameter; + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>encoding</parameter> is character encoding. If it is - not specified, internal character encoding is used. + Returns the numeric position of + the last occurrence of <parameter>needle</parameter> in the + <parameter>haystack</parameter> <type>string</type>. If + <parameter>needle</parameter> is not found, it returns &false;. </para> - <note> - <simpara> - As of PHP 5.2.0 <parameter>offset</parameter> may - be specified to begin searching an arbitrary number of characters into - the string. Negative values will stop searching at an arbitrary point - prior to the end of the string. - </simpara> - </note> - <note> - <simpara> - The <parameter>encoding</parameter> parameter was moved from - the third position to the fourth in PHP 5.2.0. For backward - compatibility, <parameter>encoding</parameter> can be specified - as the third parameter, but doing so is deprecated and will be - removed in the future. - </simpara> - </note> </refsect1> <refsect1 role="changelog"> @@ -78,6 +98,20 @@ </para> </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + <note> + <simpara> + The <parameter>encoding</parameter> parameter was moved from + the third position to the fourth in PHP 5.2.0. For backward + compatibility, <parameter>encoding</parameter> can be specified + as the third parameter, but doing so is deprecated and will be + removed in the future. + </simpara> + </note> + ¬e.mbstring.encoding.internal; + </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-strtolower.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-strtolower.xml diff -u phpdoc/en/reference/mbstring/functions/mb-strtolower.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-strtolower.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-strtolower.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-strtolower.xml Sun Dec 2 07:38:42 2007 @@ -1,5 +1,5 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> <refentry xml:id="function.mb-strtolower" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_strtolower</refname> @@ -14,14 +14,42 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_strtolower</function> returns <parameter>str</parameter> + Returns <parameter>str</parameter> with all alphabetic characters converted to lowercase. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The <type>string</type> being lowercased. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + &mbstring.encoding.parameter; + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>encoding</parameter> specifies the encoding of - <parameter>str</parameter>; if omitted, the internal character encoding - value will be used. + <parameter>str</parameter> with all alphabetic characters converted to lowercase. </para> + </refsect1> + + <refsect1 role="unicode"> + &reftitle.unicode; <para> For more information about the Unicode properties, please see <link xlink:href="&url.unicode.reports;">&url.unicode.reports;</link>. @@ -32,6 +60,10 @@ of this function is not affected by locale settings and it can convert any characters that have 'alphabetic' property, such as A-umlaut (Ä). </para> +</refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>mb_strtolower</function> example</title> @@ -46,12 +78,19 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>strtolower</function>, - <function>mb_strtoupper</function> and - <function>mb_convert_case</function>. + <simplelist> + <member><function>mb_strtoupper</function></member> + <member><function>mb_convert_case</function></member> + <member><function>strtolower</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-strtoupper.xml?r1=1.7&r2=1.7.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-strtoupper.xml diff -u phpdoc/en/reference/mbstring/functions/mb-strtoupper.xml:1.7 phpdoc/en/reference/mbstring/functions/mb-strtoupper.xml:1.7.2.1 --- phpdoc/en/reference/mbstring/functions/mb-strtoupper.xml:1.7 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-strtoupper.xml Sun Dec 2 07:38:42 2007 @@ -1,5 +1,5 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.7.2.1 $ --> <refentry xml:id="function.mb-strtoupper" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_strtoupper</refname> @@ -14,25 +14,57 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_strtoupper</function> returns <parameter>str</parameter> + Returns <parameter>str</parameter> with all alphabetic characters converted to uppercase. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>encoding</parameter> specifies the encoding of - <parameter>str</parameter>; if omitted, the internal character encoding - value will be used. + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The <type>string</type> being lowercased. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + &mbstring.encoding.parameter; + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - By contrast to <function>strtoupper</function>, '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 (ä). + <parameter>str</parameter> with all alphabetic characters converted to uppercase. </para> + </refsect1> + + <refsect1 role="unicode"> + &reftitle.unicode; <para> For more information about the Unicode properties, please see <link xlink:href="&url.unicode.reports;">&url.unicode.reports;</link>. </para> <para> + By contrast to <function>strtoupper</function>, '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 (ä). + </para> +</refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> <example> <title><function>mb_strtoupper</function> example</title> <programlisting role="php"> @@ -46,12 +78,19 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>strtoupper</function>, - <function>mb_strtolower</function> and - <function>mb_convert_case</function>. + <simplelist> + <member><function>mb_strtolower</function></member> + <member><function>mb_convert_case</function></member> + <member><function>strtoupper</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-strwidth.xml?r1=1.5&r2=1.5.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-strwidth.xml diff -u phpdoc/en/reference/mbstring/functions/mb-strwidth.xml:1.5 phpdoc/en/reference/mbstring/functions/mb-strwidth.xml:1.5.2.1 --- phpdoc/en/reference/mbstring/functions/mb-strwidth.xml:1.5 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-strwidth.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<refentry xml:id="function.mb-strwidth" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.5.2.1 $ --> +<refentry xml:id="function.mb-strwidth" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_strwidth</refname> <refpurpose>Return width of string</refpurpose> @@ -14,12 +14,10 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_strwidth</function> returns width of string - <parameter>str</parameter>. + Returns the width of <type>string</type> <parameter>str</parameter>. </para> <para> - Multi-byte character usually twice of width compare to single - byte character. + Multi-byte characters are usually twice the width of single byte characters. </para> <para> <table> @@ -56,15 +54,47 @@ </tgroup> </table> </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>encoding</parameter> is character encoding. If it is - omitted, internal encoding is used. + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The <type>string</type> being decoded. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + &mbstring.encoding.parameter; + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also: <function>mb_strimwidth</function>, - <function>mb_internal_encoding</function>. + The width of <type>string</type> <parameter>str</parameter>. </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mb_strimwidth</function></member> + <member><function>mb_internal_encoding</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-substitute-character.xml?r1=1.6&r2=1.6.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-substitute-character.xml diff -u phpdoc/en/reference/mbstring/functions/mb-substitute-character.xml:1.6 phpdoc/en/reference/mbstring/functions/mb-substitute-character.xml:1.6.2.1 --- phpdoc/en/reference/mbstring/functions/mb-substitute-character.xml:1.6 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-substitute-character.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<refentry xml:id="function.mb-substitute-character" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.6.2.1 $ --> +<refentry xml:id="function.mb-substitute-character" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_substitute_character</refname> <refpurpose>Set/Get substitution character</refpurpose> @@ -13,11 +13,10 @@ <methodparam choice="opt"><type>mixed</type><parameter>substrchar</parameter></methodparam> </methodsynopsis> <para> - <function>mb_substitute_character</function> 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). + Specifies a substitution character when input character encoding is invalid + or character code does not exist in output character + encoding. Invalid characters may be substituted &null; (no output), + <type>string</type> or <type>integer</type> value (Unicode character code value). </para> <para> This setting affects <function>mb_convert_encoding</function>, @@ -25,30 +24,49 @@ <function>mb_output_handler</function>, and <function>mb_send_mail</function>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>substchar</parameter> : Specify Unicode value as - integer or specify as string as follows - <itemizedlist> - <listitem> - <simpara> - "none" : no output - </simpara> - </listitem> - <listitem> - <simpara> - "long" : Output character code value (Example: - U+3000,JIS+7E7E) - </simpara> - </listitem> - </itemizedlist> + <variablelist> + <varlistentry> + <term><parameter>substrchar</parameter></term> + <listitem> + <para> + Specify the Unicode value as an <type>integer</type>, + or as one of the following <type>string</type>s: + <itemizedlist> + <listitem> + <simpara> + "none" : no output + </simpara> + </listitem> + <listitem> + <simpara> + "long" : Output character code value (Example: U+3000,JIS+7E7E) + </simpara> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - Return Value: If <parameter>substchar</parameter> is set, it - returns &true; for success, otherwise returns - &false;. If <parameter>substchar</parameter> is - not set, it returns Unicode value or - "<literal>none</literal>"/"<literal>long</literal>". + If <parameter>substchar</parameter> is set, it returns &true; for success, + otherwise returns &false;. + If <parameter>substchar</parameter> is not set, it returns the Unicode value, + or "<literal>none</literal>" or "<literal>long</literal>". </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>mb_substitute_character</function> example</title> @@ -69,6 +87,7 @@ </example> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-substr-count.xml?r1=1.4&r2=1.4.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-substr-count.xml diff -u phpdoc/en/reference/mbstring/functions/mb-substr-count.xml:1.4 phpdoc/en/reference/mbstring/functions/mb-substr-count.xml:1.4.2.1 --- phpdoc/en/reference/mbstring/functions/mb-substr-count.xml:1.4 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-substr-count.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<refentry xml:id="function.mb-substr-count" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.4.2.1 $ --> +<refentry xml:id="function.mb-substr-count" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_substr_count</refname> <refpurpose>Count the number of substring occurrences</refpurpose> @@ -15,15 +15,53 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_substr_count</function> returns the number of times the + Counts the number of times the <parameter>needle</parameter> substring occurs in the - <parameter>haystack</parameter> string. + <parameter>haystack</parameter> <type>string</type>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>encoding</parameter> specifies the encoding for - <parameter>needle</parameter> and <parameter>haystack</parameter>. - If omitted, internal character encoding is used. + <variablelist> + <varlistentry> + <term><parameter>haystack</parameter></term> + <listitem> + <para> + The <type>string</type> being checked. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>needle</parameter></term> + <listitem> + <para> + The <type>string</type> being found. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + &mbstring.encoding.parameter; + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The number of times the + <parameter>needle</parameter> substring occurs in the + <parameter>haystack</parameter> <type>string</type>. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>mb_substr_count</function> example</title> @@ -36,11 +74,19 @@ </programlisting> </example> </para> - <simpara> - See also <function>substr_count</function>, - <function>mb_strpos</function>, <function>mb_substr</function>. - </simpara> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mb_strpos</function></member> + <member><function>mb_substr</function></member> + <member><function>substr_count</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-substr.xml?r1=1.4&r2=1.4.2.1&diff_format=u Index: phpdoc/en/reference/mbstring/functions/mb-substr.xml diff -u phpdoc/en/reference/mbstring/functions/mb-substr.xml:1.4 phpdoc/en/reference/mbstring/functions/mb-substr.xml:1.4.2.1 --- phpdoc/en/reference/mbstring/functions/mb-substr.xml:1.4 Thu Sep 20 20:55:38 2007 +++ phpdoc/en/reference/mbstring/functions/mb-substr.xml Sun Dec 2 07:38:42 2007 @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<refentry xml:id="function.mb-substr" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.4.2.1 $ --> +<refentry xml:id="function.mb-substr" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>mb_substr</refname> <refpurpose>Get part of string</refpurpose> @@ -16,32 +16,73 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>mb_substr</function> returns the portion of - <parameter>str</parameter> specified by the - <parameter>start</parameter> and - <parameter>length</parameter> parameters. - </para> - <para> - <function>mb_substr</function> performs multi-byte safe + Performs a multi-byte safe <function>substr</function> operation based on number of characters. Position is counted from the beginning of <parameter>str</parameter>. First character's position is 0. Second character position is 1, and so on. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - If <parameter>encoding</parameter> is omitted, internal encoding - is assumed. + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The <type>string</type> being checked. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>start</parameter></term> + <listitem> + <para> + The first position used in <parameter>str</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>length</parameter></term> + <listitem> + <para> + The maximum length of the returned <type>string</type>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + &mbstring.encoding.parameter; + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>encoding</parameter> is character encoding. If it is - omitted, internal character encoding is used. + <function>mb_substr</function> returns the portion of + <parameter>str</parameter> specified by the + <parameter>start</parameter> and + <parameter>length</parameter> parameters. </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mb_strcut</function>, - <function>mb_internal_encoding</function>. + <simplelist> + <member><function>mb_strcut</function></member> + <member><function>mb_internal_encoding</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file