JArchiveBzip2/extract

The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

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 Bzip2 compressed file to a given path

[Edit Descripton]

Template:Description:JArchiveBzip2/extract

Syntax[edit]

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[edit]

boolean True if successful

Defined in[edit]

libraries/joomla/filesystem/archive/bzip2.php

Importing[edit]

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

Source Body[edit]

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[edit]

API15