Extracting ViewBlock from View.

View was getting too fat.

lib/Cake/View/View.php

@@ -20,6 +20,7 @@
 App::uses('HelperCollection', 'View');
 App::uses('AppHelper', 'View/Helper');
 App::uses('Router', 'Routing');
+App::uses('ViewBlock', 'View');
 
 /**
  * View, the V in the MVC triad. View interacts with Helpers and view variables passed
@@ -52,6 +53,13 @@ class View extends Object {
  */
 	public $Helpers;
 
+/**
+ * ViewBlock instance.
+ *
+ * @var ViewBlock
+ */
+	public $Blocks;
+
 /**
  * Name of the plugin.
  *
@@ -218,20 +226,6 @@ class View extends Object {
  */
 	protected $_scripts = array();
 
-/**
- * Block content.  An array of blocks indexed by name.
- *
- * @var array
- */
-	protected $_blocks = array();
-
-/**
- * Name of the block being captured.
- *
- * @var string
- */
-	private $__activeBlock = null;
-
 /**
  * Holds an array of paths.
  *
@@ -289,6 +283,7 @@ class View extends Object {
 			}
 		}
 		$this->Helpers = new HelperCollection($this);
+		$this->Blocks = new ViewBlock();
 		parent::__construct();
 	}
 
@@ -549,54 +544,35 @@ class View extends Object {
  * Get the names of all the existing blocks.
  *
  * @return array An array containing the blocks.
+ * @see ViewBlock::keys()
  */
 	public function blocks() {
-		return array_keys($this->_blocks);
+		return $this->Blocks->keys();
 	}
 
 /**
  * Start capturing output for a 'block'
  *
- * Blocks allow you to create slots or blocks of dynamic content in the layout.
- * view files can implement some or all of a layout's slots.
- *
- * You can end capturing blocks using View::end().  Blocks can be output
- * using View::get();
- *
  * @param string $name The name of the block to capture for.
  * @return void
+ * @see ViewBlock::start()
  */
 	public function start($name) {
-		$this->__activeBlock = $name;
+		return $this->Blocks->start($name);
-		ob_start();
 	}
 
 /**
  * Append to an existing or new block.  Appending to a new 
  * block will create the block.
  *
- * Calling append() without a value will create a new capturing
- * block that needs to be finished with View::end(). The content
- * of the new capturing context will be added to the existing block context.
- *
  * @param string $name Name of the block
  * @param string $value The content for the block.
  * @return void
  * @throws CakeException when you use non-string values.
+ * @see ViewBlock::append()
  */
 	public function append($name, $value = null) {
-		if (isset($value)) {
+		return $this->Blocks->append($name, $value);
-			if (!is_string($value)) {
-				throw new CakeException(__d('cake_dev', '$value must be a string.'));
-			}
-			if (!isset($this->_blocks[$name])) {
-				$this->_blocks[$name] = '';
-			}
-			$this->_blocks[$name] .= $value;
-		} else {
-			$this->_blockAppend = true;
-			$this->start($name);
-		}
 	}
 
 /**
@@ -607,12 +583,10 @@ class View extends Object {
  * @param string $value The content for the block.
  * @return void
  * @throws CakeException when you use non-string values.
+ * @see ViewBlock::assign()
  */
 	public function assign($name, $value) {
-		if (!is_string($value)) {
+		return $this->Blocks->set($name, $value);
-			throw new CakeException(__d('cake_dev', 'Blocks can only contain strings.'));
-		}
-		$this->_blocks[$name] = $value;
 	}
 
 /**
@@ -620,29 +594,20 @@ class View extends Object {
  *
  * @param string $name Name of the block
  * @return The block content or '' if the block does not exist.
+ * @see ViewBlock::fetch()
  */
 	public function fetch($name) {
-		if (!isset($this->_blocks[$name])) {
+		return $this->Blocks->get($name);
-			return '';
-		}
-		return $this->_blocks[$name];
 	}
 
 /**
  * End a capturing block. The compliment to View::start()
  *
  * @return void
- * @see View::start()
+ * @see ViewBlock::start()
  */
 	public function end() {
-		if (!empty($this->__activeBlock)) {
+		return $this->Blocks->end();
-			$content = ob_get_clean();
-			if (!isset($this->_blocks[$this->__activeBlock])) {
-				$this->_blocks[$this->__activeBlock] = '';
-			}
-			$this->_blocks[$this->__activeBlock] .= $content;
-		}
-		$this->__activeBlock = null;
 	}
 
 /**
@@ -650,6 +615,7 @@ class View extends Object {
  * parent view and populate blocks in the parent template.
  *
  * @param string $name The view or element to 'extend' the current one with.
+ * @return void
  */
 	public function extend($name) {
 		if ($this->_inElement) {

lib/Cake/View/ViewBlock.php

@@ -0,0 +1,138 @@
+<?php
+/**
+ * PHP 5
+ *
+ * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
+ * Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
+ *
+ * Licensed under The MIT License
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
+ * @link          http://cakephp.org CakePHP(tm) Project
+ * @since         CakePHP(tm) v2.1
+ * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
+ */
+/**
+ * ViewBlock implements the concept of Blocks or Slots in the View layer.
+ * Slots or blocks are combined with extending views and layouts to afford slots
+ * of content that are present in a layout or parent view, but are defined by the child
+ * view or elements used in the view.
+ *
+ * @package Cake.View
+ */
+class ViewBlock {
+
+/**
+ * Block content.  An array of blocks indexed by name.
+ *
+ * @var array
+ */
+	protected $_blocks = array();
+
+/**
+ * The active block being captured.
+ *
+ * @var string
+ */
+	protected $_active = null;
+
+/**
+ * Start capturing output for a 'block'
+ *
+ * Blocks allow you to create slots or blocks of dynamic content in the layout.
+ * view files can implement some or all of a layout's slots.
+ *
+ * You can end capturing blocks using View::end().  Blocks can be output
+ * using View::get();
+ *
+ * @param string $name The name of the block to capture for.
+ * @return void
+ */
+	public function start($name) {
+		$this->_active = $name;
+		ob_start();
+	}
+
+/**
+ * End a capturing block. The compliment to ViewBlock::start()
+ *
+ * @return void
+ * @see ViewBlock::start()
+ */
+	public function end() {
+		if (!empty($this->_active)) {
+			$content = ob_get_clean();
+			if (!isset($this->_blocks[$this->_active])) {
+				$this->_blocks[$this->_active] = '';
+			}
+			$this->_blocks[$this->_active] .= $content;
+		}
+		$this->_active = null;
+	}
+
+/**
+ * Append to an existing or new block.  Appending to a new 
+ * block will create the block.
+ *
+ * Calling append() without a value will create a new capturing
+ * block that needs to be finished with View::end(). The content
+ * of the new capturing context will be added to the existing block context.
+ *
+ * @param string $name Name of the block
+ * @param string $value The content for the block.
+ * @return void
+ * @throws CakeException when you use non-string values.
+ */
+	public function append($name, $value = null) {
+		if (isset($value)) {
+			if (!is_string($value)) {
+				throw new CakeException(__d('cake_dev', '$value must be a string.'));
+			}
+			if (!isset($this->_blocks[$name])) {
+				$this->_blocks[$name] = '';
+			}
+			$this->_blocks[$name] .= $value;
+		} else {
+			$this->start($name);
+		}
+	}
+
+/**
+ * Set the content for a block.  This will overwrite any
+ * existing content.
+ *
+ * @param string $name Name of the block
+ * @param string $value The content for the block.
+ * @return void
+ * @throws CakeException when you use non-string values.
+ */
+	public function set($name, $value) {
+		if (!is_string($value)) {
+			throw new CakeException(__d('cake_dev', 'Blocks can only contain strings.'));
+		}
+		$this->_blocks[$name] = $value;
+	}
+
+/**
+ * Get the content for a block.
+ *
+ * @param string $name Name of the block
+ * @return The block content or '' if the block does not exist.
+ */
+	public function get($name) {
+		if (!isset($this->_blocks[$name])) {
+			return '';
+		}
+		return $this->_blocks[$name];
+	}
+
+/**
+ * Get the names of all the existing blocks.
+ *
+ * @return array An array containing the blocks.
+ */
+	public function keys() {
+		return array_keys($this->_blocks);
+	}
+}