archive/php-src
1
0
Fork 0
mirror of https://github.com/php/php-src.git synced 2025-08-18 15:08:55 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Update protos.

Browse source
This commit is contained in:
Steph Fox 2008-02-25 16:27:23 +00:00
parent eaef0319d2
commit 6a63b3921e
1 changed files with 46 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

77
ext/phar/phar_object.c
View file

@ -1727,11 +1727,12 @@ static void phar_convert_to_other(phar_archive_data *source, int convert, char *
} }
/* }}} */ /* }}} */
/* {{{ proto bool Phar::convertToTar([int compression, [string extension]]) /* {{{ proto bool Phar::convertToTar([int compression, [string file_ext]])
* Convert the phar archive to the tar file format. The first parameter can * Convert a phar or phar.zip archive to the tar file format. The first
* be one of Phar::GZ or Phar::BZ2 to specify whole-file compression. The * parameter can be one of Phar::GZ or Phar::BZ2 to specify whole-file
* second parameter allows the user to determine the new filename extension * compression. The second parameter allows the user to determine the new
* (default is phar.tar). Both parameters are optional. * filename extension (default is phar.tar/phar.tar.bz2/phar.tar.gz).
* Both parameters are optional.
*/ */
PHP_METHOD(Phar, convertToTar) PHP_METHOD(Phar, convertToTar)
{ {
@ -1792,8 +1793,10 @@ PHP_METHOD(Phar, convertToTar)
} }
/* }}} */ /* }}} */
/* {{{ proto bool Phar::convertToZip() /* {{{ proto bool Phar::convertToZip([string file_ext])
* Convert the phar archive to the zip file format * Convert a phar or phar.tar archive to the zip file format. The single
* optional argument allows the user to determine the new filename extension
* (default is phar.zip).
*/ */
PHP_METHOD(Phar, convertToZip) PHP_METHOD(Phar, convertToZip)
{ {
@ -1825,11 +1828,12 @@ PHP_METHOD(Phar, convertToZip)
} }
/* }}} */ /* }}} */
/* {{{ proto bool Phar::convertToPhar([int compression, [bool rename]]) /* {{{ proto bool Phar::convertToPhar([int compression, [string file_ext]])
* Convert the phar archive to the tar file format. The first parameter can * Convert a phar.tar or phar.zip archive to the phar file format. The first
* be one of Phar::GZ or Phar::BZ2 to specify whole-file compression. The * parameter can be one of Phar::GZ or Phar::BZ2 to specify whole-file
* second parameter determines whether the filename should be changed to * compression. The second parameter allows the user to determine the new
* reflect the new type (on by default). Both parameters are optional. * filename extension (default is phar/phar.bz2/phar.gz).
* Both parameters are optional.
*/ */
PHP_METHOD(Phar, convertToPhar) PHP_METHOD(Phar, convertToPhar)
{ {
@ -1881,7 +1885,7 @@ PHP_METHOD(Phar, convertToPhar)
if (phar_obj->arc.archive->donotflush) { if (phar_obj->arc.archive->donotflush) {
zend_throw_exception_ex(spl_ce_BadMethodCallException, 0 TSRMLS_CC, zend_throw_exception_ex(spl_ce_BadMethodCallException, 0 TSRMLS_CC,
"Cannot convert phar archive to phar format, call stopBuffering() first"); "Cannot convert archive to phar format, call stopBuffering() first");
return; return;
} }
@ -1891,7 +1895,8 @@ PHP_METHOD(Phar, convertToPhar)
/* }}} */ /* }}} */
/* {{{ proto int|false Phar::isCompressed() /* {{{ proto int|false Phar::isCompressed()
* Returns Phar::GZ or PHAR::BZ2 if the entire phar archive is compressed (.tar.gz/tar.bz and so on) * Returns Phar::GZ or PHAR::BZ2 if the entire archive is compressed
* (.tar.gz/tar.bz2 and so on), or FALSE otherwise.
*/ */
PHP_METHOD(Phar, isCompressed) PHP_METHOD(Phar, isCompressed)
{ {
@ -1908,7 +1913,7 @@ PHP_METHOD(Phar, isCompressed)
/* }}} */ /* }}} */
/* {{{ proto bool Phar::delete(string entry) /* {{{ proto bool Phar::delete(string entry)
* Delete a file from within the Phar * Deletes a named file within the archive.
*/ */
PHP_METHOD(Phar, delete) PHP_METHOD(Phar, delete)
{ {
@ -1955,7 +1960,7 @@ PHP_METHOD(Phar, delete)
/* }}} */ /* }}} */
/* {{{ proto int Phar::getAlias() /* {{{ proto int Phar::getAlias()
* Returns the alias for the PHAR or NULL * Returns the alias for the Phar or NULL.
*/ */
PHP_METHOD(Phar, getAlias) PHP_METHOD(Phar, getAlias)
{ {
@ -1968,7 +1973,8 @@ PHP_METHOD(Phar, getAlias)
/* }}} */ /* }}} */
/* {{{ proto bool Phar::setAlias(string alias) /* {{{ proto bool Phar::setAlias(string alias)
* Set the alias for the PHAR * Sets the alias for a Phar archive. The default value is the full path
* to the archive.
*/ */
PHP_METHOD(Phar, setAlias) PHP_METHOD(Phar, setAlias)
{ {
@ -2055,7 +2061,7 @@ PHP_METHOD(Phar, startBuffering)
/* }}} */ /* }}} */
/* {{{ proto bool Phar::isBuffering() /* {{{ proto bool Phar::isBuffering()
* Returns whether write operations are flushing to disk immediately * Returns whether write operations are flushing to disk immediately.
*/ */
PHP_METHOD(Phar, isBuffering) PHP_METHOD(Phar, isBuffering)
{ {
@ -2066,7 +2072,7 @@ PHP_METHOD(Phar, isBuffering)
/* }}} */ /* }}} */
/* {{{ proto bool Phar::stopBuffering() /* {{{ proto bool Phar::stopBuffering()
* Save the contents of a modified phar * Saves the contents of a modified archive to disk.
*/ */
PHP_METHOD(Phar, stopBuffering) PHP_METHOD(Phar, stopBuffering)
{ {
@ -2090,7 +2096,8 @@ PHP_METHOD(Phar, stopBuffering)
/* }}} */ /* }}} */
/* {{{ proto bool Phar::setStub(string|stream stub [, int len]) /* {{{ proto bool Phar::setStub(string|stream stub [, int len])
* Change the stub of the archive * Change the stub in a phar, phar.tar or phar.zip archive to something other
* than the default. The stub *must* end with a call to __HALT_COMPILER().
*/ */
PHP_METHOD(Phar, setStub) PHP_METHOD(Phar, setStub)
{ {
@ -2138,10 +2145,17 @@ PHP_METHOD(Phar, setStub)
/* }}} */ /* }}} */
/* {{{ proto bool Phar::setDefaultStub([string index[, string webindex]]) /* {{{ proto bool Phar::setDefaultStub([string index[, string webindex]])
* Sets a stub that can be used to run a phar-based archive without the phar extension * In a pure phar archive, sets a stub that can be used to run the archive
* index is the CLI startup filename, which defaults to "index.php" * regardless of whether the phar extension is available. The first parameter
* webindex is the web startup filename and also defaults to "index.php" * is the CLI startup filename, which defaults to "index.php". The second
* (falling back to CLI behaviour) * parameter is the web startup filename and also defaults to "index.php"
* (falling back to CLI behaviour).
* Both parameters are optional.
* In a phar.zip or phar.tar archive, the default stub is used only to
* identify the archive to the extension as a Phar object. This allows the
* extension to treat phar.zip and phar.tar types as honorary phars. Since
* files cannot be loaded via this kind of stub, no parameters are accepted
* when the Phar object is zip- or tar-based.
*/ */
PHP_METHOD(Phar, setDefaultStub) PHP_METHOD(Phar, setDefaultStub)
{ {
@ -2197,10 +2211,11 @@ PHP_METHOD(Phar, setStub)
/* }}} */ /* }}} */
/* {{{ proto array Phar::setSignatureAlgorithm(int sigtype) /* {{{ proto array Phar::setSignatureAlgorithm(int sigtype)
* set the signature algorithm for a phar and apply it. The * Sets the signature algorithm for a phar and applies it. The signature
* signature algorithm must be one of Phar::MD5, Phar::SHA1, * algorithm must be one of Phar::MD5, Phar::SHA1, Phar::SHA256,
* Phar::SHA256, Phar::SHA512, or Phar::PGP (pgp not yet supported and * Phar::SHA512, or Phar::PGP (PGP is not yet supported and falls back to
* falls back to SHA-1) * SHA-1). Note that zip- and tar- based phar archives cannot support
* signatures.
*/ */
PHP_METHOD(Phar, setSignatureAlgorithm) PHP_METHOD(Phar, setSignatureAlgorithm)
{ {
@ -2256,7 +2271,7 @@ PHP_METHOD(Phar, setSignatureAlgorithm)
/* }}} */ /* }}} */
/* {{{ proto array|false Phar::getSignature() /* {{{ proto array|false Phar::getSignature()
* Return signature or false * Returns a hash signature, or FALSE if the archive is unsigned.
*/ */
PHP_METHOD(Phar, getSignature) PHP_METHOD(Phar, getSignature)
{ {
@ -2708,7 +2723,7 @@ PHP_METHOD(Phar, offsetUnset)
/* }}} */ /* }}} */
/* {{{ proto string Phar::getStub() /* {{{ proto string Phar::getStub()
* Get the pre-phar stub * Returns the stub at the head of a phar archive as a string.
*/ */
PHP_METHOD(Phar, getStub) PHP_METHOD(Phar, getStub)
{ {
@ -2795,7 +2810,7 @@ carry_on:
/* }}}*/ /* }}}*/
/* {{{ proto int Phar::hasMetaData() /* {{{ proto int Phar::hasMetaData()
* Returns whether phar has global metadata * Returns TRUE if the phar has global metadata, FALSE otherwise.
*/ */
PHP_METHOD(Phar, hasMetadata) PHP_METHOD(Phar, hasMetadata)
{ {