From de6dd71a28e6323f1873900e299dd3374059b80e Mon Sep 17 00:00:00 2001
From: Christoph Michael Becker <cmb@php.net>
Date: Mon, 31 Aug 2015 23:58:07 +0000
Subject: [PATCH] documented parameters of openssl_seal()

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@337684 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/openssl/functions/openssl-seal.xml | 38 ++++++++++++++++++--
 1 file changed, 36 insertions(+), 2 deletions(-)

diff --git a/reference/openssl/functions/openssl-seal.xml b/reference/openssl/functions/openssl-seal.xml
index 7119c2f2e7..ff3d278ed0 100644
--- a/reference/openssl/functions/openssl-seal.xml
+++ b/reference/openssl/functions/openssl-seal.xml
@@ -14,11 +14,11 @@
    <methodparam><type>string</type><parameter role="reference">sealed_data</parameter></methodparam>
    <methodparam><type>array</type><parameter role="reference">env_keys</parameter></methodparam>
    <methodparam><type>array</type><parameter>pub_key_ids</parameter></methodparam>
-   <methodparam choice="opt"><type>string</type><parameter>method</parameter></methodparam>
+   <methodparam choice="opt"><type>string</type><parameter>method</parameter><initializer>"RC4"</initializer></methodparam>
   </methodsynopsis>
   <para>
    <function>openssl_seal</function> seals (encrypts)
-   <parameter>data</parameter> by using RC4 with a randomly generated
+   <parameter>data</parameter> by using the given <parameter>method</parameter> with a randomly generated
    secret key. The key is encrypted with each of the public keys
    associated with the identifiers in <parameter>pub_key_ids</parameter>
    and each encrypted key is returned
@@ -37,6 +37,7 @@
      <term><parameter>data</parameter></term>
      <listitem>
       <para>
+       The data to seal.
       </para>
      </listitem>
     </varlistentry>
@@ -44,6 +45,7 @@
      <term><parameter>sealed_data</parameter></term>
      <listitem>
       <para>
+       The sealed data.
       </para>
      </listitem>
     </varlistentry>
@@ -51,6 +53,7 @@
      <term><parameter>env_keys</parameter></term>
      <listitem>
       <para>
+       Array of encrypted keys.
       </para>
      </listitem>
     </varlistentry>
@@ -58,6 +61,15 @@
      <term><parameter>pub_key_ids</parameter></term>
      <listitem>
       <para>
+       Array of public key resource identifiers.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>method</parameter></term>
+     <listitem>
+      <para>
+       The cipher method.
       </para>
      </listitem>
     </varlistentry>
@@ -110,6 +122,28 @@ openssl_free_key($pk2);
   </para>
  </refsect1>
 
+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <informaltable>
+   <tgroup cols="2">
+    <thead>
+     <row>
+      <entry>&Version;</entry>
+      <entry>&Description;</entry>
+     </row>
+    </thead>
+    <tbody>
+     <row>
+      <entry>5.3.0</entry>
+      <entry>
+       The <parameter>method</parameter> parameter was added.
+      </entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </informaltable>
+ </refsect1>
+
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>