mirror of
https://github.com/fofolee/uTools-Manuals.git
synced 2025-06-18 22:06:57 +08:00
251 lines
11 KiB
HTML
251 lines
11 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||
<html>
|
||
<head>
|
||
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
|
||
<title>将一个字符串写入文件</title>
|
||
</head>
|
||
<body class="docs"><div id="layout">
|
||
<div id="layout-content"><div id="function.file-put-contents" class="refentry">
|
||
<div class="refnamediv">
|
||
<h1 class="refname">file_put_contents</h1>
|
||
<p class="verinfo">(PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">file_put_contents</span> — <span class="dc-title">将一个字符串写入文件</span></p>
|
||
|
||
</div>
|
||
<div class="refsect1 description" id="refsect1-function.file-put-contents-description">
|
||
<h3 class="title">说明</h3>
|
||
<div class="methodsynopsis dc-description">
|
||
<span class="methodname"><strong>file_put_contents</strong></span>
|
||
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$filename</code></span>
|
||
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$data</code></span>
|
||
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code><span class="initializer"> = 0</span></span>
|
||
[, <span class="methodparam"><span class="type">resource</span> <code class="parameter">$context</code></span>
|
||
]] ) : <span class="type">int</span></div>
|
||
|
||
<p class="para rdfs-comment">
|
||
和依次调用 <span class="function"><a href="fopen.html" class="function">fopen()</a></span>，<span class="function"><a href="fwrite.html" class="function">fwrite()</a></span>
|
||
以及 <span class="function"><a href="fclose.html" class="function">fclose()</a></span> 功能一样。
|
||
</p>
|
||
<p class="para">
|
||
If <code class="parameter">filename</code> does not exist, the file is created.
|
||
Otherwise, the existing file is overwritten, unless the
|
||
<strong><code>FILE_APPEND</code></strong> flag is set.
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="refsect1 parameters" id="refsect1-function.file-put-contents-parameters">
|
||
<h3 class="title">参数</h3>
|
||
<p class="para">
|
||
<dl>
|
||
|
||
|
||
<dt>
|
||
<code class="parameter">filename</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
要被写入数据的文件名。
|
||
</p>
|
||
</dd>
|
||
|
||
|
||
|
||
<dt>
|
||
<code class="parameter">data</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
要写入的数据。类型可以是 <span class="type"><a href="language.types.string.html" class="type string">string</a></span>，<span class="type"><a href="language.types.array.html" class="type array">array</a></span>
|
||
或者是 <span class="type"><span class="type stream">stream</span></span> 资源（如上面所说的那样）。
|
||
</p>
|
||
<p class="para">
|
||
如果 <code class="parameter">data</code>
|
||
指定为 stream 资源，这里 stream
|
||
中所保存的缓存数据将被写入到指定文件中，这种用法就相似于使用
|
||
<span class="function"><a href="stream_copy_to_stream.html" class="function">stream_copy_to_stream()</a></span> 函数。
|
||
</p>
|
||
<p class="para">
|
||
参数 <code class="parameter">data</code> 可以是数组（但不能为多维数组），这就相当于
|
||
<em>file_put_contents($filename, join('', $array))</em>。
|
||
</p>
|
||
</dd>
|
||
|
||
|
||
|
||
<dt>
|
||
<code class="parameter">flags</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
<code class="parameter">flags</code> 的值可以是
|
||
以下 flag 使用 OR (<em>|</em>) 运算符进行的组合。
|
||
</p>
|
||
<p class="para">
|
||
<table class="doctable table">
|
||
<caption><strong>Available flags</strong></caption>
|
||
|
||
<thead>
|
||
<tr>
|
||
<th>Flag</th>
|
||
<th>描述</th>
|
||
</tr>
|
||
|
||
</thead>
|
||
|
||
<tbody class="tbody">
|
||
<tr>
|
||
<td>
|
||
<strong><code>FILE_USE_INCLUDE_PATH</code></strong>
|
||
</td>
|
||
<td>
|
||
在 include 目录里搜索 <code class="parameter">filename</code>。
|
||
更多信息可参见 <a href="ini.core.html#ini.include-path" class="link">include_path</a>。
|
||
</td>
|
||
</tr>
|
||
|
||
<tr>
|
||
<td>
|
||
<strong><code>FILE_APPEND</code></strong>
|
||
</td>
|
||
<td>
|
||
如果文件 <code class="parameter">filename</code> 已经存在，追加数据而不是覆盖。
|
||
</td>
|
||
</tr>
|
||
|
||
<tr>
|
||
<td>
|
||
<strong><code>LOCK_EX</code></strong>
|
||
</td>
|
||
<td>
|
||
在写入时获得一个独占锁。
|
||
</td>
|
||
</tr>
|
||
|
||
|
||
</tbody>
|
||
|
||
</table>
|
||
|
||
</p>
|
||
</dd>
|
||
|
||
|
||
|
||
<dt>
|
||
<code class="parameter">context</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
一个 context 资源。
|
||
</p>
|
||
</dd>
|
||
|
||
|
||
</dl>
|
||
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="refsect1 returnvalues" id="refsect1-function.file-put-contents-returnvalues">
|
||
<h3 class="title">返回值</h3>
|
||
<p class="para">
|
||
该函数将返回写入到文件内数据的字节数，失败时返回<strong><code>FALSE</code></strong>
|
||
</p>
|
||
<div class="warning"><strong class="warning">Warning</strong><p class="simpara">此函数可能返回布尔值
|
||
<strong><code>FALSE</code></strong>，但也可能返回等同于 <strong><code>FALSE</code></strong> 的非布尔值。请阅读 <a href="language.types.boolean.html" class="link">布尔类型</a>章节以获取更多信息。应使用
|
||
<a href="language.operators.comparison.html" class="link">===
|
||
运算符</a>来测试此函数的返回值。</p></div>
|
||
</div>
|
||
|
||
|
||
<div class="refsect1 examples" id="refsect1-function.file-put-contents-examples">
|
||
<h3 class="title">范例</h3>
|
||
<p class="para">
|
||
<div class="example" id="example-2782">
|
||
<p><strong>Example #1 Simple usage example</strong></p>
|
||
<div class="example-contents">
|
||
<div class="phpcode"><pre><span style="color: #000000">
|
||
<span style="color: #0000BB"><?php<br />$file </span><span style="color: #007700">= </span><span style="color: #DD0000">'people.txt'</span><span style="color: #007700">;<br /></span><span style="color: #FF8000">// Open the file to get existing content<br /></span><span style="color: #0000BB">$current </span><span style="color: #007700">= </span><span style="color: #0000BB">file_get_contents</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// Append a new person to the file<br /></span><span style="color: #0000BB">$current </span><span style="color: #007700">.= </span><span style="color: #DD0000">"John Smith\n"</span><span style="color: #007700">;<br /></span><span style="color: #FF8000">// Write the contents back to the file<br /></span><span style="color: #0000BB">file_put_contents</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">, </span><span style="color: #0000BB">$current</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
|
||
</span>
|
||
</pre></div>
|
||
</div>
|
||
|
||
</div>
|
||
<div class="example" id="example-2783">
|
||
<p><strong>Example #2 Using flags</strong></p>
|
||
<div class="example-contents">
|
||
<div class="phpcode"><pre><span style="color: #000000">
|
||
<span style="color: #0000BB"><?php<br />$file </span><span style="color: #007700">= </span><span style="color: #DD0000">'people.txt'</span><span style="color: #007700">;<br /></span><span style="color: #FF8000">// The new person to add to the file<br /></span><span style="color: #0000BB">$person </span><span style="color: #007700">= </span><span style="color: #DD0000">"John Smith\n"</span><span style="color: #007700">;<br /></span><span style="color: #FF8000">// Write the contents to the file, <br />// using the FILE_APPEND flag to append the content to the end of the file<br />// and the LOCK_EX flag to prevent anyone else writing to the file at the same time<br /></span><span style="color: #0000BB">file_put_contents</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">, </span><span style="color: #0000BB">$person</span><span style="color: #007700">, </span><span style="color: #0000BB">FILE_APPEND </span><span style="color: #007700">| </span><span style="color: #0000BB">LOCK_EX</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
|
||
</span>
|
||
</pre></div>
|
||
</div>
|
||
|
||
</div>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="refsect1 changelog" id="refsect1-function.file-put-contents-changelog">
|
||
<h3 class="title">更新日志</h3>
|
||
<p class="para">
|
||
<table class="doctable informaltable">
|
||
|
||
<thead>
|
||
<tr>
|
||
<th>版本</th>
|
||
<th>说明</th>
|
||
</tr>
|
||
|
||
</thead>
|
||
|
||
<tbody class="tbody">
|
||
<tr>
|
||
<td>5.0.0</td>
|
||
<td>
|
||
Added context support
|
||
</td>
|
||
</tr>
|
||
|
||
<tr>
|
||
<td>5.1.0</td>
|
||
<td>
|
||
添加了对 <strong><code>LOCK_EX</code></strong> 的支持和 <code class="parameter">data</code>
|
||
参数处理 stream 资源的功能。
|
||
</td>
|
||
</tr>
|
||
|
||
|
||
</tbody>
|
||
|
||
</table>
|
||
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="refsect1 notes" id="refsect1-function.file-put-contents-notes">
|
||
<h3 class="title">注释</h3>
|
||
<blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">此函数可安全用于二进制对象。</span></p></blockquote>
|
||
<div class="tip"><strong class="tip">Tip</strong><p class="simpara">如已启用<a href="filesystem.configuration.html#ini.allow_url_fopen" class="link">fopen 包装器</a>，在此函数中， URL 可作为文件名。关于如何指定文件名详见 <span class="function"><a href="fopen.html" class="function">fopen()</a></span>。各种
|
||
wapper 的不同功能请参见 <a href="wrappers.html" class="xref">支持的协议和封装协议</a>，注意其用法及其可提供的预定义变量。</p></div>
|
||
</div>
|
||
|
||
|
||
<div class="refsect1 seealso" id="refsect1-function.file-put-contents-seealso">
|
||
<h3 class="title">参见</h3>
|
||
<p class="para">
|
||
<ul class="simplelist">
|
||
<li class="member"><span class="function"><a href="fopen.html" class="function" rel="rdfs-seeAlso">fopen()</a> - 打开文件或者 URL</span></li>
|
||
<li class="member"><span class="function"><a href="fwrite.html" class="function" rel="rdfs-seeAlso">fwrite()</a> - 写入文件（可安全用于二进制文件）</span></li>
|
||
<li class="member"><span class="function"><a href="file_get_contents.html" class="function" rel="rdfs-seeAlso">file_get_contents()</a> - 将整个文件读入一个字符串</span></li>
|
||
<li class="member"><span class="function"><a href="stream_context_create.html" class="function" rel="rdfs-seeAlso">stream_context_create()</a> - 创建资源流上下文</span></li>
|
||
</ul>
|
||
</p>
|
||
</div>
|
||
|
||
</div></div></div></body></html> |