PHP8 RarEntry::extract
(PECL rar >= 0.1)
RarEntry::extract — 从存档中提取条目
说明
public RarEntry::extract(
string $dir,
string $filepath = "",
string $password = NULL,
bool $extended_data = false
): bool
RarEntry::extract() 提取条目的数据。 它将在指定的文件中创建新文件,其名称与条目的名称相同, 除非指定了第二个参数。有关详细信息,请参阅下文。dir
参数
dir
应提取文件的目录的路径。此参数为 当且仅当不是时才考虑。如果两者兼而有之 参数为空,解压到当前目录将是 企图。
filepath
filepath
包含目录和文件名的路径(相对或绝对路径) 提取的文件。此参数将覆盖参数和原始文件名。
dir
password
用于加密此条目的密码。如果条目未加密,则不会使用此值,并且可以 省略。如果省略此参数并加密条目,则将使用提供给 rar_open() 的密码(如果有)。如果输入了错误的密码,则显式 或通过 rar_open() 隐式,CRC 检查将失败,此方法将失败并返回
false
。 如果未提供密码,并且需要密码,则此方法将失败并返回false
。 您可以使用 RarEntry::isEncrypted() 检查条目是否加密。extended_data
如果
为 true
,则将在数据提取中设置扩展信息,例如 NTFS ACL 和 Unix 所有者信息 文件,只要它存在于存档中即可。
警告
在版本 2.0.0 之前,此函数不会处理相对 正确的路径。使用 realpath() 作为解决方法。
返回值
成功时返回 true, 或者在失败时返回 false。
更新日志
版本 | 说明 |
---|---|
PECL rar 3.0.0 | extended_data 被添加。 |
PECL rar 3.0.0 | 对具有重复条目名称的 RAR 存档的支持不再有缺陷。 |
示例
示例 #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
?>
示例 #2 如何提取存档中的所有文件:
<?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);
?>
参见
- RarEntry::getStream() - 获取条目的文件处理程序
- rar:// wapper