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.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@241624 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Nick Berard 2007-08-20 04:50:47 +00:00
parent a8c63e8d09
commit 10b70d7572
2 changed files with 17 additions and 9 deletions

View file

@ -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>

View file

@ -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 @@ The length of the string: 2
&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>