Use only full path for layout (#115)

Author: vjik

CHANGELOG.md

@@ -1,8 +1,8 @@
 # Yii View Extension Change Log
 
-## 6.1.2 under development
+## 7.0.0 under development
 
-- no changes in this release.
+- Chg #115: Only a full path can now be used as a layout (@vjik)
 
 ## 6.1.1 June 06, 2024
 

UPGRADE.md

@@ -0,0 +1,12 @@
+# Upgrading Instructions for Yii View Extension
+
+This file contains the upgrade notes. These notes highlight changes that could break your
+application when you upgrade the package from one version to another.
+
+> **Important!** The following upgrading instructions are cumulative. That is, if you want
+> to upgrade from version A to version C and there is version B between A and C, you need
+> to following the instructions for both A and B.
+
+## Upgrade from 6.x
+
+- Change layout value that passed to `ViewRenderer` constructor and `withLayout()` method to full path.

composer.json

@@ -35,7 +35,7 @@
         "yiisoft/friendly-exception": "^1.0",
         "yiisoft/html": "^2.5|^3.0",
         "yiisoft/strings": "^2.0",
-        "yiisoft/view": "^6.0|^7.0|^8.0"
+        "yiisoft/view": "^9.0"
     },
     "require-dev": {
         "httpsoft/http-message": "^1.0",

src/ViewRenderer.php

@@ -27,7 +27,6 @@
 use function is_array;
 use function is_int;
 use function is_string;
-use function pathinfo;
 use function preg_match;
 use function rtrim;
 use function sprintf;
@@ -61,8 +60,8 @@ final class ViewRenderer implements ViewContextInterface
      * @param Aliases $aliases The aliases instance.
      * @param WebView $view The web view instance.
      * @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 string|null $layout The full path to the layout file to be applied to views. If null, the layout will
+     * not be applied.
      * @param array $injections The injection instances or class names.
      *
      * @psalm-param array<object|string> $injections
@@ -241,8 +240,8 @@ public function withViewPath(string $viewPath): self
     /**
      * Returns a new instance with the specified layout.
      *
-     * @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 string|null $layout The full path to the layout file to be applied to views. If null, the layout will
+     * not be applied.
      */
     public function withLayout(?string $layout): self
     {
@@ -331,7 +330,7 @@ private function renderProxy(
             return $content;
         }
 
-        $layout = $this->findLayoutFile($this->layout, $currentView);
+        $layout = $this->aliases->get($this->layout);
 
         $layoutParameters = array_filter(
             $injectLayoutParameters,
@@ -511,30 +510,6 @@ private function injectLinkTags(array $tags, WebView $view): void
         }
     }
 
-    /**
-     * Finds a layout file based on the given file path or alias.
-     *
-     * @param string $file The file path or alias.
-     *
-     * @return string The path to the file with the file extension.
-     */
-    private function findLayoutFile(string $file, WebView $view): string
-    {
-        $file = $this->aliases->get($file);
-
-        if (pathinfo($file, PATHINFO_EXTENSION) !== '') {
-            return $file;
-        }
-
-        $layoutFile = $file . '.' . $view->getDefaultExtension();
-
-        if ($view->getDefaultExtension() !== 'php' && !is_file($layoutFile)) {
-            $layoutFile = $file . '.php';
-        }
-
-        return $layoutFile;
-    }
-
     /**
      * Returns a controller name based on controller instance.
      *

tests/ViewRendererTest.php

@@ -39,14 +39,11 @@ final class ViewRendererTest extends TestCase
 {
     use TestTrait;
 
-    /**
-     * @dataProvider extensionsProvider
-     */
-    public function testRenderAndRenderAsString(string $extension): void
+    public function testRenderAndRenderAsString(): void
     {
         $renderer = $this
-            ->getRenderer($extension)
-            ->withLayout('@views/with-injection/layout')
+            ->getRenderer()
+            ->withLayout('@views/with-injection/layout.php')
             ->withControllerName('with-injection')
             ->withInjections(new TestInjection());
 
@@ -77,14 +74,6 @@ public function testRenderAndRenderAsString(string $extension): void
         );
     }
 
-    public function extensionsProvider(): array
-    {
-        return [
-            ['php'],
-            ['tpl'],
-        ];
-    }
-
     public function testRenderWithAbsoluteLayoutPath(): void
     {
         $renderer = $this
@@ -371,7 +360,7 @@ public function testLayoutParametersInjectionsToNestedViews(): void
     {
         $renderer = $this
             ->getRenderer()
-            ->withLayout('@views/nested-layout/layout')
+            ->withLayout('@views/nested-layout/layout.php')
             ->withInjections(new TitleInjection());
 
         $response = $renderer->render('empty');
@@ -386,7 +375,7 @@ public function testChangeInjectionsAfterCreateProxyAndBeforeRender(): void
     {
         $renderer = $this
             ->getRenderer()
-            ->withLayout('@views/with-injection/layout')
+            ->withLayout('@views/with-injection/layout.php')
             ->withControllerName('with-injection')
             ->withInjections(new TestInjection());
 
@@ -419,7 +408,7 @@ public function testPassingCommonParametersFromContentToLayout(): void
         $renderer = $this
             ->getRenderer()
             ->withViewPath('@views/passing-parameters-to-layout')
-            ->withLayout('@views/passing-parameters-to-layout/layout');
+            ->withLayout('@views/passing-parameters-to-layout/layout.php');
 
         $response = $renderer->render('content', [
             'h1' => 'HELLO',
@@ -434,7 +423,7 @@ public function testCommonParametersOverrideLayout(): void
     {
         $renderer = $this
             ->getRenderer()
-            ->withLayout('@views/override-layout-parameters/layout')
+            ->withLayout('@views/override-layout-parameters/layout.php')
             ->withInjections(new CommonParametersInjection());
 
         $response = $renderer->render('empty');
@@ -449,7 +438,7 @@ public function testInRenderSetParametersOverrideLayout(): void
         $renderer = $this
             ->getRenderer()
             ->withViewPath('@views/override-layout-parameters')
-            ->withLayout('@views/override-layout-parameters/layout')
+            ->withLayout('@views/override-layout-parameters/layout.php')
             ->withInjections(new CommonParametersInjection(), new LayoutParametersInjection());
 
         $response = $renderer->render('content');
@@ -463,7 +452,7 @@ public function testRenderParametersNotOverrideLayout(): void
     {
         $renderer = $this
             ->getRenderer()
-            ->withLayout('@views/override-layout-parameters/layout')
+            ->withLayout('@views/override-layout-parameters/layout.php')
             ->withInjections(new LayoutParametersInjection());
 
         $response = $renderer->render('empty', ['seoTitle' => 'custom']);
@@ -494,7 +483,7 @@ public function testLazyLoadingInjection(): void
 
         $renderer = $this
             ->getRenderer(injectionContainer: new InjectionContainer($container))
-            ->withLayout('@views/simple/layout')
+            ->withLayout('@views/simple/layout.php')
             ->withControllerName('simple')
             ->withInjections(CharsetInjection::class);
 
@@ -515,7 +504,7 @@ public function testLazyLoadingInjectionWithoutContainer(): void
     {
         $renderer = $this
             ->getRenderer()
-            ->withLayout('@views/simple/layout')
+            ->withLayout('@views/simple/layout.php')
             ->withControllerName('simple')
             ->withInjections(CharsetInjection::class);
 
@@ -528,14 +517,14 @@ public function testLayoutSpecificInjections(): void
     {
         $renderer = $this
             ->getRenderer()
-            ->withLayout('@views/nested-layout/layout')
+            ->withLayout('@views/nested-layout/layout.php')
             ->withInjections(
                 new LayoutSpecificInjections(
-                    '@views/nested-layout/layout',
+                    '@views/nested-layout/layout.php',
                     new TitleInjection(),
                 ),
                 new LayoutSpecificInjections(
-                    '@views/layout',
+                    '@views/layout.php',
                     new TestInjection(),
                 ),
                 new class () implements MetaTagsInjectionInterface {
@@ -568,15 +557,14 @@ public function testImmutability(): void
     }
 
     private function getRenderer(
-        string $defaultExtension = 'php',
         ?InjectionContainerInterface $injectionContainer = null,
     ): ViewRenderer {
         return new ViewRenderer(
             new DataResponseFactory(new ResponseFactory(), new StreamFactory()),
             new Aliases(['@views' => $this->getViewsDir()]),
-            (new WebView('@views', new SimpleEventDispatcher()))->withDefaultExtension($defaultExtension),
+            new WebView('@views', new SimpleEventDispatcher()),
             '@views',
-            '@views/layout',
+            '@views/layout.php',
             injectionContainer: $injectionContainer
         );
     }