HTTP_Download::sendArchive

HTTP_Download::sendArchive() – オンザフライで生成されたアーカイブを送出する

Synopsis

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

Description

Archive_Tar もしくは Archive_Zip によってオンザフライで生成されたアーカイブを送出します。

パラメータ $files は、 ファイルもしくはディレクトリの配列、あるいは、 アーカイブに格納されるべきファイルもしくはディレクトリをスペースで 区切った文字列を指定できます。

パラメータ $type は以下のいずれかです。 HTTP_DOWNLOAD_TAR, HTTP_DOWNLOAD_TGZ, HTTP_DOWNLOAD_BZ2 もしくは HTTP_DOWNLOAD_ZIP

このメソッドの仕様は推奨されません。 代わりに HTTP_Download_Archive::send() を使用してください。

Parameter

  • string $name - アーカイブが持つべき名前を指定します。

  • mixed $files - ファイルもしくはディレクトリのリストを指定します。

  • string $type = - アーカイブのフォーマット (TAR, TGZ, BZ2 または ZIP) を指定します。

  • string $add_path = '' - ファイルの前に追加するパスを指定します。

  • string $strip_path = '' - ファイルから外すべきパスを指定します。

Return value

Returns TRUE on success, PEAR_Error on failure.

Note

This function should be called statically.