mirror of
https://github.com/macintoshplus/doc-en.git
synced 2026-03-24 17:02:07 +01:00
1293 lines
32 KiB
XML
1293 lines
32 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<appendix xml:id="zip.constants" xmlns="http://docbook.org/ns/docbook">
|
|
&reftitle.constants;
|
|
&extension.constants;
|
|
|
|
<para>
|
|
<classname>ZipArchive</classname> uses class constants.
|
|
There are various types of constants, main are:
|
|
Flags (prefixed with <literal>FL_</literal>),
|
|
Global flags (prefixed with <literal>AFL_</literal>),
|
|
errors (prefixed with <literal>ER_</literal>) and
|
|
mode (no prefix).
|
|
</para>
|
|
|
|
<variablelist xml:id="ziparchive.constants.mode">
|
|
<title>Archive open modes</title>
|
|
<varlistentry xml:id="ziparchive.constants.create">
|
|
<term>
|
|
<constant>ZipArchive::CREATE</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Create the archive if it does not exist.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.overwrite">
|
|
<term>
|
|
<constant>ZipArchive::OVERWRITE</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
If archive exists, ignore its current contents.
|
|
In other words, handle it the same way as an empty archive.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="ziparchive.constants.excl">
|
|
<term>
|
|
<constant>ZipArchive::EXCL</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Error if archive already exists.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="ziparchive.constants.rdonly">
|
|
<term>
|
|
<constant>ZipArchive::RDONLY</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Open archive in read only mode.
|
|
Available as of PHP 7.4.3 and PECL zip 1.17.1, respectively,
|
|
if built against libzip ≥ 1.0.0.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="ziparchive.constants.checkcons">
|
|
<term>
|
|
<constant>ZipArchive::CHECKCONS</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Perform additional consistency checks on the archive, and error if they fail.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist xml:id="ziparchive.constants.afl">
|
|
<title>Archive global flags</title>
|
|
<varlistentry xml:id="ziparchive.constants.afl-rdonly">
|
|
<term>
|
|
<constant>ZipArchive::AFL_RDONLY</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Archive is read only, cannot be cleared.
|
|
Available as of PHP 8.3.0 and PECL zip 1.22.0, respectively,
|
|
if built against libzip ≥ 1.10.0.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.afl-is-torrentzip">
|
|
<term>
|
|
<constant>ZipArchive::AFL_IS_TORRENTZIP</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Current archive is torrentzipped.
|
|
Available as of PHP 8.3.0 and PECL zip 1.22.0, respectively,
|
|
if built against libzip ≥ 1.10.0.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.afl-want-torrentzip">
|
|
<term>
|
|
<constant>ZipArchive::AFL_WANT_TORRENTZIP</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Write archive in torrentzip format.
|
|
Available as of PHP 8.3.0 and PECL zip 1.22.0, respectively,
|
|
if built against libzip ≥ 1.10.0.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.afl-create-or-keep-file-for-empty-archive">
|
|
<term>
|
|
<constant>ZipArchive::AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Don't remove file if archive is empty.
|
|
Available as of PHP 8.3.0 and PECL zip 1.22.0, respectively,
|
|
if built against libzip ≥ 1.10.0.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist xml:id="ziparchive.constants.fl">
|
|
<title>Archive flags</title>
|
|
<varlistentry xml:id="ziparchive.constants.fl-nocase">
|
|
<term>
|
|
<constant>ZipArchive::FL_NOCASE</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Ignore case on name lookup
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.fl-nodir">
|
|
<term>
|
|
<constant>ZipArchive::FL_NODIR</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Ignore directory component
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.fl-compressed">
|
|
<term>
|
|
<constant>ZipArchive::FL_COMPRESSED</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Read compressed data
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.fl-unchanged">
|
|
<term>
|
|
<constant>ZipArchive::FL_UNCHANGED</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Use original data, ignoring changes.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.fl-recompress">
|
|
<term>
|
|
<constant>ZipArchive::FL_RECOMPRESS</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Force recompression of data.
|
|
Available as of PHP 8.0.0 and PECL zip 1.18.0.
|
|
Deprecated as of PHP 8.3.0 and PECL zip 1.22.1,
|
|
will be removed in a future version of libzip.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.fl-encrypted">
|
|
<term>
|
|
<constant>ZipArchive::FL_ENCRYPTED</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Read encrypted data (implies FL_COMPRESSED).
|
|
Available as of PHP 8.0.0 and PECL zip 1.18.0.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.fl-overwrite">
|
|
<term>
|
|
<constant>ZipArchive::FL_OVERWRITE</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
If file with name exists, overwrite (replace) it.
|
|
Available as of PHP 8.0.0 and PECL zip 1.18.0.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.fl-local">
|
|
<term>
|
|
<constant>ZipArchive::FL_LOCAL</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
In local header.
|
|
Available as of PHP 8.0.0 and PECL zip 1.18.0.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.fl-central">
|
|
<term>
|
|
<constant>ZipArchive::FL_CENTRAL</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
In central directory.
|
|
Available as of PHP 8.0.0 and PECL zip 1.18.0.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="ziparchive.constants.fl-enc-guess">
|
|
<term>
|
|
<constant>ZipArchive::FL_ENC_GUESS</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Guess string encoding (is default). Available as of PHP 7.0.8.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.fl-enc-raw">
|
|
<term>
|
|
<constant>ZipArchive::FL_ENC_RAW</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Get unmodified string. Available as of PHP 7.0.8.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.fl-enc-strict">
|
|
<term>
|
|
<constant>ZipArchive::FL_ENC_STRICT</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Follow specification strictly. Available as of PHP 7.0.8.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.fl-enc-utf-8">
|
|
<term>
|
|
<constant>ZipArchive::FL_ENC_UTF_8</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
String is UTF-8 encoded. Available as of PHP 7.0.8.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.fl-enc-cp437">
|
|
<term>
|
|
<constant>ZipArchive::FL_ENC_CP437</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
String is CP437 encoded. Available as of PHP 7.0.8.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.fl-open-file-now">
|
|
<term>
|
|
<constant>ZipArchive::FL_OPEN_FILE_NOW</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Open the file when added instead of waiting for archive to be closed.
|
|
Be aware of file descriptors consumption.
|
|
Available as of PHP 8.3.0 and PECL zip 1.22.1.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist xml:id="ziparchive.constants.cm">
|
|
<title>Compression modes</title>
|
|
<varlistentry xml:id="ziparchive.constants.cm-default">
|
|
<term>
|
|
<constant>ZipArchive::CM_DEFAULT</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
better of deflate or store.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.cm-store">
|
|
<term>
|
|
<constant>ZipArchive::CM_STORE</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
stored (uncompressed).
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.cm-shrink">
|
|
<term>
|
|
<constant>ZipArchive::CM_SHRINK</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
shrunk
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.cm-reduce-1">
|
|
<term>
|
|
<constant>ZipArchive::CM_REDUCE_1</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
reduced with factor 1
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.cm-reduce-2">
|
|
<term>
|
|
<constant>ZipArchive::CM_REDUCE_2</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
reduced with factor 2
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.cm-reduce-3">
|
|
<term>
|
|
<constant>ZipArchive::CM_REDUCE_3</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
reduced with factor 3
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.cm-reduce-4">
|
|
<term>
|
|
<constant>ZipArchive::CM_REDUCE_4</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
reduced with factor 4
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.cm-implode">
|
|
<term>
|
|
<constant>ZipArchive::CM_IMPLODE</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
imploded
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.cm-deflate">
|
|
<term>
|
|
<constant>ZipArchive::CM_DEFLATE</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
deflated
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.cm-deflate64">
|
|
<term>
|
|
<constant>ZipArchive::CM_DEFLATE64</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
deflate64
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.cm-pkware-implode">
|
|
<term>
|
|
<constant>ZipArchive::CM_PKWARE_IMPLODE</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
PKWARE imploding
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.cm-bzip2">
|
|
<term>
|
|
<constant>ZipArchive::CM_BZIP2</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
BZIP2 algorithm
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.cm-lzma">
|
|
<term>
|
|
<constant>ZipArchive::CM_LZMA</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
LZMA algorithm
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.cm-lzma2">
|
|
<term>
|
|
<constant>ZipArchive::CM_LZMA2</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
LZMA2 algorithm.
|
|
Available as of PHP 7.4.3 and PECL zip 1.16.0, respectively,
|
|
if built against libzip ≥ 1.6.0.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.cm-zstd">
|
|
<term>
|
|
<constant>ZipArchive::CM_ZSTD</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Zstandard algorithm.
|
|
Available as of PHP 8.0.0 and PECL zip 1.19.1, respectively,
|
|
if built against libzip ≥ 1.8.0.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.cm-xz">
|
|
<term>
|
|
<constant>ZipArchive::CM_XZ</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
XZ algorithm.
|
|
Available as of PHP 7.4.3 and PECL zip 1.16.1, respectively,
|
|
if built against libzip ≥ 1.6.0.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.cm-terse">
|
|
<term>
|
|
<constant>ZipArchive::CM_TERSE</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara/>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.cm-lz77">
|
|
<term>
|
|
<constant>ZipArchive::CM_LZ77</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara/>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.cm-wavpack">
|
|
<term>
|
|
<constant>ZipArchive::CM_WAVPACK</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara/>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.cm-ppmd">
|
|
<term>
|
|
<constant>ZipArchive::CM_PPMD</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara/>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist xml:id="ziparchive.constants.er">
|
|
<title>Errors</title>
|
|
<varlistentry xml:id="ziparchive.constants.er-ok">
|
|
<term>
|
|
<constant>ZipArchive::ER_OK</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
No error.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.er-multidisk">
|
|
<term>
|
|
<constant>ZipArchive::ER_MULTIDISK</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Multi-disk zip archives not supported.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.er-rename">
|
|
<term>
|
|
<constant>ZipArchive::ER_RENAME</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Renaming temporary file failed.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.er-close">
|
|
<term>
|
|
<constant>ZipArchive::ER_CLOSE</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Closing zip archive failed
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.er-seek">
|
|
<term>
|
|
<constant>ZipArchive::ER_SEEK</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Seek error
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.er-read">
|
|
<term>
|
|
<constant>ZipArchive::ER_READ</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Read error
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="ziparchive.constants.er-write">
|
|
<term>
|
|
<constant>ZipArchive::ER_WRITE</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Write error
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.er-crc">
|
|
<term>
|
|
<constant>ZipArchive::ER_CRC</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
CRC error
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.er-zipclosed">
|
|
<term>
|
|
<constant>ZipArchive::ER_ZIPCLOSED</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Containing zip archive was closed
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.er-noent">
|
|
<term>
|
|
<constant>ZipArchive::ER_NOENT</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
No such file.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.er-exists">
|
|
<term>
|
|
<constant>ZipArchive::ER_EXISTS</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
File already exists
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.er-open">
|
|
<term>
|
|
<constant>ZipArchive::ER_OPEN</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Can't open file
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.er-tmpopen">
|
|
<term>
|
|
<constant>ZipArchive::ER_TMPOPEN</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Failure to create temporary file.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.er-zlib">
|
|
<term>
|
|
<constant>ZipArchive::ER_ZLIB</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Zlib error
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="ziparchive.constants.er-memory">
|
|
<term>
|
|
<constant>ZipArchive::ER_MEMORY</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Memory allocation failure
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="ziparchive.constants.er-changed">
|
|
<term>
|
|
<constant>ZipArchive::ER_CHANGED</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Entry has been changed
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="ziparchive.constants.er-compnotsupp">
|
|
<term>
|
|
<constant>ZipArchive::ER_COMPNOTSUPP</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Compression method not supported.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.er-eof">
|
|
<term>
|
|
<constant>ZipArchive::ER_EOF</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Premature EOF
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.er-inval">
|
|
<term>
|
|
<constant>ZipArchive::ER_INVAL</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Invalid argument
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.er-nozip">
|
|
<term>
|
|
<constant>ZipArchive::ER_NOZIP</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Not a zip archive
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.er-internal">
|
|
<term>
|
|
<constant>ZipArchive::ER_INTERNAL</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Internal error
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.er-incons">
|
|
<term>
|
|
<constant>ZipArchive::ER_INCONS</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Zip archive inconsistent
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.er-remove">
|
|
<term>
|
|
<constant>ZipArchive::ER_REMOVE</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Can't remove file
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.er-deleted">
|
|
<term>
|
|
<constant>ZipArchive::ER_DELETED</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Entry has been deleted
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.er-encrnotsupp">
|
|
<term>
|
|
<constant>ZipArchive::ER_ENCRNOTSUPP</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Encryption method not supported.
|
|
Available as of PHP 7.4.3 and PECL zip 1.16.1, respectively.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.er-rdonly">
|
|
<term>
|
|
<constant>ZipArchive::ER_RDONLY</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Read-only archive.
|
|
Available as of PHP 7.4.3 and PECL zip 1.16.1, respectively.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.er-nopasswd">
|
|
<term>
|
|
<constant>ZipArchive::ER_NOPASSWD</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
No password provided.
|
|
Available as of PHP 7.4.3 and PECL zip 1.16.1, respectively.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.er-wrongpasswd">
|
|
<term>
|
|
<constant>ZipArchive::ER_WRONGPASSWD</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Wrong password provided.
|
|
Available as of PHP 7.4.3 and PECL zip 1.16.1, respectively.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.er-opnotsupp">
|
|
<term>
|
|
<constant>ZipArchive::ER_OPNOTSUPP</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Operation not supported.
|
|
Available as of PHP 7.4.3 and PECL zip 1.16.1, respectively,
|
|
if built against libzip ≥ 1.0.0.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.er-inuse">
|
|
<term>
|
|
<constant>ZipArchive::ER_INUSE</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Resource still in use.
|
|
Available as of PHP 7.4.3 and PECL zip 1.16.1, respectively,
|
|
if built against libzip ≥ 1.0.0.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.er-tell">
|
|
<term>
|
|
<constant>ZipArchive::ER_TELL</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Tell error.
|
|
Available as of PHP 7.4.3 and PECL zip 1.16.1, respectively,
|
|
if built against libzip ≥ 1.0.0.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.er-compressed-data">
|
|
<term>
|
|
<constant>ZipArchive::ER_COMPRESSED_DATA</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Compressed data invalid.
|
|
Available as of PHP 7.4.3 and PECL zip 1.16.1, respectively,
|
|
if built against libzip ≥ 1.6.0.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.er-cancelled">
|
|
<term>
|
|
<constant>ZipArchive::ER_CANCELLED</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Operation cancelled.
|
|
Available as of PHP 7.4.3 and PECL zip 1.16.1, respectively,
|
|
if built against libzip ≥ 1.6.0.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.er-data-length">
|
|
<term>
|
|
<constant>ZipArchive::ER_DATA_LENGTH</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Unexpected length of data.
|
|
Available as of PHP 8.3.0 and PECL zip 1.22.0, respectively,
|
|
if built against libzip ≥ 1.10.0.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.er-not-allowed">
|
|
<term>
|
|
<constant>ZipArchive::ER_NOT_ALLOWED</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Not allowed in torrentzip.
|
|
Available as of PHP 8.3.0 and PECL zip 1.22.0, respectively,
|
|
if built against libzip ≥ 1.10.0.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.er-truncated-zip">
|
|
<term>
|
|
<constant>ZipArchive::ER_TRUNCATED_ZIP</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Possibly truncated or corrupted zip archive.
|
|
Available as of PHP 8.4.0 and PECL zip 1.22.4, respectively,
|
|
if built against libzip ≥ 1.11.1.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist xml:id="ziparchive.constants.em">
|
|
<title>Encryption modes</title>
|
|
<varlistentry xml:id="ziparchive.constants.em-none">
|
|
<term>
|
|
<constant>ZipArchive::EM_NONE</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
No encryption. Available as of PHP 7.2.0 and PECL zip 1.14.0, respectively.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.em-trad-pkware">
|
|
<term>
|
|
<constant>ZipArchive::EM_TRAD_PKWARE</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Traditional PKWARE encryption. Available as of PHP 8.0.0 and PECL zip 1.19.0, respectively.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.em-aes-128">
|
|
<term>
|
|
<constant>ZipArchive::EM_AES_128</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
AES 128 encryption. Available as of PHP 7.2.0 and PECL zip 1.14.0, respectively,
|
|
if built against libzip ≥ 1.2.0.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.em-aes-192">
|
|
<term>
|
|
<constant>ZipArchive::EM_AES_192</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
AES 192 encryption. Available as of PHP 7.2.0 and PECL zip 1.14.0, respectively,
|
|
if built against libzip ≥ 1.2.0.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.em-aes-256">
|
|
<term>
|
|
<constant>ZipArchive::EM_AES_256</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
AES 256 encryption. Available as of PHP 7.2.0 and PECL zip 1.14.0, respectively,
|
|
if built against libzip ≥ 1.2.0.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.em-unknown">
|
|
<term>
|
|
<constant>ZipArchive::EM_UNKNOWN</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Unknown encryption algorithm. Available as of PHP 8.0.0 and PECL zip 1.19.0, respectively.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist xml:id="ziparchive.constants.length">
|
|
<title>Length parameter constants</title>
|
|
<varlistentry xml:id="ziparchive.constants.length-to-end">
|
|
<term>
|
|
<constant>ZipArchive::LENGTH_TO_END</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Use file size, if the file grows additionnal data is ignored, if the file shrinks an error is raised (<constant>ZipArchive::ER_DATA_LENGTH</constant>).
|
|
Available as of PHP 8.3.0 and PECL zip 1.22.2.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.length-unchecked">
|
|
<term>
|
|
<constant>ZipArchive::LENGTH_UNCHECKED</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Use all available data.
|
|
Available as of PHP 8.3.0 and PECL zip 1.22.2, if built against libzip ≥ 1.10.1.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist xml:id="ziparchive.constants.other">
|
|
<title>Other constants</title>
|
|
<varlistentry xml:id="ziparchive.constants.libzip-version">
|
|
<term>
|
|
<constant>ZipArchive::LIBZIP_VERSION</constant>
|
|
(<type>string</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Zip library version. Available as of PHP 7.4.3 and PECL zip 1.16.0.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist xml:id="ziparchive.constants.opsys">
|
|
<title>Operating system constants for external attributes</title>
|
|
<varlistentry xml:id="ziparchive.constants.opsys-dos">
|
|
<term>
|
|
<constant>ZipArchive::OPSYS_DOS</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara/>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.opsys-amiga">
|
|
<term>
|
|
<constant>ZipArchive::OPSYS_AMIGA</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara/>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.opsys-openvms">
|
|
<term>
|
|
<constant>ZipArchive::OPSYS_OPENVMS</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara/>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.opsys-unix">
|
|
<term>
|
|
<constant>ZipArchive::OPSYS_UNIX</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara/>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.opsys-vm-cms">
|
|
<term>
|
|
<constant>ZipArchive::OPSYS_VM_CMS</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara/>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.opsys-atari-st">
|
|
<term>
|
|
<constant>ZipArchive::OPSYS_ATARI_ST</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara/>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.opsys-os-2">
|
|
<term>
|
|
<constant>ZipArchive::OPSYS_OS_2</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara/>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.opsys-macintosh">
|
|
<term>
|
|
<constant>ZipArchive::OPSYS_MACINTOSH</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara/>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.opsys-z-system">
|
|
<term>
|
|
<constant>ZipArchive::OPSYS_Z_SYSTEM</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara/>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.opsys-cpm">
|
|
<term>
|
|
<constant>ZipArchive::OPSYS_CPM</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara/>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.opsys-windows-ntfs">
|
|
<term>
|
|
<constant>ZipArchive::OPSYS_WINDOWS_NTFS</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara/>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.opsys-mvs">
|
|
<term>
|
|
<constant>ZipArchive::OPSYS_MVS</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara/>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.opsys-vse">
|
|
<term>
|
|
<constant>ZipArchive::OPSYS_VSE</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara/>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.opsys-acorn-risc">
|
|
<term>
|
|
<constant>ZipArchive::OPSYS_ACORN_RISC</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara/>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.opsys-vfat">
|
|
<term>
|
|
<constant>ZipArchive::OPSYS_VFAT</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara/>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.opsys-alternate-mvs">
|
|
<term>
|
|
<constant>ZipArchive::OPSYS_ALTERNATE_MVS</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara/>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.opsys-beos">
|
|
<term>
|
|
<constant>ZipArchive::OPSYS_BEOS</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara/>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.opsys-tandem">
|
|
<term>
|
|
<constant>ZipArchive::OPSYS_TANDEM</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara/>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.opsys-os-4000">
|
|
<term>
|
|
<constant>ZipArchive::OPSYS_OS_400</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara/>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.opsys-os-x">
|
|
<term>
|
|
<constant>ZipArchive::OPSYS_OS_X</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara/>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="ziparchive.constants.opsys-default">
|
|
<term>
|
|
<constant>ZipArchive::OPSYS_DEFAULT</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Since PECL zip 1.12.4
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</appendix>
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|