Skip to content

Require ext-zlib during installation #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
clue merged 1 commit into from
Apr 24, 2020
Merged

Require ext-zlib during installation #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,17 +248,22 @@ $ composer require clue/zlib-react:^0.2.2
See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.

This project aims to run on any platform and thus does not require any PHP
extensions and supports running on legacy PHP 5.4 through current PHP 7+.
extensions besides `ext-zlib` and supports running on legacy PHP 5.4 through current
PHP 7+.
It's *highly recommended to use PHP 7+* for this project.

The `ext-zlib` extension is not required to install this library, however it
is required to actually do anything meaningful with this library.
Each of the above methods will throw an `Exception` if this extension is
missing.
The `ext-zlib` extension is required for handling the underlying data compression
and decompression.
This extension is already installed as part of many PHP distributions out-of-the-box,
e.g. it ships with Debian/Ubuntu-based PHP installations and Windows-based
builds by default. If you're building PHP from source, you may have to
[manually enable](https://www.php.net/manual/en/zlib.installation.php) it.

We're committed to providing a smooth upgrade path for legacy setups.
If you need to support legacy PHP 5.3 and legacy HHVM, you may want to check out
the legacy `v0.2.x` release branch.
This legacy release branch also provides an installation candidate that does not
require `ext-zlib` during installation but uses runtime checks instead.

## Tests

Expand Down
1 change: 1 addition & 0 deletions composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
],
"require": {
"php": ">=5.4",
"ext-zlib": "*",
"clue/stream-filter": "~1.3",
"react/stream": "^1.0 || ^0.7 || ^0.6"
},
Expand Down
6 changes: 0 additions & 6 deletions examples/91-benchmark-compress.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,6 @@
exit(1);
}

if (!defined('ZLIB_ENCODING_GZIP')) {
fwrite(STDERR, 'Requires PHP with ext-zlib enabled' . PHP_EOL);
exit(1);
}


if (extension_loaded('xdebug')) {
echo 'NOTICE: The "xdebug" extension is loaded, this has a major impact on performance.' . PHP_EOL;
}
Expand Down
5 changes: 0 additions & 5 deletions examples/92-benchmark-decompress.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,6 @@
exit(1);
}

if (!defined('ZLIB_ENCODING_GZIP')) {
fwrite(STDERR, 'Requires PHP with ext-zlib enabled' . PHP_EOL);
exit(1);
}

if ($argc !== 2) {
fwrite(STDERR, 'No archive given, requires single argument' . PHP_EOL);
exit(1);
Expand Down
5 changes: 0 additions & 5 deletions examples/gunzip.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,6 @@
exit(1);
}

if (!defined('ZLIB_ENCODING_GZIP')) {
fwrite(STDERR, 'Requires PHP with ext-zlib enabled' . PHP_EOL);
exit(1);
}

$loop = React\EventLoop\Factory::create();

$in = new React\Stream\ReadableResourceStream(STDIN, $loop);
Expand Down
5 changes: 0 additions & 5 deletions examples/gzip.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,6 @@
exit(1);
}

if (!defined('ZLIB_ENCODING_GZIP')) {
fwrite(STDERR, 'Requires PHP with ext-zlib enabled' . PHP_EOL);
exit(1);
}

$loop = React\EventLoop\Factory::create();

$in = new React\Stream\ReadableResourceStream(STDIN, $loop);
Expand Down
12 changes: 6 additions & 6 deletions src/ZlibFilterStream.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ class ZlibFilterStream extends TransformStream
*/
public static function createGzipCompressor($level = -1)
{
return new Compressor(15 | 16 /* ZLIB_ENCODING_GZIP */, $level);
return new Compressor(ZLIB_ENCODING_GZIP, $level);
}

/**
Expand All @@ -33,7 +33,7 @@ public static function createGzipCompressor($level = -1)
*/
public static function createGzipDecompressor()
{
return new Decompressor(15 | 16 /* ZLIB_ENCODING_GZIP */);
return new Decompressor(ZLIB_ENCODING_GZIP);
}

/**
Expand All @@ -42,7 +42,7 @@ public static function createGzipDecompressor()
*/
public static function createDeflateCompressor($level = -1)
{
return new Compressor(-15 /* ZLIB_ENCODING_RAW */, $level);
return new Compressor(ZLIB_ENCODING_RAW, $level);
}

/**
Expand All @@ -51,7 +51,7 @@ public static function createDeflateCompressor($level = -1)
*/
public static function createDeflateDecompressor()
{
return new Decompressor(-15 /* ZLIB_ENCODING_RAW */);
return new Decompressor(ZLIB_ENCODING_RAW);
}

/**
Expand All @@ -60,7 +60,7 @@ public static function createDeflateDecompressor()
*/
public static function createZlibCompressor($level = -1)
{
return new Compressor(15 /* ZLIB_ENCODING_DEFLATE */, $level);
return new Compressor(ZLIB_ENCODING_DEFLATE, $level);
}

/**
Expand All @@ -69,7 +69,7 @@ public static function createZlibCompressor($level = -1)
*/
public static function createZlibDecompressor()
{
return new Decompressor(15 /* ZLIB_ENCODING_DEFLATE */);
return new Decompressor(ZLIB_ENCODING_DEFLATE);
}

private $filter;
Expand Down