-
Notifications
You must be signed in to change notification settings - Fork 42
/
file-put-contents.xml
215 lines (207 loc) · 6.63 KB
/
file-put-contents.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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: ea62fb83196997032641b50fe44420305466195e Maintainer: tihox Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.file-put-contents">
<refnamediv>
<refname>file_put_contents</refname>
<refpurpose>Schreibt Daten in eine Datei</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>int</type><type>false</type></type><methodname>file_put_contents</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam><type>mixed</type><parameter>data</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>context</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Diese Funktion entspricht <function>fopen</function>,
<function>fwrite</function> und <function>fclose</function>, um Daten in eine Datei zu schreiben.
</para>
<para>
Wenn <parameter>filename</parameter> nicht existiert, wird die Datei erstellt.
Sonst wird die existierende Datei überschrieben, es sei denn
<constant>FILE_APPEND</constant> ist gesetzt.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
Pfad zur Datei in die die Daten geschrieben werden sollen.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
Die zu schreibenden Daten. Kann entweder <type>string</type>, oder
<type>array</type> sowie <type>stream</type> sein.
</para>
<para>
Wenn <parameter>data</parameter> eine <type>stream</type>-Quelle ist, wird
der verbleibende Puffer des Streams in die festgelegte Datei kopiert.
Dies ähnelt der Funktion <function>stream_copy_to_stream</function>.
</para>
<para>
Sie können auch den Parameter <parameter>data</parameter> als eindimensionales Array angeben.
Dies ist äquivalent zu
<literal>file_put_contents($filename, implode('', $array))</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
Der Wert von <parameter>flags</parameter> kann eine Kombination der folgenden Flags sein, verbunden mit dem binären OR(<literal>|</literal>)
-Operator.
</para>
<para>
<table>
<title>verfügbare Flags</title>
<tgroup cols="2">
<thead>
<row>
<entry>Flag</entry>
<entry>Beschreibung</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<constant>FILE_USE_INCLUDE_PATH</constant>
</entry>
<entry>
Sucht nach <parameter>filename</parameter> im enthaltenen Verzeichnis.
Siehe <link linkend="ini.include-path">include_path</link> für mehr Information.
</entry>
</row>
<row>
<entry>
<constant>FILE_APPEND</constant>
</entry>
<entry>
Falls die Datei <parameter>filename</parameter> bereits existiert, füge die Daten
an die Datei an anstatt diese zu überschreiben.
</entry>
</row>
<row>
<entry>
<constant>LOCK_EX</constant>
</entry>
<entry>
Erwirbt exklusive Schreibrechte auf die Datei während mit dem
Schreiben fortgefahren wird. Anders ausgedrückt erfolgt ein
<function>flock</function> Aufruf zwischen dem
<function>fopen</function> Aufruf und dem
<function>fwrite</function> Aufruf. Das ist nicht das gleiche wie
ein <function>fopen</function> Aufruf mit Modus "x".
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
Eine gültige Kontakt-Ressource erstellt mit der Funktion
<function>stream_context_create</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Diese Funktion gibt die Anzahl der geschriebenen Bytes oder
&false; bei einem Fehler zurück.
</para>
&return.falseproblem;
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Einfaches Verwendungsbeispiel</title>
<programlisting role="php">
<![CDATA[
<?php
$file = 'people.txt';
// Öffnet die Datei, um den vorhandenen Inhalt zu laden
$current = file_get_contents($file);
// Fügt eine neue Person zur Datei hinzu
$current .= "John Smith\n";
// Schreibt den Inhalt in die Datei zurück
file_put_contents($file, $current);
?>
]]>
</programlisting>
</example>
<example>
<title>Verwendung der Flags</title>
<programlisting role="php">
<![CDATA[
<?php
$file = 'people.txt';
//Die neue Person, die zur Datei hinzugefügt werden soll
$person = "John Smith\n";
// Schreibt den Inhalt in die Datei
// unter Verwendung des Flags FILE_APPEND, um den Inhalt an das Ende der Datei anzufügen
// und das Flag LOCK_EX, um ein Schreiben in die selbe Datei zur gleichen Zeit zu verhindern
file_put_contents($file, $person, FILE_APPEND | LOCK_EX);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
¬e.bin-safe;
&tip.fopen-wrapper;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fopen</function></member>
<member><function>fwrite</function></member>
<member><function>file_get_contents</function></member>
<member><function>stream_context_create</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
-->