|
|
|
|
Bookmark this on Delicious
Share on Facebook
 Slashdot It!
Digg file_put_contents
Write a string to a file
(PHP 5)
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
Parameters
Return Values
The function returns the amount of bytes that were written to the file, or
ChangeLog
Notes
Note:
This function is binary-safe.
Tip:
You can use a URL as a filename with this function if the fopen wrappers have been enabled. See fopen() for more details on how to specify the filename and Appendix O, List of Supported Protocols/Wrappers for a list of supported URL protocols. Related Examples ( Source code ) » file_put_contents Examples ( Source code ) » FeedAggregator using HttpRequest Examples ( Source code ) » Download big file using HttpRequest Code Examples / Notes » file_put_contentssendoshin
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
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 egingell
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; } } ?> me
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
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. martin
@me at briandichiara dot com you want to have a look at the function "touch" |
Change Language
basename chgrp chmod chown clearstatcache copy delete dirname disk_free_space disk_total_space diskfreespace fclose feof fflush fgetc fgetcsv fgets fgetss file_exists file_get_contents file_put_contents file fileatime filectime filegroup fileinode filemtime fileowner fileperms filesize filetype flock fnmatch fopen fpassthru fputcsv fputs fread fscanf fseek fstat ftell ftruncate fwrite glob is_dir is_executable is_file is_link is_readable is_uploaded_file is_writable is_writeable lchgrp lchown link linkinfo lstat mkdir move_uploaded_file parse_ini_file pathinfo pclose popen readfile readlink realpath rename rewind rmdir set_file_buffer stat symlink tempnam tmpfile touch umask unlink |
