-
Notifications
You must be signed in to change notification settings - Fork 59
Expand file tree
/
Copy pathhtmlentities.xml
More file actions
275 lines (264 loc) · 8.49 KB
/
htmlentities.xml
File metadata and controls
275 lines (264 loc) · 8.49 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
<?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 &#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 &#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 'apostrophee' est <b>gras</b>
Un 'apostrophe' est <b>gras</b>
]]>
</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
-->