JArchiveBzip2
Implements \JArchiveExtractableBzip2 format adapter for the JArchive class
since |
1.5 |
---|---|
deprecated |
4.0 use the Joomla\Archive\Bzip2 class instead |
package |
Joomla.Platform |
Methods
extract
Extract a Bzip2 compressed file to a given path
extract(string $archive, string $destination, array $options = array()) : boolean
since |
1.5 |
---|---|
throws |
|
Arguments
- $archive
string
Path to Bzip2 archive to extract- $destination
string
Path to extract archive to- $options
array
Extraction options [unused]
Response
boolean
True if successful
extractStream
Method to extract archive using stream objects
extractStream(string $archive, string $destination, array $options = array()) : boolean
since |
3.6.0 |
---|
Arguments
- $archive
string
Path to Bzip2 archive to extract- $destination
string
Path to extract archive to- $options
array
Extraction options [unused]
Response
boolean
True if successful
isSupported
Tests whether this adapter can unpack files on this computer.
isSupported() : boolean
since |
2.5.0 |
---|
Response
boolean
True if supported
raiseWarning
Temporary private method to isolate JError from the extract method This code should be removed when JError is removed.
raiseWarning(integer $code, string $msg) : \JException
since |
3.6.0 |
---|---|
throws |
|
Arguments
- $code
integer
The application-internal error code for this error- $msg
string
The error message, which may also be shown the user if need be.
Response
\JException
JException instance if JError class exists
Properties
_data
Bzip2 file data buffer
since |
1.5 |
---|
Type(s)
string