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

Generate zip methodsynopses based on stubs

Browse source 
Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>

Closes GH-302.
This commit is contained in:
Máté Kocsis 2021-01-01 20:14:24 +01:00 committed by Christoph M. Becker
parent 5453bb7d88
commit c0a030bf35
40 changed files with 188 additions and 213 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
reference/zip/functions/zip-entry-close.xml
View file

@ -10,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>zip_entry_close</methodname>
<methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam>
<methodparam><type>resource</type><parameter>zip_ent</parameter></methodparam>
</methodsynopsis>
<para>
Closes the specified directory entry.
@ -21,7 +21,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>zip_entry</parameter></term>
<term><parameter>zip_ent</parameter></term>
<listitem>
<para>
A directory entry previously opened <function>zip_entry_open</function>.
@ -73,7 +73,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

5
reference/zip/functions/zip-entry-compressedsize.xml
View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>zip_entry_compressedsize</methodname>
<type class="union"><type>int</type><type>false</type></type><methodname>zip_entry_compressedsize</methodname>
<methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam>
</methodsynopsis>
<para>
@ -34,7 +34,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The compressed size.
The compressed size, &return.falseforfailure;.
</para>
</refsect1>
@ -74,7 +74,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

5
reference/zip/functions/zip-entry-compressionmethod.xml
View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>zip_entry_compressionmethod</methodname>
<type class="union"><type>string</type><type>false</type></type><methodname>zip_entry_compressionmethod</methodname>
<methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam>
</methodsynopsis>
<para>
@ -35,7 +35,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The compression method.
The compression method, &return.falseforfailure;.
</para>
</refsect1>
@ -75,7 +75,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

5
reference/zip/functions/zip-entry-filesize.xml
View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>zip_entry_filesize</methodname>
<type class="union"><type>int</type><type>false</type></type><methodname>zip_entry_filesize</methodname>
<methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam>
</methodsynopsis>
<para>
@ -34,7 +34,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The size of the directory entry.
The size of the directory entry, &return.falseforfailure;.
</para>
</refsect1>
@ -74,7 +74,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

5
reference/zip/functions/zip-entry-name.xml
View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>zip_entry_name</methodname>
<type class="union"><type>string</type><type>false</type></type><methodname>zip_entry_name</methodname>
<methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam>
</methodsynopsis>
<para>
@ -34,7 +34,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The name of the directory entry.
The name of the directory entry, &return.falseforfailure;.
</para>
</refsect1>
@ -74,7 +74,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

9
reference/zip/functions/zip-entry-open.xml
View file

@ -9,10 +9,10 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>zip_entry_open</methodname>
<methodparam><type>resource</type><parameter>zip</parameter></methodparam>
<type>bool</type><methodname>zip_entry_open</methodname>
<methodparam><type>resource</type><parameter>zip_dp</parameter></methodparam>
<methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>mode</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>mode</parameter><initializer>"rb"</initializer></methodparam>
</methodsynopsis>
<para>
Opens a directory entry in a zip file for reading.
@ -23,7 +23,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>zip</parameter></term>
<term><parameter>zip_dp</parameter></term>
<listitem>
<para>
A valid resource handle returned by <function>zip_open</function>.
@ -107,7 +107,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

7
reference/zip/functions/zip-entry-read.xml
View file

@ -9,9 +9,9 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>zip_entry_read</methodname>
<type class="union"><type>string</type><type>false</type></type><methodname>zip_entry_read</methodname>
<methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter><initializer>1024</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>len</parameter><initializer>1024</initializer></methodparam>
</methodsynopsis>
<para>
Reads from an open directory entry.
@ -30,7 +30,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>length</parameter></term>
<term><parameter>len</parameter></term>
<listitem>
<para>
The number of bytes to return.
@ -89,7 +89,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

3
reference/zip/functions/zip-read.xml
View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>zip_read</methodname>
<type class="union"><type>resource</type><type>false</type></type><methodname>zip_read</methodname>
<methodparam><type>resource</type><parameter>zip</parameter></methodparam>
</methodsynopsis>
<para>
@ -79,7 +79,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

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

@ -9,8 +9,8 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>ZipArchive::addFile</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>entryname</parameter><initializer>&null;</initializer></methodparam>
<methodparam><type>string</type><parameter>filepath</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>entryname</parameter><initializer>""</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>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>ZipArchive::FL_OVERWRITE</initializer></methodparam>
@ -25,7 +25,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<term><parameter>filepath</parameter></term>
<listitem>
<para>
The path to the file to add.
@ -36,7 +36,7 @@
<term><parameter>entryname</parameter></term>
<listitem>
<para>
If supplied, this is the local name inside the ZIP archive that will override the <parameter>filename</parameter>.
If supplied and not empty, this is the local name inside the ZIP archive that will override the <parameter>filepath</parameter>.
</para>
</listitem>
</varlistentry>
@ -156,7 +156,6 @@ if ($zip->open('test.zip') === TRUE) {
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

5
reference/zip/ziparchive/addfromstring.xml
View file

@ -10,7 +10,7 @@
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>ZipArchive::addFromString</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>string</type><parameter>contents</parameter></methodparam>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>ZipArchive::FL_OVERWRITE</initializer></methodparam>
</methodsynopsis>
<para>
@ -31,7 +31,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>contents</parameter></term>
<term><parameter>content</parameter></term>
<listitem>
<para>
The contents to use to create the entry. It is used in a binary
@ -126,7 +126,6 @@ if ($zip->open('test.zip') === TRUE) {
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

4
reference/zip/ziparchive/addglob.xml
View file

@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="ziparchive.addglob" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ZipArchive::addGlob</refname>
@ -13,7 +12,7 @@
<modifier>public</modifier> <type class="union"><type>array</type><type>false</type></type><methodname>ZipArchive::addGlob</methodname>
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>array()</initializer></methodparam>
<methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>[]</initializer></methodparam>
</methodsynopsis>
<para>
Add files from a directory which match the glob <parameter>pattern</parameter>.
@ -203,7 +202,6 @@ if ($ret !== TRUE) {
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

4
reference/zip/ziparchive/addpattern.xml
View file

@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="ziparchive.addpattern" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ZipArchive::addPattern</refname>
@ -13,7 +12,7 @@
<modifier>public</modifier> <type class="union"><type>array</type><type>false</type></type><methodname>ZipArchive::addPattern</methodname>
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>path</parameter><initializer>"."</initializer></methodparam>
<methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>array()</initializer></methodparam>
<methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>[]</initializer></methodparam>
</methodsynopsis>
<para>
Add files from a directory which match the regular expression <parameter>pattern</parameter>.
@ -94,7 +93,6 @@ if ($ret !== TRUE) {
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

9
reference/zip/ziparchive/extractto.xml
View file

@ -9,8 +9,8 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>ZipArchive::extractTo</methodname>
<methodparam><type>string</type><parameter>destination</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>entries</parameter></methodparam>
<methodparam><type>string</type><parameter>pathto</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>array</type><type>string</type><type>null</type></type><parameter>files</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Extract the complete archive or the given files to the specified
@ -30,7 +30,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>destination</parameter></term>
<term><parameter>pathto</parameter></term>
<listitem>
<para>
Location where to extract the files.
@ -38,7 +38,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>entries</parameter></term>
<term><parameter>files</parameter></term>
<listitem>
<para>
The entries to extract. It accepts either a single entry name or
@ -94,7 +94,6 @@ if ($res === TRUE) {
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

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

@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>ZipArchive::getArchiveComment</methodname>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Returns the Zip archive comment.
@ -62,7 +62,6 @@ if ($res === TRUE) {
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

3
reference/zip/ziparchive/getcommentindex.xml
View file

@ -10,7 +10,7 @@
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>ZipArchive::getCommentIndex</methodname>
<methodparam><type>int</type><parameter>index</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Returns the comment of an entry using the entry index.
@ -66,7 +66,6 @@ if ($res === TRUE) {
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

3
reference/zip/ziparchive/getcommentname.xml
View file

@ -10,7 +10,7 @@
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>ZipArchive::getCommentName</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Returns the comment of an entry using the entry name.
@ -66,7 +66,6 @@ if ($res === TRUE) {
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

8
reference/zip/ziparchive/getexternalattributesname.xml
View file

@ -8,12 +8,11 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type>
<methodname>ZipArchive::getExternalAttributesName</methodname>
<modifier>public</modifier> <type>bool</type><methodname>ZipArchive::getExternalAttributesName</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>int</type><parameter role="reference">opsys</parameter></methodparam>
<methodparam><type>int</type><parameter role="reference">attr</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Retrieve the external attributes of an entry defined by its name.
@ -66,7 +65,6 @@
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@ -86,4 +84,4 @@ End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-->

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

@ -10,8 +10,8 @@
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>string</type><type>false</type></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>
<methodparam choice="opt"><type>int</type><parameter>len</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Returns the entry contents using its index.
@ -30,7 +30,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>length</parameter></term>
<term><parameter>len</parameter></term>
<listitem>
<para>
The length to be read from the entry. If <literal>0</literal>, then the
@ -98,7 +98,6 @@ if ($zip->open('test.zip') === TRUE) {
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

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

@ -10,8 +10,8 @@
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>string</type><type>false</type></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>
<methodparam choice="opt"><type>int</type><parameter>len</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Returns the entry contents using its name.
@ -30,7 +30,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>length</parameter></term>
<term><parameter>len</parameter></term>
<listitem>
<para>
The length to be read from the entry. If <literal>0</literal>, then the
@ -118,7 +118,6 @@ if ($z->open(dirname(__FILE__) . '/test_im.zip')) {
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

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

@ -10,7 +10,7 @@
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>ZipArchive::getNameIndex</methodname>
<methodparam><type>int</type><parameter>index</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Returns the name of an entry using its index.
@ -67,7 +67,6 @@ if ($zip->open('test.zip') == TRUE) {
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

11
reference/zip/ziparchive/getstatusstring.xml
View file

@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>ZipArchive::getStatusString</methodname>
<modifier>public</modifier> <type>string</type><methodname>ZipArchive::getStatusString</methodname>
<void/>
</methodsynopsis>
<para>
@ -24,7 +24,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a <type>string</type> with the status message on success&return.falseforfailure;.
Returns a <type>string</type> with the status message.
</para>
</refsect1>
@ -46,6 +46,12 @@
This method can be called on closed archive.
</entry>
</row>
<row>
<entry>8.0.0 / 1.18.0</entry>
<entry>
This method no longer returns &false; on failure.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
@ -53,7 +59,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

7
reference/zip/ziparchive/iscompressionmethoddupported.xml
View file

@ -9,9 +9,9 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>ZipArchive::isCompressionMethodSupported</methodname>
<modifier>public</modifier> <modifier>static</modifier> <type>bool</type><methodname>ZipArchive::isCompressionMethodSupported</methodname>
<methodparam><type>int</type><parameter>method</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>encode</parameter><initializer>true</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>enc</parameter><initializer>&true;</initializer></methodparam>
</methodsynopsis>
<para>
Check if a compression method is supported by libzip.
@ -32,7 +32,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>encode</parameter></term>
<term><parameter>enc</parameter></term>
<listitem>
<para>
If &true; check for compression, else check for decompression.
@ -70,7 +70,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

7
reference/zip/ziparchive/isencryptionmethoddupported.xml
View file

@ -9,9 +9,9 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>ZipArchive::isEncryptionMethodSupported</methodname>
<modifier>public</modifier> <modifier>static</modifier> <type>bool</type><methodname>ZipArchive::isEncryptionMethodSupported</methodname>
<methodparam><type>int</type><parameter>method</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>encode</parameter><initializer>true</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>enc</parameter><initializer>&true;</initializer></methodparam>
</methodsynopsis>
<para>
Check if a compression method is supported by libzip.
@ -32,7 +32,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>encode</parameter></term>
<term><parameter>enc</parameter></term>
<listitem>
<para>
If &true; check for encryption, else check for decryption.
@ -70,7 +70,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

3
reference/zip/ziparchive/locatename.xml
View file

@ -10,7 +10,7 @@
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>int</type><type>false</type></type><methodname>ZipArchive::locateName</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Locates an entry using its name.
@ -106,7 +106,6 @@ $zip->close();
</screen>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

136
reference/zip/ziparchive/open.xml
View file

@ -8,9 +8,9 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mixed</type><methodname>ZipArchive::open</methodname>
<modifier>public</modifier> <type class="union"><type>bool</type><type>int</type></type><methodname>ZipArchive::open</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Opens a new or existing zip archive for reading, writing or modifying.
@ -72,87 +72,60 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; on success, or one of the following error codes:
<variablelist>
<varlistentry>
<term><parameter>Error codes</parameter></term>
<listitem>
<para>
Returns &true; on success or the error code.
<itemizedlist>
<listitem>
<para>
<constant>ZipArchive::ER_EXISTS</constant>
</para>
<para>
File already exists.
</para>
</listitem>
<listitem>
<para>
<constant>ZipArchive::ER_INCONS</constant>
</para>
<para>
Zip archive inconsistent.
</para>
</listitem>
<listitem>
<para>
<constant>ZipArchive::ER_INVAL</constant>
</para>
<para>
Invalid argument.
</para>
</listitem>
<listitem>
<para>
<constant>ZipArchive::ER_MEMORY</constant>
</para>
<para>
Malloc failure.
</para>
</listitem>
<listitem>
<para>
<constant>ZipArchive::ER_NOENT</constant>
</para>
<para>
No such file.
</para>
</listitem>
<listitem>
<para>
<constant>ZipArchive::ER_NOZIP</constant>
</para>
<para>
Not a zip archive.
</para>
</listitem>
<listitem>
<para>
<constant>ZipArchive::ER_OPEN</constant>
</para>
<para>
Can't open file.
</para>
</listitem>
<listitem>
<para>
<constant>ZipArchive::ER_READ</constant>
</para>
<para>
Read error.
</para>
</listitem>
<listitem>
<para>
<constant>ZipArchive::ER_SEEK</constant>
</para>
<para>
Seek error.
</para>
</listitem>
</itemizedlist>
</para>
<term><constant>ZipArchive::ER_EXISTS</constant></term>
<listitem>
<simpara>File already exists.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>ZipArchive::ER_INCONS</constant></term>
<listitem>
<simpara>Zip archive inconsistent.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>ZipArchive::ER_INVAL</constant></term>
<listitem>
<simpara>Invalid argument.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>ZipArchive::ER_MEMORY</constant></term>
<listitem>
<simpara>Malloc failure.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>ZipArchive::ER_NOENT</constant></term>
<listitem>
<simpara>No such file.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>ZipArchive::ER_NOZIP</constant></term>
<listitem>
<simpara>Not a zip archive.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>ZipArchive::ER_OPEN</constant></term>
<listitem>
<simpara>Can't open file.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>ZipArchive::ER_READ</constant></term>
<listitem>
<simpara>Read error.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>ZipArchive::ER_SEEK</constant></term>
<listitem>
<simpara>Seek error.</simpara>
</listitem>
</varlistentry>
</variablelist>
@ -218,7 +191,6 @@ if ($res === TRUE) {
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

5
reference/zip/ziparchive/renameindex.xml
View file

@ -10,7 +10,7 @@
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>ZipArchive::renameIndex</methodname>
<methodparam><type>int</type><parameter>index</parameter></methodparam>
<methodparam><type>string</type><parameter>newname</parameter></methodparam>
<methodparam><type>string</type><parameter>new_name</parameter></methodparam>
</methodsynopsis>
<para>
Renames an entry defined by its index.
@ -29,7 +29,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>newname</parameter></term>
<term><parameter>new_name</parameter></term>
<listitem>
<para>
New name.
@ -66,7 +66,6 @@ if ($res === TRUE) {
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

5
reference/zip/ziparchive/renamename.xml
View file

@ -10,7 +10,7 @@
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>ZipArchive::renameName</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>string</type><parameter>newname</parameter></methodparam>
<methodparam><type>string</type><parameter>new_name</parameter></methodparam>
</methodsynopsis>
<para>
Renames an entry defined by its name.
@ -29,7 +29,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>newname</parameter></term>
<term><parameter>new_name</parameter></term>
<listitem>
<para>
New name.
@ -66,7 +66,6 @@ if ($res === TRUE) {
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

7
reference/zip/ziparchive/replacefile.xml
View file

@ -9,8 +9,8 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>ZipArchive::replaceFile</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam><type>int</type><parameter>index</parameter></methodparam>
<methodparam><type>string</type><parameter>filepath</parameter></methodparam>
<methodparam><type>string</type><parameter>index</parameter></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>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
@ -25,7 +25,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<term><parameter>filepath</parameter></term>
<listitem>
<para>
The path to the file to add.
@ -115,7 +115,6 @@ if ($zip->open('test.zip') === TRUE) {
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

1
reference/zip/ziparchive/setcommentindex.xml
View file

@ -67,7 +67,6 @@ if ($res === TRUE) {
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

1
reference/zip/ziparchive/setcommentname.xml
View file

@ -67,7 +67,6 @@ if ($res === TRUE) {
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

9
reference/zip/ziparchive/setcompressionindex.xml
View file

@ -10,8 +10,8 @@
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>ZipArchive::setCompressionIndex</methodname>
<methodparam><type>int</type><parameter>index</parameter></methodparam>
<methodparam><type>int</type><parameter>comp_method</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>comp_flags</parameter><initializer>0</initializer></methodparam>
<methodparam><type>int</type><parameter>method</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>compflags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Set the compression method of an entry defined by its index.
@ -30,7 +30,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>comp_method</parameter></term>
<term><parameter>method</parameter></term>
<listitem>
<para>
The compression method, one of the
@ -39,7 +39,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>comp_flags</parameter></term>
<term><parameter>compflags</parameter></term>
<listitem>
<para>
Compression level.
@ -80,7 +80,6 @@ if ($res === TRUE) {
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

9
reference/zip/ziparchive/setcompressionname.xml
View file

@ -10,8 +10,8 @@
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>ZipArchive::setCompressionName</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>int</type><parameter>comp_method</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>comp_flags</parameter><initializer>0</initializer></methodparam>
<methodparam><type>int</type><parameter>method</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>compflags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Set the compression method of an entry defined by its name.
@ -30,7 +30,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>comp_method</parameter></term>
<term><parameter>method</parameter></term>
<listitem>
<para>
The compression method, one of the
@ -39,7 +39,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>comp_flags</parameter></term>
<term><parameter>compflags</parameter></term>
<listitem>
<para>
Compression level.
@ -99,7 +99,6 @@ if ($res === TRUE) {
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

28
reference/zip/ziparchive/setencryptionindex.xml
View file

@ -8,11 +8,10 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type>
<methodname>ZipArchive::setEncryptionIndex</methodname>
<modifier>public</modifier> <type>bool</type><methodname>ZipArchive::setEncryptionIndex</methodname>
<methodparam><type>int</type><parameter>index</parameter></methodparam>
<methodparam><type>int</type><parameter>method</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>password</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Set the encryption method of an entry defined by its index.
@ -65,6 +64,28 @@
</note>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>password</parameter> is now nullable.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
@ -75,7 +96,6 @@
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

29
reference/zip/ziparchive/setencryptionname.xml
View file

@ -8,11 +8,10 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type>
<methodname>ZipArchive::setEncryptionName</methodname>
<modifier>public</modifier> <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>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>password</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Set the encryption method of an entry defined by its name.
@ -55,6 +54,29 @@
&return.success;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>password</parameter> is now nullable.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
@ -103,7 +125,6 @@ if ($zip->open('test.zip', ZipArchive::CREATE) === TRUE) {
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

8
reference/zip/ziparchive/setexternalattributesindex.xml
View file

@ -8,12 +8,11 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type>
<methodname>ZipArchive::setExternalAttributesIndex</methodname>
<modifier>public</modifier> <type>bool</type><methodname>ZipArchive::setExternalAttributesIndex</methodname>
<methodparam><type>int</type><parameter>index</parameter></methodparam>
<methodparam><type>int</type><parameter>opsys</parameter></methodparam>
<methodparam><type>int</type><parameter>attr</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Set the external attributes of an entry defined by its index.
@ -65,7 +64,6 @@
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@ -85,4 +83,4 @@ End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-->

8
reference/zip/ziparchive/setexternalattributesname.xml
View file

@ -8,12 +8,11 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type>
<methodname>ZipArchive::setExternalAttributesName</methodname>
<modifier>public</modifier> <type>bool</type><methodname>ZipArchive::setExternalAttributesName</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>int</type><parameter>opsys</parameter></methodparam>
<methodparam><type>int</type><parameter>attr</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Set the external attributes of an entry defined by its name.
@ -93,7 +92,6 @@ if (is_array($stat) && $zip->open('test.zip', ZipArchive::CREATE) === TRUE) {
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@ -113,4 +111,4 @@ End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-->

6
reference/zip/ziparchive/setmtimeindex.xml
View file

@ -8,11 +8,10 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type>
<methodname>ZipArchive::setMtimeIndex</methodname>
<modifier>public</modifier> <type class="union"><type>bool</type><type>null</type></type><methodname>ZipArchive::setMtimeIndex</methodname>
<methodparam><type>int</type><parameter>index</parameter></methodparam>
<methodparam><type>int</type><parameter>timestamp</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Set the modification time of an entry defined by its index.
@ -102,7 +101,6 @@ if ($zip->open('test.zip', ZipArchive::CREATE) === TRUE) {
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

6
reference/zip/ziparchive/setmtimename.xml
View file

@ -8,11 +8,10 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type>
<methodname>ZipArchive::setMtimeName</methodname>
<modifier>public</modifier> <type class="union"><type>bool</type><type>null</type></type><methodname>ZipArchive::setMtimeName</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>int</type><parameter>timestamp</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Set the modification time of an entry defined by its name.
@ -102,7 +101,6 @@ if ($zip->open('test.zip', ZipArchive::CREATE) === TRUE) {
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

3
reference/zip/ziparchive/statindex.xml
View file

@ -10,7 +10,7 @@
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>array</type><type>false</type></type><methodname>ZipArchive::statIndex</methodname>
<methodparam><type>int</type><parameter>index</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
The function obtains information about the entry defined by its
@ -86,7 +86,6 @@ Array
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

3
reference/zip/ziparchive/statname.xml
View file

@ -10,7 +10,7 @@
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>array</type><type>false</type></type><methodname>ZipArchive::statName</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
The function obtains information about the entry defined by its
@ -104,7 +104,6 @@ Array
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml