Actions

API15

Difference between revisions of "JArchiveBzip2/extract"

From Joomla! Documentation

< API15:JArchiveBzip2
(New page: ===Description=== Extract a Bzip2 compressed file to a given path <span class="editsection" style="font-size:76%;"> <nowiki>[</nowiki>[[Description:JArchiveBzip2/extract|Edit Descript...)
 
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>[[Description:JArchiveBzip2/extract|Edit Descripton]]<nowiki>]</nowiki>
+
<nowiki>[<! removed edit link to red link >]</nowiki>
 
</span>
 
</span>
  
{{Description:JArchiveBzip2/extract}}
+
<! removed transcluded page call, red link never existed >
  
 
===Syntax===
 
===Syntax===
Line 70: Line 70:
  
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[SeeAlso:JArchiveBzip2/extract|Edit See Also]]<nowiki>]</nowiki>
+
<nowiki>[<! removed edit link to red link >]</nowiki>
 
</span>
 
</span>
{{SeeAlso:JArchiveBzip2/extract}}
+
<! removed transcluded page call, red link never existed >
  
 
===Examples===
 
===Examples===
Line 85: Line 85:
 
  format= ,,,
 
  format= ,,,
 
</dpl>
 
</dpl>
 +
[[Category:Archived pages API15]]

Latest revision as of 08:42, 12 May 2013

Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Contents

Description

Extract a Bzip2 compressed file to a given path

[<! removed edit link to red link >]

<! removed transcluded page call, red link never existed >

Syntax

extract($archive, $destination, $options=array())
Parameter Name Default Value Description
$archive $archive Path to Bzip2 archive to extract
$destination $destination Path to extract archive to
$options array() $options Extraction options [unused]

Returns

boolean True if successful

Defined in

libraries/joomla/filesystem/archive/bzip2.php

Importing

jimport( 'joomla.filesystem.archive.bzip2' );

Source Body

function extract($archive, $destination, $options = array ())
{
        // Initialize variables
        $this->_data = null;
 
        if (!extension_loaded('bz2')) {
                $this->set('error.message', 'BZip2 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'));
        }
 
        $buffer = bzdecompress($this->_data);
        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

<CodeExamplesForm />