API16:JArchiveBzip2/extract

The "API16" 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

Extract a Bzip2 compressed file to a given path

<! 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 ())
{
        // Initialise variables.
        $this->_data = null;

        if (!extension_loaded('bz2')) {
                $this->set('error.message', 'BZip2 Not Supported');
                return JError::raiseWarning(100, $this->get('error.message'));
        }

        /* // old style: read the whole file and then parse it
        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);
        unset($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'));
        }
        //*/

        // New style! streams!
        $input =& JFactory::getStream();
        $input->set('processingmethod','bz'); // use bzip
        if(!$input->open($archive)) {
                $this->set('error.message', 'Unable to read archive (bz2)');
                return JError::raiseWarning(100, $this->get('error.message'));
        }

        $output =& JFactory::getStream();
        if(!$output->open($destination, 'w')) {
                $this->set('error.message', 'Unable to write archive (bz2)');
                $input->close(); // close the previous file
                return JError::raiseWarning(100, $this->get('error.message'));
        }

        $written = 0;
        do {
                $this->_data = $input->read($input->get('chunksize', 8196));
                if($this->_data) {
                        if(!$output->write($this->_data)) {
                                $this->set('error.message', 'Unable to write file (bz2)');
                                return JError::raiseWarning(100, $this->get('error.message'));
                        }
                }
        } while ($this->_data);
        $output->close();
        $input->close();
        return true;
}

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

Examples

<CodeExamplesForm />