<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Predefined Constants</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="zip.resources.html">Resource Types</a></div>
<div class="next" style="text-align: right; float: right;"><a href="zip.examples.html">Examples</a></div>
<div class="up"><a href="book.zip.html">Zip</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="zip.constants" class="appendix">
<h1>Predefined Constants</h1>
<p class="simpara">
The constants below are defined by this extension, and
will only be available when the extension has either
been compiled into PHP or dynamically loaded at runtime.
</p>
<p class="para">
<a href="class.ziparchive.html" class="classname">ZipArchive</a> uses class constants.
There are three types of constants :
Flags (prefixed with <em>FL_</em>),
errors (prefixed with <em>ER_</em>) and
mode (no prefix).
</p>
<dl>
<dt id="ziparchive.constants.create">
<span class="term">
<strong><code>ZipArchive::CREATE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Create the archive if it does not exist.
</span>
</dd>
</dt>
<dt id="ziparchive.constants.overwrite">
<span class="term">
<strong><code>ZipArchive::OVERWRITE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Always start a new archive, this mode will overwrite the file if
it already exists.
</span>
</dd>
</dt>
<dt id="ziparchive.constants.excl">
<span class="term">
<strong><code>ZipArchive::EXCL</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Error if archive already exists.
</span>
</dd>
</dt>
<dt id="ziparchive.constants.checkcons">
<span class="term">
<strong><code>ZipArchive::CHECKCONS</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Perform additional consistency checks on the archive, and error if they fail.
</span>
</dd>
</dt>
<dt id="ziparchive.constants.fl-nocase">
<span class="term">
<strong><code>ZipArchive::FL_NOCASE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Ignore case on name lookup
</span>
</dd>
</dt>
<dt id="ziparchive.constants.fl-nodir">
<span class="term">
<strong><code>ZipArchive::FL_NODIR</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Ignore directory component
</span>
</dd>
</dt>
<dt id="ziparchive.constants.fl-compressed">
<span class="term">
<strong><code>ZipArchive::FL_COMPRESSED</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Read compressed data
</span>
</dd>
</dt>
<dt id="ziparchive.constants.fl-unchanged">
<span class="term">
<strong><code>ZipArchive::FL_UNCHANGED</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Use original data, ignoring changes.
</span>
</dd>
</dt>
<dt id="ziparchive.constants.cm-default">
<span class="term">
<strong><code>ZipArchive::CM_DEFAULT</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
better of deflate or store.
</span>
</dd>
</dt>
<dt id="ziparchive.constants.cm-store">
<span class="term">
<strong><code>ZipArchive::CM_STORE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
stored (uncompressed).
</span>
</dd>
</dt>
<dt id="ziparchive.constants.cm-shrink">
<span class="term">
<strong><code>ZipArchive::CM_SHRINK</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
shrunk
</span>
</dd>
</dt>
<dt id="ziparchive.constants.cm-reduce-1">
<span class="term">
<strong><code>ZipArchive::CM_REDUCE_1</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
reduced with factor 1
</span>
</dd>
</dt>
<dt id="ziparchive.constants.cm-reduce-2">
<span class="term">
<strong><code>ZipArchive::CM_REDUCE_2</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
reduced with factor 2
</span>
</dd>
</dt>
<dt id="ziparchive.constants.cm-reduce-3">
<span class="term">
<strong><code>ZipArchive::CM_REDUCE_3</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
reduced with factor 3
</span>
</dd>
</dt>
<dt id="ziparchive.constants.cm-reduce-4">
<span class="term">
<strong><code>ZipArchive::CM_REDUCE_4</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
reduced with factor 4
</span>
</dd>
</dt>
<dt id="ziparchive.constants.cm-implode">
<span class="term">
<strong><code>ZipArchive::CM_IMPLODE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
imploded
</span>
</dd>
</dt>
<dt id="ziparchive.constants.cm-deflate">
<span class="term">
<strong><code>ZipArchive::CM_DEFLATE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
deflated
</span>
</dd>
</dt>
<dt id="ziparchive.constants.cm-deflate64">
<span class="term">
<strong><code>ZipArchive::CM_DEFLATE64</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
deflate64
</span>
</dd>
</dt>
<dt id="ziparchive.constants.cm-pkware-implode">
<span class="term">
<strong><code>ZipArchive::CM_PKWARE_IMPLODE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
PKWARE imploding
</span>
</dd>
</dt>
<dt id="ziparchive.constants.cm-bzip2">
<span class="term">
<strong><code>ZipArchive::CM_BZIP2</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
BZIP2 algorithm
</span>
</dd>
</dt>
<dt id="ziparchive.constants.er-ok">
<span class="term">
<strong><code>ZipArchive::ER_OK</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
No error.
</span>
</dd>
</dt>
<dt id="ziparchive.constants.er-multidisk">
<span class="term">
<strong><code>ZipArchive::ER_MULTIDISK</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Multi-disk zip archives not supported.
</span>
</dd>
</dt>
<dt id="ziparchive.constants.er-rename">
<span class="term">
<strong><code>ZipArchive::ER_RENAME</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Renaming temporary file failed.
</span>
</dd>
</dt>
<dt id="ziparchive.constants.er-close">
<span class="term">
<strong><code>ZipArchive::ER_CLOSE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Closing zip archive failed
</span>
</dd>
</dt>
<dt id="ziparchive.constants.er-seek">
<span class="term">
<strong><code>ZipArchive::ER_SEEK</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Seek error
</span>
</dd>
</dt>
<dt id="ziparchive.constants.er-read">
<span class="term">
<strong><code>ZipArchive::ER_READ</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Read error
</span>
</dd>
</dt>
<dt id="ziparchive.constants.er-write">
<span class="term">
<strong><code>ZipArchive::ER_WRITE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Write error
</span>
</dd>
</dt>
<dt id="ziparchive.constants.er-crc">
<span class="term">
<strong><code>ZipArchive::ER_CRC</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
CRC error
</span>
</dd>
</dt>
<dt id="ziparchive.constants.er-zipclosed">
<span class="term">
<strong><code>ZipArchive::ER_ZIPCLOSED</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Containing zip archive was closed
</span>
</dd>
</dt>
<dt id="ziparchive.constants.er-noent">
<span class="term">
<strong><code>ZipArchive::ER_NOENT</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
No such file.
</span>
</dd>
</dt>
<dt id="ziparchive.constants.er-exists">
<span class="term">
<strong><code>ZipArchive::ER_EXISTS</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
File already exists
</span>
</dd>
</dt>
<dt id="ziparchive.constants.er-open">
<span class="term">
<strong><code>ZipArchive::ER_OPEN</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Can't open file
</span>
</dd>
</dt>
<dt id="ziparchive.constants.er-tmpopen">
<span class="term">
<strong><code>ZipArchive::ER_TMPOPEN</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Failure to create temporary file.
</span>
</dd>
</dt>
<dt id="ziparchive.constants.er-zlib">
<span class="term">
<strong><code>ZipArchive::ER_ZLIB</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Zlib error
</span>
</dd>
</dt>
<dt id="ziparchive.constants.er-memory">
<span class="term">
<strong><code>ZipArchive::ER_MEMORY</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Memory allocation failure
</span>
</dd>
</dt>
<dt id="ziparchive.constants.er-changed">
<span class="term">
<strong><code>ZipArchive::ER_CHANGED</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Entry has been changed
</span>
</dd>
</dt>
<dt id="ziparchive.constants.er-compnotsupp">
<span class="term">
<strong><code>ZipArchive::ER_COMPNOTSUPP</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Compression method not supported.
</span>
</dd>
</dt>
<dt id="ziparchive.constants.er-eof">
<span class="term">
<strong><code>ZipArchive::ER_EOF</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Premature EOF
</span>
</dd>
</dt>
<dt id="ziparchive.constants.er-inval">
<span class="term">
<strong><code>ZipArchive::ER_INVAL</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Invalid argument
</span>
</dd>
</dt>
<dt id="ziparchive.constants.er-nozip">
<span class="term">
<strong><code>ZipArchive::ER_NOZIP</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Not a zip archive
</span>
</dd>
</dt>
<dt id="ziparchive.constants.er-internal">
<span class="term">
<strong><code>ZipArchive::ER_INTERNAL</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Internal error
</span>
</dd>
</dt>
<dt id="ziparchive.constants.er-incons">
<span class="term">
<strong><code>ZipArchive::ER_INCONS</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Zip archive inconsistent
</span>
</dd>
</dt>
<dt id="ziparchive.constants.er-remove">
<span class="term">
<strong><code>ZipArchive::ER_REMOVE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Can't remove file
</span>
</dd>
</dt>
<dt id="ziparchive.constants.er-deleted">
<span class="term">
<strong><code>ZipArchive::ER_DELETED</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Entry has been deleted
</span>
</dd>
</dt>
</dl>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="zip.resources.html">Resource Types</a></div>
<div class="next" style="text-align: right; float: right;"><a href="zip.examples.html">Examples</a></div>
<div class="up"><a href="book.zip.html">Zip</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
