doc-fr/reference/zip/ziparchive/setencryptionname.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: c0a030bf35b5eac2701ba97788f9e49cdbfdf049 Maintainer: jbnahan Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="ziparchive.setencryptionname" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ZipArchive::setEncryptionName</refname>
  <refpurpose>Définit la méthode de chiffrement d'une entrée définit par son nom</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>bool</type><methodname>ZipArchive::setEncryptionName</methodname>
   <methodparam><type>string</type><parameter>name</parameter></methodparam>
   <methodparam><type>int</type><parameter>method</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>password</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Définit la méthode de chiffrement d'une entrée définit par son nom.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>name</parameter></term>
     <listitem>
      <para>
       Nom de l'entrée.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>method</parameter></term>
     <listitem>
      <para>
       La méthode de chiffrement définit par l'une des constantes ZipArchive::EM_.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>password</parameter></term>
     <listitem>
      <para>
       Mot de passe optionnel, valeur par défaut utilisé si absent.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>password</parameter> est désormais nullable.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
    <para>
     Cet exemple crée un fichier d'archive ZIP
     <filename>test.zip</filename> et ajoute
     le fichier <filename>test.txt</filename>
     chiffré grâce à la méthode AES 256.
    </para>
    <example>
     <title>Archiver et chiffrer un fichier</title>
     <programlisting role="php">
<![CDATA[
<?php
$zip = new ZipArchive();
if ($zip->open('test.zip', ZipArchive::CREATE) === TRUE) {
    $zip->setPassword('secret');
    $zip->addFile('text.txt');
    $zip->setEncryptionName('text.txt', ZipArchive::EM_AES_256);
    $zip->close();
    echo "Ok\n";
} else {
    echo "KO\n";
}
?>
]]>
     </programlisting>
    </example>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Cette fonction est seulement disponible quand compilé contre libzip ≥ 1.2.0.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>ZipArchive::setPassword</methodname></member>
    <member><methodname>ZipArchive::setEncryptionIndex</methodname></member>
   </simplelist>
  </para>
 </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:"~/.phpdoc/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
-->