mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-25 13:28:56 +00:00
10b70d7572
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
141 lines
3.7 KiB
XML
141 lines
3.7 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.6 $ -->
|
|
<refentry xml:id="function.unicode-encode" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>unicode_encode</refname>
|
|
<refpurpose>Convert a unicode string in any encoding</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<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>errmode</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Takes a <type>unicode</type> string and converts it to a string in
|
|
the specified <parameter>encoding</parameter>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>input</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The <type>unicode</type> string that is converted.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>encoding</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The new encoding for <parameter>input</parameter>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>errmode</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
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>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
A <type>string</type> on success, or &false; on failure.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="errors">
|
|
&reftitle.errors;
|
|
<para>
|
|
Emits a <constant>E_WARNING</constant> level error if a converter cannot
|
|
be created for the desired <parameter>encoding</parameter>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>A <function>unicode_encode</function> example</title>
|
|
<para>
|
|
Note: The characters will be seen instead of entities in the output.
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
header ('Content-Type: text/plain; charset=ISO-8859-2');
|
|
|
|
$encoded = unicode_encode ('\u0150\u0179', 'ISO-8859-2');
|
|
|
|
echo 'Unicode semantics: ', ini_get ('unicode_semantics'), PHP_EOL;
|
|
echo 'The string itself:', $encoded, PHP_EOL;
|
|
echo 'The length of the string: ', strlen ($encoded);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
Unicode semantics: 1
|
|
The string itself: ŐŹ
|
|
The length of the string: 2
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
&warn.experimental.func;
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&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>
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"../../../../manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|