Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Developer Network License

The Joomla! Developer Network content is © copyright 2006 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5

 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>

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

Class JObject   (Subpackage Base)

Class JArchiveGzip   (Subpackage FileSystem)
Variable Summary
Variable string $_data
Variable array $_flags
Method Summary
Method boolean extract (string $archive, string $destination, [array $options = array ()])
Variables
string $_data = null (line 50)

Gzip file data buffer

array $_flags = array (
'FTEXT' => 0x01,
'FHCRC' => 0x02,
'FEXTRA' => 0x04,
'FNAME' => 0x08,
'FCOMMENT' => 0x10
)
(line 38)

Gzip file flags.

Methods
extract (line 62)

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

Get file data offset for archive

  • return: Data position marker for archive
  • since: 1.5
  • access: public
int _getFilePosition ()

Inherited Methods

Inherited From JObject

 JObject::JObject()
 JObject::__construct()
 JObject::get()
 JObject::getPublicProperties()
 JObject::set()
 JObject::toString()

Documentation generated on Mon, 05 Mar 2007 21:05:14 +0000 by phpDocumentor 1.3.1