rar_broken_is(3) php man page | unix.com

RAR_BROKEN_IS(3)							 1							  RAR_BROKEN_IS(3)

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

       Object oriented style (method):

SYNOPSIS
       public bool RarArchive::isBroken (void  )

DESCRIPTION
       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
	      o $rarfile
		- A RarArchive object, opened with rar_open(3).

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($file, null, '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($file, null, 'retnull');
	      var_dump(rar_broken_is($arch));
	      ?>

SEE ALSO
       RarArchive::setAllowBroken.

PHP Documentation Group 													  RAR_BROKEN_IS(3)