RarEntry::extract
(PECL rar >= 0.1)
RarEntry::extract — Extract entry from the archive
Description
$dir
[, string $filepath = ""
[, string $password = NULL
[, bool $extended_data = false
]]] )
RarEntry::extract() extracts the entry's data.
It will create new file in the specified
dir with the name identical to the entry's name,
unless the second argument is specified. See below for more information.
Parameters
-
dir -
Path to the directory where files should be extracted. This parameter is considered if and only if
filepathis not. If both parameters are empty an extraction to the current directory will be attempted. -
filepath -
Path (relative or absolute) containing the directory and filename of the extracted file. This parameter overrides both the parameter
dirand the original file name. -
password -
The password used to encrypt this entry. If the entry is not encrypted, this value will not be used and can be omitted. If this parameter is omitted and the entry is encrypted, the password given to rar_open(), if any, will be used. If a wrong password is given, either explicitly or implicitly via rar_open(), CRC checking will fail and this method will fail and return
FALSE. If no password is given and one is required, this method will fail and returnFALSE. You can check whether an entry is encrypted with RarEntry::isEncrypted(). -
extended_data -
If
TRUE, extended information such as NTFS ACLs and Unix owner information will be set in the extract files, as long as it's present in the archive.
Prior to version 2.0.0, this function would not handle relative paths correctly. Use realpath() as a workaround.
Return Values
Returns TRUE on success or FALSE on failure.
Changelog
| Version | Description |
|---|---|
| 3.0.0 |
extended_data was added.
|
| 3.0.0 | Support for RAR archives with repeated entry names is no longer defective. |
Examples
Example #1 RarEntry::extract() example
<?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 #2 How to extract all files in archive:
<?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);
?>
- PHP Руководство
- Функции по категориям
- Индекс функций
- Справочник функций
- Расширения для сжатия и архивации
- Архивирование Rar
- Функция RarEntry::extract() - Извлекает элемент из архива
- Функция RarEntry::getAttr() - Возвращает атрибуты элемента архива
- Функция RarEntry::getCrc() - Возвращает CRC элемента архива
- Функция RarEntry::getFileTime() - Возвращает последнее время изменения элемента
- Функция RarEntry::getHostOs() - Возвращает оригинальную ОС элемента
- Функция RarEntry::getMethod() - Возвращает метод компрессии элемента
- Функция RarEntry::getName() - Возвращает имя элемента
- Функция RarEntry::getPackedSize() - Возвращает размер сжатого элемента
- Функция RarEntry::getStream() - Get file handler for entry
- Функция RarEntry::getUnpackedSize() - Возвращает размер элемента в распакованном состоянии
- Функция RarEntry::getVersion() - Возвращает минимальную версию программы RAR, необходимую для распаковки элемента
- Функция RarEntry::isDirectory() - Test whether an entry represents a directory
- Функция RarEntry::isEncrypted() - Test whether an entry is encrypted
- Функция RarEntry::__toString() - Get text representation of entry
Коментарии
If the entry to extract is a directory as per RarEntry::isDirectory(), this method does not seem to extract the entries below that directory as one might expect from using the command-line RAR or WinRAR.Example #2 has a mistake.
This one works fine:
<?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->getName());
$entry->extract("."); // extract to the current dir
}
rar_close($rar_file);
?>