API15:JArchiveBzip2/extract

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.

Description

Extract a Bzip2 compressed file to a given path

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;
}

Examples

<CodeExamplesForm />