HTTP_Download::sendArchive

HTTP_Download::sendArchive() -- Send an archive created on the fly

Synopsis

mixed HTTP_Download::sendArchive ( string $name , mixed $files , string $type = HTTP_DOWNLOAD_TGZ , string $add_path = '' , string $strip_path = '' )

Description

Send an archive created on the fly by Archive_Tar or Archive_Zip.

The parameter $files can be an array of files/directories or a space separated string of files/directories which should be packed to an archive.

The parameter $type can be one of HTTP_DOWNLOAD_TAR, HTTP_DOWNLOAD_TGZ, HTTP_DOWNLOAD_BZ2 and HTTP_DOWNLOAD_ZIP.

Note: The usage of this method is deprecated. Use HTTP_Download_Archive::send() instead.

Parameter

string $name - the name the archive should have
mixed $files - list of files/directories
string $type = HTTP_DOWNLOAD_TGZ - the format of the archive (TAR, TGZ, BZ2 or ZIP)
string $add_path = '' - path that should be prepended to the files
string $strip_path = '' - path that should be stripped from the files

Return value

Returns TRUE on success, PEAR_Error on failure.

Note

This function should be called statically.