Add PartialView class, fix issue with stashing/restoring context in W…

…ireframe::render()

CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.29.0] - 2024-01-10
+
+### Added
+- New PartialView class that extends TemplateFile core class.
+
+### Fixed
+- Fixed an issue where rendering page within page did not properly restore the $view API variable to the state it was in before rendering said page.
+
 ## [0.28.0] - 2024-01-10
 
 ### Added

Wireframe.info.json

@@ -1,7 +1,7 @@
 {
     "title": "Wireframe",
     "summary": "Wireframe is an output framework for ProcessWire CMS/CMF.",
-    "version": "0.28.0",
+    "version": "0.29.0",
     "author": "Teppo Koivula",
     "href": "https://wireframe-framework.com",
     "requires": [

Wireframe.module.php

@@ -14,7 +14,7 @@
  * @method static string|Page|NullPage page($source, $args = []) Static getter (factory) method for Pages.
  * @method static string|null partial(string $partial_name, array $args = []) Static getter (factory) method for Partials.
  *
- * @version 0.28.0
+ * @version 0.29.0
  * @author Teppo Koivula <[email protected]>
  * @license Mozilla Public License v2.0 https://mozilla.org/MPL/2.0/
  */
@@ -853,6 +853,7 @@ public function ___render(array $data = []): ?string {
             $stashed_context = array_pop($this->stash);
             $this->page = $stashed_context['page'];
             $this->view = $stashed_context['view'];
+            $this->wire('view', $this->view);
             $this->controller = $stashed_context['controller'];
             $this->data = $stashed_context['data'];
             if ($this->page && $this->controller) {

lib/Partial.php

@@ -20,6 +20,13 @@ class Partial extends \ProcessWire\Wire {
      */
     protected $filenames = [];
 
+    /**
+     * Partial View
+     *
+     * @var PartialView
+     */
+    protected $partial_view;
+
     /**
      * Constructor
      *
@@ -72,10 +79,12 @@ public function ___render(array $args = []): string {
         if (empty($filename)) {
             return '';
         }
-        $template = $this->wire(new \ProcessWire\TemplateFile());
-        $template->setFilename($filename);
-        $template->data($args);
-        return $template->render() ?: '';
+        if (!$this->partial_view) {
+            $this->partial_view = $this->wire(new PartialView());
+        }
+        $this->partial_view->setFilename($filename);
+        $this->partial_view->data($args);
+        return $this->partial_view->render() ?: '';
     }
 
     /**

lib/PartialView.php

@@ -0,0 +1,63 @@
+<?php
+
+namespace Wireframe;
+
+use ProcessWire\WireException;
+
+/**
+ * Wireframe Partial View component
+ *
+ * This class is a wrapper for the ProcessWire TemplateFile class with some modifications and the
+ * addition of the Wireframe namespace.
+ *
+ * @version 0.0.1
+ * @author Teppo Koivula <[email protected]>
+ * @license Mozilla Public License v2.0 https://mozilla.org/MPL/2.0/
+ */
+class PartialView extends \ProcessWire\TemplateFile {
+
+    /**
+     * Render the partial
+     *
+     * This method is a copy of the TemplateFile::render() method with unnecessary parts, such as
+     * prepend/append file handling and various configuration flags, removed.
+     *
+     * @return string The output of the partial file
+     * @throws WireException if file not exist or if any exceptions is thrown by included file(s)
+     */
+    public function ___render() {
+
+        if (!$this->filename) return '';
+
+        if (!file_exists($this->filename)) {
+            $error = "Partial file does not exist: $this->filename";
+            throw new WireException($error);
+        }
+
+        $this->renderReady();
+
+        // make API variables available to PHP file
+        $fuel = array_merge($this->getArray(), self::$globals); // so that script can foreach all vars to see what's there
+        extract($fuel);
+        ob_start();
+
+        // include main file to render
+        try {
+            $this->fileReady($this->filename);
+            $this->returnValue = require($this->filename);
+            $this->fileFinished();
+        } catch(\Exception $e) {
+            if ($this->fileFailed($this->filename, $e)) throw $this->renderFailed($e);
+        }
+
+        $out = ob_get_contents();
+        ob_end_clean();
+
+        $this->renderFinished();
+
+        $out = trim($out);
+
+        return $out;
+    }
+
+}