Make viewPath in ViewRenderer constructor optional

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 - Enh #79: Add debug collector for yiisoft/yii-debug (@xepozz)
 - Bug #82: Fixed find for layout file due to compatibility with `yiisoft/view` (@rustamwin)
+- Enh #99: Make `viewPath` in `ViewRenderer` constructor optional (@vjik)
 
 ## 6.0.0 February 16, 2023
 

src/ViewRenderer.php

@@ -4,6 +4,7 @@
 
 namespace Yiisoft\Yii\View;
 
+use LogicException;
 use RuntimeException;
 use Throwable;
 use Yiisoft\Aliases\Aliases;
@@ -42,15 +43,15 @@
  */
 final class ViewRenderer implements ViewContextInterface
 {
-    private string $viewPath;
+    private ?string $viewPath = null;
     private ?string $name = null;
     private ?string $locale = null;
 
     /**
      * @param DataResponseFactoryInterface $responseFactory The data response factory instance.
      * @param Aliases $aliases The aliases instance.
      * @param WebView $view The web view instance.
-     * @param string $viewPath The full path to the directory of views or its alias.
+     * @param string|null $viewPath The full path to the directory of views or its alias.
      * @param string|null $layout The layout name (e.g. "layout/main") to be applied to views.
      * If null, the layout will not be applied.
      * @param object[] $injections The injection instances.
@@ -59,11 +60,11 @@
         private DataResponseFactoryInterface $responseFactory,
         private Aliases $aliases,
         private WebView $view,
-        string $viewPath,
+        ?string $viewPath = null,
         private ?string $layout = null,
         private array $injections = []
     ) {
-        $this->viewPath = rtrim($viewPath, '/');
+        $this->setViewPath($viewPath);
     }
 
     /**
@@ -75,6 +76,10 @@
      */
     public function getViewPath(): string
     {
+        if ($this->viewPath === null) {
+            throw new LogicException('The view path is not set.');
+        }
+
         return $this->aliases->get($this->viewPath) . ($this->name ? '/' . $this->name : '');
     }
 
@@ -218,7 +223,7 @@
     public function withViewPath(string $viewPath): self
     {
         $new = clone $this;
-        $new->viewPath = rtrim($viewPath, '/');
+        $new->setViewPath($viewPath);
         return $new;
     }
 
@@ -243,7 +248,7 @@
     public function withAddedInjections(object ...$injections): self
     {
         $new = clone $this;
         $new->injections = array_merge($this->injections, $injections);
         return $new;
     }
 
@@ -266,7 +271,7 @@
      */
     public function withLocale(string $locale): self
     {
         $new = clone $this;
         $new->locale = $locale;
         return $new;
     }
@@ -345,10 +350,10 @@
         $parameters = [];
         foreach ($this->injections as $injection) {
             if ($injection instanceof CommonParametersInjectionInterface) {
                 $parameters = array_merge($parameters, $injection->getCommonParameters());
             }
         }
         return $parameters;
     }
 
     /**
@@ -363,7 +368,7 @@
         $parameters = [];
         foreach ($this->injections as $injection) {
             if ($injection instanceof LayoutParametersInjectionInterface) {
                 $parameters = array_merge($parameters, $injection->getLayoutParameters());
             }
         }
         return $parameters;
@@ -553,4 +558,9 @@
     {
         return get_debug_type($value);
     }
+
+    private function setViewPath(?string $path): void
+    {
+        $this->viewPath = $path === null ? null : rtrim($path, '/');
+    }
 }

tests/ViewRendererTest.php

@@ -6,6 +6,7 @@
 
 use HttpSoft\Message\ResponseFactory;
 use HttpSoft\Message\StreamFactory;
+use LogicException;
 use PHPUnit\Framework\TestCase;
 use ReflectionObject;
 use RuntimeException;
@@ -466,6 +467,19 @@ public function testRenderParametersNotOverrideLayout(): void
         $this->assertEqualStringsIgnoringLineEndings($expected, (string) $response->getBody());
     }
 
+    public function testWithoutViewPath(): void
+    {
+        $viewRenderer = new ViewRenderer(
+            new DataResponseFactory(new ResponseFactory(), new StreamFactory()),
+            new Aliases(),
+            new WebView(__DIR__, new SimpleEventDispatcher()),
+        );
+
+        $this->expectException(LogicException::class);
+        $this->expectExceptionMessage('The view path is not set.');
+        $viewRenderer->getViewPath();
+    }
+
     public function testImmutability(): void
     {
         $original = $this->getRenderer();