Class JArchiveGzip

Description

Gzip format adapter for the JArchive class

This class is inspired from and draws heavily in code and concept from the Compress package of The Horde Project <http://www.horde.org>

  • since: 11.1

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

JObject
   |
   --JArchiveGzip
Variable Summary
string $_data
array $_flags
Method Summary
static boolean isSupported ()
boolean extract (string $archive, string $destination, [array $options = array ()])
integer _getFilePosition ()
Variables
string $_data = null (line 41)

Gzip file data buffer

  • since: 11.1
  • access: private
array $_flags = array('FTEXT' => 0x01, 'FHCRC' => 0x02, 'FEXTRA' => 0x04, 'FNAME' => 0x08, 'FCOMMENT' => 0x10) (line 33)

Gzip file flags.

  • since: 11.1
  • access: private

Inherited Variables

Inherited from JObject

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

Tests whether this adapter can unpack files on this computer.

  • return: True if supported
  • since: 11.3
  • access: public
static boolean isSupported ()
extract (line 54)

Extract a Gzip 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 ZIP archive to extract
  • string $destination: Path to extract archive to
  • array $options: Extraction options [unused]
_getFilePosition (line 151)

Get file data offset for archive

  • return: Data position marker for archive
  • since: 11.1
  • access: public
integer _getFilePosition ()

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:55:14 -0500 by phpDocumentor 1.4.4