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)
Check Out this Related Man Page
RAR_OPEN(3) 1 RAR_OPEN(3)RarArchive::open - Open RAR archive
Object oriented style (method):
SYNOPSIS
publicstatic RarArchive RarArchive::open (string $filename, [string $password = NULL], [callable $volume_callback = NULL])
DESCRIPTION
Procedural style:
RarArchive rar_open (string $filename, [string $password = NULL], [callable $volume_callback = NULL])
Open specified RAR archive and return RarArchive instance representing it.
Note
If opening a multi-volume archive, the path of the first volume should be passed as the first parameter. Otherwise, not all files
will be shown. This is by design.
PARAMETERS
o $filename
- Path to the Rar archive.
o $password
- A plain password, if needed to decrypt the headers. It will also be used by default if encrypted files are found. Note that the
files may have different passwords in respect to the headers and among them.
o $volume_callback
- A function that receives one parameter - the path of the volume that was not found - and returns a string with the correct path
for such volume or NULL if such volume does not exist or is not known. The programmer should ensure the passed function doesn't
cause loops as this function is called repeatedly if the path returned in a previous call did not correspond to the needed volume.
Specifying this parameter omits the notice that would otherwise be emitted whenever a volume is not found; an implementation that
only returns NULL can therefore be used to merely omit such notices.
Warning
Prior to version 2.0.0, this function would not handle relative paths correctly. Use realpath(3) as a workaround.
RETURN VALUES
Returns the requested RarArchive instance or FALSE on failure.
CHANGELOG
+--------+-----------------------------+
|Version | |
| | |
| | Description |
| | |
+--------+-----------------------------+
| 3.0.0 | |
| | |
| | $volume_callback was added. |
| | |
+--------+-----------------------------+
EXAMPLES
Example #1
Object oriented style
<?php
$rar_arch = RarArchive::open('encrypted_headers.rar', 'samplepassword');
if ($rar_arch === FALSE)
die("Failed opening file");
$entries = $rar_arch->getEntries();
if ($entries === FALSE)
die("Failed fetching entries");
echo "Found " . count($entries) . " files.
";
if (empty($entries))
die("No valid entries found.");
$stream = reset($entries)->getStream();
if ($stream === FALSE)
die("Failed opening first file");
$rar_arch->close();
echo "Content of first one follows:
";
echo stream_get_contents($stream);
fclose($stream);
?>
The above example will output something similar to:
Found 2 files.
Content of first one follows:
Encrypted file 1 contents.
Example #2
Procedural style
<?php
$rar_arch = rar_open('encrypted_headers.rar', 'samplepassword');
if ($rar_arch === FALSE)
die("Failed opening file");
$entries = rar_list($rar_arch);
if ($entries === FALSE)
die("Failed fetching entries");
echo "Found " . count($entries) . " files.
";
if (empty($entries))
die("No valid entries found.");
$stream = reset($entries)->getStream();
if ($stream === FALSE)
die("Failed opening first file");
rar_close($rar_arch);
echo "Content of first one follows:
";
echo stream_get_contents($stream);
fclose($stream);
?>
Example #3
Volume Callback
<?php
/* In this example, there's a volume named multi_broken.part1.rar
* whose next volume is named multi.part2.rar */
function resolve($vol) {
if (preg_match('/_broken/', $vol))
return str_replace('_broken', '', $vol);
else
return null;
}
$rar_file1 = rar_open(dirname(__FILE__).'/multi_broken.part1.rar', null, 'resolve');
$entry = $rar_file1->getEntry('file2.txt');
$entry->extract(null, dirname(__FILE__) . "/temp_file2.txt");
?>
SEE ALSO
rar:// wrapper.
PHP Documentation Group RAR_OPEN(3)