html-entity-decode.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: d45a16b5f91dfa1702a2d185fa1b627cac5b1341 Maintainer: seros Status: ready -->
<!-- Reviewed: yes Maintainer: seros -->
<refentry xml:id="function.html-entity-decode" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>html_entity_decode</refname>
  <refpurpose>Convierte todas las entidades HTML a sus caracteres correspondientes</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>html_entity_decode</methodname>
   <methodparam><type>string</type><parameter>string</parameter></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>ini_get("default_charset")</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>html_entity_decode</function> es el opuesto de
   <function>htmlentities</function> en el sentido de que convierte todas las entidades HTML
   del <parameter>string</parameter> a sus caracteres correspondientes.
  </para>
  <para>
   Para ser más precisos, esta función decodifica todas las entidades (incluyendo todas las entidades
   numéricas) que a) sean necesariamente válidas para el tipo de documento elegido — es decir,
   para XML, esta función no decodifica las entidades con nombres que podrían estar definidas
   en algunos DTD — y b) aquellos caracteres que están en el conjunto de caracteres codificado
   asociado con la codificación elegida y que están permitidos en el tipo de
   documento elegido. Todas las demás entidades se dejan tal cual.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       El string de entrada.
      </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, los cuales especifican cómo manejar las comillas
       y el tipo de documento utilizado. El valor predeterminado es <literal>ENT_COMPAT | ENT_HTML401</literal>.
       <table>
        <title>Constantes disponibles para <parameter>flags</parameter></title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>Nombre de constante</entry>
           <entry>Descripción</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry><constant>ENT_COMPAT</constant></entry>
           <entry>Convertirá las comillas dobles y sólo dejará las comillas simples.</entry>
          </row>
          <row>
           <entry><constant>ENT_QUOTES</constant></entry>
           <entry>Convertirá tanto las comillas dobles como las simples.</entry>
          </row>
          <row>
           <entry><constant>ENT_NOQUOTES</constant></entry>
           <entry>Dejará tanto las comillas dobles como las simples sin convertir.</entry>
          </row>
          <row>
           <entry><constant>ENT_HTML401</constant></entry>
           <entry>
            Manejar el código como HTML 4.01.
           </entry>
          </row>
          <row>
           <entry><constant>ENT_XML1</constant></entry>
           <entry>
            Manejar el código como XML 1.
           </entry>
          </row>
          <row>
           <entry><constant>ENT_XHTML</constant></entry>
           <entry>
            Manejar el código como XHTML.
           </entry>
          </row>
          <row>
           <entry><constant>ENT_HTML5</constant></entry>
           <entry>
            Manejar el código como HTML 5.
           </entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>encoding</parameter></term>
     <listitem>
      &strings.parameter.encoding;
      &reference.strings.charsets;
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve el string descodificado.
  </para>
 </refsect1>
 
 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      &strings.changelog.encoding;
      <row>
       <entry>5.4.0</entry>
       <entry>
        La codificación predeterminada se cambió de ISO-8859-1 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>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Decodificación de entidades HTML</title>
    <programlisting role="php">
<![CDATA[
<?php
$orig = "I'll \"walk\" the <b>dog</b> now";

$a = htmlentities($orig);

$b = html_entity_decode($a);

echo $a; // I'll &quot;walk&quot; the &lt;b&gt;dog&lt;/b&gt; now

echo $b; // I'll "walk" the <b>dog</b> now
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 
 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Puede que se pregunte por qué trim(html_entity_decode('&amp;nbsp;')); no
    reduce el string a un string vacío. Esto es porque la entidad
    '&amp;nbsp;' no es el código ASCII 32 (el cual es eliminado por
    <function>trim</function>), sino el código ASCII 160 (0xa0) en la 
    codificación ISO 8859-1.
   </para>
  </note>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>htmlentities</function></member>
    <member><function>htmlspecialchars</function></member>
    <member><function>get_html_translation_table</function></member>
    <member><function>urldecode</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
-->