1: <?php
  2: /**
  3:  * Magento
  4:  *
  5:  * NOTICE OF LICENSE
  6:  *
  7:  * This source file is subject to the Open Software License (OSL 3.0)
  8:  * that is bundled with this package in the file LICENSE.txt.
  9:  * It is also available through the world-wide-web at this URL:
 10:  * http://opensource.org/licenses/osl-3.0.php
 11:  * If you did not receive a copy of the license and are unable to
 12:  * obtain it through the world-wide-web, please send an email
 13:  * to license@magentocommerce.com so we can send you a copy immediately.
 14:  *
 15:  * DISCLAIMER
 16:  *
 17:  * Do not edit or add to this file if you wish to upgrade Magento to newer
 18:  * versions in the future. If you wish to customize Magento for your
 19:  * needs please refer to http://www.magentocommerce.com for more information.
 20:  *
 21:  * @category    Mage
 22:  * @package     Mage_Catalog
 23:  * @copyright   Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
 24:  * @license     http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
 25:  */
 26: 
 27: /**
 28:  * Catalog category helper
 29:  *
 30:  * @author      Magento Core Team <core@magentocommerce.com>
 31:  */
 32: class Mage_Catalog_Helper_Product_View extends Mage_Core_Helper_Abstract
 33: {
 34:     // List of exceptions throwable during prepareAndRender() method
 35:     public $ERR_NO_PRODUCT_LOADED = 1;
 36:     public $ERR_BAD_CONTROLLER_INTERFACE = 2;
 37: 
 38:      /**
 39:      * Inits layout for viewing product page
 40:      *
 41:      * @param Mage_Catalog_Model_Product $product
 42:      * @param Mage_Core_Controller_Front_Action $controller
 43:      *
 44:      * @return Mage_Catalog_Helper_Product_View
 45:      */
 46:     public function initProductLayout($product, $controller)
 47:     {
 48:         $design = Mage::getSingleton('catalog/design');
 49:         $settings = $design->getDesignSettings($product);
 50: 
 51:         if ($settings->getCustomDesign()) {
 52:             $design->applyCustomDesign($settings->getCustomDesign());
 53:         }
 54: 
 55:         $update = $controller->getLayout()->getUpdate();
 56:         $update->addHandle('default');
 57:         $controller->addActionLayoutHandles();
 58: 
 59:         $update->addHandle('PRODUCT_TYPE_' . $product->getTypeId());
 60:         $update->addHandle('PRODUCT_' . $product->getId());
 61:         $controller->loadLayoutUpdates();
 62: 
 63:         // Apply custom layout update once layout is loaded
 64:         $layoutUpdates = $settings->getLayoutUpdates();
 65:         if ($layoutUpdates) {
 66:             if (is_array($layoutUpdates)) {
 67:                 foreach($layoutUpdates as $layoutUpdate) {
 68:                     $update->addUpdate($layoutUpdate);
 69:                 }
 70:             }
 71:         }
 72: 
 73:         $controller->generateLayoutXml()->generateLayoutBlocks();
 74: 
 75:         // Apply custom layout (page) template once the blocks are generated
 76:         if ($settings->getPageLayout()) {
 77:             $controller->getLayout()->helper('page/layout')->applyTemplate($settings->getPageLayout());
 78:         }
 79: 
 80:         $currentCategory = Mage::registry('current_category');
 81:         $root = $controller->getLayout()->getBlock('root');
 82:         if ($root) {
 83:             $controllerClass = $controller->getFullActionName();
 84:             if ($controllerClass != 'catalog-product-view') {
 85:                 $root->addBodyClass('catalog-product-view');
 86:             }
 87:             $root->addBodyClass('product-' . $product->getUrlKey());
 88:             if ($currentCategory instanceof Mage_Catalog_Model_Category) {
 89:                 $root->addBodyClass('categorypath-' . $currentCategory->getUrlPath())
 90:                     ->addBodyClass('category-' . $currentCategory->getUrlKey());
 91:             }
 92:         }
 93: 
 94:         return $this;
 95:     }
 96: 
 97:     /**
 98:      * Prepares product view page - inits layout and all needed stuff
 99:      *
100:      * $params can have all values as $params in Mage_Catalog_Helper_Product - initProduct().
101:      * Plus following keys:
102:      *   - 'buy_request' - Varien_Object holding buyRequest to configure product
103:      *   - 'specify_options' - boolean, whether to show 'Specify options' message
104:      *   - 'configure_mode' - boolean, whether we're in Configure-mode to edit product configuration
105:      *
106:      * @param int $productId
107:      * @param Mage_Core_Controller_Front_Action $controller
108:      * @param null|Varien_Object $params
109:      *
110:      * @return Mage_Catalog_Helper_Product_View
111:      */
112:     public function prepareAndRender($productId, $controller, $params = null)
113:     {
114:         // Prepare data
115:         $productHelper = Mage::helper('catalog/product');
116:         if (!$params) {
117:             $params = new Varien_Object();
118:         }
119: 
120:         // Standard algorithm to prepare and rendern product view page
121:         $product = $productHelper->initProduct($productId, $controller, $params);
122:         if (!$product) {
123:             throw new Mage_Core_Exception($this->__('Product is not loaded'), $this->ERR_NO_PRODUCT_LOADED);
124:         }
125: 
126:         $buyRequest = $params->getBuyRequest();
127:         if ($buyRequest) {
128:             $productHelper->prepareProductOptions($product, $buyRequest);
129:         }
130: 
131:         if ($params->hasConfigureMode()) {
132:             $product->setConfigureMode($params->getConfigureMode());
133:         }
134: 
135:         Mage::dispatchEvent('catalog_controller_product_view', array('product' => $product));
136: 
137:         if ($params->getSpecifyOptions()) {
138:             $notice = $product->getTypeInstance(true)->getSpecifyOptionMessage();
139:             Mage::getSingleton('catalog/session')->addNotice($notice);
140:         }
141: 
142:         Mage::getSingleton('catalog/session')->setLastViewedProductId($product->getId());
143: 
144:         $this->initProductLayout($product, $controller);
145: 
146:         $controller->initLayoutMessages(array('catalog/session', 'tag/session', 'checkout/session'))
147:             ->renderLayout();
148: 
149:         return $this;
150:     }
151: }
152: