file_get_contents
As to the previous user note, it would be wise to include that code within a conditional statement, as to prevent re-defining file_put_contents and the FILE_APPEND constant in PHP 5:
<?php
if ( !function_exists('file_put_contents') && !defined('FILE_APPEND') ) {
...
}
?>
Also, if the file could not be accessed for writing, the function should return boolean false, not 0. An error is different from 0 bytes written, in this case.
file_put_contents
(PHP 5)
file_put_contents — Write a string to a file
Beschreibung
This function is identical to calling fopen(), fwrite() and fclose() successively to write data to a file.
If filename does not exist, the file is created.
Otherwise, the existing file is overwritten, unless the
FILE_APPEND flag is set.
Parameter-Liste
-
filename -
Path to the file where to write the data.
-
data -
The data to write. Can be either a string, an array or a stream resource.
If
datais a stream resource, the remaining buffer of that stream will be copied to the specified file. This is similar with using stream_copy_to_stream().You can also specify the
dataparameter as a single dimension array. This is equivalent to file_put_contents($filename, implode('', $array)). -
flags -
The value of
flagscan be any combination of the following flags, joined with the binary OR (|) operator.Available flags Flag Description FILE_USE_INCLUDE_PATHSearch for filenamein the include directory. See include_path for more information.FILE_APPENDIf file filenamealready exists, append the data to the file instead of overwriting it.LOCK_EXAcquire an exclusive lock on the file while proceeding to the writing. -
context -
A valid context resource created with stream_context_create().
Rückgabewerte
The function returns the number of bytes that were written to the file, or
FALSE on failure.
Warnung
Diese Funktion kann sowohl das
boolsche FALSE zurückliefern, als auch einen nicht-boolschen Wert, welcher zu FALSE ausgewertet wird.
Weitere Informationen entnehmen Sie bitte dem Abschnitt über die
boolschen Typen. Benutzen Sie deshalb
den === Operator,
um den Rückgabewert dieser Funktion zu überprüfen.
Beispiele
Beispiel #1 Simple usage example
<?php
$file = 'people.txt';
// Open the file to get existing content
$current = file_get_contents($file);
// Append a new person to the file
$current .= "John Smith\n";
// Write the contents back to the file
file_put_contents($file, $current);
?>
Beispiel #2 Using flags
<?php
$file = 'people.txt';
// The new person to add to the file
$person = "John Smith\n";
// Write the contents to the file,
// using the FILE_APPEND flag to append the content to the end of the file
// and the LOCK_EX flag to prevent anyone else writing to the file at the same time
file_put_contents($file, $person, FILE_APPEND | LOCK_EX);
?>
Changelog
| Version | Beschreibung |
|---|---|
| 5.0.0 | Added context support |
| 5.1.0 |
Added support for LOCK_EX and the ability to pass
a stream resource to the data parameter
|
Anmerkungen
Hinweis: Diese Funktion ist binary safe.
Tipp
Mit dieser Funktion können Sie eine URL als Dateinamen verwenden, falls Sie fopen wrappers ermöglicht haben. Mehr Details dazu, wie Sie den Dateinamen angeben müssen finden Sie bei fopen(). Eine Liste der unterstützten URL Protokolle, die Fähigkeiten der verschiedenen Wrapper, Hinweise zu deren Verwendung und Informationen zu den eventuell vorhandenen vordefinierten Variablen finden Sie unter Unterstützte Protokolle and Wrappers.
Siehe auch
- fopen() - Öffnet eine Datei oder URL
- fwrite() - Schreibt Binärdaten in eine Datei
- file_get_contents() - Liest die gesamte Datei in einen String
- stream_context_create() - Creates a stream context
add a note
User Contributed Notesfile_put_contents
Curtis
21-Dec-2006 12:20
21-Dec-2006 12:20
egingell at sisna dot com
23-Jul-2006 01:11
23-Jul-2006 01:11
In reply to the previous note:
If you want to emulate this function in PHP4, you need to return the bytes written as well as support for arrays, flags.
I can only figure out the FILE_APPEND flag and array support. If I could figure out "resource context" and the other flags, I would include those too.
<?
define('FILE_APPEND', 1);
function file_put_contents($n, $d, $flag = false) {
$mode = ($flag == FILE_APPEND || strtoupper($flag) == 'FILE_APPEND') ? 'a' : 'w';
$f = @fopen($n, $mode);
if ($f === false) {
return 0;
} else {
if (is_array($d)) $d = implode($d);
$bytes_written = fwrite($f, $d);
fclose($f);
return $bytes_written;
}
}
?>
16-Jul-2006 10:24
simple function for php4:
function file_put_contents($n,$d) {
$f=@fopen($n,"w");
if (!$f) {
return false;
} else {
fwrite($f,$d);
fclose($f);
return true;
}
}
sendoshin at awswan dot com
06-Mar-2006 08:01
06-Mar-2006 08:01
To clear up what was said by pvenegas+php at gmail dot com on 11-Oct-2005 08:13, file_put_contents() will replace the file by default. Here's the complete set of rules this function follows when accessing a file:
1. Was FILE_USE_INCUDE_PATH passed in the call? If so, check the include path for an existing copy of *filename*.
2. Does the file already exist? If not, first create it in the current working directory. Either way, open the file.
3. Was LOCK_EX passed in the call? If so, lock the file.
4. Was the function called with FILE_APPEND? If not, clear the file's contents. Otherwise, move to the end of the file.
5. Write *data* into the file.
6. Close the file and release any locks.
If you don't want to completely replace the contents of the file you're writing to, be sure to use FILE_APPEND (same as fopen() with 'a') in the *flags*. If you don't, whatever used to be there will be gone (fopen() with 'w').
Hope that helps someone (and that it makes sense ^^)!
- Sendoshin
pvenegas+php at gmail dot com
12-Oct-2005 04:13
12-Oct-2005 04:13
Note that if the specified file already exists, this function effectively discards its contents (equivalent to fopen with 'w') and inserts the new data. The documentation doesn't say this explicitly, so this might help those who are unsure.
Jared Kuolt
04-Mar-2005 09:14
04-Mar-2005 09:14
Note that this function will create the file if it does not exists, assuming PHP has write access to the folder.
aidan at php dot net
21-May-2004 04:11
21-May-2004 04:11
This functionality is now implemented in the PEAR package PHP_Compat.
More information about using this function without upgrading your version of PHP can be found on the below link:
http://pear.php.net/package/PHP_Compat