Gzip
Implements \Joomla\Archive\ExtractableInterfaceGzip 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 slusarz@horde.org Michael Cochrane mike@graftonhall.co.nz |
---|---|
since |
1.0 |
Methods
__construct
Create a new Archive object.
__construct(array|\ArrayAccess $options = array())
since |
1.0 |
---|---|
throws |
|
Arguments
- $options
array|\ArrayAccess
An array of options
extract
Extract a Gzip compressed file to a given path
extract(string $archive, string $destination) : boolean
since |
1.0 |
---|---|
throws |
|
Arguments
- $archive
string
Path to ZIP archive to extract- $destination
string
Path to extract archive to
Response
boolean
True if successful
getFilePosition
Get file data offset for archive
getFilePosition() : integer
since |
1.0 |
---|---|
throws |
|
Response
integer
Data position marker for archive
isSupported
Tests whether this adapter can unpack files on this computer.
isSupported() : boolean
since |
1.0 |
---|
Response
boolean
True if supported
Properties
flags
Gzip file flags.
since |
1.0 |
---|
Type(s)
array
data
Gzip file data buffer
since |
1.0 |
---|
Type(s)
string
options
Holds the options array.
since |
1.0 |
---|
Type(s)
array|\ArrayAccess