Browse documentation

#Snappy

Pure PHP implementation of the Google Snappy compression algorithm.

This library is a port of the javascript library snappyjs to PHP. If you can, install the PHP Extension. Without the extension, this library registers polyfill functions.

#Installation

For the installation instructions, read the installation page.

#Usage

<?php

$string = 'This is some random string';

echo \snappy_uncompress(\snappy_compress($string)); // This is some random string

#Performance

The PHP implementation is much slower than the extension. This is a benchmark script and its results:

<?php

include __DIR__ . '/../vendor/autoload.php';

$faker = \Faker\Factory::create();

$texts = [];
for ($i = 0; $i < 10_000; $i++) {
    $textSize = \random_int(100, 5000);
    $texts[] = $faker->text($textSize);
}

$snappy = new \Flow\Snappy\Snappy();

echo "Starting Benchmark\n\n";

$flowStart = microtime(true);
foreach ($texts as $text) {
    if ($snappy->uncompress($snappy->compress($text)) !== $text) {
        die('snappy flow failed');
    }
}
$flowEnd = microtime(true);
echo "Snappy Flow time: " . ($flowEnd - $flowStart) . "\n";

$extStart = microtime(true);
foreach ($texts as $text) {
    if (\snappy_uncompress(\snappy_compress($text)) !== $text) {
        die('snappy ext failed');
    }
}
$extEnd = microtime(true);
echo "Snappy PHP Extension time: " . ($extEnd - $extStart) . "\n";

Output:

$ php benchmark_snappy.php
Starting Benchmark

Snappy Flow time: 6.6838178634644
Snappy PHP Extension time: 0.31190991401672

Found a typo or an outdated section? Edit this page on GitHub ↗