htmlentities.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 06394ea77c2f8972e3884c00bede861ef5eb04da Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.htmlentities" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>htmlentities</refname>
  <refpurpose>Convierte todos los caracteres elegibles en entidades HTML</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>htmlentities</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>double_encode</parameter><initializer>&true;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>htmlentities</function> es idéntica a la función
   <function>htmlspecialchars</function>, salvo que todos los caracteres
   que tienen equivalentes en entidades HTML son efectivamente
   traducidos.
   La función <function>get_html_translation_table</function> puede ser utilizada
   para retornar la tabla de traducción utilizada
   en función de las constantes <parameter>flags</parameter> proporcionadas.
  </para>
  <para>
   Si se desea realizar la operación inversa, se debe utilizar
   la función <function>html_entity_decode</function>.
  </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 uno o varios flags siguientes, que determinan la forma
       en que las comillas serán gestionadas, cómo las secuencias de código inválido serán
       gestionadas así como el tipo de documento utilizado. Por omisión, es
       <literal>ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401</literal>.
       <table>
        <title>Constantes disponibles para <parameter>flags</parameter></title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>Constante</entry>
           <entry>Descripción</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry><constant>ENT_COMPAT</constant></entry>
           <entry>Convierte las comillas dobles e ignora las comillas simples.</entry>
          </row>
          <row>
           <entry><constant>ENT_QUOTES</constant></entry>
           <entry>Convierte las comillas dobles y las comillas simples.</entry>
          </row>
          <row>
           <entry><constant>ENT_NOQUOTES</constant></entry>
           <entry>Ignora las comillas dobles y las comillas simples.</entry>
          </row>
          <row>
           <entry><constant>ENT_IGNORE</constant></entry>
           <entry>
            Ignora las secuencias de caracteres inválidas en lugar de retornar un
            string vacío. El uso de este flag es fuertemente
            desaconsejado por
            <link xlink:href="&url.delete.nonchars;">razones de seguridad</link>.
           </entry>
          </row>
          <row>
           <entry><constant>ENT_SUBSTITUTE</constant></entry>
           <entry>
            Reemplaza las secuencias de código inválido con un carácter de reemplazo
            Unicode U+FFFD (UTF-8) o &amp;#FFFD; (de lo contrario) en lugar de retornar un
            string vacío.
           </entry>
          </row>
          <row>
           <entry><constant>ENT_DISALLOWED</constant></entry>
           <entry>
            Reemplaza los puntos de código inválidos del documento proporcionado con
            un carácter de reemplazo Unicode U+FFFD (UTF-8) o &amp;#FFFD;
            (de lo contrario) en lugar de dejarlo tal cual. Esto puede ser útil para,
            por ejemplo, asegurar el correcto formato de documentos XML que contienen
            contenido externo.
           </entry>
          </row>
          <row>
           <entry><constant>ENT_HTML401</constant></entry>
           <entry>
            Gestiona el código como HTML 4.01.
           </entry>
          </row>
          <row>
           <entry><constant>ENT_XML1</constant></entry>
           <entry>
            Gestiona el código como XML 1.
           </entry>
          </row>
          <row>
           <entry><constant>ENT_XHTML</constant></entry>
           <entry>
            Gestiona el código como XHTML.
           </entry>
          </row>
          <row>
           <entry><constant>ENT_HTML5</constant></entry>
           <entry>
            Gestiona 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>
    <varlistentry>
     <term><parameter>double_encode</parameter></term>
     <listitem>
      <para>
       Cuando <parameter>double_encode</parameter> está desactivado, PHP no codificará
       las entidades html existentes. Por omisión, todo es convertido.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retorna el string codificado.
  </para>
  <para>
   Si la entrada <parameter>string</parameter> contiene una secuencia de
   código inválido en el encoding <parameter>encoding</parameter>
   proporcionado, un string vacío será retornado, a menos que el flag
   <constant>ENT_IGNORE</constant> o el flag
   <constant>ENT_SUBSTITUTE</constant> esté definido.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.1.0</entry>
      <entry>
       <parameter>flags</parameter> cambió de <constant>ENT_COMPAT</constant> a
       <constant>ENT_QUOTES</constant> | <constant>ENT_SUBSTITUTE</constant> | <constant>ENT_HTML401</constant>.
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>encoding</parameter> ahora es nullable.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo con <function>htmlentities</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$str = 'Un \'apostrophe\' en <strong>gras</strong>';

echo htmlentities($str);
echo "\n\n";
echo htmlentities($str, ENT_COMPAT);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Un &#039;apostrophee&#039; est &lt;b&gt;gras&lt;/b&gt;

Un 'apostrophe' est &lt;b&gt;gras&lt;/b&gt
]]>
    </screen>
   </example>
  </para>

  <para>
   <example>
    <title>Utilización de <constant>ENT_IGNORE</constant></title>
    <programlisting role="php">
<![CDATA[
<?php
$str = "\x8F!!!";

// Muestra un string vacío
echo htmlentities($str, ENT_QUOTES, "UTF-8");

// Muestra "!!!"
echo htmlentities($str, ENT_QUOTES | ENT_IGNORE, "UTF-8");
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>html_entity_decode</function></member>
    <member><function>get_html_translation_table</function></member>
    <member><function>htmlspecialchars</function></member>
    <member><function>nl2br</function></member>
    <member><function>urlencode</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
-->