├── README.md
├── app
    ├── code
    │   └── local
    │   │   └── Alanstormdotcom
    │   │       └── Layoutviewer
    │   │           ├── Model
    │   │               ├── Layout
    │   │               │   └── Update.php
    │   │               └── Observer.php
    │   │           └── etc
    │   │               └── config.xml
    └── etc
    │   └── modules
    │       └── Alanstormdotcom_Layoutviewer.xml
├── build_layout_viewer.bash
├── composer.json
└── modman


/README.md:
--------------------------------------------------------------------------------
 1 | LayoutViewer
 2 | ============
 3 | 
 4 | A Magento module that dumps layout information via query string.
 5 | 
 6 | This extension's functionality has been supplanted by <a href="http://store.pulsestorm.net/products/commerce-bug-2">Commerce Bug</a>, but it's kept here for historical and educational purposes. 
 7 | 
 8 | ###Layout Viewer
 9 | 
10 | Implements a query string based way to view layout information for a particular request. 
11 | 
12 | Original Blog Post: http://alanstorm.com/layouts_blocks_and_templates
13 | 
14 | ###Build Instructions
15 | 
16 | The `build_layout_viewer.bash` file is a bash script that will create a simple tar archive of the extension files. 
17 | 
18 |     $ ./build_layout_viewer.bash
19 |     
20 | This script assumes the existence of a `var` folder.    


--------------------------------------------------------------------------------
/app/code/local/Alanstormdotcom/Layoutviewer/Model/Layout/Update.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 | * The MIT License (MIT)
 4 | * 
 5 | * Copyright (c) 2010 - 2013 Pulse Storm LLC
 6 | * 
 7 | * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 | * of this software and associated documentation files (the "Software"), to deal
 9 | * in the Software without restriction, including without limitation the rights
10 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 | * copies of the Software, and to permit persons to whom the Software is
12 | * furnished to do so, subject to the following conditions:
13 | * 
14 | * The above copyright notice and this permission notice shall be included in
15 | * all copies or substantial portions of the Software.
16 | * 
17 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 | * THE SOFTWARE.
24 | */
25 | class Alanstormdotcom_Layoutviewer_Model_Layout_Update extends Mage_Core_Model_Layout_Update {		
26 |     //we'll display this request's package layout
27 |     
28 |     //we'll also display this request's "reduced" layout, etc. etc
29 |     
30 | 
31 |     public function getPackageLayout() {
32 |         $this->fetchFileLayoutUpdates();
33 |         return $this->_packageLayout;
34 |     }		
35 | }


--------------------------------------------------------------------------------
/app/code/local/Alanstormdotcom/Layoutviewer/Model/Observer.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 | * The MIT License (MIT)
 4 | * 
 5 | * Copyright (c) 2010 - 2013 Pulse Storm LLC
 6 | * 
 7 | * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 | * of this software and associated documentation files (the "Software"), to deal
 9 | * in the Software without restriction, including without limitation the rights
10 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 | * copies of the Software, and to permit persons to whom the Software is
12 | * furnished to do so, subject to the following conditions:
13 | * 
14 | * The above copyright notice and this permission notice shall be included in
15 | * all copies or substantial portions of the Software.
16 | * 
17 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 | * THE SOFTWARE.
24 | */
25 | class Alanstormdotcom_Layoutviewer_Model_Observer extends Varien_Object{
26 |     const FLAG_SHOW_LAYOUT 			= 'showLayout';
27 |     const FLAG_SHOW_LAYOUT_FORMAT 	= 'showLayoutFormat';		
28 |     const HTTP_HEADER_TEXT			= 'Content-Type: text/plain';
29 |     const HTTP_HEADER_HTML			= 'Content-Type: text/html';
30 |     const HTTP_HEADER_XML			= 'Content-Type: text/xml';
31 |     
32 |     private $request;
33 |     
34 |     private function init() {
35 |         $this->setLayout(Mage::app()->getFrontController()->getAction()->getLayout());
36 |         $this->setUpdate($this->getLayout()->getUpdate());
37 |     }
38 |     
39 |     //entry point
40 |     public function checkForLayoutDisplayRequest($observer) {			
41 |         $this->init();
42 |         /** @var Mage_Core_Controller_Varien_Action $controllerAction */
43 |         $controllerAction = $observer->getEvent()->getData('controller_action');
44 |         if ($controllerAction->getRequest()->isDispatched()) {
45 |             $is_set = array_key_exists(self::FLAG_SHOW_LAYOUT, $_GET);
46 |             if(		$is_set && 'package' == $_GET[self::FLAG_SHOW_LAYOUT]) {
47 |                 $this->outputPackageLayout();
48 |             }
49 |             else if($is_set && 'page'    == $_GET[self::FLAG_SHOW_LAYOUT]) {
50 |                 $this->outputPageLayout();			
51 |             }
52 |             else if($is_set && 'handles' == $_GET[self::FLAG_SHOW_LAYOUT]) {
53 |                 $this->outputHandles();
54 |             }
55 |         }
56 |     }
57 | 
58 |     private function outputHandles() {
59 |         $update = $this->getUpdate();
60 |         $handles = $update->getHandles();
61 |         echo '<h1>','Handles For This Request','</h1>'."\n";
62 |         echo '<ol>' . "\n";
63 |         foreach($handles as $handle) {
64 |             echo '<li>',$handle,'</li>';
65 |         }
66 |         echo '</ol>' . "\n";			
67 |         die();
68 |     }
69 |     
70 |     private function outputHeaders() {
71 |         $is_set = array_key_exists(self::FLAG_SHOW_LAYOUT_FORMAT,$_GET);			
72 |         $header		= self::HTTP_HEADER_XML;
73 |         if($is_set && 'text' == $_GET[self::FLAG_SHOW_LAYOUT_FORMAT]) {
74 |             $header = self::HTTP_HEADER_TEXT;
75 |         }
76 |         header($header);
77 |     }
78 |     
79 |     private function outputPageLayout() {
80 |         $layout = $this->getLayout();
81 |         $this->outputHeaders();		
82 |         die($layout->getNode()->asXML());		
83 |     }
84 |     
85 |     private function outputPackageLayout() {
86 |         $update = $this->getUpdate();
87 |         $this->outputHeaders();
88 |         die($update->getPackageLayout()->asXML());
89 |     }
90 | }


--------------------------------------------------------------------------------
/app/code/local/Alanstormdotcom/Layoutviewer/etc/config.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <config>	
 3 | 	<modules>
 4 | 	<Alanstormdotcom_Layoutviewer>
 5 | 		<version>0.1.0</version>
 6 | 	</Alanstormdotcom_Layoutviewer></modules>
 7 | 
 8 | 	<global>
 9 | 		<models>
10 | 			<alanstormdotcom_layoutviewer>
11 | 				<class>Alanstormdotcom_Layoutviewer_Model</class>
12 | 			</alanstormdotcom_layoutviewer>
13 | 			
14 | 			<core>
15 | 				<rewrite>
16 | 					<layout_update>Alanstormdotcom_Layoutviewer_Model_Layout_Update</layout_update>
17 | 				</rewrite>
18 | 			</core>
19 | 			
20 | 		</models>
21 | 	
22 | 		<events>
23 | 			<controller_action_postdispatch>
24 | 				<observers>
25 | 					<alanstormdotcom_layoutviewer_model_observer>
26 | 						<type>singleton</type>						
27 | 						<class>Alanstormdotcom_Layoutviewer_Model_Observer</class>
28 | 						<method>checkForLayoutDisplayRequest</method>
29 | 					</alanstormdotcom_layoutviewer_model_observer>
30 | 				</observers>
31 | 			</controller_action_postdispatch>
32 | 		</events>
33 | 	</global>	
34 | </config>
35 | 


--------------------------------------------------------------------------------
/app/etc/modules/Alanstormdotcom_Layoutviewer.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <config>
 3 | 	<modules>
 4 | 		<Alanstormdotcom_Layoutviewer>
 5 | 			<active>false</active>
 6 | 			<codePool>local</codePool>
 7 | 		</Alanstormdotcom_Layoutviewer>
 8 | 	</modules>
 9 | </config>
10 | 


--------------------------------------------------------------------------------
/build_layout_viewer.bash:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 | 
3 | mkdir var/build
4 | 
5 | #OS X, prevent ._ files
6 | export COPYFILE_DISABLE=true
7 | tar -cvf var/build/Layout_Viewer.tar app/code/local/Alanstormdotcom/Layoutviewer app/etc/modules/Alanstormdotcom_Layoutviewer.xml
8 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name"          : "pulsestorm/layoutviewer",
 3 |     "type"          : "magento-module",
 4 |     "description"   : "A Magento module that dumps layout information via query string.",    
 5 |     "version"       : "0.1.0",
 6 |     "keywords"      : ["magento","blocks","layout"],
 7 |     "license"       : "MIT",
 8 |     "homepage"      : "http://alanstorm.com/layouts_blocks_and_templates",
 9 |     
10 |     "authors": [
11 |         {
12 |             "name"  : "Alan Storm",
13 |             "email" : "alanstorm@alanstorm.com",
14 |             "homepage": "http://alanstorm.com",
15 |             "role": "developer"            
16 |         }
17 |     ],
18 |     "require": {
19 |         "php": ">=5.2.0",    
20 |         "magento-hackathon/magento-composer-installer": "*"
21 |     }
22 | }
23 | 


--------------------------------------------------------------------------------
/modman:
--------------------------------------------------------------------------------
1 | app/code/local/Alanstormdotcom/Layoutviewer/		app/code/local/Alanstormdotcom/Layoutviewer/
2 | app/etc/modules/Alanstormdotcom_Layoutviewer.xml	app/etc/modules/Alanstormdotcom_Layoutviewer.xml
3 | 


--------------------------------------------------------------------------------