nicobn Mon Aug 20 04:50:47 2007 UTC
Modified files:
/phpdoc/en/reference/unicode/functions unicode-decode.xml
unicode-encode.xml
Log:
After discussing this with Derick, we came to the conclusion that it would
be better to rename the 'flags' parameter to 'errormode'. If flags are
needed in the future, another parameter will be added. The prototypes of
the functions in php-src/ext/unicode/unicode.c have not yet been changed
to reflect this.
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/unicode/functions/unicode-decode.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/unicode/functions/unicode-decode.xml
diff -u phpdoc/en/reference/unicode/functions/unicode-decode.xml:1.2
phpdoc/en/reference/unicode/functions/unicode-decode.xml:1.3
--- phpdoc/en/reference/unicode/functions/unicode-decode.xml:1.2 Sun Aug
19 17:52:21 2007
+++ phpdoc/en/reference/unicode/functions/unicode-decode.xml Mon Aug 20
04:50:47 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry xml:id="function.unicode-decode"
xmlns="http://docbook.org/ns/docbook";>
<refnamediv>
<refname>unicode_decode</refname>
@@ -11,7 +11,7 @@
<type>unicode </type><methodname>unicode_decode</methodname>
<methodparam><type>string</type><parameter>input</parameter></methodparam>
<methodparam><type>string</type><parameter>encoding</parameter></methodparam>
- <methodparam
choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
+ <methodparam
choice="opt"><type>int</type><parameter>errmode</parameter></methodparam>
</methodsynopsis>
<para>
Convert a binary string encoded in <parameter>encoding</parameter> to a
@@ -40,10 +40,13 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>flags</parameter></term>
+ <term><parameter>errmode</parameter></term>
<listitem>
<para>
- Conversion flags.
+ Conversion error mode. This parameter determines the action to take when
+ the converter cannot convert a character. For a list of available modes,
+ refer to <function>unicode_set_error_mode</function>. If the parameter
+ is not set, the global error mode is used.
</para>
</listitem>
</varlistentry>
@@ -75,8 +78,9 @@
&reftitle.seealso;
<para>
<simplelist>
- <member><function>unicode_encode</function></member>
+ <member><function>unicode_set_error_mode</function></member>
<member><function>unicode_semantics</function></member>
+ <member><function>unicode_encode</function></member>
</simplelist>
</para>
</refsect1>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/unicode/functions/unicode-encode.xml?r1=1.5&r2=1.6&diff_format=u
Index: phpdoc/en/reference/unicode/functions/unicode-encode.xml
diff -u phpdoc/en/reference/unicode/functions/unicode-encode.xml:1.5
phpdoc/en/reference/unicode/functions/unicode-encode.xml:1.6
--- phpdoc/en/reference/unicode/functions/unicode-encode.xml:1.5 Sun Aug
19 17:48:33 2007
+++ phpdoc/en/reference/unicode/functions/unicode-encode.xml Mon Aug 20
04:50:47 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.unicode-encode"
xmlns="http://docbook.org/ns/docbook";>
<refnamediv>
<refname>unicode_encode</refname>
@@ -11,7 +11,7 @@
<type>string</type><methodname>unicode_encode</methodname>
<methodparam><type>unicode</type><parameter>input</parameter></methodparam>
<methodparam><type>string</type><parameter>encoding</parameter></methodparam>
- <methodparam><type>int</type><parameter>flags</parameter></methodparam>
+ <methodparam><type>int</type><parameter>errmode</parameter></methodparam>
</methodsynopsis>
<para>
Takes a <type>unicode</type> string and converts it to a string in
@@ -40,10 +40,13 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>flags</parameter></term>
+ <term><parameter>errmode</parameter></term>
<listitem>
<para>
- Conversion flags.
+ Conversion error mode. This parameter determines the action to take when
+ the converter cannot convert a character. For a list of available modes,
+ refer to <function>unicode_set_error_mode</function>. If the parameter
+ is not set, the global error mode is used.
</para>
</listitem>
</varlistentry>
@@ -108,6 +111,7 @@
&reftitle.seealso;
<para>
<simplelist>
+ <member><function>unicode_set_error_mode</function></member>
<member><function>unicode_semantics</function></member>
<member><function>unicode_decode</function></member>
</simplelist>
