svn: /phpdoc/en/trunk/reference/zip/ziparchive/ addfile.xml getarchivecomment.xml getfromindex.xml getfromname.xml getnameindex.xml unchangeall.xml
| From: | Richard Quadling | Date: | Thu, 27 Jan 2011 11:55:38 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/zip/ziparchive/ addfile.xml getarchivecomment.xml getfromindex.xml getfromname.xml getnameindex.xml unchangeall.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-7686@lists.php.net to get a copy of this message | ||
rquadling Thu, 27 Jan 2011 11:55:38 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=307780
Log:
ZipArchive reflection and parameter parsing now match, and so should the documentation. Fixes docbug
aspects to bug #53166
Bug: http://bugs.php.net/53166 (Closed)
ZipArchive::addFile() is missing parameters in docs
Changed paths:
U phpdoc/en/trunk/reference/zip/ziparchive/addfile.xml
U phpdoc/en/trunk/reference/zip/ziparchive/getarchivecomment.xml
U phpdoc/en/trunk/reference/zip/ziparchive/getfromindex.xml
U phpdoc/en/trunk/reference/zip/ziparchive/getfromname.xml
U phpdoc/en/trunk/reference/zip/ziparchive/getnameindex.xml
U phpdoc/en/trunk/reference/zip/ziparchive/unchangeall.xml
Modified: phpdoc/en/trunk/reference/zip/ziparchive/addfile.xml
===================================================================
--- phpdoc/en/trunk/reference/zip/ziparchive/addfile.xml 2011-01-27 11:47:31 UTC (rev 307779)
+++ phpdoc/en/trunk/reference/zip/ziparchive/addfile.xml 2011-01-27 11:55:38 UTC (rev 307780)
@@ -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 subclasses to
<classname>ZipArchive</classname>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>length</parameter></term>
+ <listitem>
+ <para>
+ This parameter is not used but is required to subclasses to
<classname>ZipArchive</classname>.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
</para>
</refsect1>
Modified: phpdoc/en/trunk/reference/zip/ziparchive/getarchivecomment.xml
===================================================================
--- phpdoc/en/trunk/reference/zip/ziparchive/getarchivecomment.xml 2011-01-27 11:47:31 UTC (rev
307779)
+++ phpdoc/en/trunk/reference/zip/ziparchive/getarchivecomment.xml 2011-01-27 11:55:38 UTC (rev
307780)
@@ -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">
Modified: phpdoc/en/trunk/reference/zip/ziparchive/getfromindex.xml
===================================================================
--- phpdoc/en/trunk/reference/zip/ziparchive/getfromindex.xml 2011-01-27 11:47:31 UTC (rev 307779)
+++ phpdoc/en/trunk/reference/zip/ziparchive/getfromindex.xml 2011-01-27 11:55:38 UTC (rev 307780)
@@ -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>
Modified: phpdoc/en/trunk/reference/zip/ziparchive/getfromname.xml
===================================================================
--- phpdoc/en/trunk/reference/zip/ziparchive/getfromname.xml 2011-01-27 11:47:31 UTC (rev 307779)
+++ phpdoc/en/trunk/reference/zip/ziparchive/getfromname.xml 2011-01-27 11:55:38 UTC (rev 307780)
@@ -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>
Modified: phpdoc/en/trunk/reference/zip/ziparchive/getnameindex.xml
===================================================================
--- phpdoc/en/trunk/reference/zip/ziparchive/getnameindex.xml 2011-01-27 11:47:31 UTC (rev 307779)
+++ phpdoc/en/trunk/reference/zip/ziparchive/getnameindex.xml 2011-01-27 11:55:38 UTC (rev 307780)
@@ -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>
Modified: phpdoc/en/trunk/reference/zip/ziparchive/unchangeall.xml
===================================================================
--- phpdoc/en/trunk/reference/zip/ziparchive/unchangeall.xml 2011-01-27 11:47:31 UTC (rev 307779)
+++ phpdoc/en/trunk/reference/zip/ziparchive/unchangeall.xml 2011-01-27 11:55:38 UTC (rev 307780)
@@ -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.