Add CI check ensuring interfaces have return types

wouterj · fabpot · commit 27d79475d8bc · 2023-04-22T10:23:52.000+02:00
diff --git a/Helper/HelperInterface.php b/Helper/HelperInterface.php
@@ -27,6 +27,8 @@ public function getName();
 
     /**
      * Sets the default charset.
+     *
+     * @return void
      */
     public function setCharset(string $charset);
 
diff --git a/StreamingEngineInterface.php b/StreamingEngineInterface.php
@@ -25,6 +25,8 @@ interface StreamingEngineInterface
      *
      * @throws \RuntimeException if the template cannot be rendered
      * @throws \LogicException   if the template cannot be streamed
+     *
+     * @return void
      */
     public function stream(string|TemplateReferenceInterface $name, array $parameters = []);
 }
diff --git a/Tests/DelegatingEngineTest.php b/Tests/DelegatingEngineTest.php
@@ -50,13 +50,10 @@ public function testStreamDelegatesToSupportedEngine()
         $streamingEngine = $this->getStreamingEngineMock('template.php', true);
         $streamingEngine->expects($this->once())
             ->method('stream')
-            ->with('template.php', ['foo' => 'bar'])
-            ->willReturn('<html />');
+            ->with('template.php', ['foo' => 'bar']);
 
         $delegatingEngine = new DelegatingEngine([$streamingEngine]);
-        $result = $delegatingEngine->stream('template.php', ['foo' => 'bar']);
-
-        $this->assertNull($result);
+        $delegatingEngine->stream('template.php', ['foo' => 'bar']);
     }
 
     public function testStreamRequiresStreamingEngine()

Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,8 @@ interface StreamingEngineInterface`
`25`	`25`	`*`
`26`	`26`	`* @throws \RuntimeException if the template cannot be rendered`
`27`	`27`	`* @throws \LogicException if the template cannot be streamed`
	`28`	`+ *`
	`29`	`+ * @return void`
`28`	`30`	`*/`
`29`	`31`	`public function stream(string\|TemplateReferenceInterface $name, array $parameters = []);`
`30`	`32`	`}`