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:  * Enter description here ...
 28:  *
 29:  * @method Mage_Catalog_Model_Resource_Product_Indexer_Price _getResource()
 30:  * @method Mage_Catalog_Model_Resource_Product_Indexer_Price getResource()
 31:  * @method Mage_Catalog_Model_Product_Indexer_Price setEntityId(int $value)
 32:  * @method int getCustomerGroupId()
 33:  * @method Mage_Catalog_Model_Product_Indexer_Price setCustomerGroupId(int $value)
 34:  * @method int getWebsiteId()
 35:  * @method Mage_Catalog_Model_Product_Indexer_Price setWebsiteId(int $value)
 36:  * @method int getTaxClassId()
 37:  * @method Mage_Catalog_Model_Product_Indexer_Price setTaxClassId(int $value)
 38:  * @method float getPrice()
 39:  * @method Mage_Catalog_Model_Product_Indexer_Price setPrice(float $value)
 40:  * @method float getFinalPrice()
 41:  * @method Mage_Catalog_Model_Product_Indexer_Price setFinalPrice(float $value)
 42:  * @method float getMinPrice()
 43:  * @method Mage_Catalog_Model_Product_Indexer_Price setMinPrice(float $value)
 44:  * @method float getMaxPrice()
 45:  * @method Mage_Catalog_Model_Product_Indexer_Price setMaxPrice(float $value)
 46:  * @method float getTierPrice()
 47:  * @method Mage_Catalog_Model_Product_Indexer_Price setTierPrice(float $value)
 48:  *
 49:  * @category    Mage
 50:  * @package     Mage_Catalog
 51:  * @author      Magento Core Team <core@magentocommerce.com>
 52:  */
 53: class Mage_Catalog_Model_Product_Indexer_Price extends Mage_Index_Model_Indexer_Abstract
 54: {
 55:     /**
 56:      * Data key for matching result to be saved in
 57:      */
 58:     const EVENT_MATCH_RESULT_KEY = 'catalog_product_price_match_result';
 59: 
 60:     /**
 61:      * Reindex price event type
 62:      */
 63:     const EVENT_TYPE_REINDEX_PRICE = 'catalog_reindex_price';
 64: 
 65:     /**
 66:      * Matched Entities instruction array
 67:      *
 68:      * @var array
 69:      */
 70:     protected $_matchedEntities = array(
 71:         Mage_Catalog_Model_Product::ENTITY => array(
 72:             Mage_Index_Model_Event::TYPE_SAVE,
 73:             Mage_Index_Model_Event::TYPE_DELETE,
 74:             Mage_Index_Model_Event::TYPE_MASS_ACTION,
 75:             self::EVENT_TYPE_REINDEX_PRICE,
 76:         ),
 77:         Mage_Core_Model_Config_Data::ENTITY => array(
 78:             Mage_Index_Model_Event::TYPE_SAVE
 79:         ),
 80:         Mage_Catalog_Model_Convert_Adapter_Product::ENTITY => array(
 81:             Mage_Index_Model_Event::TYPE_SAVE
 82:         ),
 83:         Mage_Customer_Model_Group::ENTITY => array(
 84:             Mage_Index_Model_Event::TYPE_SAVE
 85:         )
 86:     );
 87: 
 88:     protected $_relatedConfigSettings = array(
 89:         Mage_Catalog_Helper_Data::XML_PATH_PRICE_SCOPE,
 90:         Mage_CatalogInventory_Model_Stock_Item::XML_PATH_MANAGE_STOCK
 91:     );
 92: 
 93:     /**
 94:      * Initialize resource model
 95:      *
 96:      */
 97:     protected function _construct()
 98:     {
 99:         $this->_init('catalog/product_indexer_price');
100:     }
101: 
102:     /**
103:      * Retrieve Indexer name
104:      *
105:      * @return string
106:      */
107:     public function getName()
108:     {
109:         return Mage::helper('catalog')->__('Product Prices');
110:     }
111: 
112:     /**
113:      * Retrieve Indexer description
114:      *
115:      * @return string
116:      */
117:     public function getDescription()
118:     {
119:         return Mage::helper('catalog')->__('Index product prices');
120:     }
121: 
122:     /**
123:      * Retrieve attribute list has an effect on product price
124:      *
125:      * @return array
126:      */
127:     protected function _getDependentAttributes()
128:     {
129:         return array(
130:             'price',
131:             'special_price',
132:             'special_from_date',
133:             'special_to_date',
134:             'tax_class_id',
135:             'status',
136:             'required_options',
137:             'force_reindex_required'
138:         );
139:     }
140: 
141:     /**
142:      * Check if event can be matched by process.
143:      * Rewrited for checking configuration settings save (like price scope).
144:      *
145:      * @param Mage_Index_Model_Event $event
146:      * @return bool
147:      */
148:     public function matchEvent(Mage_Index_Model_Event $event)
149:     {
150:         $data       = $event->getNewData();
151:         if (isset($data[self::EVENT_MATCH_RESULT_KEY])) {
152:             return $data[self::EVENT_MATCH_RESULT_KEY];
153:         }
154: 
155:         if ($event->getEntity() == Mage_Core_Model_Config_Data::ENTITY) {
156:             $data = $event->getDataObject();
157:             if ($data && in_array($data->getPath(), $this->_relatedConfigSettings)) {
158:                 $result = $data->isValueChanged();
159:             } else {
160:                 $result = false;
161:             }
162:         } elseif ($event->getEntity() == Mage_Customer_Model_Group::ENTITY) {
163:             $result = $event->getDataObject() && $event->getDataObject()->isObjectNew();
164:         } else {
165:             $result = parent::matchEvent($event);
166:         }
167: 
168:         $event->addNewData(self::EVENT_MATCH_RESULT_KEY, $result);
169: 
170:         return $result;
171:     }
172: 
173:     /**
174:      * Register data required by catalog product delete process
175:      *
176:      * @param Mage_Index_Model_Event $event
177:      */
178:     protected function _registerCatalogProductDeleteEvent(Mage_Index_Model_Event $event)
179:     {
180:         /* @var $product Mage_Catalog_Model_Product */
181:         $product = $event->getDataObject();
182: 
183:         $parentIds = $this->_getResource()->getProductParentsByChild($product->getId());
184:         if ($parentIds) {
185:             $event->addNewData('reindex_price_parent_ids', $parentIds);
186:         }
187:     }
188: 
189:     /**
190:      * Register data required by catalog product save process
191:      *
192:      * @param Mage_Index_Model_Event $event
193:      */
194:     protected function _registerCatalogProductSaveEvent(Mage_Index_Model_Event $event)
195:     {
196:         /* @var $product Mage_Catalog_Model_Product */
197:         $product      = $event->getDataObject();
198:         $attributes   = $this->_getDependentAttributes();
199:         $reindexPrice = $product->getIsRelationsChanged() || $product->getIsCustomOptionChanged()
200:             || $product->dataHasChangedFor('tier_price_changed')
201:             || $product->getIsChangedWebsites()
202:             || $product->getForceReindexRequired();
203: 
204:         foreach ($attributes as $attributeCode) {
205:             $reindexPrice = $reindexPrice || $product->dataHasChangedFor($attributeCode);
206:         }
207: 
208:         if ($reindexPrice) {
209:             $event->addNewData('product_type_id', $product->getTypeId());
210:             $event->addNewData('reindex_price', 1);
211:         }
212:     }
213: 
214:     protected function _registerCatalogProductMassActionEvent(Mage_Index_Model_Event $event)
215:     {
216:         /* @var $actionObject Varien_Object */
217:         $actionObject = $event->getDataObject();
218:         $attributes   = $this->_getDependentAttributes();
219:         $reindexPrice = false;
220: 
221:         // check if attributes changed
222:         $attrData = $actionObject->getAttributesData();
223:         if (is_array($attrData)) {
224:             foreach ($attributes as $attributeCode) {
225:                 if (array_key_exists($attributeCode, $attrData)) {
226:                     $reindexPrice = true;
227:                     break;
228:                 }
229:             }
230:         }
231: 
232:         // check changed websites
233:         if ($actionObject->getWebsiteIds()) {
234:             $reindexPrice = true;
235:         }
236: 
237:         // register affected products
238:         if ($reindexPrice) {
239:             $event->addNewData('reindex_price_product_ids', $actionObject->getProductIds());
240:         }
241:     }
242: 
243:     /**
244:      * Register data required by process in event object
245:      *
246:      * @param Mage_Index_Model_Event $event
247:      */
248:     protected function _registerEvent(Mage_Index_Model_Event $event)
249:     {
250:         $event->addNewData(self::EVENT_MATCH_RESULT_KEY, true);
251:         $entity = $event->getEntity();
252: 
253:         if ($entity == Mage_Core_Model_Config_Data::ENTITY || $entity == Mage_Customer_Model_Group::ENTITY) {
254:             $process = $event->getProcess();
255:             $process->changeStatus(Mage_Index_Model_Process::STATUS_REQUIRE_REINDEX);
256:         } else if ($entity == Mage_Catalog_Model_Convert_Adapter_Product::ENTITY) {
257:             $event->addNewData('catalog_product_price_reindex_all', true);
258:         } else if ($entity == Mage_Catalog_Model_Product::ENTITY) {
259:             switch ($event->getType()) {
260:                 case Mage_Index_Model_Event::TYPE_DELETE:
261:                     $this->_registerCatalogProductDeleteEvent($event);
262:                     break;
263: 
264:                 case Mage_Index_Model_Event::TYPE_SAVE:
265:                     $this->_registerCatalogProductSaveEvent($event);
266:                     break;
267: 
268:                 case Mage_Index_Model_Event::TYPE_MASS_ACTION:
269:                     $this->_registerCatalogProductMassActionEvent($event);
270:                     break;
271:                 case self::EVENT_TYPE_REINDEX_PRICE:
272:                     $event->addNewData('id', $event->getDataObject()->getId());
273:                     break;
274:             }
275: 
276:             // call product type indexers registerEvent
277:             $indexers = $this->_getResource()->getTypeIndexers();
278:             foreach ($indexers as $indexer) {
279:                 $indexer->registerEvent($event);
280:             }
281:         }
282:     }
283: 
284:     /**
285:      * Process event
286:      *
287:      * @param Mage_Index_Model_Event $event
288:      */
289:     protected function _processEvent(Mage_Index_Model_Event $event)
290:     {
291:         $data = $event->getNewData();
292:         if ($event->getType() == self::EVENT_TYPE_REINDEX_PRICE) {
293:             $this->_getResource()->reindexProductIds($data['id']);
294:             return;
295:         }
296:         if (!empty($data['catalog_product_price_reindex_all'])) {
297:             $this->reindexAll();
298:         }
299:         if (empty($data['catalog_product_price_skip_call_event_handler'])) {
300:             $this->callEventHandler($event);
301:         }
302:     }
303: }
304: