php8.5
Home/ Manual/ rar / rararchive/ RarArchive::getEntry

RarArchive::getEntry

PHP function Edit on GitHub ✎

(PECL rar >= 2.0.0)

Get entry object from the RAR archive

Description

Oop (method):

RarArchive::getEntry(string $entryname): RarEntry|false

Procedural:

rar_entry_get(RarArchive $rarfile, string $entryname): RarEntry|false

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

rarfile

A RarArchive object, opened with rar_open().

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 Falseforfailure.

Examples

Oop

php
<?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 not get such entry");
echo get_class($rar_entry)."\n";
echo $rar_entry;
$rar_arch->close();
?>

The above example will output something similar to:

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

Procedural

php
<?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 not get such entry");
echo get_class($rar_entry)."\n";
echo $rar_entry;
rar_close($rar_arch);
?>

See Also

Source: reference/rar/rararchive/getentry.xml · from the official PHP manual (php/doc-en)