Class JArchiveBzip2

Description

Bzip2 format adapter for the JArchive class

  • since: 11.1

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

JObject
   |
   --JArchiveBzip2
Variable Summary
string $_data
Method Summary
static boolean isSupported ()
static void loadExtension ()
JArchiveBzip2 __construct ()
boolean extract (string $archive, string $destination, [array $options = array ()])
Variables
string $_data = null (line 29)

Bzip2 file data buffer

  • since: 11.1
  • access: private

Inherited Variables

Inherited from JObject

JObject::$_errors
Methods
static method isSupported (line 140)

Tests whether this adapter can unpack files on this computer.

  • return: True if supported
  • since: 11.3
  • access: public
static boolean isSupported ()
static method loadExtension (line 154)

Load the bzip2 extension

  • since: 11.3
  • access: private
static void loadExtension ()
Constructor __construct (line 36)

Constructor tries to load the bz2 extension if not loaded

  • since: 11.1
  • access: public
JArchiveBzip2 __construct ()

Redefinition of:
JObject::__construct()
Class constructor, overridden in descendant classes.
extract (line 52)

Extract a Bzip2 compressed file to a given path

  • return: True if successful
  • since: 11.1
  • 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::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::toString()
JObject::__toString()

Documentation generated on Mon, 25 Jun 2012 13:52:39 -0500 by phpDocumentor 1.4.4