sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

WS, preparation for the new doc style

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@242741 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson 2007-09-20 20:55:38 +00:00
parent 213a341fcb
commit a19afca437
44 changed files with 2015 additions and 2057 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

121
reference/mbstring/functions/mb-convert-case.xml
View file

@ -1,51 +1,52 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<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>
<refpurpose>Perform case folding on a string</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>mb_convert_case</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
<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
<parameter>mode</parameter>.
</para>
<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.
</para>
<para>
The return value is str with the appropriate case folding applied.
</para>
<para>
By contrast to the standard case folding functions such as
<function>strtolower</function> and <function>strtoupper</function>,
case folding is performed on the basis of the Unicode character
properties. Thus the behaviour of this function is not affected
by locale settings and it can convert any characters that have
'alphabetic' property, such as A-umlaut (&Auml;).
</para>
<para>
For more information about the Unicode properties, please see <link
xlink:href="&url.unicode.reports;">&url.unicode.reports;</link>.
</para>
<para>
<example>
<title><function>mb_convert_case</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.8 $ -->
<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>
<refpurpose>Perform case folding on a string</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_convert_case</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
<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
<parameter>mode</parameter>.
</para>
<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.
</para>
<para>
The return value is str with the appropriate case folding applied.
</para>
<para>
By contrast to the standard case folding functions such as
<function>strtolower</function> and <function>strtoupper</function>,
case folding is performed on the basis of the Unicode character
properties. Thus the behaviour of this function is not affected
by locale settings and it can convert any characters that have
'alphabetic' property, such as A-umlaut (&Auml;).
</para>
<para>
For more information about the Unicode properties, please see <link
xlink:href="&url.unicode.reports;">&url.unicode.reports;</link>.
</para>
<para>
<example>
<title><function>mb_convert_case</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$str = "mary had a Little lamb and she loved it so";
@ -55,19 +56,19 @@ $str = mb_convert_case($str, MB_CASE_TITLE, "UTF-8");
echo $str; // Prints Mary Had A Little Lamb And She Loved It So
?>
]]>
</programlisting>
</example>
</para>
<para>
See also <function>mb_strtolower</function>,
<function>mb_strtoupper</function>,
<function>strtolower</function>,
<function>strtoupper</function>,
<function>ucfirst</function>&listendand;
<function>ucwords</function>
</para>
</refsect1>
</refentry>
</programlisting>
</example>
</para>
<para>
See also <function>mb_strtolower</function>,
<function>mb_strtoupper</function>,
<function>strtolower</function>,
<function>strtoupper</function>,
<function>ucfirst</function>&listendand;
<function>ucwords</function>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

84
reference/mbstring/functions/mb-convert-encoding.xml
View file

@ -1,38 +1,38 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.1 -->
<refentry xml:id="function.mb-convert-encoding" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_convert_encoding</refname>
<refpurpose>Convert character encoding</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>mb_convert_encoding</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam><type>string</type><parameter>to_encoding</parameter></methodparam>
<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>.
</para>
<para>
<parameter>str</parameter> : String to be converted.
</para>
<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.
</para>
<para>
<example>
<title><function>mb_convert_encoding</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.mb-convert-encoding" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_convert_encoding</refname>
<refpurpose>Convert character encoding</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_convert_encoding</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam><type>string</type><parameter>to_encoding</parameter></methodparam>
<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>.
</para>
<para>
<parameter>str</parameter> : String to be converted.
</para>
<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.
</para>
<para>
<example>
<title><function>mb_convert_encoding</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* Convert internal character encoding to SJIS */
@ -48,14 +48,14 @@ $str = mb_convert_encoding($str, "UCS-2LE", "JIS, eucjp-win, sjis-win");
$str = mb_convert_encoding($str, "EUC-JP", "auto");
?>
]]>
</programlisting>
</example>
</para>
<para>
See also <function>mb_detect_order</function>.
</para>
</refsect1>
</refentry>
</programlisting>
</example>
</para>
<para>
See also <function>mb_detect_order</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

296
reference/mbstring/functions/mb-convert-kana.xml
View file

@ -1,148 +1,146 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.1 -->
<refentry xml:id="function.mb-convert-kana" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_convert_kana</refname>
<refpurpose>
Convert "kana" one from another ("zen-kaku", "han-kaku" and more)
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>mb_convert_kana</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>option</parameter></methodparam>
<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>.
</para>
<para>
<parameter>encoding</parameter> is character encoding. If it is
omitted, internal character encoding is used.
</para>
<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>
</para>
<para>
<example>
<title><function>mb_convert_kana</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.11 $ -->
<refentry xml:id="function.mb-convert-kana" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_convert_kana</refname>
<refpurpose>Convert "kana" one from another ("zen-kaku", "han-kaku" and more)</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_convert_kana</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>option</parameter></methodparam>
<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>.
</para>
<para>
<parameter>encoding</parameter> is character encoding. If it is
omitted, internal character encoding is used.
</para>
<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>
</para>
<para>
<example>
<title><function>mb_convert_kana</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* Convert all "kana" to "zen-kaku" "kata-kana" */
@ -153,11 +151,11 @@ $str = mb_convert_kana($str, "KVC");
$str = mb_convert_kana($str, "KVa");
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

102
reference/mbstring/functions/mb-convert-variables.xml
View file

@ -1,50 +1,50 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.1 -->
<refentry xml:id="function.mb-convert-variables" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_convert_variables</refname>
<refpurpose>Convert character code in variable(s)</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>mb_convert_variables</methodname>
<methodparam><type>string</type><parameter>to_encoding</parameter></methodparam>
<methodparam><type>mixed</type><parameter>from_encoding</parameter></methodparam>
<methodparam><type>mixed</type><parameter role="reference">vars</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter role="reference">...</parameter></methodparam>
</methodsynopsis>
<para>
<function>mb_convert_variables</function> convert
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.
</para>
<para>
<function>mb_convert_variables</function> join strings in Array
or Object to detect encoding, since encoding detection tends to
fail for short strings. Therefore, it is impossible to mix
encoding in single array or object.
</para>
<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.
</para>
<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.
</para>
<para>
<example>
<title><function>mb_convert_variables</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.9 $ -->
<refentry xml:id="function.mb-convert-variables" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_convert_variables</refname>
<refpurpose>Convert character code in variable(s)</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_convert_variables</methodname>
<methodparam><type>string</type><parameter>to_encoding</parameter></methodparam>
<methodparam><type>mixed</type><parameter>from_encoding</parameter></methodparam>
<methodparam><type>mixed</type><parameter role="reference">vars</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter role="reference">...</parameter></methodparam>
</methodsynopsis>
<para>
<function>mb_convert_variables</function> convert
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.
</para>
<para>
<function>mb_convert_variables</function> join strings in Array
or Object to detect encoding, since encoding detection tends to
fail for short strings. Therefore, it is impossible to mix
encoding in single array or object.
</para>
<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.
</para>
<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.
</para>
<para>
<example>
<title><function>mb_convert_variables</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* Convert variables $post1, $post2 to internal encoding */
@ -52,11 +52,11 @@ $interenc = mb_internal_encoding();
$inputenc = mb_convert_variables($interenc, "ASCII,UTF-8,SJIS-win", $post1, $post2);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

50
reference/mbstring/functions/mb-decode-mimeheader.xml
View file

@ -1,29 +1,29 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.1 -->
<refentry xml:id="function.mb-decode-mimeheader" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_decode_mimeheader</refname>
<refpurpose>Decode string in MIME header field</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>mb_decode_mimeheader</methodname>
<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.
</para>
<para>
It returns decoded string in internal character encoding.
</para>
<para>
See also <function>mb_encode_mimeheader</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.4 $ -->
<refentry xml:id="function.mb-decode-mimeheader" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_decode_mimeheader</refname>
<refpurpose>Decode string in MIME header field</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_decode_mimeheader</methodname>
<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.
</para>
<para>
It returns decoded string in internal character encoding.
</para>
<para>
See also <function>mb_encode_mimeheader</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

82
reference/mbstring/functions/mb-decode-numericentity.xml
View file

@ -1,38 +1,36 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.1 -->
<refentry xml:id="function.mb-decode-numericentity" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_decode_numericentity</refname>
<refpurpose>
Decode HTML numeric string reference to character
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>mb_decode_numericentity</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam><type>array</type><parameter>convmap</parameter></methodparam>
<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.
</para>
<para>
<parameter>convmap</parameter> is array to specifies code area to
convert.
</para>
<para>
<parameter>encoding</parameter> is character encoding. If it is
omitted, internal character encoding is used.
</para>
<para>
<example>
<title><parameter>convmap</parameter> example</title>
<programlisting role="php">
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.mb-decode-numericentity" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_decode_numericentity</refname>
<refpurpose>Decode HTML numeric string reference to character</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_decode_numericentity</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam><type>array</type><parameter>convmap</parameter></methodparam>
<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.
</para>
<para>
<parameter>convmap</parameter> is array to specifies code area to
convert.
</para>
<para>
<parameter>encoding</parameter> is character encoding. If it is
omitted, internal character encoding is used.
</para>
<para>
<example>
<title><parameter>convmap</parameter> example</title>
<programlisting role="php">
<![CDATA[
$convmap = array (
int start_code1, int end_code1, int offset1, int mask1,
@ -43,14 +41,14 @@ $convmap = array (
// Add offsetN to value and take bit-wise 'AND' with maskN,
// then convert value to numeric string reference.
]]>
</programlisting>
</example>
</para>
<para>
See also <function>mb_encode_numericentity</function>.
</para>
</refsect1>
</refentry>
</programlisting>
</example>
</para>
<para>
See also <function>mb_encode_numericentity</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

92
reference/mbstring/functions/mb-detect-encoding.xml
View file

@ -1,42 +1,42 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.1 -->
<refentry xml:id="function.mb-detect-encoding" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_detect_encoding</refname>
<refpurpose>Detect character encoding</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>mb_detect_encoding</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>encoding_list</parameter></methodparam>
<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.
</para>
<para>
If <parameter>encoding_list</parameter> is omitted,
detect_order is used.
</para>
<para>
<parameter>strict</parameter> specifies whether to use
the strict encoding detection or not.
Default is &false;.
</para>
<para>
<example>
<title><function>mb_detect_encoding</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.mb-detect-encoding" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_detect_encoding</refname>
<refpurpose>Detect character encoding</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_detect_encoding</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>encoding_list</parameter></methodparam>
<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.
</para>
<para>
If <parameter>encoding_list</parameter> is omitted,
detect_order is used.
</para>
<para>
<parameter>strict</parameter> specifies whether to use
the strict encoding detection or not.
Default is &false;.
</para>
<para>
<example>
<title><function>mb_detect_encoding</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* Detect character encoding with current detect_order */
@ -55,14 +55,14 @@ $ary[] = "EUC-JP";
echo mb_detect_encoding($str, $ary);
?>
]]>
</programlisting>
</example>
</para>
<para>
See also <function>mb_detect_order</function>.
</para>
</refsect1>
</refentry>
</programlisting>
</example>
</para>
<para>
See also <function>mb_detect_order</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

156
reference/mbstring/functions/mb-detect-order.xml
View file

@ -1,64 +1,62 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.1 -->
<refentry xml:id="function.mb-detect-order" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_detect_order</refname>
<refpurpose>
Set/Get character encoding detection order
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>mb_detect_order</methodname>
<methodparam choice="opt"><type>mixed</type><parameter>encoding_list</parameter></methodparam>
</methodsynopsis>
<para>
<function>mb_detect_order</function> sets 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>
<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>
<!-- $Revision: 1.8 $ -->
<refentry xml:id="function.mb-detect-order" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_detect_order</refname>
<refpurpose>Set/Get character encoding detection order</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>mb_detect_order</methodname>
<methodparam choice="opt"><type>mixed</type><parameter>encoding_list</parameter></methodparam>
</methodsynopsis>
<para>
<function>mb_detect_order</function> sets 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>
<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>
<![CDATA[
; Always detect as ISO-8859-1
detect_order = ISO-8859-1, UTF-8
@ -67,14 +65,14 @@ detect_order = ISO-8859-1, UTF-8
; valid for UTF-8
detect_order = UTF-8, ASCII, UTF-7
]]>
</programlisting>
</example>
</para>
</note>
<para>
<example>
<title><function>mb_detect_order</function> examples</title>
<programlisting role="php">
</programlisting>
</example>
</para>
</note>
<para>
<example>
<title><function>mb_detect_order</function> examples</title>
<programlisting role="php">
<![CDATA[
<?php
/* Set detection order by enumerated list */
@ -90,17 +88,17 @@ mb_detect_order($ary);
echo implode(", ", mb_detect_order());
?>
]]>
</programlisting>
</example>
</para>
<para>
See also <function>mb_internal_encoding</function>,
<function>mb_http_input</function>,
<function>mb_http_output</function> and
<function>mb_send_mail</function>.
</para>
</refsect1>
</refentry>
</programlisting>
</example>
</para>
<para>
See also <function>mb_internal_encoding</function>,
<function>mb_http_input</function>,
<function>mb_http_output</function> and
<function>mb_send_mail</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

126
reference/mbstring/functions/mb-encode-mimeheader.xml
View file

@ -1,49 +1,49 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.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>
<refpurpose>Encode string for MIME header</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>mb_encode_mimeheader</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>transfer_encoding</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>linefeed</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>indent</parameter></methodparam>
</methodsynopsis>
<para>
<function>mb_encode_mimeheader</function> encodes a given string
<parameter>str</parameter> by the MIME header encoding scheme.
Returns a converted version of the string represented in ASCII.
</para>
<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>
<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>
<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>
<para>
<example>
<title><function>mb_encode_mimeheader</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.11 $ -->
<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>
<refpurpose>Encode string for MIME header</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_encode_mimeheader</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>transfer_encoding</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>linefeed</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>indent</parameter></methodparam>
</methodsynopsis>
<para>
<function>mb_encode_mimeheader</function> encodes a given string
<parameter>str</parameter> by the MIME header encoding scheme.
Returns a converted version of the string represented in ASCII.
</para>
<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>
<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>
<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>
<para>
<example>
<title><function>mb_encode_mimeheader</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$name = ""; // kanji
@ -53,24 +53,24 @@ $addr = mb_encode_mimeheader($name, "UTF-7", "Q") . " <" . $mbox . "@" . $doma .
echo $addr;
?>
]]>
</programlisting>
</example>
</para>
<note>
<para>
This function isn't designed to break lines at higher-level
contextual break points (word boundaries, etc.).
This behaviour may clutter up the original string with unexpected spaces.
</para>
</note>
<para>
The <parameter>indent</parameter> was added as of PHP 5.
</para>
<para>
See also <function>mb_decode_mimeheader</function>.
</para>
</refsect1>
</refentry>
</programlisting>
</example>
</para>
<note>
<para>
This function isn't designed to break lines at higher-level
contextual break points (word boundaries, etc.).
This behaviour may clutter up the original string with unexpected spaces.
</para>
</note>
<para>
The <parameter>indent</parameter> was added as of PHP 5.
</para>
<para>
See also <function>mb_decode_mimeheader</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

98
reference/mbstring/functions/mb-encode-numericentity.xml
View file

@ -1,38 +1,36 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.1 -->
<refentry xml:id="function.mb-encode-numericentity" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_encode_numericentity</refname>
<refpurpose>
Encode character to HTML numeric string reference
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>mb_encode_numericentity</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam><type>array</type><parameter>convmap</parameter></methodparam>
<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.
</para>
<para>
<parameter>convmap</parameter> is array specifies code area to
convert.
</para>
<para>
<parameter>encoding</parameter> is character encoding.
</para>
<para>
<example>
<title><parameter>convmap</parameter> example</title>
<programlisting role="php">
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.mb-encode-numericentity" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_encode_numericentity</refname>
<refpurpose>Encode character to HTML numeric string reference</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_encode_numericentity</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam><type>array</type><parameter>convmap</parameter></methodparam>
<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.
</para>
<para>
<parameter>convmap</parameter> is array specifies code area to
convert.
</para>
<para>
<parameter>encoding</parameter> is character encoding.
</para>
<para>
<example>
<title><parameter>convmap</parameter> example</title>
<programlisting role="php">
<![CDATA[
$convmap = array (
int start_code1, int end_code1, int offset1, int mask1,
@ -43,15 +41,13 @@ $convmap = array (
// Add offsetN to value and take bit-wise 'AND' with maskN, then
// it converts value to numeric string reference.
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title>
<function>mb_encode_numericentity</function> example
</title>
<programlisting role="php">
</programlisting>
</example>
</para>
<para>
<example>
<title><function>mb_encode_numericentity</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* Convert Left side of ISO-8859-1 to HTML numeric character reference */
@ -74,14 +70,14 @@ $convmap = array(
$str = mb_encode_numericentity($str, $convmap, "sjis-win");
?>
]]>
</programlisting>
</example>
</para>
<para>
See also <function>mb_decode_numericentity</function>.
</para>
</refsect1>
</refentry>
</programlisting>
</example>
</para>
<para>
See also <function>mb_decode_numericentity</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

68
reference/mbstring/functions/mb-ereg-match.xml
View file

@ -1,39 +1,37 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.23 -->
<refentry xml:id="function.mb-ereg-match" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_ereg_match</refname>
<refpurpose>
Regular expression match for multibyte string
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<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>
</methodsynopsis>
<simpara>
<function>mb_ereg_match</function> returns &true; if
<parameter>string</parameter> matches regular expression
<parameter>pattern</parameter>, &false; if not.
</simpara>
<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>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.mb-ereg-match" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_ereg_match</refname>
<refpurpose>Regular expression match for multibyte string</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<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>
</methodsynopsis>
<simpara>
<function>mb_ereg_match</function> returns &true; if
<parameter>string</parameter> matches regular expression
<parameter>pattern</parameter>, &false; if not.
</simpara>
<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>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

94
reference/mbstring/functions/mb-ereg-replace.xml
View file

@ -1,51 +1,51 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.23 -->
<refentry xml:id="function.mb-ereg-replace" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_ereg_replace</refname>
<refpurpose>Replace regular expression with multibyte support</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>mb_ereg_replace</methodname>
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
<methodparam><type>string</type><parameter>replacement</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>option</parameter></methodparam>
</methodsynopsis>
<simpara>
<function>mb_ereg_replace</function> 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.
</simpara>
<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_eregi_replace</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.mb-ereg-replace" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_ereg_replace</refname>
<refpurpose>Replace regular expression with multibyte support</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_ereg_replace</methodname>
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
<methodparam><type>string</type><parameter>replacement</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>option</parameter></methodparam>
</methodsynopsis>
<simpara>
<function>mb_ereg_replace</function> 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.
</simpara>
<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_eregi_replace</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

66
reference/mbstring/functions/mb-ereg-search-getpos.xml
View file

@ -1,38 +1,36 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.23 -->
<refentry xml:id="function.mb-ereg-search-getpos" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_ereg_search_getpos</refname>
<refpurpose>
Returns start point for next regular expression match
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>mb_ereg_search_getpos</methodname>
<void/>
</methodsynopsis>
<simpara>
<function>mb_ereg_search_getpos</function> returns
the point to start regular expression match for
<function>mb_ereg_search</function>,
<function>mb_ereg_search_pos</function>,
<function>mb_ereg_search_regs</function>. The position is
represented by bytes from the head of string.
</simpara>
<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>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.mb-ereg-search-getpos" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_ereg_search_getpos</refname>
<refpurpose>Returns start point for next regular expression match</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>mb_ereg_search_getpos</methodname>
<void/>
</methodsynopsis>
<simpara>
<function>mb_ereg_search_getpos</function> returns
the point to start regular expression match for
<function>mb_ereg_search</function>,
<function>mb_ereg_search_pos</function>,
<function>mb_ereg_search_regs</function>. The position is
represented by bytes from the head of string.
</simpara>
<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>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

74
reference/mbstring/functions/mb-ereg-search-getregs.xml
View file

@ -1,42 +1,40 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.23 -->
<refentry xml:id="function.mb-ereg-search-getregs" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_ereg_search_getregs</refname>
<refpurpose>
Retrieve the result from the last multibyte regular expression
match
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>mb_ereg_search_getregs</methodname>
<void/>
</methodsynopsis>
<simpara>
<function>mb_ereg_search_getregs</function> returns an array
including the sub-string of matched part by last
<function>mb_ereg_search</function>,
<function>mb_ereg_search_pos</function>,
<function>mb_ereg_search_regs</function>. If there are some
maches, the first element will have the matched sub-string, the
second element will have the first part grouped with brackets,
the third element will have the second part grouped with
brackets, and so on. It returns &false; on error;
</simpara>
<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>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.mb-ereg-search-getregs" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_ereg_search_getregs</refname>
<refpurpose>Retrieve the result from the last multibyte regular expression match
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>mb_ereg_search_getregs</methodname>
<void/>
</methodsynopsis>
<simpara>
<function>mb_ereg_search_getregs</function> returns an array
including the sub-string of matched part by last
<function>mb_ereg_search</function>,
<function>mb_ereg_search_pos</function>,
<function>mb_ereg_search_regs</function>. If there are some
matches, the first element will have the matched sub-string, the
second element will have the first part grouped with brackets,
the third element will have the second part grouped with
brackets, and so on. It returns &false; on error;
</simpara>
<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>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

73
reference/mbstring/functions/mb-ereg-search-init.xml
View file

@ -1,42 +1,39 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.23 -->
<refentry xml:id="function.mb-ereg-search-init" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_ereg_search_init</refname>
<refpurpose>
Setup string and regular expression for multibyte regular
expression match
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>mb_ereg_search_init</methodname>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<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_init</function> sets
<parameter>string</parameter> and <parameter>pattern</parameter>
for 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.
</para>
<para>
See also: <function>mb_regex_encoding</function>,
<function>mb_ereg_search_regs</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.mb-ereg-search-init" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_ereg_search_init</refname>
<refpurpose>Setup string and regular expression for multibyte regularexpression match</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mb_ereg_search_init</methodname>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<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_init</function> sets
<parameter>string</parameter> and <parameter>pattern</parameter>
for 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.
</para>
<para>
See also: <function>mb_regex_encoding</function>,
<function>mb_ereg_search_regs</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

77
reference/mbstring/functions/mb-ereg-search-pos.xml
View file

@ -1,44 +1,41 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.23 -->
<refentry xml:id="function.mb-ereg-search-pos" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_ereg_search_pos</refname>
<refpurpose>
Return position and length of matched part of multibyte regular
expression for predefined multibyte string
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>mb_ereg_search_pos</methodname>
<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>
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>
<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>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.9 $ -->
<refentry xml:id="function.mb-ereg-search-pos" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_ereg_search_pos</refname>
<refpurpose>Return position and length of matched part of multibyte regular expression for predefined multibyte string</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>mb_ereg_search_pos</methodname>
<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>
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>
<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>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

68
reference/mbstring/functions/mb-ereg-search-regs.xml
View file

@ -1,39 +1,37 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.23 -->
<refentry xml:id="function.mb-ereg-search-regs" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_ereg_search_regs</refname>
<refpurpose>
Returns the matched part of multibyte regular expression
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>mb_ereg_search_regs</methodname>
<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_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
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.
</simpara>
<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>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.mb-ereg-search-regs" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_ereg_search_regs</refname>
<refpurpose>Returns the matched part of multibyte regular expression</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>mb_ereg_search_regs</methodname>
<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_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
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.
</simpara>
<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>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

58
reference/mbstring/functions/mb-ereg-search-setpos.xml
View file

@ -1,34 +1,32 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.23 -->
<refentry xml:id="function.mb-ereg-search-setpos" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_ereg_search_setpos</refname>
<refpurpose>
Set start point of next regular expression match
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>mb_ereg_search_setpos</methodname>
<methodparam><type>int</type><parameter>position</parameter></methodparam>
</methodsynopsis>
<simpara>
<function>mb_ereg_search_setpos</function> sets the starting
point of match for <function>mb_ereg_search</function>.
</simpara>
<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>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.8 $ -->
<refentry xml:id="function.mb-ereg-search-setpos" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_ereg_search_setpos</refname>
<refpurpose>Set start point of next regular expression match</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mb_ereg_search_setpos</methodname>
<methodparam><type>int</type><parameter>position</parameter></methodparam>
</methodsynopsis>
<simpara>
<function>mb_ereg_search_setpos</function> sets the starting
point of match for <function>mb_ereg_search</function>.
</simpara>
<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>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

68
reference/mbstring/functions/mb-ereg-search.xml
View file

@ -1,39 +1,37 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.23 -->
<refentry xml:id="function.mb-ereg-search" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_ereg_search</refname>
<refpurpose>
Multibyte regular expression match for predefined multibyte string
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>mb_ereg_search</methodname>
<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</function> returns &true; if the
multibyte string matches with the regular expression, &false; for
otherwise. The string for matching is set by
<function>mb_ereg_search_init</function>. If
<parameter>pattern</parameter> is not specified, the previous one
is used.
</simpara>
<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>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.mb-ereg-search" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_ereg_search</refname>
<refpurpose>Multibyte regular expression match for predefined multibyte string</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mb_ereg_search</methodname>
<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</function> returns &true; if the
multibyte string matches with the regular expression, &false; for
otherwise. The string for matching is set by
<function>mb_ereg_search_init</function>. If
<parameter>pattern</parameter> is not specified, the previous one
is used.
</simpara>
<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>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

76
reference/mbstring/functions/mb-ereg.xml
View file

@ -1,42 +1,42 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.23 -->
<refentry xml:id="function.mb-ereg" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_ereg</refname>
<refpurpose>Regular expression match with multibyte support</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<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>
</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.
</simpara>
<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_eregi</function>
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.mb-ereg" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_ereg</refname>
<refpurpose>Regular expression match with multibyte support</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<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>
</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.
</simpara>
<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_eregi</function>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

77
reference/mbstring/functions/mb-eregi-replace.xml
View file

@ -1,44 +1,41 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.23 -->
<refentry xml:id="function.mb-eregi-replace" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_eregi_replace</refname>
<refpurpose>
Replace regular expression with multibyte support
ignoring case
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>mb_eregi_replace</methodname>
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
<methodparam><type>string</type><parameter>replace</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>option</parameter></methodparam>
</methodsynopsis>
<simpara>
<function>mb_ereg_replace</function> 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>.
</simpara>
<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_replace</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.mb-eregi-replace" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_eregi_replace</refname>
<refpurpose>Replace regular expression with multibyte support ignoring case</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_eregi_replace</methodname>
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
<methodparam><type>string</type><parameter>replace</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>option</parameter></methodparam>
</methodsynopsis>
<simpara>
<function>mb_ereg_replace</function> 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>.
</simpara>
<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_replace</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

80
reference/mbstring/functions/mb-eregi.xml
View file

@ -1,45 +1,43 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.23 -->
<refentry xml:id="function.mb-eregi" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_eregi</refname>
<refpurpose>
Regular expression match ignoring case with multibyte support
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<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>
</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.
</simpara>
<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>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.mb-eregi" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_eregi</refname>
<refpurpose>Regular expression match ignoring case with multibyte support</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<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>
</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.
</simpara>
<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>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

70
reference/mbstring/functions/mb-get-info.xml
View file

@ -1,39 +1,39 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.1 -->
<refentry xml:id="function.mb-get-info" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_get_info</refname>
<refpurpose>Get internal settings of mbstring</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>mb_get_info</methodname>
<methodparam choice="opt"><type>string</type><parameter>type</parameter></methodparam>
</methodsynopsis>
<simpara>
<function>mb_get_info</function> returns internal setting
parameter of mbstring.
</simpara>
<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.
</para>
<para>
If <parameter>type</parameter> is specified for "http_output",
"http_input", "internal_encoding", "func_overload",
the specified setting parameter will be returned.
</para>
<para>
See also <function>mb_internal_encoding</function>,
<function>mb_http_output</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.mb-get-info" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_get_info</refname>
<refpurpose>Get internal settings of mbstring</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>mb_get_info</methodname>
<methodparam choice="opt"><type>string</type><parameter>type</parameter></methodparam>
</methodsynopsis>
<simpara>
<function>mb_get_info</function> returns internal setting
parameter of mbstring.
</simpara>
<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.
</para>
<para>
If <parameter>type</parameter> is specified for "http_output",
"http_input", "internal_encoding", "func_overload",
the specified setting parameter will be returned.
</para>
<para>
See also <function>mb_internal_encoding</function>,
<function>mb_http_output</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

72
reference/mbstring/functions/mb-http-input.xml
View file

@ -1,40 +1,40 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.1 -->
<refentry xml:id="function.mb-http-input" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_http_input</refname>
<refpurpose>Detect HTTP input character encoding</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>mb_http_input</methodname>
<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.
</simpara>
<para>
<parameter>type</parameter>: Input string specifies input
type. &quot;G&quot; for GET, &quot;P&quot; for POST,
&quot;C&quot; 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.
</para>
<para>
Return Value: Character encoding name.
If <function>mb_http_input</function> does not process specified
HTTP input, it returns &false;.
</para>
<para>
See also <function>mb_internal_encoding</function>,
<function>mb_http_output</function>,
<function>mb_detect_order</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.mb-http-input" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_http_input</refname>
<refpurpose>Detect HTTP input character encoding</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>mb_http_input</methodname>
<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.
</simpara>
<para>
<parameter>type</parameter>: Input string specifies input
type. &quot;G&quot; for GET, &quot;P&quot; for POST,
&quot;C&quot; 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.
</para>
<para>
Return Value: Character encoding name.
If <function>mb_http_input</function> does not process specified
HTTP input, it returns &false;.
</para>
<para>
See also <function>mb_internal_encoding</function>,
<function>mb_http_output</function>,
<function>mb_detect_order</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

68
reference/mbstring/functions/mb-http-output.xml
View file

@ -1,38 +1,38 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.1 -->
<refentry xml:id="function.mb-http-output" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_http_output</refname>
<refpurpose>Set/Get HTTP output character encoding</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>mb_http_output</methodname>
<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.
</para>
<para>
If <parameter>encoding</parameter> is omitted,
<function>mb_http_output</function> returns current HTTP output
character encoding.
</para>
<para>
See also <function>mb_internal_encoding</function>,
<function>mb_http_input</function>,
<function>mb_detect_order</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.mb-http-output" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_http_output</refname>
<refpurpose>Set/Get HTTP output character encoding</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>mb_http_output</methodname>
<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.
</para>
<para>
If <parameter>encoding</parameter> is omitted,
<function>mb_http_output</function> returns current HTTP output
character encoding.
</para>
<para>
See also <function>mb_internal_encoding</function>,
<function>mb_http_input</function>,
<function>mb_detect_order</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

98
reference/mbstring/functions/mb-internal-encoding.xml
View file

@ -1,44 +1,42 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.1 -->
<refentry xml:id="function.mb-internal-encoding" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_internal_encoding</refname>
<refpurpose>
Set/Get internal character encoding
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>mb_internal_encoding</methodname>
<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.
</para>
<para>
<parameter>encoding</parameter>: Character encoding name
</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.
</para>
<para>
<example>
<title><function>mb_internal_encoding</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.mb-internal-encoding" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_internal_encoding</refname>
<refpurpose>Set/Get internal character encoding</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>mb_internal_encoding</methodname>
<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.
</para>
<para>
<parameter>encoding</parameter>: Character encoding name
</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.
</para>
<para>
<example>
<title><function>mb_internal_encoding</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* Set internal character encoding to UTF-8 */
@ -48,16 +46,16 @@ mb_internal_encoding("UTF-8");
echo mb_internal_encoding();
?>
]]>
</programlisting>
</example>
</para>
<para>
See also <function>mb_http_input</function>,
<function>mb_http_output</function> and
<function>mb_detect_order</function>.
</para>
</refsect1>
</refentry>
</programlisting>
</example>
</para>
<para>
See also <function>mb_http_input</function>,
<function>mb_http_output</function> and
<function>mb_detect_order</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

87
reference/mbstring/functions/mb-language.xml
View file

@ -1,48 +1,47 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.3 -->
<refentry xml:id="function.mb-language" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_language</refname>
<refpurpose>
Set/Get current language
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>mb_language</methodname>
<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.
</para>
<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.
</para>
<para>
Return Value: 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
&false;.
</para>
<para>
See also <function>mb_send_mail</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.mb-language" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_language</refname>
<refpurpose>Set/Get current language</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>mb_language</methodname>
<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.
</para>
<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.
</para>
<para>
Return Value: 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
&false;.
</para>
<para>
See also <function>mb_send_mail</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

168
reference/mbstring/functions/mb-output-handler.xml
View file

@ -1,95 +1,93 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.1 -->
<refentry xml:id="function.mb-output-handler" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_output_handler</refname>
<refpurpose>
Callback function converts character encoding in output buffer
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>mb_output_handler</methodname>
<methodparam><type>string</type><parameter>contents</parameter></methodparam>
<methodparam><type>int</type><parameter>status</parameter></methodparam>
</methodsynopsis>
<para>
<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
HTTP output character encoding.
</para>
<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
</para>
<para>
<parameter>status</parameter> : Output buffer status
</para>
<para>
Return Value: String converted
</para>
<para>
<example>
<title><function>mb_output_handler</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.mb-output-handler" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_output_handler</refname>
<refpurpose>Callback function converts character encoding in output buffer</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_output_handler</methodname>
<methodparam><type>string</type><parameter>contents</parameter></methodparam>
<methodparam><type>int</type><parameter>status</parameter></methodparam>
</methodsynopsis>
<para>
<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
HTTP output character encoding.
</para>
<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
</para>
<para>
<parameter>status</parameter> : Output buffer status
</para>
<para>
Return Value: String converted
</para>
<para>
<example>
<title><function>mb_output_handler</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
mb_http_output("UTF-8");
ob_start("mb_output_handler");
?>
]]>
</programlisting>
</example>
</para>
<note>
<para>
If you want to output some binary data such as image from PHP
script with PHP 4.3.0 or later, Content-Type: header must be send
using <function>header</function> before any binary data was send
to client (e.g. header("Content-Type: image/png")).
If Content-Type: header was send, output character encoding
conversion will not be performed.
</para>
<para>
Note that if 'Content-Type: text/*' was send using
<function>header</function>, the sending data is regarded as text,
encoding conversion will be performed using character encoding
settings.
</para>
<para>
If you want to output some binary data such as image from PHP
script with PHP 4.2.x or earlier, you must set output encoding to
&quot;pass&quot; using <function>mb_http_output</function>.
</para>
</note>
<para>
See also <function>ob_start</function>.
</para>
</refsect1>
</refentry>
</programlisting>
</example>
</para>
<note>
<para>
If you want to output some binary data such as image from PHP
script with PHP 4.3.0 or later, Content-Type: header must be send
using <function>header</function> before any binary data was send
to client (e.g. header("Content-Type: image/png")).
If Content-Type: header was send, output character encoding
conversion will not be performed.
</para>
<para>
Note that if 'Content-Type: text/*' was send using
<function>header</function>, the sending data is regarded as text,
encoding conversion will be performed using character encoding
settings.
</para>
<para>
If you want to output some binary data such as image from PHP
script with PHP 4.2.x or earlier, you must set output encoding to
&quot;pass&quot; using <function>mb_http_output</function>.
</para>
</note>
<para>
See also <function>ob_start</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

78
reference/mbstring/functions/mb-parse-str.xml
View file

@ -1,44 +1,42 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.3 -->
<refentry xml:id="function.mb-parse-str" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_parse_str</refname>
<refpurpose>
Parse GET/POST/COOKIE data and set global variable
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>mb_parse_str</methodname>
<methodparam><type>string</type><parameter>encoded_string</parameter></methodparam>
<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
sets global variables. Since PHP does not provide raw POST/COOKIE
data, it can only used for GET data for now. It preses URL
encoded data, detects encoding, converts coding to internal
encoding and set values to <parameter>result</parameter> array or
global variables.
</para>
<para>
<parameter>encoded_string</parameter>: URL encoded data.
</para>
<para>
<parameter>result</parameter>: Array contains decoded and
character encoding converted values.
</para>
<para>
Return Value: It returns &true; for success or &false; for failure.
</para>
<para>
See also <function>mb_detect_order</function>,
<function>mb_internal_encoding</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.mb-parse-str" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_parse_str</refname>
<refpurpose>Parse GET/POST/COOKIE data and set global variable</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mb_parse_str</methodname>
<methodparam><type>string</type><parameter>encoded_string</parameter></methodparam>
<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
sets global variables. Since PHP does not provide raw POST/COOKIE
data, it can only used for GET data for now. It preses URL
encoded data, detects encoding, converts coding to internal
encoding and set values to <parameter>result</parameter> array or
global variables.
</para>
<para>
<parameter>encoded_string</parameter>: URL encoded data.
</para>
<para>
<parameter>result</parameter>: Array contains decoded and
character encoding converted values.
</para>
<para>
Return Value: It returns &true; for success or &false; for failure.
</para>
<para>
See also <function>mb_detect_order</function>,
<function>mb_internal_encoding</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

56
reference/mbstring/functions/mb-preferred-mime-name.xml
View file

@ -1,27 +1,27 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.1 -->
<refentry xml:id="function.mb-preferred-mime-name" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_preferred_mime_name</refname>
<refpurpose>Get MIME charset string</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>mb_preferred_mime_name</methodname>
<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.
</para>
<para>
<example>
<title><function>mb_preferred_mime_string</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.mb-preferred-mime-name" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_preferred_mime_name</refname>
<refpurpose>Get MIME charset string</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_preferred_mime_name</methodname>
<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.
</para>
<para>
<example>
<title><function>mb_preferred_mime_string</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$outputenc = "sjis-win";
@ -30,11 +30,11 @@ ob_start("mb_output_handler");
header("Content-Type: text/html; charset=" . mb_preferred_mime_name($outputenc));
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

58
reference/mbstring/functions/mb-regex-encoding.xml
View file

@ -1,34 +1,32 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.23 -->
<refentry xml:id="function.mb-regex-encoding" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_regex_encoding</refname>
<refpurpose>
Returns current encoding for multibyte regex as string
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<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.
</para>
<para>
See also: <function>mb_internal_encoding</function>,
<function>mb_ereg</function>
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.mb-regex-encoding" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_regex_encoding</refname>
<refpurpose>Returns current encoding for multibyte regex as string</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<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.
</para>
<para>
See also: <function>mb_internal_encoding</function>,
<function>mb_ereg</function>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

64
reference/mbstring/functions/mb-regex-set-options.xml
View file

@ -1,37 +1,35 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.23 -->
<refentry xml:id="function.mb-regex-set-options" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_regex_set_options</refname>
<refpurpose>
Set/Get the default options for mbregex functions
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>mb_regex_set_options</methodname>
<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.
</simpara>
<para>
Returns the previous options. If <parameter>options</parameter> is
omitted, it returns the string that describes the current options.
</para>
<para>
See also
<function>mb_split</function>,
<function>mb_ereg</function> and
<function>mb_eregi</function>
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.mb-regex-set-options" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_regex_set_options</refname>
<refpurpose>Set/Get the default options for mbregex functions</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_regex_set_options</methodname>
<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.
</simpara>
<para>
Returns the previous options. If <parameter>options</parameter> is
omitted, it returns the string that describes the current options.
</para>
<para>
See also
<function>mb_split</function>,
<function>mb_ereg</function> and
<function>mb_eregi</function>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

132
reference/mbstring/functions/mb-send-mail.xml
View file

@ -1,71 +1,69 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.19 -->
<refentry xml:id="function.mb-send-mail" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_send_mail</refname>
<refpurpose>
Send encoded mail
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>mb_send_mail</methodname>
<methodparam><type>string</type><parameter>to</parameter></methodparam>
<methodparam><type>string</type><parameter>subject</parameter></methodparam>
<methodparam><type>string</type><parameter>message</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>additional_headers</parameter></methodparam>
<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.
</para>
<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>
<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>
<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>
<para>
&return.success;
</para>
<para>
See also <function>mail</function>,
<function>mb_encode_mimeheader</function>, and
<function>mb_language</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.mb-send-mail" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_send_mail</refname>
<refpurpose>Send encoded mail</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mb_send_mail</methodname>
<methodparam><type>string</type><parameter>to</parameter></methodparam>
<methodparam><type>string</type><parameter>subject</parameter></methodparam>
<methodparam><type>string</type><parameter>message</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>additional_headers</parameter></methodparam>
<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.
</para>
<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>
<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>
<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>
<para>
&return.success;
</para>
<para>
See also <function>mail</function>,
<function>mb_encode_mimeheader</function>, and
<function>mb_language</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

78
reference/mbstring/functions/mb-split.xml
View file

@ -1,43 +1,43 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.23 -->
<refentry xml:id="function.mb-split" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_split</refname>
<refpurpose>Split multibyte string using regular expression</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<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>
</methodsynopsis>
<simpara>
<function>mb_split</function> split 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.
</simpara>
<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>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.mb-split" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_split</refname>
<refpurpose>Split multibyte string using regular expression</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<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>
</methodsynopsis>
<simpara>
<function>mb_split</function> split 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.
</simpara>
<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>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

90
reference/mbstring/functions/mb-strcut.xml
View file

@ -1,49 +1,49 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.1 -->
<refentry xml:id="function.mb-strcut" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_strcut</refname>
<refpurpose>Get part of string</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>mb_strcut</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam><type>int</type><parameter>start</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
<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
second byte or larger, it starts from first byte of multi-byte
character.
</para>
<para>
It subtracts string from <parameter>str</parameter> that is
shorter than <parameter>length</parameter> AND character that is
not part of multi-byte string or not being middle of shift
sequence.
</para>
<para>
<parameter>encoding</parameter> is character encoding. If it is
not set, internal character encoding is used.
</para>
<para>
See also <function>mb_substr</function>,
<function>mb_internal_encoding</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.4 $ -->
<refentry xml:id="function.mb-strcut" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_strcut</refname>
<refpurpose>Get part of string</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_strcut</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam><type>int</type><parameter>start</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
<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
second byte or larger, it starts from first byte of multi-byte
character.
</para>
<para>
It subtracts string from <parameter>str</parameter> that is
shorter than <parameter>length</parameter> AND character that is
not part of multi-byte string or not being middle of shift
sequence.
</para>
<para>
<parameter>encoding</parameter> is character encoding. If it is
not set, internal character encoding is used.
</para>
<para>
See also <function>mb_substr</function>,
<function>mb_internal_encoding</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

102
reference/mbstring/functions/mb-strimwidth.xml
View file

@ -1,60 +1,60 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.1 -->
<refentry xml:id="function.mb-strimwidth" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_strimwidth</refname>
<refpurpose>Get truncated string with specified width</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>mb_strimwidth</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam><type>int</type><parameter>start</parameter></methodparam>
<methodparam><type>int</type><parameter>width</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>trimmarker</parameter></methodparam>
<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)
</para>
<para>
<parameter>trimmarker</parameter> is string that is added to the
end of string when string is truncated.
</para>
<para>
<parameter>encoding</parameter> is character encoding. If it is
omitted, internal encoding is used.
</para>
<para>
<example>
<title><function>mb_strimwidth</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.mb-strimwidth" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_strimwidth</refname>
<refpurpose>Get truncated string with specified width</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_strimwidth</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam><type>int</type><parameter>start</parameter></methodparam>
<methodparam><type>int</type><parameter>width</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>trimmarker</parameter></methodparam>
<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)
</para>
<para>
<parameter>trimmarker</parameter> is string that is added to the
end of string when string is truncated.
</para>
<para>
<parameter>encoding</parameter> is character encoding. If it is
omitted, internal encoding is used.
</para>
<para>
<example>
<title><function>mb_strimwidth</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$str = mb_strimwidth($str, 0, 40, "..>");
?>
]]>
</programlisting>
</example>
</para>
<para>
See also <function>mb_strwidth</function> and
<function>mb_internal_encoding</function>.
</para>
</refsect1>
</refentry>
</programlisting>
</example>
</para>
<para>
See also <function>mb_strwidth</function> and
<function>mb_internal_encoding</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

62
reference/mbstring/functions/mb-strlen.xml
View file

@ -1,35 +1,35 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.1 -->
<refentry xml:id="function.mb-strlen" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_strlen</refname>
<refpurpose>Get string length</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>mb_strlen</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<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.
</para>
<para>
<parameter>encoding</parameter> is character encoding for
<parameter>str</parameter>. If <parameter>encoding</parameter> is
omitted, internal character encoding is used.
</para>
<para>
See also <function>mb_internal_encoding</function>,
<function>strlen</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.mb-strlen" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_strlen</refname>
<refpurpose>Get string length</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>mb_strlen</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<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.
</para>
<para>
<parameter>encoding</parameter> is character encoding for
<parameter>str</parameter>. If <parameter>encoding</parameter> is
omitted, internal character encoding is used.
</para>
<para>
See also <function>mb_internal_encoding</function>,
<function>strlen</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

102
reference/mbstring/functions/mb-strpos.xml
View file

@ -1,55 +1,55 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.1 -->
<refentry xml:id="function.mb-strpos" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_strpos</refname>
<refpurpose>
Find position of first occurrence of string in a string
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>mb_strpos</methodname>
<methodparam><type>string</type><parameter>haystack</parameter></methodparam>
<methodparam><type>string</type><parameter>needle</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>offset</parameter></methodparam>
<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;.
</para>
<para>
<function>mb_strpos</function> performs 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.
</para>
<para>
<parameter>offset</parameter> is search offset. If it is not
specified, 0 is used.
</para>
<para>
<parameter>encoding</parameter> is character encoding name. If it
is omitted, internal character encoding is used.
</para>
<para>
See also <function>mb_strrpos</function>,
<function>mb_internal_encoding</function>,
<function>strpos</function>
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.mb-strpos" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_strpos</refname>
<refpurpose>
Find position of first occurrence of string in a string
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>mb_strpos</methodname>
<methodparam><type>string</type><parameter>haystack</parameter></methodparam>
<methodparam><type>string</type><parameter>needle</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>offset</parameter></methodparam>
<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;.
</para>
<para>
<function>mb_strpos</function> performs 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.
</para>
<para>
<parameter>offset</parameter> is search offset. If it is not
specified, 0 is used.
</para>
<para>
<parameter>encoding</parameter> is character encoding name. If it
is omitted, internal character encoding is used.
</para>
<para>
See also <function>mb_strrpos</function>,
<function>mb_internal_encoding</function>,
<function>strpos</function>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

93
reference/mbstring/functions/mb-strtolower.xml
View file

@ -1,40 +1,41 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<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>
<refpurpose>Make a string lowercase</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>mb_strtolower</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
<para>
<function>mb_strtolower</function> returns <parameter>str</parameter>
with all alphabetic characters converted to lowercase.
</para>
<para>
<parameter>encoding</parameter> specifies the encoding of
<parameter>str</parameter>; if omitted, the internal character encoding
value will be used.
</para>
<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>strtolower</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 (&Auml;).
</para>
<para>
<example>
<title><function>mb_strtolower</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.7 $ -->
<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>
<refpurpose>Make a string lowercase</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_strtolower</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
<para>
<function>mb_strtolower</function> returns <parameter>str</parameter>
with all alphabetic characters converted to lowercase.
</para>
<para>
<parameter>encoding</parameter> specifies the encoding of
<parameter>str</parameter>; if omitted, the internal character encoding
value will be used.
</para>
<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>strtolower</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 (&Auml;).
</para>
<para>
<example>
<title><function>mb_strtolower</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$str = "Mary Had A Little Lamb and She LOVED It So";
@ -42,16 +43,16 @@ $str = mb_strtolower($str);
echo $str; // Prints mary had a little lamb and she loved it so
?>
]]>
</programlisting>
</example>
</para>
<para>
See also <function>strtolower</function>,
<function>mb_strtoupper</function> and
<function>mb_convert_case</function>.
</para>
</refsect1>
</refentry>
</programlisting>
</example>
</para>
<para>
See also <function>strtolower</function>,
<function>mb_strtoupper</function> and
<function>mb_convert_case</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

93
reference/mbstring/functions/mb-strtoupper.xml
View file

@ -1,40 +1,41 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<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>
<refpurpose>Make a string uppercase</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>mb_strtoupper</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
<para>
<function>mb_strtoupper</function> returns <parameter>str</parameter>
with all alphabetic characters converted to uppercase.
</para>
<para>
<parameter>encoding</parameter> specifies the encoding of
<parameter>str</parameter>; if omitted, the internal character encoding
value will be used.
</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 (&auml;).
</para>
<para>
For more information about the Unicode properties, please see <link
xlink:href="&url.unicode.reports;">&url.unicode.reports;</link>.
</para>
<para>
<example>
<title><function>mb_strtoupper</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.7 $ -->
<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>
<refpurpose>Make a string uppercase</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_strtoupper</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
<para>
<function>mb_strtoupper</function> returns <parameter>str</parameter>
with all alphabetic characters converted to uppercase.
</para>
<para>
<parameter>encoding</parameter> specifies the encoding of
<parameter>str</parameter>; if omitted, the internal character encoding
value will be used.
</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 (&auml;).
</para>
<para>
For more information about the Unicode properties, please see <link
xlink:href="&url.unicode.reports;">&url.unicode.reports;</link>.
</para>
<para>
<example>
<title><function>mb_strtoupper</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$str = "Mary Had A Little Lamb and She LOVED It So";
@ -42,16 +43,16 @@ $str = mb_strtoupper($str);
echo $str; // Prints MARY HAD A LITTLE LAMB AND SHE LOVED IT SO
?>
]]>
</programlisting>
</example>
</para>
<para>
See also <function>strtoupper</function>,
<function>mb_strtolower</function> and
<function>mb_convert_case</function>.
</para>
</refsect1>
</refentry>
</programlisting>
</example>
</para>
<para>
See also <function>strtoupper</function>,
<function>mb_strtolower</function> and
<function>mb_convert_case</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

134
reference/mbstring/functions/mb-strwidth.xml
View file

@ -1,71 +1,71 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.1 -->
<refentry xml:id="function.mb-strwidth" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_strwidth</refname>
<refpurpose>Return width of string</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>mb_strwidth</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
<para>
<function>mb_strwidth</function> returns width of string
<parameter>str</parameter>.
</para>
<para>
Multi-byte character usually twice of width compare to single
byte character.
</para>
<para>
<table>
<title>Characters width</title>
<tgroup cols="2">
<thead>
<row>
<entry>Chars</entry>
<entry>Width</entry>
</row>
</thead>
<tbody>
<row>
<entry>U+0000 - U+0019</entry>
<entry>0</entry>
</row>
<row>
<entry>U+0020 - U+1FFF</entry>
<entry>1</entry>
</row>
<row>
<entry>U+2000 - U+FF60</entry>
<entry>2</entry>
</row>
<row>
<entry>U+FF61 - U+FF9F</entry>
<entry>1</entry>
</row>
<row>
<entry>U+FFA0 - </entry>
<entry>2</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
<parameter>encoding</parameter> is character encoding. If it is
omitted, internal encoding is used.
</para>
<para>
See also: <function>mb_strimwidth</function>,
<function>mb_internal_encoding</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.mb-strwidth" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_strwidth</refname>
<refpurpose>Return width of string</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>mb_strwidth</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
<para>
<function>mb_strwidth</function> returns width of string
<parameter>str</parameter>.
</para>
<para>
Multi-byte character usually twice of width compare to single
byte character.
</para>
<para>
<table>
<title>Characters width</title>
<tgroup cols="2">
<thead>
<row>
<entry>Chars</entry>
<entry>Width</entry>
</row>
</thead>
<tbody>
<row>
<entry>U+0000 - U+0019</entry>
<entry>0</entry>
</row>
<row>
<entry>U+0020 - U+1FFF</entry>
<entry>1</entry>
</row>
<row>
<entry>U+2000 - U+FF60</entry>
<entry>2</entry>
</row>
<row>
<entry>U+FF61 - U+FF9F</entry>
<entry>1</entry>
</row>
<row>
<entry>U+FFA0 - </entry>
<entry>2</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
<parameter>encoding</parameter> is character encoding. If it is
omitted, internal encoding is used.
</para>
<para>
See also: <function>mb_strimwidth</function>,
<function>mb_internal_encoding</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

118
reference/mbstring/functions/mb-substitute-character.xml
View file

@ -1,58 +1,58 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.1 -->
<refentry xml:id="function.mb-substitute-character" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_substitute_character</refname>
<refpurpose>Set/Get substitution character</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>mb_substitute_character</methodname>
<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).
</para>
<para>
This setting affects <function>mb_convert_encoding</function>,
<function>mb_convert_variables</function>,
<function>mb_output_handler</function>,
and <function>mb_send_mail</function>.
</para>
<para>
<parameter>substchar</parameter> : Specify Unicode value as
integer or specify as string as follows
<itemizedlist>
<listitem>
<simpara>
&quot;none&quot; : no output
</simpara>
</listitem>
<listitem>
<simpara>
&quot;long&quot; : Output character code value (Example:
U+3000,JIS+7E7E)
</simpara>
</listitem>
</itemizedlist>
</para>
<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
&quot;<literal>none</literal>&quot;/&quot;<literal>long</literal>&quot;.
</para>
<para>
<example>
<title><function>mb_substitute_character</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.mb-substitute-character" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_substitute_character</refname>
<refpurpose>Set/Get substitution character</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>mb_substitute_character</methodname>
<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).
</para>
<para>
This setting affects <function>mb_convert_encoding</function>,
<function>mb_convert_variables</function>,
<function>mb_output_handler</function>,
and <function>mb_send_mail</function>.
</para>
<para>
<parameter>substchar</parameter> : Specify Unicode value as
integer or specify as string as follows
<itemizedlist>
<listitem>
<simpara>
&quot;none&quot; : no output
</simpara>
</listitem>
<listitem>
<simpara>
&quot;long&quot; : Output character code value (Example:
U+3000,JIS+7E7E)
</simpara>
</listitem>
</itemizedlist>
</para>
<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
&quot;<literal>none</literal>&quot;/&quot;<literal>long</literal>&quot;.
</para>
<para>
<example>
<title><function>mb_substitute_character</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* Set with Unicode U+3013 (GETA MARK) */
@ -65,11 +65,11 @@ mb_substitute_character("long");
echo mb_substitute_character();
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

75
reference/mbstring/functions/mb-substr-count.xml
View file

@ -1,46 +1,47 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<refentry xml:id="function.mb-substr-count" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_substr_count</refname>
<refpurpose>Count the number of substring occurrences</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>mb_substr_count</methodname>
<methodparam><type>string</type><parameter>haystack</parameter></methodparam>
<methodparam><type>string</type><parameter>needle</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
<para>
<function>mb_substr_count</function> returns the number of times the
<parameter>needle</parameter> substring occurs in the
<parameter>haystack</parameter> string.
</para>
<para>
<parameter>encoding</parameter> specifies the encoding for
<parameter>needle</parameter> and <parameter>haystack</parameter>.
If omitted, internal character encoding is used.
</para>
<para>
<example>
<title><function>mb_substr_count</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.4 $ -->
<refentry xml:id="function.mb-substr-count" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_substr_count</refname>
<refpurpose>Count the number of substring occurrences</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>mb_substr_count</methodname>
<methodparam><type>string</type><parameter>haystack</parameter></methodparam>
<methodparam><type>string</type><parameter>needle</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
<para>
<function>mb_substr_count</function> returns the number of times the
<parameter>needle</parameter> substring occurs in the
<parameter>haystack</parameter> string.
</para>
<para>
<parameter>encoding</parameter> specifies the encoding for
<parameter>needle</parameter> and <parameter>haystack</parameter>.
If omitted, internal character encoding is used.
</para>
<para>
<example>
<title><function>mb_substr_count</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
echo mb_substr_count("This is a test", "is"); // prints out 2
?>
]]>
</programlisting>
</example>
</para>
<simpara>
See also <function>substr_count</function>,
<function>mb_strpos</function>, <function>mb_substr</function>.
</simpara>
</refsect1>
</refentry>
</programlisting>
</example>
</para>
<simpara>
See also <function>substr_count</function>,
<function>mb_strpos</function>, <function>mb_substr</function>.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

88
reference/mbstring/functions/mb-substr.xml
View file

@ -1,48 +1,48 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.1 -->
<refentry xml:id="function.mb-substr" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_substr</refname>
<refpurpose>Get part of string</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>mb_substr</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam><type>int</type><parameter>start</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
<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
<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>
<para>
If <parameter>encoding</parameter> is omitted, internal encoding
is assumed.
</para>
<para>
<parameter>encoding</parameter> is character encoding. If it is
omitted, internal character encoding is used.
</para>
<para>
See also <function>mb_strcut</function>,
<function>mb_internal_encoding</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.4 $ -->
<refentry xml:id="function.mb-substr" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_substr</refname>
<refpurpose>Get part of string</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_substr</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam><type>int</type><parameter>start</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
<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
<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>
<para>
If <parameter>encoding</parameter> is omitted, internal encoding
is assumed.
</para>
<para>
<parameter>encoding</parameter> is character encoding. If it is
omitted, internal character encoding is used.
</para>
<para>
See also <function>mb_strcut</function>,
<function>mb_internal_encoding</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables: