rar_comment_get(3) [php man page]

RAR_COMMENT_GET(3)							 1							RAR_COMMENT_GET(3)

RarArchive::getComment - Get comment text from the RAR archive

       Object oriented style (method):

SYNOPSIS

       public string RarArchive::getComment (void  )

DESCRIPTION

       Procedural style:
       string rar_comment_get (RarArchive  $rarfile)

	Get the (global) comment stored in the RAR archive. It may be up to 64 KiB long.

       Note

	       This extension does not support comments at the entry level.

PARAMETERS

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

RETURN VALUES

	Returns the comment or NULL if there is none.

       Note

	       RAR has currently no support for unicode comments. The encoding of the result of this function is not specified, but it will proba-
	      bly be Windows-1252.

EXAMPLES

       Example #1

	      Object oriented style

	      <?php
	      $rar_arch = RarArchive::open('commented.rar');
	      echo $rar_arch->getComment();
	      ?>

	      The above example will output something similar to:

	      This is the comment of the file commented.rar.

       Example #2

	      Procedural style

	      <?php
	      $rar_arch = rar_open('commented.rar');
	      echo rar_comment_get($rar_arch);
	      ?>

PHP Documentation Group 													RAR_COMMENT_GET(3)

RAR_ENTRY_GET(3)							 1							  RAR_ENTRY_GET(3)

RarArchive::getEntry - Get entry object from the RAR archive

       Object oriented style (method):

SYNOPSIS

       public RarEntry RarArchive::getEntry (string  $entryname)

DESCRIPTION

       Procedural style:
       RarEntry rar_entry_get (RarArchive  $rarfile, string  $entryname)

	Get entry object (file or directory) from the RAR archive.

       Note

	      You can also get entry objects using RarArchive::getEntries.

	      Note that a RAR archive can have multiple entries with the same name; this method will retrieve only the first.

PARAMETERS

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

	      o $entryname
		- Path to the entry within the RAR archive.

	      Note

		     The path must be the same returned by RarEntry::getName.

RETURN VALUES

	Returns the matching RarEntry object or FALSE on failure.

EXAMPLES

       Example #1

	      Object oriented style

	      <?php
	      $rar_arch = RarArchive::open('solid.rar');
	      if ($rar_arch === FALSE)
		  die("Could not open RAR archive.");
	      $rar_entry = $rar_arch->getEntry('tese.txt');
	      if ($rar_entry === FALSE)
		  die("Could get such entry");
	      echo get_class($rar_entry)."
";
	      echo $rar_entry;
	      $rar_arch->close();
	      ?>

	      The above example will output something similar to:

	      RarEntry
	      RarEntry for file "tese.txt" (23b93a7a)

       Example #2

	      Procedural style

	      <?php
	      $rar_arch = rar_open('solid.rar');
	      if ($rar_arch === FALSE)
		  die("Could not open RAR archive.");
	      $rar_entry = rar_entry_get($rar_arch, 'tese.txt');
	      if ($rar_entry === FALSE)
		  die("Could get such entry");
	      echo get_class($rar_entry)."
";
	      echo $rar_entry;
	      rar_close($rar_arch);
	      ?>

SEE ALSO

       RarArchive::getEntries, rar:// wrapper.

PHP Documentation Group 													  RAR_ENTRY_GET(3)