(PHP Extension) Compressing and Decompressing Files Using Streaming (CompressFile / DecompressFile)

See more Compression Examples

This example demonstrates how to compress a file to a binary format and then restore it using the Chilkat.Compression class. The CompressFile method reads the source file, compresses it using the specified algorithm, and writes the result to a destination file. The DecompressFile method performs the reverse operation, restoring the original file from the compressed data.

Both operations are performed internally in streaming mode, allowing files of any size to be processed efficiently without loading the entire file into memory. The example also includes a simple verification step by comparing file sizes to confirm that the decompressed output matches the original input.

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

<?php

include("chilkat.php");

$success = false;

// This example assumes the Chilkat API has already been unlocked.
// See Global Unlock Sample for sample code.

$compress = new CkCompression();

// Use the zlib algorithm (recommended for general use)
$compress->put_Algorithm('zlib');

// ------------------------------------------------------------------
// Compress a file
// ------------------------------------------------------------------

$inputFile = 'c:/temp/example.txt';
$compressedFile = 'c:/temp/example.txt.zlib';

$success = $compress->CompressFile($inputFile,$compressedFile);
if ($success == false) {
    print 'Compression failed:' . "\n";
    print $compress->lastErrorText() . "\n";
    exit;
}

print 'File compressed successfully:' . "\n";
print '  Input:      ' . $inputFile . "\n";
print '  Compressed: ' . $compressedFile . "\n";

// ------------------------------------------------------------------
// Decompress the file back to its original form
// ------------------------------------------------------------------

$decompressedFile = 'c:/temp/example_restored.txt';

$success = $compress->DecompressFile($compressedFile,$decompressedFile);
if ($success == false) {
    print 'Decompression failed:' . "\n";
    print $compress->lastErrorText() . "\n";
    exit;
}

print 'File decompressed successfully:' . "\n";
print '  Output: ' . $decompressedFile . "\n";

// ------------------------------------------------------------------
// Optional: Verify file sizes (basic sanity check)
// ------------------------------------------------------------------

$fac = new CkFileAccess();

$originalSize = $fac->FileSize($inputFile);
$restoredSize = $fac->FileSize($decompressedFile);

print 'Original file size:   ' . $originalSize . "\n";
print 'Restored file size:   ' . $restoredSize . "\n";

if ($originalSize == $restoredSize) {
    print 'Sizes match (basic verification successful).' . "\n";
}
else {
    print 'Warning: File sizes differ.' . "\n";
}


?>