http://blog.ifeeline.com/369.html中，原文作者介绍了一个查看包布局 和 页面布局 和 句柄的插件：configviewer。虽然实现比较简单，但是比较有研究价值。

首先这个插件通过Magento中的事件触发而工作的。如果不理解这个，请参考http://blog.ifeeline.com/465.html。

先看这个插件的配置文件

<?xml version="1.0"?>
<config>	
	<modules>
	<Vfeelit_Layoutviewer>
		<version>0.1.0</version>
	</Vfeelit_Layoutviewer></modules>

	<global>
		<models>
			<vfeelit_layoutviewer>
				<class>Vfeelit_Layoutviewer_Model</class>
			</vfeelit_layoutviewer>
			
			<core>
				<rewrite>
					<layout_update>Vfeelit_Layoutviewer_Model_Layout_Update</layout_update>
				</rewrite>
			</core>
			
		</models>
	
		<events>
			<controller_action_postdispatch>
				<observers>
					<vfeelit_layoutviewer_model_observer>
						<type>singleton</type>						
						<class>Vfeelit_Layoutviewer_Model_Observer</class>
						<method>checkForLayoutDisplayRequest</method>
					</vfeelit_layoutviewer_model_observer>
				</observers>
			</controller_action_postdispatch>
		</events>
	</global>	
</config>

首先是core里面的rewrite标签，这里提供了一个覆盖核心类的方法。比如，Mage:getModel(‘core/layout_update’)，获取的是Mage_Core_Model_Layout_Update，通过rewrite，那么就会得到里面对应值（Vfeelit_Layoutviewer_Model_Layout_Update）。

相当于是使用Vfeelit_Layoutviewer_Model_Layout_Update替换了系统默认的Mage_Core_Model_Layout_Update。那么看看自定义的类：

	class Vfeelit_Layoutviewer_Model_Layout_Update extends Mage_Core_Model_Layout_Update {		
		public function getPackageLayout() {
			$this->fetchFileLayoutUpdates();
			return $this->_packageLayout;
		}		
	}

这个就是自定义的类的全部内容。注意，它是继承Mage_Core_Model_Layout_Update类的(必须)，然后提供了一个自定义的方法：getPackageLayout()。当然，也可以覆盖继承过来的方法。这个就是Magento替换核心类的方案。

这里先跳到events标签，里面的controller_action_postdispatch是事件名，看起来是在控制器的分发之后触发的：

// Mage_Core_Controller_Varien_Action
    public function postDispatch()
    {
		//……
        Mage::dispatchEvent('controller_action_postdispatch', array('controller_action'=>$this));
    }

正如我们所见，的确如此。 控制器的分发过程可以参考http://blog.ifeeline.com/481.html。这个事件触发执行的代码基本可以认为是临近最后要执行的代码了，就等着把输出缓冲送回客户端了（执行完代码就输出），这个时候要执行Vfeelit_Layoutviewer_Model_Observer类对象的checkForLayoutDisplayRequest方法：

//Vfeelit_Layoutviewer_Model_Observer
		private function init() {
$this->setLayout(Mage::app()->getFrontController()->getAction()->getLayout());
			$this->setUpdate($this->getLayout()->getUpdate());
		}
		
		//entry point
		public function checkForLayoutDisplayRequest($observer) {			
			$this->init();
			$is_set = array_key_exists(self::FLAG_SHOW_LAYOUT, $_GET);
			if(		$is_set && 'package' == $_GET[self::FLAG_SHOW_LAYOUT]) {
				$this->outputPackageLayout();
			}
			else if($is_set && 'page'    == $_GET[self::FLAG_SHOW_LAYOUT]) {
				$this->outputPageLayout();			
			}
			else if($is_set && 'handles' == $_GET[self::FLAG_SHOW_LAYOUT]) {
				$this->outputHandles();
			}
		}
 

首先执行的是init方法，它从控制器中获取布局对象，这个就是Mage_Core_Model_Layout。然后这个对象保存在_data[‘layout’]中。接下来从布局对象中调用getUpdate()方法获取layout_update对象，注意，layout_update已经通过rewrite指令修改为了Vfeelit_Layoutviewer_Model_Layout_Update类型，所以这个方法就会获取一个这个类型的对象引用保存到_data[‘update’]中。 然后根据条件调用outputPackageLayout 和 outputPageLayout 和 outputHandles方法：

接下来继续看具体方法：

	class Vfeelit_Layoutviewer_Model_Observer extends Varien_Object{
		const FLAG_SHOW_LAYOUT 			= 'showLayout';
		const FLAG_SHOW_LAYOUT_FORMAT 	= 'showLayoutFormat';		
		const HTTP_HEADER_TEXT			= 'Content-Type: text/plain';
		const HTTP_HEADER_HTML			= 'Content-Type: text/html';
		const HTTP_HEADER_XML			= 'Content-Type: text/xml';
		
		private $request;
		
		private function init() {
$this->setLayout(Mage::app()->getFrontController()->getAction()->getLayout());
			$this->setUpdate($this->getLayout()->getUpdate());
		}
		
		//entry point
		public function checkForLayoutDisplayRequest($observer) {			
			$this->init();
			$is_set = array_key_exists(self::FLAG_SHOW_LAYOUT, $_GET);
			if(		$is_set && 'package' == $_GET[self::FLAG_SHOW_LAYOUT]) {
				$this->outputPackageLayout();
			}
			else if($is_set && 'page'    == $_GET[self::FLAG_SHOW_LAYOUT]) {
				$this->outputPageLayout();			
			}
			else if($is_set && 'handles' == $_GET[self::FLAG_SHOW_LAYOUT]) {
				$this->outputHandles();
			}
		}

		private function outputHandles() {
			$update = $this->getUpdate();
			$handles = $update->getHandles();
			echo '<h1>','Handles For This Request','</h1>'."\n";
			echo '<ol>' . "\n";
			foreach($handles as $handle) {
				echo '<li>',$handle,'</li>';
			}
			echo '</ol>' . "\n";			
			die();
		}
		
		private function outputHeaders() {
			$is_set = array_key_exists(self::FLAG_SHOW_LAYOUT_FORMAT,$_GET);			
			$header		= self::HTTP_HEADER_XML;
			if($is_set && 'text' == $_GET[self::FLAG_SHOW_LAYOUT_FORMAT]) {
				$header = self::HTTP_HEADER_TEXT;
			}
			header($header);
		}
		
		private function outputPageLayout() {
			$layout = $this->getLayout();		//获取layout对象
			$this->outputHeaders();		
			die($layout->getNode()->asXML());	//直接从layout获取页面布局
		}
		
		private function outputPackageLayout() {
			$update = $this->getUpdate();
			$this->outputHeaders();
			die($update->getPackageLayout()->asXML()); //从layout_update对象中获取包布局
		}
	}

看outputPageLayout方法，调用update的getPackageLayout()方法，上面已经说过，系统的Layout_Update对象已经换成了Vfeelit_Layoutviewer_Model_Layout_Update，其实它仅仅是添加了getPackageLayout方法而已。它里面调用了继承过来的fetchFileLayoutUpdates()方法，它把所有的布局XML读取进来，然后放入到_packageLayout中。细节可以参考：http://blog.ifeeline.com/488.html。

考虑到事件的触发是在postdispatch时，看起来，这个layout_update已经读取了相关的文件了，但是那必须是在控制器方法调用了loadLayout()为假设的，如果没有调用，那意味着Layout_update还没有读取布局xml文件。当要读取包布局时就是空白了。为了无论如何至少能把包布局呈现出来了，这里重写了Layout_Update类并实现了getPackageLayout方法，不管如何都读取包布局（如果没有执行loadLayout方法，句柄和页面布局是无法呈现的），但是这里的考虑还是有一点欠缺，因为layout_update的内容可能还有来自数据库的配置（目录产品CMS都可能应用自定义的布局配置，写入数据库中），方法中直接读取文件配置，没有考虑这个。改进方法是，如果有Layout_Update对象，就使用它，如果没有才强制手动读取：

	class Vfeelit_Layoutviewer_Model_Layout_Update extends Mage_Core_Model_Layout_Update {		
		public function getPackageLayout() {
			if(empty($this->_packageLayout)){
				$this->fetchFileLayoutUpdates();
			}
			return $this->_packageLayout;
		}		
}

这个工具是在做页面布局时可以使得我们可以查看包布局和页面布局和句柄，非常实用。同时，通过研究这个工具的代码，可以知道如果重写系统的核心类和系统的事件机制，还有控制器分发过程和包布局和页面布局与句柄的关系(使用句柄从包布局中剥离页面布局)。

永久链接：http://blog.ifeeline.com/512.html
原创文章，转载务必保留出处。