file_get_contents
File put contents fails if you try to put a file in a directory that doesn't exist. This creates the directory.
<?php
function file_force_contents($dir, $contents){
$parts = explode('/', $dir);
$file = array_pop($parts);
$dir = '';
foreach($parts as $part)
if(!is_dir($dir .= "/$part")) mkdir($dir);
file_put_contents("$dir/$file", $contents);
}
?>
file_put_contents
(PHP 5)
file_put_contents — Escribir una cadena sobre un archivo
Descripción
int file_put_contents
( string $nombre_archivo
, mixed $datos
[, int $banderas
[, resource $contexto
]] )
Esta función es idéntica a llamar fopen(), fwrite(), y fclose() sucesivamente para escribir datos en un archivo.
Si nombre_archivo no existe, el archivo es creado. De lo contrario, el archivo existente el sobrescrito, a menos que la bandera FILE_APPEND sea definida.
Lista de parámetros
- nombre_archivo
-
Ruta al archivo en donde escribir los datos
- datos
-
Los datos a escribir. Puede ser un valor tipo string, array o un recurso stream (explicado anteriormente).
Si datos es un recurso de tipo stream, el resto del búfer de esa secuencia será copiado al archivo especificado. Esto es similar al uso de stream_copy_to_stream().
También es posible especificar el parámetro datos como una matriz uni-dimensional. Esto es equivalente a file_put_contents($nombre_archive, implode('', $matriz)).
- banderas
-
El valor de banderas puede ser cualquier combinación de las siguientes banderas (con algunas restricciones), unidas con el operador binario OR (|).
Banderas disponibles Bandera Descripción FILE_USE_INCLUDE_PATH Buscar por nombre_archivo en el directorio de inclusiones. Vea include_path para más información. FILE_APPEND Si el archivo nombre_archivo ya existe, anexar los datos al archivo en lugar de sobrescribirlo. LOCK_EX Adquirir un bloqueo exclusivo sobre el archivo mientras se procede con la escritura. FILE_TEXT datos es escrito en modo de texto. Si la semántica unicode está habilitada, la codificación predeterminada es UTF-8. Es posible especificar una codificación diferente creando un contexto personalizado o modificando el predeterminado mediante stream_default_encoding(). Esta bandera no puede ser usada junto con FILE_BINARY. Esta bandera está disponible únicamente a partir de PHP 6. FILE_BINARY datos será escrito en modo binario. Este es el comportamiento predeterminado y la bandera no pude ser usada junto con FILE_TEXT. Esta bandera está disponible únicamente desde PHP 6. - contexto
-
Un recurso de contexto creado con stream_context_create().
Valores retornados
La función devuelve la cantidad de bytes escritos al archivo, o FALSE en caso de fallo.
Registro de cambios
| Versión | Descripción |
|---|---|
| 5.0.0 | Se agregó el soporte para contextos |
| 5.1.0 | Se agregó soporte para LOCK_EX y la habilidad de pasar un recurso de secuencia al parámetro datos |
| 6.0.0 | Se agregó el soporte para las banderas FILE_TEXT y FILE_BINARY |
Notes
Note: Esta función es segura binariamente.
Tip
Puede usar una URL como nombre de archivo con esta función si los fopen wrappers han sido activados. Consulte fopen() para más detalles sobre cómo especificar el nombre de fichero y Lista de Protocolos/Envolturas Soportadas una lista de protocolos URL soportados
add a note
User Contributed Notesfile_put_contents
TrentTompkins at gmail dot com
02-Jul-2008 09:25
02-Jul-2008 09:25
Anonymous
02-May-2008 03:06
02-May-2008 03:06
file_put_contents() will cause concurrency problems - that is, it doesn't write files atomically (in a single operation), which sometimes means that one php script will be able to, for example, read a file before another script is done writing that file completely.
The following function was derived from a function in Smarty (http://smarty.php.net) which uses rename() to replace the file - rename() is atomic on Linux.
On Windows, rename() is not currently atomic, but should be in the next release. Until then, this function, if used on Windows, will fall back on unlink() and rename(), which is still not atomic...
<?php
define("FILE_PUT_CONTENTS_ATOMIC_TEMP", dirname(__FILE__)."/cache");
define("FILE_PUT_CONTENTS_ATOMIC_MODE", 0777);
function file_put_contents_atomic($filename, $content) {
$temp = tempnam(FILE_PUT_CONTENTS_ATOMIC_TEMP, 'temp');
if (!($f = @fopen($temp, 'wb'))) {
$temp = FILE_PUT_CONTENTS_ATOMIC_TEMP . DIRECTORY_SEPARATOR . uniqid('temp');
if (!($f = @fopen($temp, 'wb'))) {
trigger_error("file_put_contents_atomic() : error writing temporary file '$temp'", E_USER_WARNING);
return false;
}
}
fwrite($f, $content);
fclose($f);
if (!@rename($temp, $filename)) {
@unlink($filename);
@rename($temp, $filename);
}
@chmod($filename, FILE_PUT_CONTENTS_ATOMIC_MODE);
return true;
}
?>
the geek man at hot mail point com
03-Jan-2008 09:23
03-Jan-2008 09:23
I use the following code to create a rudimentary text editor. It's not fancy, but then it doesn't have to be. You could easily add a parameter to specify a file to edit; I have not done so to avoid the potential security headaches.
There are still obvious security holes here, but for most applications it should be reasonably safe if implemented for brief periods in a counterintuitive spot. (Nobody says you have to make a PHP file for that purpose; you can tack it on anywhere, so long as it is at the beginning of a file.)
<?php
$random1 = 'randomly_generated_string';
$random2 = 'another_randomly_generated_string';
$target_file = 'file_to_edit.php';
$this_file = 'the_current_file.php';
if ($_REQUEST[$random1] === $random2) {
if (isset($_POST['content']))
file_put_contents($target_file, get_magic_quotes_qpc() ? stripslashes($_POST['content']) : $_POST['content']);
die('<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Editing...</title>
</head>
<body>
<form method="post" action="' . $this_file . '" />
<input type="hidden" name="' . $random1 . '" value="' . $random2 . '" />
<textarea name="content" rows="50" cols="100">' . file_get_contents($target_file) . '</textarea><br />
<input type="submit" value="Save Changes" />
</form>
</body>
</html>');
}
?>
Then simply browse to hxxp://www.example.com/{$this_file}?{$random1}={$random2}, with the appropriate values substituted for each bracketed variable. Please note that this code assumes the target file to be world writable (-rw-rw-rw- or 666) and will fail to save properly without error if it is not.
Once again, this is by no means secure or permanent, but as a quick fix for brief edits to noncritical files it should be sufficient, and its small size is a definite bonus.
egingell at sisna dot com
21-Dec-2007 12:15
21-Dec-2007 12:15
There is a better way. www.php.net/touch
Since you're not adding anything to the file,
<?php
function updateFile($filename) {
if (!file_exists($filename)) return;
touch($filename);
}
?>
me at briandichiara dot com
04-Oct-2007 04:20
04-Oct-2007 04:20
I was in need of a function that updated the last modified date in a php file. There may be a better way, but this is how I did it:
<?php
function updateFile($modFile){
if(!empty($modFile)){
if($fo = fopen($modFile, 'r')){
$source = '';
while (!feof($fo)) {
$source .= fgets($fo);
}
file_put_contents($modFile,$source);
fclose($fo);
}
}
}
?>
Curtis
21-Dec-2006 08:20
21-Dec-2006 08:20
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.
egingell at sisna dot com
23-Jul-2006 08:11
23-Jul-2006 08: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;
}
}
?>
sendoshin at awswan dot com
06-Mar-2006 04:01
06-Mar-2006 04: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
aidan at php dot net
20-May-2004 11:11
20-May-2004 11: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