sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

ZipArchive reflection and parameter parsing now match, and so should the documentation. Fixes docbug aspects to bug #53166

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@307780 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Richard Quadling 2011-01-27 11:55:38 +00:00
parent fd4b7c3eb3
commit 0ce32446dc
6 changed files with 65 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
reference/zip/ziparchive/addfile.xml
View file

@ -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,7 +34,23 @@
<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>

16
reference/zip/ziparchive/getarchivecomment.xml
View file

@ -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">

10
reference/zip/ziparchive/getfromindex.xml
View file

@ -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>
@ -28,6 +29,15 @@
</para>
</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>

10
reference/zip/ziparchive/getfromname.xml
View file

@ -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>
@ -28,6 +29,15 @@
</para>
</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>

10
reference/zip/ziparchive/getnameindex.xml
View file

@ -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>

2
reference/zip/ziparchive/unchangeall.xml
View file

@ -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.