<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.ziparchive.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'zh',
  ),
  'this' => 
  array (
    0 => 'ziparchive.replacefile.php',
    1 => 'ZipArchive::replaceFile',
    2 => 'Replace file in ZIP archive with a given path',
  ),
  'up' => 
  array (
    0 => 'class.ziparchive.php',
    1 => 'ZipArchive',
  ),
  'prev' => 
  array (
    0 => 'ziparchive.renamename.php',
    1 => 'ZipArchive::renameName',
  ),
  'next' => 
  array (
    0 => 'ziparchive.setarchivecomment.php',
    1 => 'ZipArchive::setArchiveComment',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/zip/ziparchive/replacefile.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="ziparchive.replacefile" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">ZipArchive::replaceFile</h1>
  <p class="verinfo">(PHP &gt;= 8.0.0, PECL zip &gt;= 1.18.0)</p><p class="refpurpose"><span class="refname">ZipArchive::replaceFile</span> &mdash; <span class="dc-title">Replace file in ZIP archive with a given path</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-ziparchive.replacefile-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>ZipArchive::replaceFile</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$filepath</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$index</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$start</code><span class="initializer"> = 0</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$length</code><span class="initializer"> = <strong><code><a href="zip.constants.php#ziparchive.constants.length-to-end">ZipArchive::LENGTH_TO_END</a></code></strong></span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$flags</code><span class="initializer"> = 0</span></span><br>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="para rdfs-comment">
   Replace file in ZIP archive with a given path.
  </p>
  <blockquote class="note"><p><strong class="note">注意</strong>: <span class="simpara">为了最大限度地提高代码可移植性，建议在 ZIP 文件名中使用斜线 (<code class="literal">/</code>) 做为目录分隔符。</span></p></blockquote>
 </div>

 <div class="refsect1 parameters" id="refsect1-ziparchive.replacefile-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">filepath</code></dt>
     <dd>
      <p class="para">
       The path to the file to add.
      </p>
     </dd>
    
    
     <dt><code class="parameter">index</code></dt>
     <dd>
      <p class="para">
       The index of the file to be replaced, its name is unchanged.
      </p>
     </dd>
    
    
     <dt><code class="parameter">start</code></dt>
     <dd>
      <p class="para">
       For partial copy, start position.
      </p>
     </dd>
    
    
     <dt><code class="parameter">length</code></dt>
     <dd>
      <p class="para">
       For partial copy, length to be copied,
       if <strong><code><a href="zip.constants.php#ziparchive.constants.length-to-end">ZipArchive::LENGTH_TO_END</a></code></strong> (0) the file size is used,
       if <strong><code><a href="zip.constants.php#ziparchive.constants.length-unchecked">ZipArchive::LENGTH_UNCHECKED</a></code></strong> the whole file is used
       (starting from <code class="parameter">start</code>).
      </p>
     </dd>
    
    
     <dt><code class="parameter">flags</code></dt>
     <dd>
      <p class="para">
       Bitmask consisting of
       <strong><code><a href="zip.constants.php#ziparchive.constants.fl-enc-guess">ZipArchive::FL_ENC_GUESS</a></code></strong>,
       <strong><code><a href="zip.constants.php#ziparchive.constants.fl-enc-utf-8">ZipArchive::FL_ENC_UTF_8</a></code></strong>,
       <strong><code><a href="zip.constants.php#ziparchive.constants.fl-enc-cp437">ZipArchive::FL_ENC_CP437</a></code></strong>,
       <strong><code><a href="zip.constants.php#ziparchive.constants.fl-open-file-now">ZipArchive::FL_OPEN_FILE_NOW</a></code></strong>.
       The behaviour of these constants is described on the
       <a href="zip.constants.php" class="link">ZIP constants</a> page.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-ziparchive.replacefile-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   成功时返回 <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>， 或者在失败时返回 <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>。
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-ziparchive.replacefile-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>8.3.0, PECL zip 1.22.1</td>
       <td>
        <strong><code><a href="zip.constants.php#ziparchive.constants.fl-open-file-now">ZipArchive::FL_OPEN_FILE_NOW</a></code></strong> was added.
       </td>
      </tr>

      <tr>
       <td>8.3.0, PECL zip 1.22.2</td>
       <td>
        <strong><code><a href="zip.constants.php#ziparchive.constants.length-to-end">ZipArchive::LENGTH_TO_END</a></code></strong> and <strong><code><a href="zip.constants.php#ziparchive.constants.length-unchecked">ZipArchive::LENGTH_UNCHECKED</a></code></strong> were added.
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-ziparchive.replacefile-examples">
  <h3 class="title">示例</h3>
    <p class="para">
     This example opens a ZIP file archive
     <var class="filename">test.zip</var> and replaces index 1 entry
     with <var class="filename">/path/to/index.txt</var>.
    </p>
    <div class="example" id="example-1">
     <p><strong>示例 #1 Open and replace</strong></p>
     <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$zip </span><span style="color: #007700">= new </span><span style="color: #0000BB">ZipArchive</span><span style="color: #007700">;<br />if (</span><span style="color: #0000BB">$zip</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">open</span><span style="color: #007700">(</span><span style="color: #DD0000">'test.zip'</span><span style="color: #007700">) === </span><span style="color: #0000BB">TRUE</span><span style="color: #007700">) {<br />    </span><span style="color: #0000BB">$zip</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">replaceFile</span><span style="color: #007700">(</span><span style="color: #DD0000">'/path/to/index.txt'</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">);<br />    </span><span style="color: #0000BB">$zip</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">close</span><span style="color: #007700">();<br />    echo </span><span style="color: #DD0000">'ok'</span><span style="color: #007700">;<br />} else {<br />    echo </span><span style="color: #DD0000">'failed'</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
     </div>

    </div>
   </div>


   <div class="refsect1 seealso" id="refsect1-ziparchive.replacefile-seealso">
    <h3 class="title">参见</h3>
    <p class="para">
     <ul class="simplelist">
      <li><span class="methodname"><a href="ziparchive.addfile.php" class="methodname" rel="rdfs-seeAlso">ZipArchive::addFile()</a> - Adds a file to a ZIP archive from the given path</span></li>
     </ul>
    </p>
   </div>

</div><?php manual_footer($setup); ?>