Docs for class JArchiveBzip2

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.

JArchiveBzip2

Description

Bzip2 format adapter for the JArchive class

since: 1.5
author: Louis Landry <louis.landry@joomla.org>

Located in /joomla/filesystem/archive/bzip2.php (line 26)

 JObject   (Subpackage Base)

 JArchiveBzip2   (Subpackage FileSystem)

Variable Summary

string $_data

Method Summary

void __construct ()

boolean extract (string $archive, string $destination, [array $options = array ()])

Variables

string $_data = null (line 32)

Bzip2 file data buffer

Inherited Variables

Inherited from JObject

JObject::$_errors

Methods

Constructor __construct (line 41)

Constructor tries to load the bz2 extension of not loaded

since: 1.5
access: protected

void __construct ()

Redefinition of:

JObject::__construct(): Class constructor, overridden in descendant classes.

extract (line 63)

Extract a Bzip2 compressed file to a given path

return: True if successful
since: 1.5
access: public

boolean extract (string $archive, string $destination, [array $options = array ()])

string $archive: Path to Bzip2 archive to extract
string $destination: Path to extract archive to
array $options: Extraction options [unused]

Inherited Methods

Inherited From JObject

JObject::JObject()
JObject::__construct()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::getPublicProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::toString()

Documentation generated on Tue, 29 Jan 2008 18:44:46 +0000 by phpDocumentor 1.3.1