rararchive.setallowbroken(3) php man page | unix.com

RARARCHIVE.SETALLOWBROKEN(3)						 1					      RARARCHIVE.SETALLOWBROKEN(3)

RarArchive::setAllowBroken - Whether opening broken archives is allowed

       Object oriented style (method):

SYNOPSIS
       public bool RarArchive::setAllowBroken (bool  $allow_broken)

DESCRIPTION
       Procedural style:
       bool rar_allow_broken_set (RarArchive  $rarfile, bool  $allow_broken)

	This  method defines whether broken archives can be read or all the operations that attempt to extract the archive entries will fail. Bro-
       ken archives are archives for which no error is detected when the file is opened but an error occurs when reading the entries.

PARAMETERS
	      o $rarfile
		- A RarArchive object, opened with rar_open(3).

	      o $allow_broken
		- Whether to allow reading broken files ( TRUE) or not ( FALSE).

RETURN VALUES
	Returns TRUE or FALSE on failure. It will only fail if the file has already been closed.

EXAMPLES
       Example #1

	      Object oriented style

	      <?php
	      function retnull() { return null; }
	      $file = dirname(__FILE__) . "/multi_broken.part1.rar";
	      /* Third argument omits "volume not found" message */
	      $a = RarArchive::open($file, null, 'retnull');
	      $a->setAllowBroken(true);
	      foreach ($a->getEntries() as $e) {
		  echo "$e
";
	      }
	      var_dump(count($a));
	      ?>

	      The above example will output something similar to:

	      RarEntry for file "file1.txt" (52b28202)
	      int(1)

       Example #2

	      Procedural style

	      <?php
	      function retnull() { return null; }
	      $file = dirname(__FILE__) . "/multi_broken.part1.rar";
	      /* Third argument omits "volume not found" message */
	      $a = rar_open($file, null, 'retnull');
	      rar_allow_broken_set($a, true);
	      foreach (rar_list($a) as $e) {
		  echo "$e
";
	      }
	      var_dump(count($a));
	      ?>

SEE ALSO
       RarArchive::isBroken.

PHP Documentation Group 											      RARARCHIVE.SETALLOWBROKEN(3)