mirror of
https://github.com/php/doc-es.git
synced 2026-03-26 16:32:13 +01:00
git-svn-id: https://svn.php.net/repository/phpdoc/es/trunk@334674 c90b9560-bf6c-de11-be94-00142212c4b1
282 lines
8.7 KiB
XML
282 lines
8.7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- EN-Revision: d45a16b5f91dfa1702a2d185fa1b627cac5b1341 Maintainer: seros Status: ready -->
|
|
<!-- Reviewed: yes Maintainer: seros -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.htmlentities" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>htmlentities</refname>
|
|
<refpurpose>Convierte todos los caracteres aplicables a 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_COMPAT | ENT_HTML401</initializer></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>ini_get("default_charset")</initializer></methodparam>
|
|
<methodparam choice="opt"><type>bool</type><parameter>double_encode</parameter><initializer>true</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Esta función es idéntica a <function>htmlspecialchars</function> en todos
|
|
los aspectos, excepto que con <function>htmlentities</function>, todos los caracteres
|
|
que tienen su equivalente HTML son convertidos a estas entidades.
|
|
</para>
|
|
<para>
|
|
Si en su lugar se desea decodificar (lo inverso), se puede utilizar
|
|
<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 bits de uno o más de los siguientes indicadores, los cuales especifican como manejar las comillas,
|
|
secuencias de unidad de código inválidas y el tipo de documento utilizado. 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>Convertirá las comillas dobles y deja solo 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_IGNORE</constant></entry>
|
|
<entry>
|
|
Descartar silenciosamente unidades de secuencia de código no válidas en lugar de devolver
|
|
un string vacío. El uso de este indicador se desaconseja debido a que
|
|
<link xlink:href="&url.delete.nonchars;">podría tener implicaciones de seguridad</link>.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>ENT_SUBSTITUTE</constant></entry>
|
|
<entry>
|
|
Reemplazar las secuencias de unidad de código inválidas con un Caracter Unicode de Reemplazo
|
|
U+FFFD (UTF-8) o &#FFFD; (no UTF-8) en lugar de devolver un string vacío.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>ENT_DISALLOWED</constant></entry>
|
|
<entry>
|
|
Reemplazar los puntos de código no válidos para el tipo de documento dado con un
|
|
Caracter de Reemplazo Unicode U+FFFD (UTF-8) o &#FFFD;
|
|
(no UTF-8) en lugar de dejarlos tal cual. Esto puede ser útil, por
|
|
ejemplo, para asegurar la formación correcta de documentos XML con
|
|
contenido externo incrustado.
|
|
</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>
|
|
<varlistentry>
|
|
<term><parameter>double_encode</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Cuando se desactiva <parameter>double_encode</parameter>, PHP no codificará
|
|
las entidades html existentes. El valor por defecto es convertir todo.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Devuelve el string codificado.
|
|
</para>
|
|
<para>
|
|
Si el <parameter>string</parameter> de entrada contiene una secuencia de unidad de código
|
|
no válida dentro de <parameter>encoding</parameter>, será devuelto un
|
|
string vacío, a menos que se definan los indicadores <constant>ENT_IGNORE</constant> o
|
|
<constant>ENT_SUBSTITUTE</constant>.
|
|
</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>
|
|
El valor por defecto del 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_SUBSTITUTE</constant>, <constant>ENT_DISALLOWED</constant>,
|
|
<constant>ENT_HTML401</constant>, <constant>ENT_XML1</constant>,
|
|
<constant>ENT_XHTML</constant> y <constant>ENT_HTML5</constant>.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>5.3.0</entry>
|
|
<entry>
|
|
Se añadió la constante <constant>ENT_IGNORE</constant>.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>5.2.3</entry>
|
|
<entry>
|
|
Se añadió el parámetro <parameter>double_encode</parameter>.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Un ejemplo de <function>htmlentities</function></title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$str = "A 'quote' is <b>bold</b>";
|
|
|
|
// Produce: A 'quote' is <b>bold</b>
|
|
echo htmlentities($str);
|
|
|
|
// Produce: A 'quote' is <b>bold</b>
|
|
echo htmlentities($str, ENT_QUOTES);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
|
|
<para>
|
|
<example>
|
|
<title>Uso de <constant>ENT_IGNORE</constant></title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$str = "\x8F!!!";
|
|
|
|
// Produce un string vacío
|
|
echo htmlentities($str, ENT_QUOTES, "UTF-8");
|
|
|
|
// Produce "!!!"
|
|
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
|
|
-->
|