php8.5
Home/ Manual/ zip / ziparchive/ ZipArchive::getStreamName

ZipArchive::getStreamName

PHP function Edit on GitHub ✎

(PHP 8 >= 8.2.0, PECL zip >= 1.20.0)

Get a file handler to the entry defined by its name (read only)

Description

ZipArchive::getStreamName(string $name, int $flags = 0): resource|false

Get a file handler to the entry defined by its name. For now, it only supports read operations.

Parameters

name

The name of the entry to use.

flags

If flags is set to ZipArchive::FL_UNCHANGED, the original unchanged stream is returned.

Return Values

Returns a file pointer (resource) on successFalseforfailure.

Examples

Get the entry contents with fread() and store it

php
<?php
$contents = '';
$z = new ZipArchive();
if ($z->open('test.zip')) {
    $fp = $z->getStreamName('test', ZipArchive::FL_UNCHANGED);
    if(!$fp) die($z->getStatusString());

    echo stream_get_contents($fp);

    fclose($fp);
}
?>

See Also

  • ZipArchive::getStreamIndex

Source: reference/zip/ziparchive/getstreamname.xml · from the official PHP manual (php/doc-en)