Beschreibung

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.

Parameter-Liste

dir

Path to the directory where files should be extracted. This parameter is
considered if and only if filepath is 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
dir and 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 return FALSE.
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.

Warnung

Prior to version 2.0.0, this function would not handle relative
paths correctly. Use realpath() as a workaround.

Rückgabewerte

Gibt bei Erfolg TRUE zurück. Im Fehlerfall wird FALSE zurückgegeben.

Changelog

Version

Beschreibung

3.0.0

extended_data was added.

3.0.0

Support for RAR archives with repeated entry names is no longer defective.

Beispiele

Beispiel #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");

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.