mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 23:08:55 +00:00
3ce9368539
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@290704 c90b9560-bf6c-de11-be94-00142212c4b1
130 lines
3.3 KiB
XML
130 lines
3.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="function.idn-to-utf8" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>idn_to_utf8</refname>
|
|
<refpurpose>Convert ASCII encoded domain name to UTF-8</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>idn_to_utf8</methodname>
|
|
<methodparam><type>string</type><parameter>ascii_domain</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter role="reference">errorcode</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
This function converts a ASCII encoded domain name to its original UTF-8 version.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>ascii_domain</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The ASCII encoded domain name. Looks like "xn--..." if the it originally contained non-ASCII characters.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>errorcode</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Will be set to the IDNA error code.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
The UTF-8 encoded version of the domain name &return.falseforfailure;.
|
|
RFC 3490 4.2 states though "ToUnicode never fails. If any step fails, then the original input
|
|
sequence is returned immediately in that step."
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="errors">
|
|
&reftitle.errors;
|
|
<para>
|
|
If an error occurs &false; is returned and the optional errorcode is set.
|
|
In addition a E_WARNING message is printed.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>idn_to_utf8</function> example</title>
|
|
<para>
|
|
First a simple example and then one explaining how to catch errors (which should never happen according to the RFC).
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
// maybe convert the result to ISO-8859-1 using utf8_decode()
|
|
echo idn_to_utf8("xn--tst-qla.de");
|
|
|
|
// Should never happen but to be sure...
|
|
$utf8 = idn_to_utf8("xn--tst-qla.de", $errorcode);
|
|
if ($utf8 === false) {
|
|
printf("Detected error %d: %s\n", $errorcode, idn_strerror($errorcode));
|
|
}
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
täst.de
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>utf8_decode</function></member>
|
|
<member><function>idn_strerror</function></member>
|
|
<member><function>idn_to_ascii</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:"~/.phpdoc/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
|
|
-->
|