diff --git a/CHANGELOG.md b/CHANGELOG.md index 80b06f1..5aaadd4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log +## Unreleased + +### Deprecated + + - FilteredStream::getReadFilter The read filter is internal and should never be used by consuming code. + - FilteredStream::getWriteFilter We did not implement writing to the streams at all. And if we do, the filter is an internal information and should not be used by consuming code. + ## 1.4.0 - 2016-10-20 ### Added diff --git a/src/Encoding/ChunkStream.php b/src/Encoding/ChunkStream.php index 3e663b6..74c2fbd 100644 --- a/src/Encoding/ChunkStream.php +++ b/src/Encoding/ChunkStream.php @@ -12,7 +12,7 @@ class ChunkStream extends FilteredStream /** * {@inheritdoc} */ - public function getReadFilter() + protected function readFilter() { return 'chunk'; } @@ -20,7 +20,7 @@ public function getReadFilter() /** * {@inheritdoc} */ - public function getWriteFilter() + protected function writeFilter() { return 'dechunk'; } diff --git a/src/Encoding/CompressStream.php b/src/Encoding/CompressStream.php index 08ea554..d1013dc 100644 --- a/src/Encoding/CompressStream.php +++ b/src/Encoding/CompressStream.php @@ -27,7 +27,7 @@ public function __construct(StreamInterface $stream, $level = -1) /** * {@inheritdoc} */ - public function getReadFilter() + protected function readFilter() { return 'zlib.deflate'; } @@ -35,7 +35,7 @@ public function getReadFilter() /** * {@inheritdoc} */ - public function getWriteFilter() + protected function writeFilter() { return 'zlib.inflate'; } diff --git a/src/Encoding/DechunkStream.php b/src/Encoding/DechunkStream.php index 56d1208..4cade83 100644 --- a/src/Encoding/DechunkStream.php +++ b/src/Encoding/DechunkStream.php @@ -14,7 +14,7 @@ class DechunkStream extends FilteredStream /** * {@inheritdoc} */ - public function getReadFilter() + protected function readFilter() { return 'dechunk'; } @@ -22,7 +22,7 @@ public function getReadFilter() /** * {@inheritdoc} */ - public function getWriteFilter() + protected function writeFilter() { return 'chunk'; } diff --git a/src/Encoding/DecompressStream.php b/src/Encoding/DecompressStream.php index 42c2838..4e3a723 100644 --- a/src/Encoding/DecompressStream.php +++ b/src/Encoding/DecompressStream.php @@ -27,7 +27,7 @@ public function __construct(StreamInterface $stream, $level = -1) /** * {@inheritdoc} */ - public function getReadFilter() + protected function readFilter() { return 'zlib.inflate'; } @@ -35,7 +35,7 @@ public function getReadFilter() /** * {@inheritdoc} */ - public function getWriteFilter() + protected function writeFilter() { return 'zlib.deflate'; } diff --git a/src/Encoding/DeflateStream.php b/src/Encoding/DeflateStream.php index 1758d11..1d7344b 100644 --- a/src/Encoding/DeflateStream.php +++ b/src/Encoding/DeflateStream.php @@ -23,7 +23,7 @@ public function __construct(StreamInterface $stream, $level = -1) /** * {@inheritdoc} */ - public function getReadFilter() + protected function readFilter() { return 'zlib.deflate'; } @@ -31,7 +31,7 @@ public function getReadFilter() /** * {@inheritdoc} */ - public function getWriteFilter() + protected function writeFilter() { return 'zlib.inflate'; } diff --git a/src/Encoding/FilteredStream.php b/src/Encoding/FilteredStream.php index c3a06fc..67033ae 100644 --- a/src/Encoding/FilteredStream.php +++ b/src/Encoding/FilteredStream.php @@ -24,16 +24,22 @@ abstract class FilteredStream implements StreamInterface /** * @var resource + * + * @deprecated since version 1.5, will be removed in 2.0 */ protected $readFilter; /** * @var callable + * + * @deprecated since version 1.5, will be removed in 2.0 */ protected $writeFilterCallback; /** * @var resource + * + * @deprecated since version 1.5, will be removed in 2.0 */ protected $writeFilter; @@ -47,12 +53,17 @@ abstract class FilteredStream implements StreamInterface /** * @param StreamInterface $stream * @param mixed|null $readFilterOptions - * @param mixed|null $writeFilterOptions + * @param mixed|null $writeFilterOptions deprecated since 1.5, will be removed in 2.0 */ public function __construct(StreamInterface $stream, $readFilterOptions = null, $writeFilterOptions = null) { - $this->readFilterCallback = Filter\fun($this->getReadFilter(), $readFilterOptions); - $this->writeFilterCallback = Filter\fun($this->getWriteFilter(), $writeFilterOptions); + $this->readFilterCallback = Filter\fun($this->readFilter(), $readFilterOptions); + $this->writeFilterCallback = Filter\fun($this->writeFilter(), $writeFilterOptions); + + if (null !== $writeFilterOptions) { + @trigger_error('The $writeFilterOptions argument is deprecated since version 1.5 and will be removed in 2.0.', E_USER_DEPRECATED); + } + $this->stream = $stream; } @@ -139,13 +150,41 @@ public function __toString() * Returns the read filter name. * * @return string + * + * @deprecated since version 1.5, will be removed in 2.0 + */ + public function getReadFilter() + { + @trigger_error('The '.__CLASS__.'::'.__METHOD__.' method is deprecated since version 1.5 and will be removed in 2.0.', E_USER_DEPRECATED); + + return $this->readFilter(); + } + + /** + * Returns the write filter name. + * + * @return string */ - abstract public function getReadFilter(); + abstract protected function readFilter(); + + /** + * Returns the write filter name. + * + * @return string + * + * @deprecated since version 1.5, will be removed in 2.0 + */ + public function getWriteFilter() + { + @trigger_error('The '.__CLASS__.'::'.__METHOD__.' method is deprecated since version 1.5 and will be removed in 2.0.', E_USER_DEPRECATED); + + return $this->writeFilter(); + } /** * Returns the write filter name. * * @return string */ - abstract public function getWriteFilter(); + abstract protected function writeFilter(); } diff --git a/src/Encoding/GzipDecodeStream.php b/src/Encoding/GzipDecodeStream.php index d87073c..4f958ed 100644 --- a/src/Encoding/GzipDecodeStream.php +++ b/src/Encoding/GzipDecodeStream.php @@ -27,7 +27,7 @@ public function __construct(StreamInterface $stream, $level = -1) /** * {@inheritdoc} */ - public function getReadFilter() + protected function readFilter() { return 'zlib.inflate'; } @@ -35,7 +35,7 @@ public function getReadFilter() /** * {@inheritdoc} */ - public function getWriteFilter() + protected function writeFilter() { return 'zlib.deflate'; } diff --git a/src/Encoding/GzipEncodeStream.php b/src/Encoding/GzipEncodeStream.php index 477f052..1066eec 100644 --- a/src/Encoding/GzipEncodeStream.php +++ b/src/Encoding/GzipEncodeStream.php @@ -27,7 +27,7 @@ public function __construct(StreamInterface $stream, $level = -1) /** * {@inheritdoc} */ - public function getReadFilter() + protected function readFilter() { return 'zlib.deflate'; } @@ -35,7 +35,7 @@ public function getReadFilter() /** * {@inheritdoc} */ - public function getWriteFilter() + protected function writeFilter() { return 'zlib.inflate'; } diff --git a/src/Encoding/InflateStream.php b/src/Encoding/InflateStream.php index e909db3..7070230 100644 --- a/src/Encoding/InflateStream.php +++ b/src/Encoding/InflateStream.php @@ -27,7 +27,7 @@ public function __construct(StreamInterface $stream, $level = -1) /** * {@inheritdoc} */ - public function getReadFilter() + protected function readFilter() { return 'zlib.inflate'; } @@ -35,7 +35,7 @@ public function getReadFilter() /** * {@inheritdoc} */ - public function getWriteFilter() + protected function writeFilter() { return 'zlib.deflate'; }