(PHP Extension) Unzip One File to a Stream

Demonstrates how to unzip a particular file contained within a .zip archive to a Chilkat stream.

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$zip = new CkZip();

// First open a .zip.
$success = $zip->OpenZip('qa_data/hamlet.zip');
if ($success != true) {
    print $zip->lastErrorText() . "\n";
    exit;
}

// Find the entry to be unzipped to a stream..
// entry is a CkZipEntry
$entry = $zip->FirstMatchingEntry('*hamlet.xml');
if ($zip->get_LastMethodSuccess() != true) {
    print $zip->lastErrorText() . "\n";
    exit;
}

// There are three ways we can unzip (inflate) to a stream.
// 
// 1) Set a sink file on the stream object and call UnzipToStream synchronously.
//    This unzips to the stream's sink (which is to simply unzip to a file in the filesystem).
// 
// 2) Create a stream object and call UnzipToStreamAsync.  This starts the unzip in a background
//    thread (after Task.Run is called).  Your application can then read the unzipped (inflated) file
//    directly from the stream.
// 
// 3) (not shown in this example) Unzip to a stream object that is the source of something else.
//    

// ----------------------------------------------------------------
// Case 1: Unzip to a file by setting the sink of streamA to a file.
$streamA = new CkStream();
$streamA->put_SinkFile('qa_output/hamletA.xml');

$success = $entry->UnzipToStream($streamA);
if ($success != true) {
    print $entry->lastErrorText() . "\n";

    exit;
}

// Close the stream to close the output file.
$success = $streamA->WriteClose();

// ----------------------------------------------------------------
// Case 2a: Uzip to a stream asynchronously. 
$streamB = new CkStream();

// unzipTask is a CkTask
$unzipTask = $entry->UnzipToStreamAsync($streamB);
if ($entry->get_LastMethodSuccess() != true) {
    print $entry->lastErrorText() . "\n";

    exit;
}

// Start the background unzip thread.
$unzipTask->Run();

// Read the stream.  (this is reading the unzipped file data)
$sb = new CkStringBuilder();
while ($streamB->get_EndOfStream() != true) {
    // Each call to ReadSb appends to the contents of sb.
    $streamB->ReadSb($sb);
}

$sb->WriteFile('qa_output/hamletB.xml','utf-8',false);

print 'Success.' . "\n";

// ----------------------------------------------------------------
// Case 2b: Uzip to a stream asynchronously and emit output while reading. 
$streamC = new CkStream();

// unzipTask is a CkTask
$unzipTask = $entry->UnzipToStreamAsync($streamC);
if ($entry->get_LastMethodSuccess() != true) {
    print $entry->lastErrorText() . "\n";

    exit;
}

$unzipTask->Run();

while ($streamC->get_EndOfStream() != true) {
    $s = $streamC->readString();
    print $s . "\n";
}

print 'Success.' . "\n";

?>