php-doc-en/reference/zip/constants.xml
Philip Olson 13339a9d26 MFB: Upgrade to the new-reference-structure
- Split reference.xml into book.xml and setup.xml
- Moved from reference.xml to book.xml:
  - The intro text (partintro), and link to constants and the new examples page
- Moved from reference.xml to setup.xml:
  - The rest: requirements, installation, configuration, and resources
- Changed the constants section to be an <appendix>
- Changed the intro ID from <extname>.intro to intro.<extname>


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@248207 c90b9560-bf6c-de11-be94-00142212c4b1
2007-12-14 02:15:26 +00:00

527 lines
10 KiB
XML

<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.6 $ -->
<appendix xml:id="zip.constants" xmlns="http://docbook.org/ns/docbook">
&reftitle.constants;
&extension.constants;
<para>
ZipArchive uses class constants. There is three types of constants,
Flags (FL_) errors (ER_) or mode (no prefix).
</para>
<variablelist>
<varlistentry>
<term>
<constant>ZIPARCHIVE::CREATE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Create the archive if it does not exist.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::OVERWRITE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Always start a new archive, this mode will overwrite the file if
it already exists.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::EXCL</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Error if archive already exists.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::CHECKCONS</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Perform additional consistency checks on the archive, and error if they fail.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::FL_NOCASE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Ignore case on name lookup
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::FL_NODIR</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Ignore directory component
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::FL_COMPRESSED</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Read compressed data
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::FL_UNCHANGED</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Use original data, ignoring changes.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::CM_DEFAULT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
better of deflate or store.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::CM_STORE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
stored (uncompressed).
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::CM_SHRINK</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
shrunk
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::CM_REDUCE_1</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
reduced with factor 1
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::CM_REDUCE_2</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
reduced with factor 2
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::CM_REDUCE_3</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
reduced with factor 3
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::CM_REDUCE_4</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
reduced with factor 4
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::CM_IMPLODE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
imploded
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::CM_DEFLATE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
deflated
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::CM_DEFLATE64</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
deflate64
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::CM_PKWARE_IMPLODE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
PKWARE imploding
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::CM_BZIP2</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
BZIP2 algorithm
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::ER_OK</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
No error.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::ER_MULTIDISK</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Multi-disk zip archives not supported.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::ER_RENAME</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Renaming temporary file failed.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::ER_CLOSE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Closing zip archive failed
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::ER_SEEK</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Seek error
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::ER_READ</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Read error
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::ER_WRITE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Write error
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::ER_CRC</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
CRC error
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::ER_ZIPCLOSED</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Containing zip archive was closed
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::ER_NOENT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
No such file.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::ER_EXISTS</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
File already exists
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::ER_OPEN</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Can't open file
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::ER_TMPOPEN</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Failure to create temporary file.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::ER_ZLIB</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Zlib error
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::ER_MEMORY</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Memory allocation failure
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::ER_CHANGED</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>
Entry has been changed
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::ER_COMPNOTSUPP</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Compression method not supported.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::ER_EOF</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Premature EOF
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::ER_INVAL</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Invalid argument
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::ER_NOZIP</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Not a zip archive
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::ER_INTERNAL</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Internal error
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::ER_INCONS</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Zip archive inconsistent
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::ER_REMOVE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Can't remove file
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ZIPARCHIVE::ER_DELETED</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Entry has been deleted
</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:"../../../../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
-->