-
Notifications
You must be signed in to change notification settings - Fork 45
/
Copy pathhtmlentities.xml
290 lines (278 loc) · 8.8 KB
/
htmlentities.xml
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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 06394ea77c2f8972e3884c00bede861ef5eb04da Maintainer: sammywg Status: ready -->
<!-- Reviewed: yes -->
<!-- Rev-Revision: e4b52745bc8ef288726f8e76e7fdc6277a2f656f Reviewer: samesch -->
<refentry xml:id="function.htmlentities" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>htmlentities</refname>
<refpurpose>Wandelt alle geeigneten Zeichen in entsprechende HTML-Entities um</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>
Diese Funktion unterscheidet sich nur dadurch von
<function>htmlspecialchars</function>, dass sie wirklich alle Zeichen, die
entsprechende HTML-Entities haben, in diese Entsprechungen umwandelt. Mit
der Funktion <function>get_html_translation_table</function> kann die
Übersetzungstabelle auf Basis der angegebenen
<parameter>flags</parameter>-Konstanten abgefragt werden.
</para>
<para>
Sollen im umgekehrten Fall stattdessen HTML-Entities dekodiert werden, kann
die Funktion <function>html_entity_decode</function> verwendet werden.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>string</parameter></term>
<listitem>
<para>
Die Eingabezeichenkette.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
Eine Bitmaske von einem oder mehreren der folgenden Flags, die die
Behandlung von Anführungszeichen, ungültigen Zeichenketten und den
genutzten Dokumententyp festlegen. Der Standardwert ist
<literal>ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401</literal>.
<table>
<title>Verfügbare <parameter>flags</parameter>-Konstanten</title>
<tgroup cols="2">
<thead>
<row>
<entry>Name der Konstante</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>ENT_COMPAT</constant></entry>
<entry>
Wandelt doppelte Anführungszeichen um und lässt einfache
Anführungszeichen unverändert.
</entry>
</row>
<row>
<entry><constant>ENT_QUOTES</constant></entry>
<entry>
Wandelt sowohl doppelte als auch einfache Anführungszeichen um.
</entry>
</row>
<row>
<entry><constant>ENT_NOQUOTES</constant></entry>
<entry>
Lässt sowohl doppelte als auch einfache Anführungszeichen
unverändert.
</entry>
</row>
<row>
<entry><constant>ENT_IGNORE</constant></entry>
<entry>
Verwirft ungültige Code-Unit-Sequenzen anstatt eine leere
Zeichenkette zurückzugeben. Die Nutzung dieser Option ist nicht
empfehlenswert, da sie
<link xlink:href="&url.delete.nonchars;">Auswirkungen auf die Sicherheit</link>
haben kann.
</entry>
</row>
<row>
<entry><constant>ENT_SUBSTITUTE</constant></entry>
<entry>
Ersetzt ungültige Code-Unit-Sequenzen mit dem
Unicode-Ersatzzeichen U+FFFD (UTF-8) oder &#FFFD;
(andernfalls).
</entry>
</row>
<row>
<entry><constant>ENT_DISALLOWED</constant></entry>
<entry>
Ersetzt Codepoints, welche in dem angegebenen Dokumenttyp ungültig
sind, mit dem Unicode-Ersatzzeichen U+FFFD (UTF-8) oder
&#FFFD; (andernfalls), anstatt sie zu belassen wie sie sind.
Dies kann zum Beispiel nützlich sein, um die Wohlgeformtheit von
XML-Dokumenten mit eingebetteten externen Inhalten
sicherzustellen.
</entry>
</row>
<row>
<entry><constant>ENT_HTML401</constant></entry>
<entry>
Behandle Code als HTML 4.01.
</entry>
</row>
<row>
<entry><constant>ENT_XML1</constant></entry>
<entry>
Behandle Code als XML 1.
</entry>
</row>
<row>
<entry><constant>ENT_XHTML</constant></entry>
<entry>
Behandle Code als XHTML.
</entry>
</row>
<row>
<entry><constant>ENT_HTML5</constant></entry>
<entry>
Behandle Code als 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>
Wenn <parameter>double_encode</parameter> ausgeschaltet ist, verändert
PHP keine bereits vorhandenen HTML-Entities. Standardmäßig wird jedoch
alles umgewandelt.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Gibt die kodierte Zeichenkette zurück.
</para>
<para>
Enthält <parameter>string</parameter> eine in dem übergebenen
<parameter>encoding</parameter> ungültige Code-Unit-Sequenz, wird eine
leere Zeichenkette zurückgegeben, sofern weder das
<constant>ENT_IGNORE</constant>- noch das
<constant>ENT_SUBSITUTE</constant>-Flag gesetzt sind.
</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> geändert von
<constant>ENT_COMPAT</constant> zu <constant>ENT_QUOTES</constant> |
<constant>ENT_SUBSTITUTE</constant> | <constant>ENT_HTML401</constant>.
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>encoding</parameter> ist jetzt nullable (akzeptiert den
&null;-Wert).
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Ein <function>htmlentities</function>-Beispiel</title>
<programlisting role="php">
<![CDATA[
<?php
$str = "Ein 'Anführungszeichen' ist <b>fett</b>";
echo htmlentities($str);
echo "\n\n";
echo htmlentities($str, ENT_COMPAT);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Ein 'Anführungszeichen' ist <b>fett</b>
Ein 'Anführungszeichen' ist <b>fett</b>
]]>
</screen>
</example>
</para>
<para>
<example>
<title>Verwendung von <constant>ENT_IGNORE</constant></title>
<programlisting role="php">
<![CDATA[
<?php
$str = "\x8F!!!";
// Gibt eine leere Zeichenkette aus
echo htmlentities($str, ENT_QUOTES, "UTF-8");
// Gibt "!!!" aus
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
-->