Skip to content

Commit 177677f

Browse files
clueclue
authored
Merge pull request #27 from clue-labs/deprecated
Remove deprecated APIs and mark ZlibFilterStream as internal only
2 parents 501fdc5 + dc07fdb commit 177677f

10 files changed

+20
-142
lines changed

‎README.md‎

Lines changed: 0 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,6 @@ supporting compression and decompression of GZIP, ZLIB and raw DEFLATE formats.
1515
* [Usage](#usage)
1616
* [Compressor](#compressor)
1717
* [Decompressor](#decompressor)
18-
* [ZlibFilterStream](#zlibfilterstream)
19-
* [createCompressor()](#createcompressor)
20-
* [createDecompressor()](#createdecompressor)
2118
* [Inconsistencies](#inconsistencies)
2219
* [Install](#install)
2320
* [Tests](#tests)
@@ -137,10 +134,6 @@ $input->pipe($filterBadWords)->pipe($compressor)->pipe($output);
137134
For more details, see ReactPHP's
138135
[`DuplexStreamInterface`](https://github.com/reactphp/stream#duplexstreaminterface).
139136

140-
> Internally, it implements the deprecated `ZlibFilterStream` class only for
141-
BC reasons. For best forwards compatibility, you should only rely on it
142-
implementing the `DuplexStreamInterface`.
143-
144137
### Decompressor
145138

146139
The `Decompressor` class can be used to decompress a stream of data.
@@ -169,59 +162,6 @@ $input->pipe($decompressor)->pipe($filterBadWords)->pipe($output);
169162
For more details, see ReactPHP's
170163
[`DuplexStreamInterface`](https://github.com/reactphp/stream#duplexstreaminterface).
171164

172-
> Internally, it implements the deprecated `ZlibFilterStream` class only for
173-
BC reasons. For best forwards compatibility, you should only rely on it
174-
implementing the `DuplexStreamInterface`.
175-
176-
### ZlibFilterStream
177-
178-
The deprecated `ZlibFilterStream` is a small wrapper around the underlying `zlib.deflate` and `zlib.inflate`
179-
stream compression filters offered via `ext-zlib`.
180-
181-
#### createCompressor()
182-
183-
The following deprecated methods can be used to
184-
create a `Compressor` instance with the respective encoding parameter:
185-
186-
```php
187-
// deprecated
188-
$compressor = ZlibFilterStream::createGzipCompressor();
189-
$compressor = ZlibFilterStream::createDeflateCompressor();
190-
$compressor = ZlibFilterStream::createZlibCompressor();
191-
```
192-
193-
Using any of these methods is deprecated.
194-
Instead, you should explicitly create a `Compressor` like this:
195-
196-
```php
197-
$encoding = ZLIB_ENCODING_GZIP; // or ZLIB_ENCODING_RAW or ZLIB_ENCODING_DEFLATE
198-
$compressor = new Clue\React\Zlib\Compressor($encoding);
199-
```
200-
201-
See also [`Compressor`](#compressor) for more details.
202-
203-
#### createDecompressor()
204-
205-
The following deprecated methods can be used to
206-
create a `Decompressor` instanceof with the respective encoding parameter:
207-
208-
```php
209-
// deprecated
210-
$decompressor = ZlibFilterStream::createGzipDecompressor();
211-
$decompressor = ZlibFilterStream::createDeflateDecompressor();
212-
$decompressor = ZlibFilterStream::createZlibDecompressor();
213-
```
214-
215-
Using any of these methods is deprecated.
216-
Instead, you should explicitly create a `Decompressor` like this:
217-
218-
```php
219-
$encoding = ZLIB_ENCODING_GZIP; // or ZLIB_ENCODING_RAW or ZLIB_ENCODING_DEFLATE
220-
$decompressor = new Clue\React\Zlib\Decompressor($encoding);
221-
```
222-
223-
See also [`Compressor`](#compressor) for more details.
224-
225165
### Inconsistencies
226166

227167
The stream compression filters are not exactly the most commonly used features of PHP.

‎src/Compressor.php‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,6 @@
3030
*
3131
* For more details, see ReactPHP's
3232
* [`DuplexStreamInterface`](https://github.com/reactphp/stream#duplexstreaminterface).
33-
*
34-
* > Internally, it implements the deprecated `ZlibFilterStream` class only for
35-
* BC reasons. For best forwards compatibility, you should only rely on it
36-
* implementing the `DuplexStreamInterface`.
3733
*/
3834
final class Compressor extends ZlibFilterStream
3935
{

‎src/Decompressor.php‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,6 @@
3030
*
3131
* For more details, see ReactPHP's
3232
* [`DuplexStreamInterface`](https://github.com/reactphp/stream#duplexstreaminterface).
33-
*
34-
* > Internally, it implements the deprecated `ZlibFilterStream` class only for
35-
* BC reasons. For best forwards compatibility, you should only rely on it
36-
* implementing the `DuplexStreamInterface`.
3733
*/
3834
final class Decompressor extends ZlibFilterStream
3935
{

‎src/ZlibFilterStream.php‎

Lines changed: 2 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -3,75 +3,21 @@
33
namespace Clue\React\Zlib;
44

55
/**
6-
* Compressor and decompressor using PHP's zlib compression filters.
6+
* [Internal] Compressor and decompressor using PHP's zlib compression filters.
77
*
88
* Supports the following compression formats:
99
*
1010
* RFC 1952 (GZIP compressed format)
1111
* RFC 1951 (raw DEFLATE compressed format)
1212
* RFC 1950 (ZLIB compressed format)
1313
*
14+
* @internal Should not be relied upon outside of this package.
1415
* @link http://php.net/manual/en/filters.compression.php
15-
* @deprecated 0.2.2 External usage of `ZlibFilterStream` is deprecated, use `Compressor` or `Decompressor` instead.
1616
* @see Compressor
1717
* @see Decompressor
1818
*/
1919
class ZlibFilterStream extends TransformStream
2020
{
21-
/**
22-
* @deprecated
23-
* @return self
24-
*/
25-
public static function createGzipCompressor($level = -1)
26-
{
27-
return new Compressor(ZLIB_ENCODING_GZIP, $level);
28-
}
29-
30-
/**
31-
* @deprecated
32-
* @return self
33-
*/
34-
public static function createGzipDecompressor()
35-
{
36-
return new Decompressor(ZLIB_ENCODING_GZIP);
37-
}
38-
39-
/**
40-
* @deprecated
41-
* @return self
42-
*/
43-
public static function createDeflateCompressor($level = -1)
44-
{
45-
return new Compressor(ZLIB_ENCODING_RAW, $level);
46-
}
47-
48-
/**
49-
* @deprecated
50-
* @return self
51-
*/
52-
public static function createDeflateDecompressor()
53-
{
54-
return new Decompressor(ZLIB_ENCODING_RAW);
55-
}
56-
57-
/**
58-
* @deprecated
59-
* @return self
60-
*/
61-
public static function createZlibCompressor($level = -1)
62-
{
63-
return new Compressor(ZLIB_ENCODING_DEFLATE, $level);
64-
}
65-
66-
/**
67-
* @deprecated
68-
* @return self
69-
*/
70-
public static function createZlibDecompressor()
71-
{
72-
return new Decompressor(ZLIB_ENCODING_DEFLATE);
73-
}
74-
7521
private $filter;
7622

7723
/**

tests/ZlibFilterDeflateDecompressorTest.php renamed to tests/DeflateDecompressorTest.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
<?php
22

3-
use Clue\React\Zlib\ZlibFilterStream;
3+
use Clue\React\Zlib\Decompressor;
44

5-
class ZlibFilterDeflateDecompressorTest extends TestCase
5+
class DeflateDecompressorTest extends TestCase
66
{
77
private $decompressor;
88

99
public function setUp()
1010
{
11-
$this->decompressor = ZlibFilterStream::createDeflateDecompressor();
11+
$this->decompressor = new Decompressor(ZLIB_ENCODING_RAW);
1212
}
1313

1414
public function testInflateEmpty()

tests/ZlibFilterDeflateCompressorTest.php renamed to tests/DelateCompressorTest.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
<?php
22

3-
use Clue\React\Zlib\ZlibFilterStream;
3+
use Clue\React\Zlib\Compressor;
44

5-
class ZlibFilterDeflateCompressorTest extends TestCase
5+
class DeflateCompressorTest extends TestCase
66
{
77
private $compressor;
88

99
public function setUp()
1010
{
11-
$this->compressor = ZlibFilterStream::createDeflateCompressor();
11+
$this->compressor = new Compressor(ZLIB_ENCODING_RAW);
1212
}
1313

1414
public function testDeflateEmpty()

tests/ZlibFilterGzipCompressorTest.php renamed to tests/GzipCompressorTest.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
<?php
22

3-
use Clue\React\Zlib\ZlibFilterStream;
3+
use Clue\React\Zlib\Compressor;
44

5-
class ZlibFilterGzipCompressorTest extends TestCase
5+
class GzipCompressorTest extends TestCase
66
{
77
private $compressor;
88

99
public function setUp()
1010
{
11-
$this->compressor = ZlibFilterStream::createGzipCompressor();
11+
$this->compressor = new Compressor(ZLIB_ENCODING_GZIP);
1212
}
1313

1414
public function testCompressEmpty()

tests/ZlibFilterGzipDecompressorTest.php renamed to tests/GzipDecompressorTest.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
<?php
22

3-
use Clue\React\Zlib\ZlibFilterStream;
3+
use Clue\React\Zlib\Decompressor;
44

5-
class ZlibFilterGzipDecompressorTest extends TestCase
5+
class GzipDecompressorTest extends TestCase
66
{
77
private $decompressor;
88

99
public function setUp()
1010
{
11-
$this->decompressor = ZlibFilterStream::createGzipDecompressor();
11+
$this->decompressor = new Decompressor(ZLIB_ENCODING_GZIP);
1212
}
1313

1414
public function testDecompressEmpty()

tests/ZlibFilterZlibCompressorTest.php renamed to tests/ZlibCompressorTest.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
<?php
22

3-
use Clue\React\Zlib\ZlibFilterStream;
3+
use Clue\React\Zlib\Compressor;
44

5-
class ZlibFilterZlibCompressorTest extends TestCase
5+
class ZlibCompressorTest extends TestCase
66
{
77
private $compressor;
88

99
public function setUp()
1010
{
11-
$this->compressor = ZlibFilterStream::createZlibCompressor();
11+
$this->compressor = new Compressor(ZLIB_ENCODING_DEFLATE);
1212
}
1313

1414
public function testCompressEmpty()

tests/ZlibFilterZlibDecompressorTest.php renamed to tests/ZlibDecompressorTest.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
<?php
22

3-
use Clue\React\Zlib\ZlibFilterStream;
3+
use Clue\React\Zlib\Decompressor;
44

5-
class ZlibFilterZlibDecompressorTest extends TestCase
5+
class ZlibDecompressorTest extends TestCase
66
{
77
private $decompressor;
88

99
public function setUp()
1010
{
11-
$this->decompressor = ZlibFilterStream::createZlibDecompressor();
11+
$this->decompressor = new Decompressor(ZLIB_ENCODING_DEFLATE);
1212
}
1313

1414
public function testDecompressEmpty()

0 commit comments

Comments
 (0)