Joomla! 1.5 API

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2011 Open Source Matters Inc and can be used in accordance with the Joomla! Electronic Documentation License. Some parts of this website may be subject to other licenses.

 Class JArchiveBzip2

Description

Bzip2 format adapter for the JArchive class

  • since: 1.5

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

Class JObject   (Subpackage Base)

Class JArchiveBzip2   (Subpackage FileSystem)
Variable Summary
Variable string $_data
Method Summary
Constructor void __construct ()
Method boolean extract (string $archive, string $destination, [array $options = array ()])
Variables
string $_data = null (line 31)

Bzip2 file data buffer

Inherited Variables

Inherited from JObject

Variable JObject::$_errors
Methods
Constructor __construct (line 40)

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 62)

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()
Support Joomla!