RarArchive::isBroken

rar_broken_is

(PECL rar >= 3.0.0)

RarArchive::isBroken -- rar_broken_is — アーカイブが壊れている (未完成である) かどうかを調べる

説明

オブジェクト指向型 (メソッド)

public RarArchive::isBroken(): bool

手続き型:

rar_broken_is(RarArchive $rarfile): bool

この関数は、アーカイブが不完全である (ボリュームがなかったり、ボリュームが途中で終わっていたりする) かどうかを調べます。

パラメータ

rarfile: rar_open() でオープンした RarArchive オブジェクト。

戻り値

アーカイブが壊れている場合に true、壊れていない場合に false を返します。この関数は、渡されたファイルがすでに閉じている場合にも false を返します。どちらの原因かを特定するには exceptions with RarException::setUsingExceptions() で例外を有効にするしかありませんが、普通は閉じたファイルを操作することはないのでこれは不要なはずです。

例

例1 オブジェクト指向型

<?php
function retnull() { return null; }
$file = dirname(__FILE__) . "/multi_broken.part1.rar";
/* Third argument is used to omit notice */
$arch = RarArchive::open($file, null, 'retnull');
var_dump($arch->isBroken());
?>

上の例の出力は、たとえば以下のようになります。

bool(true)

例2 手続き型

<?php
function retnull() { return null; }
$file = dirname(__FILE__) . "/multi_broken.part1.rar";
/* Third argument is used to omit notice */
$arch = rar_open($file, null, 'retnull');
var_dump(rar_broken_is($arch));
?>

参考

RarArchive::setAllowBroken() - 壊れたアーカイブのオープンを許可するかどうかを設定する