Starting the extend() feature.

Adding a simple test case. Still need to add callbacks around every view fragment rendered. Without that CacheHelper will not be able to cache extended views correctly.
cakephp · Dec 18, 2011 · b6919a0 · b6919a0
1 parent b866c00
commit b6919a0
Show file tree

Hide file tree

Showing 2 changed files with 86 additions and 7 deletions.
diff --git a/lib/Cake/Test/Case/View/ViewTest.php b/lib/Cake/Test/Case/View/ViewTest.php
@@ -1025,4 +1025,22 @@ public function testBlocks() {
 
 		$this->assertEquals(array('test', 'test1'), $this->View->blocks());
 	}
+
+/**
+ * Test nested extended views.
+ *
+ * @return void
+ */
+	public function testExtendNested() {
+		$this->View->layout = false;
+		$content = $this->View->render('nested_extends');
+		$expected = <<<TEXT
+This is the second parent.
+This is the first parent.
+This is the first template.
+Sidebar Content.
+
+TEXT;
+		$this->assertEquals($expected, $content);
+	}
 }
diff --git a/lib/Cake/View/View.php b/lib/Cake/View/View.php
@@ -246,6 +246,27 @@ class View extends Object {
  */
 	protected $_helpersLoaded = false;
 
+/**
+ * The names of views and their parents used with View::extend();
+ *
+ * @var array
+ */
+	protected $_parents = array();
+
+/**
+ * The currently rendering view file.
+ *
+ * @var string
+ */
+	protected $_current = null;
+
+/**
+ * Content stack, used for nested templates that all use View::extend();
+ *
+ * @var array
+ */
+	protected $_stack = array();
+
 /**
  * Constructor
  *
@@ -399,7 +420,14 @@ public function render($view = null, $layout = null) {
  * - `scripts_for_layout` - Contains content added with addScript() as well as any content in
  *   the 'meta', 'css', and 'script' blocks.  They are appended in that order.
  *
- * `$scripts_for_layout` is deprecated and will be removed in CakePHP 3.0
+ * Deprecated features:
+ * 
+ * - `$scripts_for_layout` is deprecated and will be removed in CakePHP 3.0.
+ *   Use the block features instead.  `meta`, `css` and `script` will be populated
+ *   by the matching methods on HtmlHelper.
+ * - `$title_for_layout` is deprecated and will be removed in CakePHP 3.0
+ * - `$content_for_layout` is deprecated and will be removed in CakePHP 3.0.  
+ *   Use the `content` block instead.
  *
  * @param string $content_for_layout Content to render in a view, wrapped by the surrounding layout.
  * @param string $layout Layout name
@@ -605,6 +633,16 @@ public function end() {
 		$this->__activeBlock = null;
 	}
 
+/**
+ * Provides view or element extension/inheritance.  Views can extends a 
+ * parent view and populate blocks in the parent template.
+ *
+ * @param string $name The view or element to 'extend' the current one with.
+ */
+	public function extend($name) {
+		$this->_parents[$this->_current] = $this->_getViewFileName($name);
+	}
+
 /**
  * Adds a script block or other element to be inserted in $scripts_for_layout in
  * the `<head />` of a document layout
@@ -711,17 +749,40 @@ public function loadHelpers() {
 
 /**
  * Renders and returns output for given view filename with its
- * array of data.
+ * array of data. Handles parent/extended views.
  *
- * @param string $___viewFn Filename of the view
- * @param array $___dataForView Data to include in rendered view. If empty the current View::$viewVars will be used.
+ * @param string $viewFile Filename of the view
+ * @param array $data Data to include in rendered view. If empty the current View::$viewVars will be used.
  * @return string Rendered output
  */
-	protected function _render($___viewFn, $___dataForView = array()) {
-		if (empty($___dataForView)) {
-			$___dataForView = $this->viewVars;
+	protected function _render($viewFile, $data = array()) {
+		if (empty($data)) {
+			$data = $this->viewVars;
+		}
+		$this->_current = $viewFile;
+		$content = $this->_evaluate($viewFile, $data);
+
+		if (isset($this->_parents[$viewFile])) {
+			$this->_stack[] = $this->fetch('content');
+			$this->assign('content', $content);
+
+			$content = $this->_render($this->_parents[$viewFile], $data);
+
+			$this->assign('content', array_pop($this->_stack));
 		}
 
+		return $content;
+	}
+
+/**
+ * Sandbox method to evaluate a template / view script in.
+ *
+ * @param string $___viewFn Filename of the view
+ * @param array $___dataForView Data to include in rendered view. 
+ *    If empty the current View::$viewVars will be used.
+ * @return string Rendered output
+ */
+	protected function _evaluate($___viewFn, $___dataForView) {
 		extract($___dataForView, EXTR_SKIP);
 		ob_start();