Difference between revisions of "JArchiveGzip/extract"
From Joomla! Documentation
< API15:JArchiveGzip
(New page: ===Description===
Extract a Gzip compressed file to a given path
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[Description:JArchiveGzip/extract|Edit Descripton...) |
m (removing red link to edit, no existant pages) |
||
| Line 3: | Line 3: | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
| − | <nowiki>[< | + | <nowiki>[<! removed edit link to red link >]</nowiki> |
</span> | </span> | ||
| − | + | <! removed transcluded page call, red link never existed > | |
===Syntax=== | ===Syntax=== | ||
| Line 71: | Line 71: | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
| − | <nowiki>[< | + | <nowiki>[<! removed edit link to red link >]</nowiki> |
</span> | </span> | ||
| − | + | <! removed transcluded page call, red link never existed > | |
===Examples=== | ===Examples=== | ||
| Line 86: | Line 86: | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
| + | [[Category:Archived pages API15]] | ||
Revision as of 08:42, 12 May 2013
The "API15" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.
Description[edit]
Extract a Gzip compressed file to a given path
[<! removed edit link to red link >]
<! removed transcluded page call, red link never existed >
Syntax[edit]
extract($archive, $destination, $options=array())| Parameter Name | Default Value | Description |
|---|---|---|
| $archive | $archive Path to ZIP archive to extract | |
| $destination | $destination Path to extract archive to | |
| $options | array() | $options Extraction options [unused] |
Returns[edit]
boolean True if successful
Defined in[edit]
libraries/joomla/filesystem/archive/gzip.php
Importing[edit]
jimport( 'joomla.filesystem.archive.gzip' );Source Body[edit]
function extract($archive, $destination, $options = array ())
{
// Initialize variables
$this->_data = null;
if (!extension_loaded('zlib')) {
$this->set('error.message', 'Zlib Not Supported');
return JError::raiseWarning(100, $this->get('error.message'));
}
if (!$this->_data = JFile::read($archive)) {
$this->set('error.message', 'Unable to read archive');
return JError::raiseWarning(100, $this->get('error.message'));
}
$position = $this->_getFilePosition();
$buffer = gzinflate(substr($this->_data, $position, strlen($this->_data) - $position));
if (empty ($buffer)) {
$this->set('error.message', 'Unable to decompress data');
return JError::raiseWarning(100, $this->get('error.message'));
}
if (JFile::write($destination, $buffer) === false) {
$this->set('error.message', 'Unable to write archive');
return JError::raiseWarning(100, $this->get('error.message'));
}
return true;
}[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >
Examples[edit]
<CodeExamplesForm />