rararchive(3) [php man page]

RARARCHIVE(3)								 1							     RARARCHIVE(3)

The RarArchive class

INTRODUCTION

	This  class  represents  a  RAR  archive, which may be formed by several volumes (parts) and which contains a number of RAR entries (i.e.,
       files, directories and other special objects such as symbolic links).

	Objects of this class can be traversed, yielding the entries stored in the respective RAR archive. Those  entries  can	also  be  obtained
       through RarArchive::getEntry and RarArchive::getEntries.

CLASS SYNOPSIS

       RarArchive

       final
       RarArchiveTraversable

       Methods

       o public bool RarArchive::close (void  )

       o public string RarArchive::getComment (void  )

       o public array RarArchive::getEntries (void  )

       o public RarEntry RarArchive::getEntry (string  $entryname)

       o public bool RarArchive::isBroken (void  )

       o public bool RarArchive::isSolid (void	)

       o publicstatic RarArchive RarArchive::open (string  $filename, [string  $password = NULL], [callable  $volume_callback = NULL])

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

       o public string RarArchive::__toString (void  )

PHP Documentation Group 													     RARARCHIVE(3)

RAR_LIST(3)								 1							       RAR_LIST(3)

RarArchive::getEntries - Get full list of entries from the RAR archive

       Object oriented style (method):

SYNOPSIS

       public array RarArchive::getEntries (void  )

DESCRIPTION

       Procedural style:
       array rar_list (RarArchive  $rarfile)

	Get entries list (files and directories) from the RAR archive.

       Note

	       If  the	archive has entries with the same name, this method, together with RarArchive foreach iteration and array-like access with
	      numeric indexes, are the only ones to access all the entries (i.e., RarArchive::getEntry and the rar:// wrapper are insufficient).

PARAMETERS

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

RETURN VALUES

       rar_list(3) returns array of RarEntry objects or FALSE on failure.

CHANGELOG

       +--------+---------------------------------------------------+
       |Version |						    |
       |	|						    |
       |	|		     Description		    |
       |	|						    |
       +--------+---------------------------------------------------+
       | 3.0.0	|						    |
       |	|						    |
       |	|  Support for RAR  archives  with  repeated  entry |
       |	| names is no longer defective. 		    |
       |	|						    |
       +--------+---------------------------------------------------+
EXAMPLES

       Example #1

	      Object oriented style

	      <?php
	      $rar_arch = RarArchive::open('solid.rar');
	      if ($rar_arch === FALSE)
		  die("Could not open RAR archive.");

	      $rar_entries = $rar_arch->getEntries();
	      if ($rar_entries === FALSE)
		  die("Could retrieve entries.");

	      echo "Found " . count($rar_entries) . " entries.
";

	      foreach ($rar_entries as $e) {
		  echo $e;
		  echo "
";
	      }
	      $rar_arch->close();
	      ?>

	      The above example will output something similar to:

	      Found 2 entries.
	      RarEntry for file "tese.txt" (23b93a7a)
	      RarEntry for file "unrardll.txt" (2ed64b6e)

       Example #2

	      Procedural style

	      <?php
	      $rar_arch = rar_open('solid.rar');
	      if ($rar_arch === FALSE)
		  die("Could not open RAR archive.");

	      $rar_entries = rar_list($rar_arch);
	      if ($rar_entries === FALSE)
		  die("Could retrieve entries.");

	      echo "Found " . count($rar_entries) . " entries.
";

	      foreach ($rar_entries as $e) {
		  echo $e;
		  echo "
";
	      }
	      rar_close($rar_arch);
	      ?>

SEE ALSO

       RarArchive::getEntry, rar:// wrapper.

PHP Documentation Group 													       RAR_LIST(3)