Merge pull request #192 from thephpleague/183-default-layout-ext

Default Layouts #183

composer.json

@@ -30,7 +30,8 @@
         "peridot-php/leo": "^1.6",
         "peridot-php/peridot": "^1.19",
         "peridot-php/peridot-code-coverage-reporters": "^3.0",
-        "squizlabs/php_codesniffer": "~1.5"
+        "squizlabs/php_codesniffer": "~1.5",
+        "symfony/var-dumper": "^4.0"
     },
     "autoload": {
         "psr-4": {

src/Engine.php

@@ -11,7 +11,7 @@ public function __construct($config = []) {
         $this->container = new Util\Container();
 
         $this->container->add('engine_methods', []);
-        $this->container->add('config', array_merge([
+        $this->container->add('config', [
             'render_context_var_name' => 'v',
             'ext' => 'phtml',
             'base_dir' => null,
@@ -20,7 +20,7 @@ public function __construct($config = []) {
             'validate_paths' => true,
             'php_extensions' => ['php', 'phtml'],
             'image_extensions' => ['png', 'jpg'],
-        ], $config));
+        ]);
         $this->container->add('compose', function($c) {
             return Util\id();
         });
@@ -63,6 +63,8 @@ public function __construct($config = []) {
         $this->register(new Extension\RenderContext\RenderContextExtension());
         $this->register(new Extension\LayoutSections\LayoutSectionsExtension());
         $this->register(new Extension\Folders\FoldersExtension());
+
+        $this->addConfig($config);
     }
 
     /** @return string */

src/Extension/LayoutSections/DefaultLayoutRenderTemplate.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace League\Plates\Extension\LayoutSections;
+
+use League\Plates;
+
+final class DefaultLayoutRenderTemplate extends Plates\RenderTemplate\RenderTemplateDecorator
+{
+    private $layout_path;
+
+    public function __construct(Plates\RenderTemplate $render, $layout_path) {
+        parent::__construct($render);
+        $this->layout_path = $layout_path;
+    }
+
+    public function renderTemplate(Plates\Template $template, Plates\RenderTemplate $rt = null) {
+        $ref = $template->reference;
+        $contents = $this->render->renderTemplate($template, $rt ?: $this);
+
+        if ($ref()->get('layout') || $ref()->get('is_default_layout')) {
+            return $contents;
+        }
+
+        $layout = $ref()->fork($this->layout_path, [], ['is_default_layout' => true]);
+        $ref()->with('layout', $layout->reference);
+
+        return $contents;
+    }
+
+    public static function factory($layout_path) {
+        return function(Plates\RenderTemplate $rt) use ($layout_path) {
+            return new self($rt, $layout_path);
+        };
+    }
+}
+
+

src/Extension/LayoutSections/LayoutRenderTemplate.php

@@ -20,6 +20,12 @@ public function renderTemplate(Plates\Template $template, Plates\RenderTemplate
 
         return ($rt ?: $this)->renderTemplate($layout);
     }
+
+    public static function factory() {
+        return function(Plates\RenderTemplate $render) {
+            return new static($render);
+        };
+    }
 }
 
 

src/Extension/LayoutSections/LayoutSectionsExtension.php

@@ -10,10 +10,15 @@ final class LayoutSectionsExtension implements Plates\Extension
     public function register(Plates\Engine $plates) {
         $c = $plates->getContainer();
 
+        $c->merge('config', ['default_layout_path' => null]);
         $c->wrap('compose', function($compose, $c) {
             return Plates\Util\compose($compose, sectionsCompose());
         });
-        $c->wrap('renderTemplate.factories', function($factories) {
+        $c->wrap('renderTemplate.factories', function($factories, $c) {
+            $default_layout_path = $c->get('config')['default_layout_path'];
+            if ($default_layout_path) {
+                $factories[] = DefaultLayoutRenderTemplate::factory($default_layout_path);
+            }
             $factories[] = LayoutRenderTemplate::factory();
             return $factories;
         });

src/Extension/RenderContext/RenderContextExtension.php

@@ -17,7 +17,8 @@ public function register(Plates\Engine $plates) {
                 'plates' => Plates\Util\stackGroup([
                     aliasNameFunc($c->get('renderContext.func.aliases')),
                     splitByNameFunc($c->get('renderContext.func.funcs'))
-                ])
+                ]),
+                'notFound' => notFoundFunc(),
             ];
         });
         $c->add('renderContext.func.aliases', [

src/Extension/RenderContext/func.php

@@ -188,3 +188,9 @@ function splitByNameFunc(array $handlers) {
         return $next($args);
     };
 }
+
+function notFoundFunc() {
+    return function(FuncArgs $args) {
+        throw new FuncException('The function ' . $args->func_name . ' does not exist.');
+    };
+}

src/RenderTemplate/RenderTemplateDecorator.php

@@ -13,10 +13,4 @@ public function __construct(Plates\RenderTemplate $render) {
     }
 
     abstract public function renderTemplate(Plates\Template $template, Plates\RenderTemplate $rt = null);
-
-    public static function factory() {
-        return function(Plates\RenderTemplate $render) {
-            return new static($render);
-        };
-    }
 }

test/integration/fixtures/default-layout/_layout.phtml

@@ -0,0 +1,3 @@
+<div>
+    <?=$v->section('content')?>
+</div>

test/integration/fixtures/default-layout/main.phtml

@@ -0,0 +1 @@
+<div>main</div>

test/integration/layout-sections.spec.php

@@ -0,0 +1,20 @@
+<?php
+
+use League\Plates;
+
+describe('Layout Sections Extension', function() {
+    it('allows default layout', function() {
+        $plates = new Plates\Engine([
+            'base_dir' => __DIR__ . '/fixtures/default-layout',
+            'default_layout_path' => './_layout',
+        ]);
+
+        $html = <<<html
+<div>
+    <div>main</div>
+</div>
+
+html;
+        expect($plates->render('main'))->equal($html);
+    });
+});