php-doc-en/reference/strings/functions/get-html-translation-table.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml: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 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>get_html_translation_table</methodname>
   <methodparam choice="opt"><type>int</type><parameter>table</parameter><initializer>HTML_SPECIALCHARS</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>quote_style</parameter><initializer>ENT_COMPAT</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>charset_hint</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> with the default charset.
  </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>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>table</parameter></term>
     <listitem>
      <para>
       There are two new constants (<constant>HTML_ENTITIES</constant>,
       <constant>HTML_SPECIALCHARS</constant>) that allow you to specify the
       table you want.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>quote_style</parameter></term>
     <listitem>
      <para>
       Like the <function>htmlspecialchars</function> and
       <function>htmlentities</function> functions you can optionally specify
       the <parameter>quote_style</parameter> you are working with.
       See the description
       of these modes in <function>htmlspecialchars</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>charset_hint</parameter></term>
     <listitem>
      <para>
       Like <function>htmlentities</function>, it takes an optional
       third argument <parameter>charset</parameter> which defines character
       set used in conversion.
       Presently, the ISO-8859-1 character set is used as the default.
      </para>
      &reference.strings.charsets;
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the translation table as an array.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>5.3.4</entry>
       <entry>
        The <parameter>charset_hint</parameter> parameter was added.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Translation Table Example</title>
    <programlisting role="php">
<![CDATA[
<?php
$trans = get_html_translation_table(HTML_ENTITIES);
$str = "Hallo & <Frau> & Krämer";
$encoded = strtr($str, $trans);

echo $encoded;
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Hallo &amp; &lt;Frau&gt; &amp; Kr&auml;mer
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>htmlspecialchars</function></member>
    <member><function>htmlentities</function></member>
    <member><function>html_entity_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:"~/.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
-->