From a0f65747b075a351958b95cb9f69ec5146c22d90 Mon Sep 17 00:00:00 2001
From: Remi Collet <remi@php.net>
Date: Wed, 5 Apr 2017 09:15:44 +0000
Subject: [PATCH] add ZipArchive::setEncryptionIndex and
 ZipArchive::setEncryptionName (from 1.14.0)

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@342241 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/zip/versions.xml                    |   2 +
 .../zip/ziparchive/setencryptionindex.xml     |  79 +++++++++++++
 .../zip/ziparchive/setencryptionname.xml      | 107 ++++++++++++++++++
 3 files changed, 188 insertions(+)
 create mode 100644 reference/zip/ziparchive/setencryptionindex.xml
 create mode 100644 reference/zip/ziparchive/setencryptionname.xml

diff --git a/reference/zip/versions.xml b/reference/zip/versions.xml
index 1c8587d154..91a3dd4422 100644
--- a/reference/zip/versions.xml
+++ b/reference/zip/versions.xml
@@ -35,6 +35,8 @@
  <function name="ZipArchive::setCommentName" from="PHP 5 &gt;= 5.2.0, PHP 7, PECL zip &gt;= 1.4.0"/>
  <function name="ZipArchive::setCompressionIndex" from="PHP 7, PECL zip &gt;= 1.13.0"/>
  <function name="ZipArchive::setCompressionName" from="PHP 7, PECL zip &gt;= 1.13.0"/>
+ <function name="ZipArchive::setEncryptionIndex" from="PHP &gt;= 7.2, PECL zip &gt;= 1.14.0"/>
+ <function name="ZipArchive::setEncryptionName" from="PHP &gt;= 7.2, PECL zip &gt;= 1.14.0"/>
  <function name="ZipArchive::setExternalAttributesIndex" from="PHP 5 &gt;= 5.6.0, PHP 7, PECL zip &gt;= 1.12.4"/>
  <function name="ZipArchive::setExternalAttributesName" from="PHP 5 &gt;= 5.6.0, PHP 7, PECL zip &gt;= 1.12.4"/>
  <function name="ZipArchive::setPassword" from="PHP 5 &gt;= 5.6.0, PHP 7, PECL zip &gt;= 1.12.4"/>
diff --git a/reference/zip/ziparchive/setencryptionindex.xml b/reference/zip/ziparchive/setencryptionindex.xml
new file mode 100644
index 0000000000..73a9881d4a
--- /dev/null
+++ b/reference/zip/ziparchive/setencryptionindex.xml
@@ -0,0 +1,79 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 332989 $ -->
+<refentry xml:id="ziparchive.setencryptionindex" xmlns="http://docbook.org/ns/docbook">
+ <refnamediv>
+  <refname>ZipArchive::setEncryptionIndex</refname>
+  <refpurpose>Set the encryption method of an entry defined by its index</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>bool</type>
+   <methodname>ZipArchive::setEncryptionIndex</methodname>
+   <methodparam><type>int</type><parameter>index</parameter></methodparam>
+   <methodparam><type>string</type><parameter>method</parameter></methodparam>
+   <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Set the encryption method of an entry defined by its index.
+  </para>
+ </refsect1>
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>index</parameter></term>
+     <listitem>
+      <para>
+       Index of the entry.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>method</parameter></term>
+     <listitem>
+      <para>
+       The encryption method defined by one of the ZipArchive::EM_ constants.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>password</parameter></term>
+     <listitem>
+      <para>
+       Optional password, default used when missing.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.success;
+  </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
+-->
diff --git a/reference/zip/ziparchive/setencryptionname.xml b/reference/zip/ziparchive/setencryptionname.xml
new file mode 100644
index 0000000000..945b997f31
--- /dev/null
+++ b/reference/zip/ziparchive/setencryptionname.xml
@@ -0,0 +1,107 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 339282 $ -->
+<refentry xml:id="ziparchive.setencryptionname" xmlns="http://docbook.org/ns/docbook">
+ <refnamediv>
+  <refname>ZipArchive::setEncryptionName</refname>
+  <refpurpose>Set the encryption method of an entry defined by its name</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <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>string</type><parameter>password</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Set the encryption method of an entry defined by its name.
+  </para>
+ </refsect1>
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>name</parameter></term>
+     <listitem>
+      <para>
+       Name of the entry.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>method</parameter></term>
+     <listitem>
+      <para>
+       The encryption method defined by one of the ZipArchive::EM_ constants.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>password</parameter></term>
+     <listitem>
+      <para>
+       Optional password, default used when missing.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.success;
+  </para>
+ </refsect1>
+ <refsect1 role="examples">
+  &reftitle.examples;
+    <para>
+     This example creates a ZIP file archive
+     <filename>test.zip</filename> and add
+     the file <filename>test.txt</filename>
+     encrypted using the AES 256 method.
+    </para>
+    <example>
+     <title>Archive and encrypt a file</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>
+</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
+-->