Patch php_zip.c__Reflection__Documentation for Zip Related Bug #53166

Patch version 2010-12-07 14:08 UTC

Obsolete patches:

• php_zip.c__Reflection__Documentation, revision 2010-12-07 14:06 UTC

• 2010-12-07 14:08 UTC [diff to current]
• 2010-12-07 14:06 UTC [diff to current]

Developer: rquadling@php.net

Index: ziparchive/addfile.xml
===================================================================
--- ziparchive/addfile.xml	(revision 306051)
+++ ziparchive/addfile.xml	(working copy)
@@ -10,7 +10,9 @@
   <methodsynopsis>
    <type>bool</type><methodname>ZipArchive::addFile</methodname>
    <methodparam><type>string</type><parameter>filename</parameter></methodparam>
-   <methodparam choice="opt"><type>string</type><parameter>localname</parameter></methodparam>
+   <methodparam choice="opt"><type>string</type><parameter>localname</parameter><initializer>&null;</initializer></methodparam>
+   <methodparam choice="opt"><type>int</type><parameter>start</parameter><initializer>0</initializer></methodparam>
+   <methodparam choice="opt"><type>int</type><parameter>length</parameter><initializer>0</initializer></methodparam>
   </methodsynopsis>
   <para>
    Adds a file to a ZIP archive from a given path.
@@ -32,10 +34,26 @@
      <term><parameter>localname</parameter></term>
      <listitem>
       <para>
-       local name inside ZIP archive.
+       If supplied, this is the local name inside the ZIP archive that will override the <parameter>filename</parameter>.
       </para>
      </listitem>
     </varlistentry>
+    <varlistentry>
+     <term><parameter>start</parameter></term>
+     <listitem>
+      <para>
+       This parameter is not used but is required to allow subclassing of <classname>ZipArchive</classname>.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>length</parameter></term>
+     <listitem>
+      <para>
+       This parameter is not used but is required to allow subclassing of <classname>ZipArchive</classname>.
+      </para>
+     </listitem>
+    </varlistentry>
    </variablelist>
   </para>
  </refsect1>
Index: ziparchive/getarchivecomment.xml
===================================================================
--- ziparchive/getarchivecomment.xml	(revision 306051)
+++ ziparchive/getarchivecomment.xml	(working copy)
@@ -9,7 +9,7 @@
   &reftitle.description;
   <methodsynopsis>
    <type>string</type><methodname>ZipArchive::getArchiveComment</methodname>
-   <void/>
+   <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
   </methodsynopsis>
   <para>
    Returns the Zip archive comment.
@@ -18,7 +18,19 @@
 
  <refsect1 role="parameters">
   &reftitle.parameters;
-  &no.function.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>flags</parameter></term>
+     <listitem>
+      <para>
+       If flags is set to <constant>ZIPARCHIVE::FL_UNCHANGED</constant>, the original unchanged
+       comment is returned.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
  </refsect1>
 
  <refsect1 role="returnvalues">
Index: ziparchive/getfromindex.xml
===================================================================
--- ziparchive/getfromindex.xml	(revision 306051)
+++ ziparchive/getfromindex.xml	(working copy)
@@ -10,6 +10,7 @@
   <methodsynopsis>
    <type>mixed</type><methodname>ZipArchive::getFromIndex</methodname>
    <methodparam><type>int</type><parameter>index</parameter></methodparam>
+   <methodparam choice="opt"><type>int</type><parameter>length</parameter><initializer>0</initializer></methodparam>
    <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
   </methodsynopsis>
   <para>
@@ -29,6 +30,15 @@
      </listitem>
     </varlistentry>
     <varlistentry>
+     <term><parameter>length</parameter></term>
+     <listitem>
+      <para>
+       The length to be read from the entry. If <literal>0</literal>, then the
+       entire entry is read.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
      <term><parameter>flags</parameter></term>
      <listitem>
       <para>
Index: ziparchive/getfromname.xml
===================================================================
--- ziparchive/getfromname.xml	(revision 306051)
+++ ziparchive/getfromname.xml	(working copy)
@@ -10,6 +10,7 @@
   <methodsynopsis>
    <type>mixed</type><methodname>ZipArchive::getFromName</methodname>
    <methodparam><type>string</type><parameter>name</parameter></methodparam>
+   <methodparam choice="opt"><type>int</type><parameter>length</parameter><initializer>0</initializer></methodparam>
    <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
   </methodsynopsis>
   <para>
@@ -29,6 +30,15 @@
      </listitem>
     </varlistentry>
     <varlistentry>
+     <term><parameter>length</parameter></term>
+     <listitem>
+      <para>
+       The length to be read from the entry. If <literal>0</literal>, then the
+       entire entry is read.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
      <term><parameter>flags</parameter></term>
      <listitem>
       <para>
Index: ziparchive/getnameindex.xml
===================================================================
--- ziparchive/getnameindex.xml	(revision 306051)
+++ ziparchive/getnameindex.xml	(working copy)
@@ -10,6 +10,7 @@
   <methodsynopsis>
    <type>string</type><methodname>ZipArchive::getNameIndex</methodname>
    <methodparam><type>int</type><parameter>index</parameter></methodparam>
+   <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
   </methodsynopsis>
   <para>
    Returns the name of an entry using its index.
@@ -27,6 +28,15 @@
       </para>
      </listitem>
     </varlistentry>
+    <varlistentry>
+     <term><parameter>flags</parameter></term>
+     <listitem>
+      <para>
+       If flags is set to <constant>ZIPARCHIVE::FL_UNCHANGED</constant>, the original unchanged
+       name is returned.
+      </para>
+     </listitem>
+    </varlistentry>
    </variablelist>
   </para>
  </refsect1>
Index: ziparchive/unchangeall.xml
===================================================================
--- ziparchive/unchangeall.xml	(revision 306051)
+++ ziparchive/unchangeall.xml	(working copy)
@@ -9,7 +9,7 @@
   &reftitle.description;
   <methodsynopsis>
    <type>mixed</type><methodname>ZipArchive::unchangeAll</methodname>
-    <void/>
+   <void/>
   </methodsynopsis>
   <para>
    Undo all changes done in the archive.