php-doc-en/reference/zip/constants.xml
2017-04-05 09:59:31 +00:00

700 lines
17 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 three types of constants :
Flags (prefixed with <literal>FL_</literal>),
errors (prefixed with <literal>ER_</literal>) and
mode (no prefix).
</para>
<variablelist>
<varlistentry xml:id="ziparchive.constants.create">
<term>
<constant>ZipArchive::CREATE</constant>
(<type>integer</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>integer</type>)
</term>
<listitem>
<simpara>
Always start a new archive, this mode will overwrite the file if
it already exists.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ziparchive.constants.excl">
<term>
<constant>ZipArchive::EXCL</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Error if archive already exists.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ziparchive.constants.checkcons">
<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 xml:id="ziparchive.constants.fl-nocase">
<term>
<constant>ZipArchive::FL_NOCASE</constant>
(<type>integer</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>integer</type>)
</term>
<listitem>
<simpara>
Ignore directory component
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ziparchive.constants.fl-compressed">
<term>
<constant>ZipArchive::FL_COMPRESSED</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Read compressed data
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ziparchive.constants.fl-unchanged">
<term>
<constant>ZipArchive::FL_UNCHANGED</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Use original data, ignoring changes.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ziparchive.constants.fl-enc-guess">
<term>
<constant>ZipArchive::FL_ENC_GUESS</constant>
(<type>integer</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>integer</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>integer</type>)
</term>
<listitem>
<simpara>
Follow specification strictly. Available as of PHP 7.0.8.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ziparchive.constants.fl-enc-utf8">
<term>
<constant>ZipArchive::FL_ENC_UTF_8</constant>
(<type>integer</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>integer</type>)
</term>
<listitem>
<simpara>
String is CP437 encoded. Available as of PHP 7.0.8.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ziparchive.constants.cm-default">
<term>
<constant>ZipArchive::CM_DEFAULT</constant>
(<type>integer</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>integer</type>)
</term>
<listitem>
<simpara>
stored (uncompressed).
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ziparchive.constants.cm-shrink">
<term>
<constant>ZipArchive::CM_SHRINK</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
shrunk
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ziparchive.constants.cm-reduce-1">
<term>
<constant>ZipArchive::CM_REDUCE_1</constant>
(<type>integer</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>integer</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>integer</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>integer</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>integer</type>)
</term>
<listitem>
<simpara>
imploded
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ziparchive.constants.cm-deflate">
<term>
<constant>ZipArchive::CM_DEFLATE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
deflated
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ziparchive.constants.cm-deflate64">
<term>
<constant>ZipArchive::CM_DEFLATE64</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
deflate64
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ziparchive.constants.cm-pkware-implode">
<term>
<constant>ZipArchive::CM_PKWARE_IMPLODE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
PKWARE imploding
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ziparchive.constants.cm-bzip2">
<term>
<constant>ZipArchive::CM_BZIP2</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
BZIP2 algorithm
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ziparchive.constants.er-ok">
<term>
<constant>ZipArchive::ER_OK</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
No error.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ziparchive.constants.er-multidisk">
<term>
<constant>ZipArchive::ER_MULTIDISK</constant>
(<type>integer</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>integer</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>integer</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>integer</type>)
</term>
<listitem>
<simpara>
Seek error
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ziparchive.constants.er-read">
<term>
<constant>ZipArchive::ER_READ</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Read error
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ziparchive.constants.er-write">
<term>
<constant>ZipArchive::ER_WRITE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Write error
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ziparchive.constants.er-crc">
<term>
<constant>ZipArchive::ER_CRC</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
CRC error
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ziparchive.constants.er-zipclosed">
<term>
<constant>ZipArchive::ER_ZIPCLOSED</constant>
(<type>integer</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>integer</type>)
</term>
<listitem>
<simpara>
No such file.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ziparchive.constants.er-exists">
<term>
<constant>ZipArchive::ER_EXISTS</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
File already exists
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ziparchive.constants.er-open">
<term>
<constant>ZipArchive::ER_OPEN</constant>
(<type>integer</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>integer</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>integer</type>)
</term>
<listitem>
<simpara>
Zlib error
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ziparchive.constants.er-memory">
<term>
<constant>ZipArchive::ER_MEMORY</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Memory allocation failure
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ziparchive.constants.er-changed">
<term>
<constant>ZipArchive::ER_CHANGED</constant>
(<type>string</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>integer</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>integer</type>)
</term>
<listitem>
<simpara>
Premature EOF
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ziparchive.constants.er-inval">
<term>
<constant>ZipArchive::ER_INVAL</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Invalid argument
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ziparchive.constants.er-nozip">
<term>
<constant>ZipArchive::ER_NOZIP</constant>
(<type>integer</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>integer</type>)
</term>
<listitem>
<simpara>
Internal error
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ziparchive.constants.er-incons">
<term>
<constant>ZipArchive::ER_INCONS</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Zip archive inconsistent
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ziparchive.constants.er-remove">
<term>
<constant>ZipArchive::ER_REMOVE</constant>
(<type>integer</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>integer</type>)
</term>
<listitem>
<simpara>
Entry has been deleted
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ziparchive.constants.em-none">
<term>
<constant>ZipArchive::EM_NONE</constant> (<type>integer</type>)
</term>
<listitem>
<simpara>
No encryption, since PHP 7.2.0, PECL zip 1.14.0
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ziparchive.constants.em-aez-128">
<term>
<constant>ZipArchive::EM_AES_128</constant> (<type>integer</type>)
</term>
<listitem>
<simpara>
AES 128 encryption, since PHP 7.2.0, PECL zip 1.14.0
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ziparchive.constants.em-aez-192">
<term>
<constant>ZipArchive::EM_AES_192</constant> (<type>integer</type>)
</term>
<listitem>
<simpara>
AES 1192 encryption, since PHP 7.2.0, PECL zip 1.14.0
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ziparchive.constants.em-aes256">
<term>
<constant>ZipArchive::EM_AES_256</constant> (<type>integer</type>)
</term>
<listitem>
<simpara>
AES 256 encryption, since PHP 7.2.0, PECL zip 1.14.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.default">
<term>
<constant>ZipArchive::OPSYS_DOS</constant> (<type>integer</type>)
</term>
<term>
<constant>ZipArchive::OPSYS_AMIGA</constant> (<type>integer</type>)
</term>
<term>
<constant>ZipArchive::OPSYS_OPENVMS</constant> (<type>integer</type>)
</term>
<term>
<constant>ZipArchive::OPSYS_UNIX</constant> (<type>integer</type>)
</term>
<term>
<constant>ZipArchive::OPSYS_VM_CMS</constant> (<type>integer</type>)
</term>
<term>
<constant>ZipArchive::OPSYS_ATARI_ST</constant> (<type>integer</type>)
</term>
<term>
<constant>ZipArchive::OPSYS_OS_2</constant> (<type>integer</type>)
</term>
<term>
<constant>ZipArchive::OPSYS_MACINTOSH</constant> (<type>integer</type>)
</term>
<term>
<constant>ZipArchive::OPSYS_Z_SYSTEM</constant> (<type>integer</type>)
</term>
<term>
<constant>ZipArchive::OPSYS_CPM</constant> (<type>integer</type>)
</term>
<term>
<constant>ZipArchive::OPSYS_WINDOWS_NTFS</constant> (<type>integer</type>)
</term>
<term>
<constant>ZipArchive::OPSYS_MVS</constant> (<type>integer</type>)
</term>
<term>
<constant>ZipArchive::OPSYS_VSE</constant> (<type>integer</type>)
</term>
<term>
<constant>ZipArchive::OPSYS_ACORN_RISC</constant> (<type>integer</type>)
</term>
<term>
<constant>ZipArchive::OPSYS_VFAT</constant> (<type>integer</type>)
</term>
<term>
<constant>ZipArchive::OPSYS_ALTERNATE_MVS</constant> (<type>integer</type>)
</term>
<term>
<constant>ZipArchive::OPSYS_BEOS</constant> (<type>integer</type>)
</term>
<term>
<constant>ZipArchive::OPSYS_TANDEM</constant> (<type>integer</type>)
</term>
<term>
<constant>ZipArchive::OPSYS_OS_400</constant> (<type>integer</type>)
</term>
<term>
<constant>ZipArchive::OPSYS_OS_X</constant> (<type>integer</type>)
</term>
<term>
<constant>ZipArchive::OPSYS_DEFAULT</constant> (<type>integer</type>)
</term>
<listitem>
<simpara>
Since PHP 5.6.0, 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
-->