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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<refentry id="function.file-put-contents">
<refnamediv>
<refname>file_put_contents</refname>
<refpurpose>Write a string to a file</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</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></methodparam>
<methodparam choice="opt"><type>resource</type><parameter>context</parameter></methodparam>
</methodsynopsis>
<simpara>
Identical to calling <function>fopen</function>, <function>fwrite</function>,
and <function>fclose</function> successively. The function returns the
amount of bytes that were written to the file.
</simpara>
<simpara>
<parameter>flags</parameter> can take <constant>FILE_USE_INCLUDE_PATH</constant>
and/or <constant>FILE_APPEND</constant>, however the
<constant>FILE_USE_INCLUDE_PATH</constant> option should be used with caution.
</simpara>
<para>
You can also specify the <parameter>data</parameter> parameter as an array
(not multi-dimension arrays). This is equivalent to
<literal>file_put_contents($filename, join('', $array))</literal>.
</para>
¬e.context-support;
<para>
As of PHP 5.1.0, you may also pass a stream resource to the
<parameter>data</parameter> parameter. In result, the remaining buffer of
that stream will be copied to the specified file. This is similar with
using <function>stream_copy_to_stream</function>.
</para>
¬e.bin-safe;
&tip.fopen-wrapper;
<simpara>
See also
<function>fopen</function>,
<function>fwrite</function>,
<function>fclose</function>, and
<function>file_get_contents</function>.
</simpara>
</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:"../../../../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
-->
|