From aa0244ff0563700c4e66ab3e059b4e232678cc13 Mon Sep 17 00:00:00 2001 From: Nuno Lopes Date: Tue, 12 Jul 2005 19:30:51 +0000 Subject: [PATCH] convert to new style and document the support for LOCK_EX in php 5.1 git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@190592 c90b9560-bf6c-de11-be94-00142212c4b1 --- .../functions/file-put-contents.xml | 178 +++++++++++++----- 1 file changed, 130 insertions(+), 48 deletions(-) diff --git a/reference/filesystem/functions/file-put-contents.xml b/reference/filesystem/functions/file-put-contents.xml index 0e6771da8c..0ebaf63b1e 100644 --- a/reference/filesystem/functions/file-put-contents.xml +++ b/reference/filesystem/functions/file-put-contents.xml @@ -1,52 +1,134 @@ - - - - file_put_contents - Write a string to a file - - - Description - - intfile_put_contents - stringfilename - mixeddata - intflags - resourcecontext - - - Identical to calling fopen, fwrite, - and fclose successively. The function returns the - amount of bytes that were written to the file. - - - flags can take FILE_USE_INCLUDE_PATH - and/or FILE_APPEND, however the - FILE_USE_INCLUDE_PATH option should be used with caution. - - - You can also specify the data parameter as an array - (not multi-dimension arrays). This is equivalent to - file_put_contents($filename, join('', $array)). - - ¬e.context-support; - - As of PHP 5.1.0, you may also pass a stream resource to the - data parameter. In result, the remaining buffer of - that stream will be copied to the specified file. This is similar with - using stream_copy_to_stream. - - ¬e.bin-safe; - &tip.fopen-wrapper; - - See also - fopen, - fwrite, - fclose, and - file_get_contents. - - - + + + + file_put_contents + Write a string to a file + + + &reftitle.description; + + intfile_put_contents + stringfilename + mixeddata + intflags + resourcecontext + + + Identical to calling fopen, fwrite, + and fclose successively. + + + You can also specify the data parameter as an array + (not multi-dimension arrays). This is equivalent to + file_put_contents($filename, join('', $array)). + + + As of PHP 5.1.0, you may also pass a stream resource to the + data parameter. In result, the remaining buffer of + that stream will be copied to the specified file. This is similar with + using stream_copy_to_stream. + + + + + &reftitle.parameters; + + + + filename + + + The file name where to write the data + + + + + data + + + The data to write. Can be either a string, an + array or a stream resource (explained above). + + + + + flags + + + flags can take + FILE_USE_INCLUDE_PATH, + FILE_APPEND and/or LOCK_EX + (acquire an exclusive lock), however the + FILE_USE_INCLUDE_PATH option should be used with + caution. + + + + + context + + + A context resource + + + + + + + + + &reftitle.returnvalues; + + The function returns the amount of bytes that were written to the file. + + + + + &reftitle.changelog; + + + + + + &Version; + &Description; + + + + + 5.1.0 + + Added support for LOCK_EX and the ability to pass + a stream resource to the data parameter + + + + + + + + + + + &reftitle.notes; + ¬e.bin-safe; + ¬e.context-support; + &tip.fopen-wrapper; + + + + + &reftitle.seealso; + + + fopen + fwrite + file_get_contents + + + +