Add ViewAwareTrait::toHtml()

src/ViewAwareTrait.php

@@ -40,6 +40,16 @@ public function render()
         $this->getView()->render($this);
     }
 
+    /**
+     * Convert the view to HTML with self as context object.
+     *
+     * @return string
+     */
+    public function toHtml(): string
+    {
+        return $this->getView()->toHtml($this);
+    }
+
     /**
      * Returns a closure which render the view with self as the context.
      *

src/ViewAwareTraitInterface.php

@@ -29,6 +29,13 @@ interface ViewAwareTraitInterface
      */
     public function render();
 
+    /**
+     * Convert the view to HTML with self as context object.
+     *
+     * @return string
+     */
+    public function toHtml(): string;
+
     /**
      * Returns a closure which render the view with self as the context.
      *

src/ViewInterface.php

@@ -34,7 +34,7 @@ public function render($context = null);
      *
      * @param mixed $context Optional. Context object for which to render the view.
      *
-     * @return void
+     * @return string
      */
-    public function toHtml($context = null);
+    public function toHtml($context = null): string;
 }

tests/_data/ViewAwareTraitDummy.php

@@ -8,6 +8,20 @@ class ViewAwareTraitDummy implements ViewAwareTraitInterface
 {
     use ViewAwareTrait;
 
+    /**
+     * Dummy data.
+     *
+     * @var string
+     */
+    public $name = 'Daenerys Targaryen';
+
+    /**
+     * Dummy data.
+     *
+     * @var int
+     */
+    public $dragons = 3;
+
     public function forceSetView($view)
     {
         $this->view = $view;

tests/wpunit/ViewAwareTraitTest.php

@@ -105,4 +105,21 @@ public function it_renders_the_view_with_self_as_the_context()
 
         $view->verifyInvokedOnce('render', [$this->subject]);
     }
+
+    /** @test */
+    public function it_converts_the_view_to_html_with_self_as_the_context()
+    {
+        $view = new View(
+            codecept_data_dir('dummy-template-with-context.php'),
+            wp_kses_allowed_html('post')
+        );
+        $this->subject->setView($view);
+
+        $actual = $this->subject->toHtml();
+
+        $this->assertSame(
+            $view->toHtml($this->subject),
+            $actual
+        );
+    }
 }