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_Core
 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:  * Emulation model
 29:  *
 30:  * @category    Mage
 31:  * @package     Mage_Core
 32:  * @author      Magento Core Team <core@magentocommerce.com>
 33:  */
 34: class Mage_Core_Model_App_Emulation extends Varien_Object
 35: {
 36:     /**
 37:      * Start enviromment emulation of the specified store
 38:      *
 39:      * Function returns information about initial store environment and emulates environment of another store
 40:      *
 41:      * @param integer $storeId
 42:      * @param string $area
 43:      * @param boolean $emulateSroreInlineTranslation emulate inline translation of the specified store or just disable it
 44:      *
 45:      * @return Varien_Object information about environment of the initial store
 46:      */
 47:     public function startEnvironmentEmulation($storeId, $area = Mage_Core_Model_App_Area::AREA_FRONTEND, $emulateSroreInlineTranslation = false)
 48:     {
 49:         if (is_null($area)) {
 50:             $area = Mage_Core_Model_App_Area::AREA_FRONTEND;
 51:         }
 52:         if ($emulateSroreInlineTranslation) {
 53:             $initialTranslateInline = $this->_emulateInlineTranslation($storeId, $area);
 54:         } else {
 55:             $initialTranslateInline = $this->_emulateInlineTranslation();
 56:         }
 57:         $initialDesign = $this->_emulateDesign($storeId, $area);
 58:         // Current store needs to be changed right before locale change and after design change
 59:         Mage::app()->setCurrentStore($storeId);
 60:         $initialLocaleCode = $this->_emulateLocale($storeId, $area);
 61: 
 62:         $initialEnvironmentInfo = new Varien_Object();
 63:         $initialEnvironmentInfo->setInitialTranslateInline($initialTranslateInline)
 64:             ->setInitialDesign($initialDesign)
 65:             ->setInitialLocaleCode($initialLocaleCode);
 66: 
 67:         return $initialEnvironmentInfo;
 68:     }
 69: 
 70:     /**
 71:      * Stop enviromment emulation
 72:      *
 73:      * Function restores initial store environment
 74:      *
 75:      * @param Varien_Object $initialEnvironmentInfo information about environment of the initial store
 76:      *
 77:      * @return Mage_Core_Model_App_Emulation
 78:      */
 79:     public function stopEnvironmentEmulation(Varien_Object $initialEnvironmentInfo)
 80:     {
 81:         $this->_restoreInitialInlineTranslation($initialEnvironmentInfo->getInitialTranslateInline());
 82:         $initialDesign = $initialEnvironmentInfo->getInitialDesign();
 83:         $this->_restoreInitialDesign($initialDesign);
 84:         // Current store needs to be changed right before locale change and after design change
 85:         Mage::app()->setCurrentStore($initialDesign['store']);
 86:         $this->_restoreInitialLocale($initialEnvironmentInfo->getInitialLocaleCode(), $initialDesign['area']);
 87:         return $this;
 88:     }
 89: 
 90:     /**
 91:      * Emulate inline translation of the specified store
 92:      *
 93:      * Function disables inline translation if $storeId is null
 94:      *
 95:      * @param integer|null $storeId
 96:      * @param string $area
 97:      *
 98:      * @return boolean initial inline translation state
 99:      */
100:     protected function _emulateInlineTranslation($storeId = null, $area = Mage_Core_Model_App_Area::AREA_FRONTEND)
101:     {
102:         if (is_null($storeId)) {
103:             $newTranslateInline = false;
104:         } else {
105:             if ($area == Mage_Core_Model_App_Area::AREA_ADMINHTML) {
106:                 $newTranslateInline = Mage::getStoreConfigFlag('dev/translate_inline/active_admin', $storeId);
107:             } else {
108:                 $newTranslateInline = Mage::getStoreConfigFlag('dev/translate_inline/active', $storeId);
109:             }
110:         }
111:         $translateModel = Mage::getSingleton('core/translate');
112:         $initialTranslateInline = $translateModel->getTranslateInline();
113:         $translateModel->setTranslateInline($newTranslateInline);
114:         return $initialTranslateInline;
115:     }
116: 
117:     /**
118:      * Apply design of the specified store
119:      *
120:      * @param integer $storeId
121:      * @param string $area
122:      *
123:      * @return array initial design parameters(package, store, area)
124:      */
125:     protected function _emulateDesign($storeId, $area = Mage_Core_Model_App_Area::AREA_FRONTEND)
126:     {
127:         $initialDesign = Mage::getDesign()->setAllGetOld(array(
128:             'package' => Mage::getStoreConfig('design/package/name', $storeId),
129:             'store'   => $storeId,
130:             'area'    => $area
131:         ));
132:         Mage::getDesign()->setTheme('');
133:         Mage::getDesign()->setPackageName('');
134:         return $initialDesign;
135:     }
136: 
137:     /**
138:      * Apply locale of the specified store
139:      *
140:      * @param integer $storeId
141:      * @param string $area
142:      *
143:      * @return string initial locale code
144:      */
145:     protected function _emulateLocale($storeId, $area = Mage_Core_Model_App_Area::AREA_FRONTEND)
146:     {
147:         $initialLocaleCode = Mage::app()->getLocale()->getLocaleCode();
148:         $newLocaleCode = Mage::getStoreConfig(Mage_Core_Model_Locale::XML_PATH_DEFAULT_LOCALE, $storeId);
149:         Mage::app()->getLocale()->setLocaleCode($newLocaleCode);
150:         Mage::getSingleton('core/translate')->setLocale($newLocaleCode)->init($area, true);
151:         return $initialLocaleCode;
152:     }
153: 
154:     /**
155:      * Restore initial inline translation state
156:      *
157:      * @param boolean $initialTranslateInline
158:      *
159:      * @return Mage_Core_Model_App_Emulation
160:      */
161:     protected function _restoreInitialInlineTranslation($initialTranslateInline)
162:     {
163:         $translateModel = Mage::getSingleton('core/translate');
164:         $translateModel->setTranslateInline($initialTranslateInline);
165:         return $this;
166:     }
167: 
168:     /**
169:      * Restore design of the initial store
170:      *
171:      * @param array $initialDesign
172:      *
173:      * @return Mage_Core_Model_App_Emulation
174:      */
175:     protected function _restoreInitialDesign(array $initialDesign)
176:     {
177:         Mage::getDesign()->setAllGetOld($initialDesign);
178:         Mage::getDesign()->setTheme('');
179:         Mage::getDesign()->setPackageName('');
180:         return $this;
181:     }
182: 
183:     /**
184:      * Restore locale of the initial store
185:      *
186:      * @param string $initialLocaleCode
187:      * @param string $initialArea
188:      *
189:      * @return Mage_Core_Model_App_Emulation
190:      */
191:     protected function _restoreInitialLocale($initialLocaleCode, $initialArea = Mage_Core_Model_App_Area::AREA_ADMINHTML)
192:     {
193:         Mage::app()->getLocale()->setLocaleCode($initialLocaleCode);
194:         Mage::getSingleton('core/translate')->setLocale($initialLocaleCode)->init($initialArea, true);
195:         return $this;
196:     }
197: }
198: