Deprecate FilteredStream::getReadFilter and FilteredStream::getWriteFilter

Author: ajgarlag

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

src/Encoding/ChunkStream.php

@@ -12,15 +12,15 @@ class ChunkStream extends FilteredStream
     /**
      * {@inheritdoc}
      */
-    public function getReadFilter()
+    protected function readFilter()
     {
         return 'chunk';
     }
 
     /**
      * {@inheritdoc}
      */
-    public function getWriteFilter()
+    protected function writeFilter()
     {
         return 'dechunk';
     }

src/Encoding/CompressStream.php

@@ -27,15 +27,15 @@ public function __construct(StreamInterface $stream, $level = -1)
     /**
      * {@inheritdoc}
      */
-    public function getReadFilter()
+    protected function readFilter()
     {
         return 'zlib.deflate';
     }
 
     /**
      * {@inheritdoc}
      */
-    public function getWriteFilter()
+    protected function writeFilter()
     {
         return 'zlib.inflate';
     }

src/Encoding/DechunkStream.php

@@ -14,15 +14,15 @@ class DechunkStream extends FilteredStream
     /**
      * {@inheritdoc}
      */
-    public function getReadFilter()
+    protected function readFilter()
     {
         return 'dechunk';
     }
 
     /**
      * {@inheritdoc}
      */
-    public function getWriteFilter()
+    protected function writeFilter()
     {
         return 'chunk';
     }

src/Encoding/DecompressStream.php

@@ -27,15 +27,15 @@ public function __construct(StreamInterface $stream, $level = -1)
     /**
      * {@inheritdoc}
      */
-    public function getReadFilter()
+    protected function readFilter()
     {
         return 'zlib.inflate';
     }
 
     /**
      * {@inheritdoc}
      */
-    public function getWriteFilter()
+    protected function writeFilter()
     {
         return 'zlib.deflate';
     }

src/Encoding/DeflateStream.php

@@ -23,15 +23,15 @@ public function __construct(StreamInterface $stream, $level = -1)
     /**
      * {@inheritdoc}
      */
-    public function getReadFilter()
+    protected function readFilter()
     {
         return 'zlib.deflate';
     }
 
     /**
      * {@inheritdoc}
      */
-    public function getWriteFilter()
+    protected function writeFilter()
     {
         return 'zlib.inflate';
     }

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();
 }

src/Encoding/GzipDecodeStream.php

@@ -27,15 +27,15 @@ public function __construct(StreamInterface $stream, $level = -1)
     /**
      * {@inheritdoc}
      */
-    public function getReadFilter()
+    protected function readFilter()
     {
         return 'zlib.inflate';
     }
 
     /**
      * {@inheritdoc}
      */
-    public function getWriteFilter()
+    protected function writeFilter()
     {
         return 'zlib.deflate';
     }

src/Encoding/GzipEncodeStream.php

@@ -27,15 +27,15 @@ public function __construct(StreamInterface $stream, $level = -1)
     /**
      * {@inheritdoc}
      */
-    public function getReadFilter()
+    protected function readFilter()
     {
         return 'zlib.deflate';
     }
 
     /**
      * {@inheritdoc}
      */
-    public function getWriteFilter()
+    protected function writeFilter()
     {
         return 'zlib.inflate';
     }

src/Encoding/InflateStream.php

@@ -27,15 +27,15 @@ public function __construct(StreamInterface $stream, $level = -1)
     /**
      * {@inheritdoc}
      */
-    public function getReadFilter()
+    protected function readFilter()
     {
         return 'zlib.inflate';
     }
 
     /**
      * {@inheritdoc}
      */
-    public function getWriteFilter()
+    protected function writeFilter()
     {
         return 'zlib.deflate';
     }