Skip to content

Commit 58f69fd

Browse files
committed
Rename Decoder to TarDecoder to avoid ambiguities
1 parent eec8393 commit 58f69fd

File tree

5 files changed

+12
-12
lines changed

5 files changed

+12
-12
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ processing one chunk at a time in memory without having to rely on disk I/O.
2424
## Quickstart example
2525

2626
Once [installed](#install), you can use the following code to pipe a readable
27-
tar stream into the `Decoder` which emits "entry" events for each individual file:
27+
tar stream into the `TarDecoder` which emits "entry" events for each individual file:
2828

2929
```php
3030
<?php
@@ -33,7 +33,7 @@ require __DIR__ . '/vendor/autoload.php';
3333

3434
$stream = new React\Stream\ReadableResourceStream(fopen('archive.tar', 'r'));
3535

36-
$decoder = new Clue\React\Tar\Decoder();
36+
$decoder = new Clue\React\Tar\TarDecoder();
3737

3838
$decoder->on('entry', function (array $header, React\Stream\ReadableStreamInterface $file) {
3939
echo 'File ' . $header['filename'];

examples/dump.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
$stream = new React\Stream\ReadableResourceStream(fopen($in, 'r'));
99

10-
$decoder = new Clue\React\Tar\Decoder();
10+
$decoder = new Clue\React\Tar\TarDecoder();
1111
$decoder->on('entry', function (array $header, React\Stream\ReadableStreamInterface $file) {
1212
static $i = 0;
1313
echo 'FILE #' . ++$i . PHP_EOL;

src/Decoder.php renamed to src/TarDecoder.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
* @event error(Exception $e)
1919
* @event close()
2020
*/
21-
class Decoder extends EventEmitter implements WritableStreamInterface
21+
class TarDecoder extends EventEmitter implements WritableStreamInterface
2222
{
2323
private $buffer = '';
2424
private $writable = true;

tests/FunctionalDecoderTest.php renamed to tests/FunctionalTarDecoderTest.php

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,20 @@
22

33
namespace Clue\Tests\React\Tar;
44

5-
use Clue\React\Tar\Decoder;
5+
use Clue\React\Tar\TarDecoder;
66
use React\EventLoop\Loop;
77
use React\Stream\ReadableResourceStream;
88

9-
class FunctionDecoderTest extends TestCase
9+
class FunctionalTarDecoderTest extends TestCase
1010
{
1111
private $decoder;
1212

1313
/**
1414
* @before
1515
*/
16-
public function setUpDecoderAndLoop()
16+
public function setUpTarDecoderAndLoop()
1717
{
18-
$this->decoder = new Decoder();
18+
$this->decoder = new TarDecoder();
1919
}
2020

2121
/**

tests/DecoderTest.php renamed to tests/TarDecoderTest.php

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,20 @@
22

33
namespace Clue\Tests\React\Tar;
44

5-
use Clue\React\Tar\Decoder;
5+
use Clue\React\Tar\TarDecoder;
66
use React\Stream\ThroughStream;
77
use React\Stream\ReadableStreamInterface;
88

9-
class DecoderTest extends TestCase
9+
class TarDecoderTest extends TestCase
1010
{
1111
private $decoder;
1212

1313
/**
1414
* @before
1515
*/
16-
public function setUpDecoder()
16+
public function setUpTarDecoder()
1717
{
18-
$this->decoder = new Decoder();
18+
$this->decoder = new TarDecoder();
1919
}
2020

2121
public function testWriteLessDataThanBufferSizeWillNotEmitAnyEvents()

0 commit comments

Comments
 (0)