<?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.setencryptionname.php',
    1 => 'ZipArchive::setEncryptionName',
    2 => 'Set the encryption method of an entry defined by its name',
  ),
  'up' => 
  array (
    0 => 'class.ziparchive.php',
    1 => 'ZipArchive',
  ),
  'prev' => 
  array (
    0 => 'ziparchive.setencryptionindex.php',
    1 => 'ZipArchive::setEncryptionIndex',
  ),
  'next' => 
  array (
    0 => 'ziparchive.setexternalattributesindex.php',
    1 => 'ZipArchive::setExternalAttributesIndex',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/zip/ziparchive/setencryptionname.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="ziparchive.setencryptionname" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">ZipArchive::setEncryptionName</h1>
  <p class="verinfo">(PHP &gt;= 7.2.0, PHP 8, PECL zip &gt;= 1.14.0)</p><p class="refpurpose"><span class="refname">ZipArchive::setEncryptionName</span> &mdash; <span class="dc-title">Set the encryption method of an entry defined by its name</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-ziparchive.setencryptionname-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>ZipArchive::setEncryptionName</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$name</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$method</code></span>, <span class="methodparam"><span class="attribute"><a href="class.sensitiveparameter.php">#[\SensitiveParameter]</a> </span><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$password</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="para rdfs-comment">
   Set the encryption method of an entry defined by its name.
  </p>
 </div>

 <div class="refsect1 parameters" id="refsect1-ziparchive.setencryptionname-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">name</code></dt>
     <dd>
      <p class="para">
       Name of the entry.
      </p>
     </dd>
    
    
     <dt><code class="parameter">method</code></dt>
     <dd>
      <p class="para">
       The encryption method defined by one of the ZipArchive::EM_ constants.
      </p>
     </dd>
    
    
     <dt><code class="parameter">password</code></dt>
     <dd>
      <p class="para">
       Optional password, default used when missing.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-ziparchive.setencryptionname-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.setencryptionname-changelog">
  <h3 class="title">更新日志</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>版本</th>
      <th>说明</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.0.0</td>
      <td>
       <code class="parameter">password</code> is now nullable.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-ziparchive.setencryptionname-examples">
  <h3 class="title">示例</h3>
    <p class="para">
     This example creates a ZIP file archive
     <var class="filename">test.zip</var> and add
     the file <var class="filename">test.txt</var>
     encrypted using the AES 256 method.
    </p>
    <div class="example" id="example-1">
     <p><strong>示例 #1 Archive and encrypt a file</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">ZipArchive</span><span style="color: #007700">::</span><span style="color: #0000BB">CREATE</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">setPassword</span><span style="color: #007700">(</span><span style="color: #DD0000">'secret'</span><span style="color: #007700">);<br />    </span><span style="color: #0000BB">$zip</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">addFile</span><span style="color: #007700">(</span><span style="color: #DD0000">'text.txt'</span><span style="color: #007700">);<br />    </span><span style="color: #0000BB">$zip</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">setEncryptionName</span><span style="color: #007700">(</span><span style="color: #DD0000">'text.txt'</span><span style="color: #007700">, </span><span style="color: #0000BB">ZipArchive</span><span style="color: #007700">::</span><span style="color: #0000BB">EM_AES_256</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\n"</span><span style="color: #007700">;<br />} else {<br />    echo </span><span style="color: #DD0000">"KO\n"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
     </div>

    </div>
 </div>


 <div class="refsect1 notes" id="refsect1-ziparchive.setencryptionname-notes">
  <h3 class="title">注释</h3>
  <blockquote class="note"><p><strong class="note">注意</strong>: 
   <p class="para">
    This function is only available if built against libzip ≥ 1.2.0.
   </p>
  </p></blockquote>
 </div>


 <div class="refsect1 seealso" id="refsect1-ziparchive.setencryptionname-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="methodname"><a href="ziparchive.setpassword.php" class="methodname" rel="rdfs-seeAlso">ZipArchive::setPassword()</a> - Set the password for the active archive</span></li>
    <li><span class="methodname"><a href="ziparchive.setencryptionindex.php" class="methodname" rel="rdfs-seeAlso">ZipArchive::setEncryptionIndex()</a> - Set the encryption method of an entry defined by its index</span></li>
   </ul>
  </p>
 </div>

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