apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]

Class: HTTP_Download_Archive

Source Location: /HTTP_Download-1.1.0RC3/Download/Archive.php

Class Overview


HTTP_Download_Archive


Author(s):

Version:

  • $Revision: 1.3 $

Methods


Inherited Variables

Inherited Methods


Class Details

[line 42]
HTTP_Download_Archive

Helper class for sending Archives.

  • Version: $Revision: 1.3 $
  • Access: public


[ Top ]


Method Detail

send   [line 69]

mixed send( string $name, mixed $files, [string $type = HTTP_DOWNLOAD_TGZ], [string $add_path = ''], [string $strip_path = ''])

Send a bunch of files or directories as an archive

Example:


1 require_once 'HTTP/Download/Archive.php';
2 HTTP_Download_Archive::send(
3 'myArchive.tgz',
4 '/var/ftp/pub/mike',
5 HTTP_DOWNLOAD_BZ2,
6 '',
7 '/var/ftp/pub'
8 );

  • Return: Returns true on success or PEAR_Error on failure.
  • Access: public
  • Static: This method can be called statically
  • See: Archive_Tar::createModify()

Parameters:

string   $name     name the sent archive should have
mixed   $files     files/directories
string   $type     archive type
string   $add_path     path that should be prepended to the files
string   $strip_path     path that should be stripped from the files

[ Top ]


Documentation generated on Mon, 01 Aug 2005 04:37:27 -0400 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.