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: /**
 29:  * Catalog Product Eav Indexer Model
 30:  *
 31:  * @method Mage_Catalog_Model_Resource_Product_Indexer_Eav _getResource()
 32:  * @method Mage_Catalog_Model_Resource_Product_Indexer_Eav getResource()
 33:  * @method Mage_Catalog_Model_Product_Indexer_Eav setEntityId(int $value)
 34:  * @method int getAttributeId()
 35:  * @method Mage_Catalog_Model_Product_Indexer_Eav setAttributeId(int $value)
 36:  * @method int getStoreId()
 37:  * @method Mage_Catalog_Model_Product_Indexer_Eav setStoreId(int $value)
 38:  * @method int getValue()
 39:  * @method Mage_Catalog_Model_Product_Indexer_Eav setValue(int $value)
 40:  *
 41:  * @category    Mage
 42:  * @package     Mage_Catalog
 43:  * @author      Magento Core Team <core@magentocommerce.com>
 44:  */
 45: class Mage_Catalog_Model_Product_Indexer_Eav extends Mage_Index_Model_Indexer_Abstract
 46: {
 47:     /**
 48:      * @var array
 49:      */
 50:     protected $_matchedEntities = array(
 51:         Mage_Catalog_Model_Product::ENTITY => array(
 52:             Mage_Index_Model_Event::TYPE_SAVE,
 53:             Mage_Index_Model_Event::TYPE_DELETE,
 54:             Mage_Index_Model_Event::TYPE_MASS_ACTION,
 55:         ),
 56:         Mage_Catalog_Model_Resource_Eav_Attribute::ENTITY => array(
 57:             Mage_Index_Model_Event::TYPE_SAVE,
 58:         ),
 59:         Mage_Catalog_Model_Convert_Adapter_Product::ENTITY => array(
 60:             Mage_Index_Model_Event::TYPE_SAVE
 61:         )
 62:     );
 63: 
 64:     /**
 65:      * Retrieve Indexer name
 66:      *
 67:      * @return string
 68:      */
 69:     public function getName()
 70:     {
 71:         return Mage::helper('catalog')->__('Product Attributes');
 72:     }
 73: 
 74:     /**
 75:      * Retrieve Indexer description
 76:      *
 77:      * @return string
 78:      */
 79:     public function getDescription()
 80:     {
 81:         return Mage::helper('catalog')->__('Index product attributes for layered navigation building');
 82:     }
 83: 
 84:     /**
 85:      * Initialize resource model
 86:      *
 87:      */
 88:     protected function _construct()
 89:     {
 90:         $this->_init('catalog/product_indexer_eav');
 91:     }
 92: 
 93:     /**
 94:      * Register data required by process in event object
 95:      *
 96:      * @param Mage_Index_Model_Event $event
 97:      */
 98:     protected function _registerEvent(Mage_Index_Model_Event $event)
 99:     {
100:         $entity = $event->getEntity();
101: 
102:         if ($entity == Mage_Catalog_Model_Product::ENTITY) {
103:             switch ($event->getType()) {
104:                 case Mage_Index_Model_Event::TYPE_DELETE:
105:                     $this->_registerCatalogProductDeleteEvent($event);
106:                     break;
107: 
108:                 case Mage_Index_Model_Event::TYPE_SAVE:
109:                     $this->_registerCatalogProductSaveEvent($event);
110:                     break;
111: 
112:                 case Mage_Index_Model_Event::TYPE_MASS_ACTION:
113:                     $this->_registerCatalogProductMassActionEvent($event);
114:                     break;
115:             }
116:         } else if ($entity == Mage_Catalog_Model_Resource_Eav_Attribute::ENTITY) {
117:             switch ($event->getType()) {
118:                 case Mage_Index_Model_Event::TYPE_SAVE:
119:                     $this->_registerCatalogAttributeSaveEvent($event);
120:                     break;
121:             }
122:         } else if ($entity == Mage_Catalog_Model_Convert_Adapter_Product::ENTITY) {
123:             $event->addNewData('catalog_product_eav_reindex_all', true);
124:         }
125:     }
126: 
127:     /**
128:      * Check is attribute indexable in EAV
129:      *
130:      * @param Mage_Catalog_Model_Resource_Eav_Attribute|string $attribute
131:      * @return bool
132:      */
133:     protected function _attributeIsIndexable($attribute)
134:     {
135:         if (!$attribute instanceof Mage_Catalog_Model_Resource_Eav_Attribute) {
136:             $attribute = Mage::getSingleton('eav/config')
137:                 ->getAttribute(Mage_Catalog_Model_Product::ENTITY, $attribute);
138:         }
139: 
140:         return $attribute->isIndexable();
141:     }
142: 
143:     /**
144:      * Register data required by process in event object
145:      *
146:      * @param Mage_Index_Model_Event $event
147:      * @return Mage_Catalog_Model_Product_Indexer_Eav
148:      */
149:     protected function _registerCatalogProductSaveEvent(Mage_Index_Model_Event $event)
150:     {
151:         /* @var $product Mage_Catalog_Model_Product */
152:         $product    = $event->getDataObject();
153:         $attributes = $product->getAttributes();
154:         $reindexEav = $product->getForceReindexRequired();
155:         foreach ($attributes as $attribute) {
156:             $attributeCode = $attribute->getAttributeCode();
157:             if ($this->_attributeIsIndexable($attribute) && $product->dataHasChangedFor($attributeCode)) {
158:                 $reindexEav = true;
159:                 break;
160:             }
161:         }
162: 
163:         if ($reindexEav) {
164:             $event->addNewData('reindex_eav', $reindexEav);
165:         }
166: 
167:         return $this;
168:     }
169: 
170:     /**
171:      * Register data required by process in event object
172:      *
173:      * @param Mage_Index_Model_Event $event
174:      * @return Mage_Catalog_Model_Product_Indexer_Eav
175:      */
176:     protected function _registerCatalogProductDeleteEvent(Mage_Index_Model_Event $event)
177:     {
178:         /* @var $product Mage_Catalog_Model_Product */
179:         $product    = $event->getDataObject();
180: 
181:         $parentIds  = $this->_getResource()->getRelationsByChild($product->getId());
182:         if ($parentIds) {
183:             $event->addNewData('reindex_eav_parent_ids', $parentIds);
184:         }
185: 
186:         return $this;
187:     }
188: 
189:     /**
190:      * Register data required by process in event object
191:      *
192:      * @param Mage_Index_Model_Event $event
193:      * @return Mage_Catalog_Model_Product_Indexer_Eav
194:      */
195:     protected function _registerCatalogProductMassActionEvent(Mage_Index_Model_Event $event)
196:     {
197:         $reindexEav = false;
198: 
199:         /* @var $actionObject Varien_Object */
200:         $actionObject = $event->getDataObject();
201:         // check if attributes changed
202:         $attrData = $actionObject->getAttributesData();
203:         if (is_array($attrData)) {
204:             foreach (array_keys($attrData) as $attributeCode) {
205:                 if ($this->_attributeIsIndexable($attributeCode)) {
206:                     $reindexEav = true;
207:                     break;
208:                 }
209:             }
210:         }
211: 
212:         // check changed websites
213:         if ($actionObject->getWebsiteIds()) {
214:             $reindexEav = true;
215:         }
216: 
217:         // register affected products
218:         if ($reindexEav) {
219:             $event->addNewData('reindex_eav_product_ids', $actionObject->getProductIds());
220:         }
221: 
222:         return $this;
223:     }
224: 
225:     /**
226:      * Register data required by process attribute save in event object
227:      *
228:      * @param Mage_Index_Model_Event $event
229:      * @return Mage_Catalog_Model_Product_Indexer_Eav
230:      */
231:     protected function _registerCatalogAttributeSaveEvent(Mage_Index_Model_Event $event)
232:     {
233:         /* @var $attribute Mage_Catalog_Model_Resource_Eav_Attribute */
234:         $attribute = $event->getDataObject();
235:         if ($attribute->isIndexable()) {
236:             $before = $attribute->getOrigData('is_filterable')
237:                 || $attribute->getOrigData('is_filterable_in_search')
238:                 || $attribute->getOrigData('is_visible_in_advanced_search');
239:             $after  = $attribute->getData('is_filterable')
240:                 || $attribute->getData('is_filterable_in_search')
241:                 || $attribute->getData('is_visible_in_advanced_search');
242: 
243:             if (!$before && $after || $before && !$after) {
244:                 $event->addNewData('reindex_attribute', 1);
245:                 $event->addNewData('attribute_index_type', $attribute->getIndexType());
246:                 $event->addNewData('is_indexable', $after);
247:             }
248:         }
249: 
250:         return $this;
251:     }
252: 
253:     /**
254:      * Process event
255:      *
256:      * @param Mage_Index_Model_Event $event
257:      */
258:     protected function _processEvent(Mage_Index_Model_Event $event)
259:     {
260:         $data = $event->getNewData();
261:         if (!empty($data['catalog_product_eav_reindex_all'])) {
262:             $this->reindexAll();
263:         }
264:         if (empty($data['catalog_product_eav_skip_call_event_handler'])) {
265:             $this->callEventHandler($event);
266:         }
267:     }
268: }
269: