document phar class constants

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@260021 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Greg Beaver 2008-05-19 21:57:30 +00:00
parent 65ed510145
commit e90291b5fe

View file

@ -1,9 +1,213 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<appendix xml:id="phar.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.constants;
&no.constants;
&extension.constants;
<table>
<title>Phar compression constants</title>
<tgroup cols="3">
<thead>
<row>
<entry>Constant</entry>
<entry>Value</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<constant>Phar::NONE</constant>
(<type>integer</type>)
</entry>
<entry>0x00000000</entry>
<entry>no compression</entry>
</row>
<row>
<entry>
<constant>Phar::COMPRESSED</constant>
(<type>integer</type>)
</entry>
<entry>0x0000F000</entry>
<entry>bitmask that can be used with file flags to determine if any compression is present</entry>
</row>
<row>
<entry>
<constant>Phar::GZ</constant>
(<type>integer</type>)
</entry>
<entry>0x00001000</entry>
<entry>zlib (gzip) compression</entry>
</row>
<row>
<entry>
<constant>Phar::BZ2</constant>
(<type>integer</type>)
</entry>
<entry>0x00002000</entry>
<entry>bzip2 compression</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>Phar file format constants</title>
<tgroup cols="3">
<thead>
<row>
<entry>Constant</entry>
<entry>Value</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<constant>Phar::SAME</constant>
(<type>integer</type>)
</entry>
<entry>0</entry>
<entry>retain the same file format</entry>
</row>
<row>
<entry>
<constant>Phar::PHAR</constant>
(<type>integer</type>)
</entry>
<entry>1</entry>
<entry>phar file format</entry>
</row>
<row>
<entry>
<constant>Phar::TAR</constant>
(<type>integer</type>)
</entry>
<entry>2</entry>
<entry>tar file format</entry>
</row>
<row>
<entry>
<constant>Phar::ZIP</constant>
(<type>integer</type>)
</entry>
<entry>3</entry>
<entry>zip file format</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>Phar signature constants</title>
<tgroup cols="3">
<thead>
<row>
<entry>Constant</entry>
<entry>Value</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<constant>Phar::MD5</constant>
(<type>integer</type>)
</entry>
<entry>0x0001</entry>
<entry>signature with md5 hash algorithm</entry>
</row>
<row>
<entry>
<constant>Phar::SHA1</constant>
(<type>integer</type>)
</entry>
<entry>0x0002</entry>
<entry>signature with sha1 hash algorithm</entry>
</row>
<row>
<entry>
<constant>Phar::SHA256</constant>
(<type>integer</type>)
</entry>
<entry>0x0003</entry>
<entry>signature with sha256 hash algorithm (requires hash extension)</entry>
</row>
<row>
<entry>
<constant>Phar::SHA512</constant>
(<type>integer</type>)
</entry>
<entry>0x0004</entry>
<entry>signature with sha512 hash algorithm (requires hash extension)</entry>
</row>
<row>
<entry>
<constant>Phar::PGP</constant>
(<type>integer</type>)
</entry>
<entry>0x0010</entry>
<entry>signature with PGP (unimplemented)</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>Phar webPhar mime override constants</title>
<tgroup cols="3">
<thead>
<row>
<entry>Constant</entry>
<entry>Value</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<constant>Phar::PHP</constant>
(<type>integer</type>)
</entry>
<entry>1</entry>
<entry>used to instruct the <variable>mimeoverrides</variable> parameter
of <function>Phar::webPhar</function> that the extension should be
parsed as a PHP file</entry>
</row>
<row>
<entry>
<constant>Phar::PHPS</constant>
(<type>integer</type>)
</entry>
<entry>2</entry>
<entry>used to instruct the <variable>mimeoverrides</variable> parameter
of <function>Phar::webPhar</function> that the extension should be
parsed as a PHP source file through <function>highlight_file</function></entry>
</row>
<row>
<entry>
<constant>Phar::SHA256</constant>
(<type>integer</type>)
</entry>
<entry>0x0003</entry>
<entry>signature with sha256 hash algorithm (requires hash extension)</entry>
</row>
<row>
<entry>
<constant>Phar::SHA512</constant>
(<type>integer</type>)
</entry>
<entry>0x0004</entry>
<entry>signature with sha512 hash algorithm (requires hash extension)</entry>
</row>
<row>
<entry>
<constant>Phar::PHP</constant>
(<type>integer</type>)
</entry>
<entry>0x0010</entry>
<entry>signature with PGP (unimplemented)</entry>
</row>
</tbody>
</tgroup>
</table>
</appendix>
<!-- Keep this comment at the end of the file