get-html-translation-table.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 14af302c9c0e561fa6f9cdd956268758ba9a89c5 Maintainer: seros Status: ready -->
<!-- Reviewed: yes Maintainer: seros -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.get-html-translation-table">
 <refnamediv>
  <refname>get_html_translation_table</refname>
  <refpurpose>Devuelve la tabla de traducción utilizada por <function>htmlspecialchars</function> y <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>flags</parameter><initializer>ENT_COMPAT | ENT_HTML401</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>"UTF-8"</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>get_html_translation_table</function> devolverá la
   tabla de traducción que es utilizada internamente para
   <function>htmlspecialchars</function> y
   <function>htmlentities</function>.
  </para>
  <note>
   <para>
    Los caracteres especiales se pueden codificar de varias maneras. Por ejemplo,
    <literal>"</literal> puede ser codificado como <literal>&amp;quot;</literal>,
    <literal>&amp;#34;</literal> o <literal>&amp;#x22</literal>.
    <function>get_html_translation_table</function> devuelve sólo la forma utilizada
    por <function>htmlspecialchars</function> y
    <function>htmlentities</function>.
   </para>
  </note>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>table</parameter></term>
     <listitem>
      <para>
       Qué tabla devolver. Puede ser <constant>HTML_ENTITIES</constant> o
       <constant>HTML_SPECIALCHARS</constant>).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Una máscara de bits de uno o más de los siguientes indicadores especificando qué comillas
       contendrá la tabla, así como para qué tipo de documento será la tabla. El valor por defecto es
       <literal>ENT_COMPAT | ENT_HTML401</literal>.
       <table>
        <title>Constantes disponibles para <parameter>flags</parameter></title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>Nombre de la constante</entry>
           <entry>Descripción</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry><constant>ENT_COMPAT</constant></entry>
           <entry>La tabla contendrá entidades para comillas dobles, pero no para comillas simples.</entry>
          </row>
          <row>
           <entry><constant>ENT_QUOTES</constant></entry>
           <entry>La tabla contendrá entidades para comillas dobles y simples.</entry>
          </row>
          <row>
           <entry><constant>ENT_NOQUOTES</constant></entry>
           <entry>La tabla no contendrá entidades para comillas simples ni para comillas dobles.</entry>
          </row>
          <row>
           <entry><constant>ENT_HTML401</constant></entry>
           <entry>Tabla para HTML 4.01.</entry>
          </row>
          <row>
           <entry><constant>ENT_XML1</constant></entry>
           <entry>Tabla para XML 1.</entry>
          </row>
          <row>
           <entry><constant>ENT_XHTML</constant></entry>
           <entry>Tabla para XHTML.</entry>
          </row>
          <row>
           <entry><constant>ENT_HTML5</constant></entry>
           <entry>Tabla para HTML 5.</entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>encoding</parameter></term>
     <listitem>
      <para>
       La codificación a usar.
       Si se omite, el valor por defecto para este argumento es ISO-8859-1 en
       versiones de PHP anteriores a 5.4.0, y UTF-8 a partir de PHP 5.4.0 en adelante.
      </para>
      &reference.strings.charsets;
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve la tabla de traducción como un array, con los caracteres originales
   como claves y las entidades como valores.
  </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.4.0</entry>
       <entry>
        El valor por defecto para el parámetro <parameter>encoding</parameter> se
        cambió a UTF-8.
       </entry>
      </row>
      <row>
       <entry>5.4.0</entry>
       <entry>
        Se añadieron las constantes <constant>ENT_HTML401</constant>, <constant>ENT_XML1</constant>,
        <constant>ENT_XHTML</constant> y <constant>ENT_HTML5</constant>.
       </entry>
      </row>
      <row>
       <entry>5.3.4</entry>
       <entry>
        Se añadió el parámetro <parameter>encoding</parameter>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo de tabla de traducción</title>
    <programlisting role="php">
<![CDATA[
<?php
var_dump(get_html_translation_table(HTML_ENTITIES, ENT_QUOTES | ENT_HTML5));
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
array(1510) {
  ["
"]=>
  string(9) "&NewLine;"
  ["!"]=>
  string(6) "&excl;"
  ["""]=>
  string(6) "&quot;"
  ["#"]=>
  string(5) "&num;"
  ["$"]=>
  string(8) "&dollar;"
  ["%"]=>
  string(8) "&percnt;"
  ["&"]=>
  string(5) "&amp;"
  ["'"]=>
  string(6) "&apos;"
  // ...
}
]]>
    </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
-->