JArchiveGzip
Extends \JObjectGzip 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
contributor |
Michael Slusarz [email protected] Michael Cochrane [email protected] |
---|---|
package |
Joomla.Platform |
subpackage |
FileSystem |
since |
11.1 |
Methods
__construct
Class constructor, overridden in descendant classes.
__construct(mixed $properties = null)
since |
11.1 |
---|
Arguments
- $properties
mixed
Either and associative array or another object to set the initial properties of the object.
__toString
Magic method to convert the object to a string gracefully.
__toString() : string
since |
11.1 |
---|---|
deprecated |
12.3 Classes should provide their own __toString() implementation. |
Response
string
The classname.
_getFilePosition
Get file data offset for archive
_getFilePosition() : integer
since |
11.1 |
---|
Response
integer
Data position marker for archive
def
Sets a default value if not alreay assigned
def(string $property, mixed $default = null) : mixed
since |
11.1 |
---|
Arguments
- $property
string
The name of the property.- $default
mixed
The default value.
Response
mixed
extract
Extract a Gzip compressed file to a given path
extract(string $archive, string $destination, array $options = array()) : boolean
since |
11.1 |
---|
Arguments
- $archive
string
Path to ZIP archive to extract- $destination
string
Path to extract archive to- $options
array
Extraction options [unused]
Response
boolean
True if successful
get
Returns a property of the object or the default value if the property is not set.
get(string $property, mixed $default = null) : mixed
since |
11.1 |
---|---|
see | \JObject::getProperties() |
Arguments
- $property
string
The name of the property.- $default
mixed
The default value.
Response
mixed
The value of the property.
getError
Get the most recent error message.
getError(integer $i = null, boolean $toString = true) : string
since |
11.1 |
---|---|
see | \JError |
deprecated |
12.3 JError has been deprecated |
Arguments
- $i
integer
Option error index.- $toString
boolean
Indicates if JError objects should return their error message.
Response
string
Error message
getErrors
Return all errors, if any.
getErrors() : array
since |
11.1 |
---|---|
see | \JError |
deprecated |
12.3 JError has been deprecated |
Response
array
Array of error messages or JErrors.
getProperties
Returns an associative array of object properties.
getProperties(boolean $public = true) : array
since |
11.1 |
---|---|
see | \JObject::get() |
Arguments
- $public
boolean
If true, returns only the public properties.
Response
array
isSupported
Tests whether this adapter can unpack files on this computer.
isSupported() : boolean
since |
11.3 |
---|
Response
boolean
True if supported
set
Modifies a property of the object, creating it if it does not already exist.
set(string $property, mixed $value = null) : mixed
since |
11.1 |
---|
Arguments
- $property
string
The name of the property.- $value
mixed
The value of the property to set.
Response
mixed
Previous value of the property.
setError
Add an error message.
setError(string $error) : void
since |
11.1 |
---|---|
see | \JError |
deprecated |
12.3 JError has been deprecated |
Arguments
- $error
string
Error message.
setProperties
Set the object properties based on a named array/hash.
setProperties(mixed $properties) : boolean
since |
11.1 |
---|---|
see | \JObject::set() |
Arguments
- $properties
mixed
Either an associative array or another object.
Response
boolean
toString
Converts the object to a string (the class name).
toString() : string
Properties
_flags
Gzip file flags.
since |
11.1 |
---|
Type(s)
array
_data
Gzip file data buffer
since |
11.1 |
---|
Type(s)
string
_errors
An array of error messages or Exception objects.