PHP

Unzip a Text File Entry into a StringBuilder Using ZipEntry.UnzipToSb

See more Zip Examples

This example demonstrates how to use the ZipEntry.UnzipToSb method to inflate a text file entry directly into a StringBuilder object.

The ZIP entry is uncompressed entirely in memory and appended to the StringBuilder without creating a temporary file on disk.

This is useful when:

• Processing text files directly in memory
• Avoiding temporary filesystem files
• Reading configuration files, JSON, XML, CSV, or source code from ZIP archives
• Automatically converting line endings while inflating the text

The srcCharset argument specifies how the uncompressed bytes should be interpreted, such as:

• utf-8
• utf-16
• windows-1252

The lineEndingBehavior argument controls line-ending conversion:

• 0 — Leave line endings unchanged
• 1 — Convert all line endings to bare LF
• 2 — Convert all line endings to CRLF

Suppose the ZIP archive contains:

config/settings.json

The example inflates the JSON file directly into a StringBuilder.

Chilkat2 PHP

<?php

use Chilkat2\StringBuilder;
use Chilkat2\Zip;
use Chilkat2\ZipEntry;

$success = false;

$zip = new Zip();

// Open an existing ZIP archive.
try {
    $zip->OpenZip('qa_data/zips/configFiles.zip');
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

// Locate the JSON file entry within the ZIP archive.
$entry = new ZipEntry();

$success = $zip->EntryOf('config/settings.json', $entry);
if (!$success) {
    echo "ZIP entry not found.\n";
    $zip->CloseZip();
    exit;
}

// ------------------------------------------------------------
// Inflate the ZIP entry directly into a StringBuilder.
//
// The uncompressed text is appended to the StringBuilder.
//
$sb = new StringBuilder();

// Leave line endings unchanged.
$lineEndingBehavior = 0;

// Interpret the uncompressed bytes as UTF-8 text.
$srcCharset = 'utf-8';

try {
    $entry->UnzipToSb($lineEndingBehavior, $srcCharset, $sb);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

echo "Uncompressed text:\n";
echo "\n";
echo $sb->GetAsString(), "\n";

$zip->CloseZip();

echo "Done.\n";