class JArchiveGzip implements JArchiveExtractable

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 https://www.horde.org

Methods

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

Extract a Gzip compressed file to a given path

static  boolean
isSupported()

Tests whether this adapter can unpack files on this computer.

integer
_getFilePosition()

Get file data offset for archive

Details

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

Extract a Gzip compressed file to a given path

Parameters

string $archive Path to archive to extract
string $destination Path to extract archive to
array $options Extraction options [may be unused]

Return Value

boolean True if successful

Exceptions

RuntimeException

static boolean isSupported()

Tests whether this adapter can unpack files on this computer.

Return Value

boolean True if supported

integer _getFilePosition()

Get file data offset for archive

Return Value

integer Data position marker for archive

Exceptions

RuntimeException