Merge pull request #91 from sasezaki/deprecate_stream

Declare `@deprecated` on the stream wrapper functionality (will be removed in `3.0.0`)
laminas · Dec 30, 2021 · b7d9617 · b7d9617
2 parents f3a3011 + 032ff7e
commit b7d9617
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/src/Resolver/TemplatePathStack.php b/src/Resolver/TemplatePathStack.php
@@ -96,6 +96,7 @@ public function setOptions($options)
                     $this->addPaths($value);
                     break;
                 case 'use_stream_wrapper':
+                    /** @psalm-suppress DeprecatedMethod */
                     $this->setUseStreamWrapper($value);
                     break;
                 case 'default_suffix':
@@ -247,6 +248,8 @@ public function isLfiProtectionOn()
      *
      * @param  bool $flag
      * @return TemplatePathStack
+     *
+     * @deprecated will be removed in version 3
      */
     public function setUseStreamWrapper($flag)
     {
@@ -261,6 +264,8 @@ public function setUseStreamWrapper($flag)
      * is disabled.
      *
      * @return bool
+     *
+     * @deprecated will be removed in version 3
      */
     public function useStreamWrapper()
     {
@@ -307,6 +312,7 @@ public function resolve($name, Renderer $renderer = null)
                         break;
                     }
                 }
+                /** @psalm-suppress DeprecatedMethod */
                 if ($this->useStreamWrapper()) {
                     // If using a stream wrapper, prepend the spec to the path
                     $filePath = 'laminas.view://' . $filePath;

diff --git a/src/Stream.php b/src/Stream.php
@@ -14,6 +14,8 @@
  * written by
  *     Mike Naberezny (@link http://mikenaberezny.com)
  *     Paul M. Jones  (@link http://paul-m-jones.com)
+ *
+ * @deprecated will be removed in version 3, only the normal PHP tags (<?php ?> and <?= ?>) should be used
  */
 class Stream
 {

diff --git a/test/Resolver/TemplatePathStackTest.php b/test/Resolver/TemplatePathStackTest.php
@@ -104,6 +104,7 @@ public function testMayDisableLfiProtection(): void
 
     public function testStreamWrapperDisabledByDefault(): void
     {
+        /** @psalm-suppress DeprecatedMethod */
         $this->assertFalse($this->stack->useStreamWrapper());
     }
 
@@ -113,7 +114,9 @@ public function testMayEnableStreamWrapper(): void
         if (! $flag) {
             $this->markTestSkipped('Short tags are disabled; cannot test');
         }
+        /** @psalm-suppress DeprecatedMethod */
         $this->stack->setUseStreamWrapper(true);
+        /** @psalm-suppress DeprecatedMethod */
         $this->assertTrue($this->stack->useStreamWrapper());
     }
 
@@ -162,6 +165,7 @@ public function testReturnsPathWithStreamProtocolWhenStreamWrapperEnabled(): voi
         if (! $flag) {
             $this->markTestSkipped('Short tags are disabled; cannot test');
         }
+        /** @psalm-suppress DeprecatedMethod */
         $this->stack->setUseStreamWrapper(true)
                     ->addPath($this->baseDir . '/_templates');
         $expected = 'laminas.view://' . realpath($this->baseDir . '/_templates/test.phtml');
@@ -222,6 +226,7 @@ public function testAllowsSettingOptions($options): void
         $this->assertFalse($this->stack->isLfiProtectionOn());
 
         $expected = (bool) ini_get('short_open_tag');
+        /** @psalm-suppress DeprecatedMethod */
         $this->assertSame($expected, $this->stack->useStreamWrapper());
 
         $this->assertSame($options['default_suffix'], $this->stack->getDefaultSuffix());
@@ -241,6 +246,7 @@ public function testAllowsPassingOptionsToConstructor($options): void
         $this->assertFalse($stack->isLfiProtectionOn());
 
         $expected = (bool) ini_get('short_open_tag');
+        /** @psalm-suppress DeprecatedMethod */
         $this->assertSame($expected, $stack->useStreamWrapper());
 
         $this->assertEquals(array_reverse($this->paths), $stack->getPaths()->toArray());