update_manager_archive_extract

Versions

mediamosa-21

update_manager_archive_extract($file, $directory)

Unpack a downloaded archive file.

throws Exception on failure.

Parameters

string $project The short name of the project to download.

string $file The filename of the archive you wish to extract.

string $directory The directory you wish to extract the archive into.

Return value

Archiver The Archiver object used to extract the archive.

Related topics

Update manager file management functions.

Code

modules/update/update.manager.inc, line 659

<?php
function update_manager_archive_extract($file, $directory) {
  $archiver = archiver_get_archiver($file);
  if (!$archiver) {
    throw new Exception(t('Cannot extract %file, not a valid archive.', array ('%file' => $file)));
  }
  $archiver->extract($directory);
  return $archiver;
}
?>