Joomla! Documentation™

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

Syntax

extract($archive, $destination, $options=array())

Parameter Name	Default Value	Description
$archive		$archive Path to ZIP archive to extract
$destination		$destination Path to extract archive into
$options	array()	$options Extraction options [unused]

Returns

boolean True if successful

Defined in

libraries/joomla/filesystem/archive/zip.php

Importing

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

Source Body

function extract($archive, $destination, $options = array ())
{
        if (! is_file($archive))
        {
                $this->set('error.message', 'Archive does not exist');
                return false;
        }

        if ($this->hasNativeSupport()) {
                return ($this->_extractNative($archive, $destination, $options))? true : JError::raiseWarning(100, $this->get('error.message'));
        } else {
                return ($this->_extract($archive, $destination, $options))? true : JError::raiseWarning(100, $this->get('error.message'));
        }
}

Examples

<CodeExamplesForm />