Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2008 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5. Some parts of this website may be subject to other licenses.

Class JArchive

Description
Description | Methods (details)

An Archive handling class

  • since: 1.5

Located in /joomla/filesystem/archive.php (line 23) 

Class JArchive   (Subpackage FileSystem)
Method Summary
Description | Methods (details)
Method void create (string $archive, mixed $files, [string $compress = 'tar'], [string $addPath = ''], [string $removePath = ''], [boolean $autoExt = false], [boolean $cleanUp = false])
Method boolean extract (string $archivename, string $extractdir)
Method void &getAdapter ( $type)
Methods
Description | Methods (details)
create (line 169)
void create (string $archive, mixed $files, [string $compress = 'tar'], [string $addPath = ''], [string $removePath = ''], [boolean $autoExt = false], [boolean $cleanUp = false])
  • string $archive: The name of the archive
  • mixed $files: The name of a single file or an array of files
  • string $compress: The compression for the archive
  • string $addPath: Path to add within the archive
  • string $removePath: Path to remove within the archive
  • boolean $autoExt: Automatically append the extension for the archive
  • boolean $cleanUp: Remove for source files
extract (line 30)
  • return: True for success
boolean extract (string $archivename, string $extractdir)
  • string $archivename: The name of the archive file
  • string $extractdir: Directory to unpack into
getAdapter (line 132)
void &getAdapter ( $type)
  • $type
Documentation generated on Tue, 29 Jan 2008 18:44:16 +0000 by phpDocumentor 1.3.1