SymfonyWorld Online 2022 Winter Edition

ZipArchive::getStream

(PHP 5 >= 5.2.0, PHP 7, PHP 8, PECL zip >= 1.1.0)

ZipArchive::getStreamGet a file handler to the entry defined by its name (read only)

Description

public ZipArchive::getStream(string $name): 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.

Return Values

Returns a file pointer (resource) on success or false on failure.

Examples

Example #1 Get the entry contents with fread() and store it

<?php
$contents 
'';
$z = new ZipArchive();
if (
$z->open('test.zip')) {
    
$fp $z->getStream('test');
    if(!
$fp) exit("failed\n");

    while (!
feof($fp)) {
        
$contents .= fread($fp2);
    }

    
fclose($fp);
    
file_put_contents('t',$contents);
    echo 
"done.\n";
}
?>

Example #2 Same as the previous example but with fopen() and the zip stream wrapper

<?php
$contents 
'';
$fp fopen('zip://' dirname(__FILE__) . '/test.zip#test''r');
if (!
$fp) {
    exit(
"cannot open\n");
}
while (!
feof($fp)) {
    
$contents .= fread($fp2);
}
echo 
"$contents\n";
fclose($fp);
echo 
"done.\n";
?>

Example #3 Stream wrapper and image, can be used with the xml function as well

<?php
$im 
imagecreatefromgif('zip://' dirname(__FILE__) . '/test_im.zip#pear_item.gif');
imagepng($im'a.png');
?>

See Also

add a note

User Contributed Notes 2 notes

up
0
Sbastien
1 day ago
Here a way to handle specific files from a zip archive without full extract :

<?php

$zip_file
= '/path/to/file.zip'; // I wan to get stream a CSV files

$zip = new ZipArchive();
$zip->open($zip_file);
for (
$i = 0; $i < $zip->numFiles; $i++) { // Check file by file
   
$name = $zip->getNameIndex($i); // Retrieve entry name
   
$extension = pathinfo($name, PATHINFO_EXTENSION);
    if (
$extension === 'csv') { // I want to handle csv files
       
$stream = $zip->getStream($name); // No stream index access before PHP 8.2
        // Starting PHP 8.2 $zip->getStreamIndex() or $zip->getStreamName()
        // Do stuff with $stream
        // ...
   
}
}
up
0
oleg at andreyev dot lv
4 months ago
Keep in mind that this stream is not rewindable/seekable.
To Top