PHP Unconference Europe 2015

RarArchive::isBroken

rar_broken_is

(PECL rar >= 3.0.0)

RarArchive::isBroken -- rar_broken_isTest whether an archive is broken (incomplete)

Description

Object oriented style (method):

public bool RarArchive::isBroken ( void )

Procedural style:

bool rar_broken_is ( RarArchive $rarfile )

This function determines whether an archive is incomplete, i.e., if a volume is missing or a volume is truncated.

Parameters

rarfile

A RarArchive object, opened with rar_open().

Return Values

Returns TRUE if the archive is broken, FALSE otherwise. This function may also return FALSE if the passed file has already been closed. The only way to tell the two cases apart is to enable exceptions with RarException::setUsingExceptions(); however, this should be unnecessary as a program should not operate on closed files.

Examples

Example #1 Object oriented style

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

The above example will output something similar to:

bool(true)

Example #2 Procedural style

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

See Also

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top