php-doc-en/reference/strings/functions/get-html-translation-table.xml
Jakub Vrana c78ed10a19 Returns only one form (bug )
Remove duplicate example, add see also


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@190239 c90b9560-bf6c-de11-be94-00142212c4b1
2005-07-08 08:57:39 +00:00

91 lines
3.1 KiB
XML
Raw Blame History

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- 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>
<note>
<para>
Special characters can be encoded in several ways. E.g.
<literal>"</literal> can be encoded as <literal>&amp;quot;</literal>,
<literal>&amp;#34;</literal> or <literal>&amp;#x22</literal>.
<function>get_html_translation_table</function> returns only the most
common form for them.
</para>
</note>
<para>
<example>
<title>Translation Table Example</title>
<programlisting role="php">
<![CDATA[
<?php
$trans = get_html_translation_table(HTML_ENTITIES);
$str = "Hallo & <Frau> & Kr<4B>mer";
$encoded = strtr($str, $trans);
?>
]]>
</programlisting>
</example>
The <literal>$encoded</literal> variable will now contain:
<literal>"Hallo &amp;amp; &amp;lt;Frau&amp;gt; &amp;amp;
Kr&amp;auml;mer".</literal>
</para>
<para>
See also <function>htmlspecialchars</function>,
<function>htmlentities</function>, and
<function>html_entity_decode</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
-->