1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/strings.xml, last change in rev 1.2 -->
<refentry id="function.get-html-translation-table">
<refnamediv>
<refname>get_html_translation_table</refname>
<refpurpose>
Returns the translation table used by
<function>htmlspecialchars</function> and
<function>htmlentities</function>
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>get_html_translation_table</methodname>
<methodparam choice="opt"><type>int</type><parameter>table</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>quote_style</parameter></methodparam>
</methodsynopsis>
<para>
<function>get_html_translation_table</function> will return the
translation table that is used internally for
<function>htmlspecialchars</function> and
<function>htmlentities</function>.
</para>
<para>
There are two new constants
(<constant>HTML_ENTITIES</constant>,
<constant>HTML_SPECIALCHARS</constant>) that allow you to
specify the table you want. Default value for <parameter>table</parameter>
is <constant>HTML_SPECIALCHARS</constant>. And as in the
<function>htmlspecialchars</function> and
<function>htmlentities</function> functions you can optionally
specify the <parameter>quote_style</parameter> you are working with. The default is
<constant>ENT_COMPAT</constant> mode. See the description of these modes in
<function>htmlspecialchars</function>.
</para>
<para>
<example>
<title>Translation Table Example</title>
<programlisting role="php">
<![CDATA[
<?php
$trans = get_html_translation_table(HTML_ENTITIES);
$str = "Hallo & <Frau> & Krmer";
$encoded = strtr($str, $trans);
?>
]]>
</programlisting>
</example>
The <literal>$encoded</literal> variable will now contain:
<literal>"Hallo &amp; &lt;Frau&gt; &amp;
Kr&auml;mer".</literal>
</para>
<para>
Another interesting use of this function is to, with help of <function>array_flip</function>,
change the direction of the translation.
<informalexample>
<programlisting role="php">
<![CDATA[
<?php
$trans = array_flip($trans);
$original = strtr($encoded, $trans);
?>
]]>
</programlisting>
</informalexample>
The content of <literal>$original</literal> would be: "Hallo &
<Frau> & Krämer".
</para>
<para>
See also <function>htmlspecialchars</function>,
<function>htmlentities</function>,
<function>strtr</function>, and
<function>array_flip</function>.
</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
-->
|