Rar::extract

Extract entry from the archive ()

Rar {
  bool extract(string dir,
               string filepath);
}

Rar::extract() extracts entry's data to the dir. It will create new file in the specified dir with the name identical to the entry's name.

Parameters

dir: Path to the directory where files should be extracted.
filepath: If parameter filepath is specified instead dir, Rar::extract() will extract entry's data to the specified file.

Return Values

Returns TRUE on success or FALSE on failure.

Examples

Example 2056. Rar::extract() example

copy to clipboard

<?php


$rar_file = rar_open('example.rar') or die("Failed to open Rar archive");

$entry = rar_entry_get($rar_file, 'Dir/file.txt') or die("Failed to find such entry");

$entry->extract('/dir/to'); // create /dir/to/Dir/file.txt
$entry->extract(false, '/dir/to/new_name.txt'); // create /dir/to/new_name.txt

?>

Example 2057. How to extract all files in archive:

copy to clipboard

<?php

/* example by Erik Jenssen aka erix */

$filename = "foobar.rar";
$filepath = "/home/foo/bar/";

$rar_file = rar_open($filepath.$filename);
$list = rar_list($rar_file);

foreach($list as $file) {

    $entry = rar_entry_get($rar_file, $file);

    $entry->extract("."); // extract to the current dir
}
rar_close($rar_file);

?>

Code Examples / Notes » rar_extract

lubomir stefanov

One edit for function by Erik Jenssen Line $entry = rar_entry_get($rar_file, $file); must be $entry = rar_entry_get($rar_file, $file->name); because $file is a object

christian boisjoli

As remarked by Lubomir Stefanov, example 2026 has an error. Another way to correct this error would be to replace the foreach loop as follows: <?php foreach($list as $entry) { $entry->extract("."); // extract to the current dir } ?>