Gzip

Implements ExtractableInterface

Gzip format adapter for the Archive package

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

contributor

Michael Slusarz [email protected]

Michael Cochrane [email protected]

since

1.0

package

Joomla Framework

Methods

__construct

Create a new Archive object.

__construct(array|\ArrayAccess options = []) : mixed
since

1.0

throws

\InvalidArgumentException

Arguments

options

array|\ArrayAccessAn array of options

Response

mixed

extract

Extract a Gzip compressed file to a given path

extract(string archive, string destination) : bool
since

1.0

throws

\RuntimeException

Arguments

archive

stringPath to ZIP archive to extract

destination

stringPath to extract archive to

Response

boolTrue if successful

getFilePosition

Get file data offset for archive

getFilePosition() : int
since

1.0

throws

\RuntimeException

Response

intData position marker for archive

isSupported

Tests whether this adapter can unpack files on this computer.

isSupported() : bool
static
since

1.0

Response

boolTrue if supported

Constants

FLAGS

Gzip file flags.

Value ['FTEXT' => 0x1, 'FHCRC' => 0x2, 'FEXTRA' => 0x4, 'FNAME' => 0x8, 'FCOMMENT' => 0x10]
since

1.0

Type(s)

array

Properties

data

Gzip file data buffer

since

1.0

Type(s)

string

options

Holds the options array.

since

1.0

Type(s)

array|\ArrayAccess