Archive class - Documentation for SproutCMS

Info Page:

Page options:

class Archive

Class for creating archives in various formats - zip, tar.bz2, etc

Name	Visibility	Description
`$driver`
`$paths`

Name	Visibility	Description
__construct	public	Loads the archive driver.
add	public	Adds files or directories, recursively, to an archive.
create	public	Creates a raw archive file and returns it.
save	public	Creates an archive and saves it into a file.

void $Archive->__construct ( [ string $type ] );

Loads the archive driver.

object $Archive->add ( string $path [, string $name [, bool $recursive ]] );

Adds files or directories, recursively, to an archive.

string $Archive->create ( );

Creates a raw archive file and returns it.

boolean $Archive->save ( string $filename );

Creates an archive and saves it into a file.