Docs For Class Mage_Index_Model_Indexer

Description

Abstract index process class

Predefine list of methods required by indexer

author: Magento Core Team <[email protected]>
abstract:

Located in /Index/Model/Indexer/Abstract.php (line 31)

Varien_Object
   |
   --Mage_Core_Model_Abstract
      |
      --Mage_Index_Model_Indexer_Abstract

Direct descendents

Class	Description
Mage_CatalogInventory_Model_Indexer_Stock	CatalogInventory Stock Status Indexer Model
Mage_CatalogSearch_Model_Indexer_Fulltext	CatalogSearch fulltext indexer model
Mage_Catalog_Model_Indexer_Url	Catalog url rewrites index model.
Mage_Catalog_Model_Category_Indexer_Flat	Catalog Category Flat Indexer Model
Mage_Catalog_Model_Category_Indexer_Product	Category products indexer model.
Mage_Catalog_Model_Product_Indexer_Price	Magento
Mage_Catalog_Model_Product_Indexer_Eav	Catalog Product Eav Indexer Model
Mage_Catalog_Model_Product_Indexer_Flat	Magento
Mage_Tag_Model_Indexer_Summary	Tag Indexer Model

Variable Summary

mixed $_matchedEntities

Method Summary

Mage_Index_Model_Indexer_Abstract callEventHandler (Mage_Index_Model_Event $event)

string getDescription ()

string getName ()

bool matchEntityAndType (string $entity, string $type)

bool matchEvent (Mage_Index_Model_Event $event)

Mage_Index_Model_Indexer_Abstract processEvent (Mage_Index_Model_Event $event)

void register (Mage_Index_Model_Event $event)

void reindexAll ()

void _processEvent (Mage_Index_Model_Event $event)

void _registerEvent (Mage_Index_Model_Event $event)

Variables

mixed $_matchedEntities = array() (line 33)

access: protected

Redefined in descendants as:

Mage_CatalogInventory_Model_Indexer_Stock::$_matchedEntities
Mage_CatalogSearch_Model_Indexer_Fulltext::$_matchedEntities : Indexer must be match entities
Mage_Catalog_Model_Indexer_Url::$_matchedEntities : Index math: product save, category save, store save store group save, config save
Mage_Catalog_Model_Category_Indexer_Flat::$_matchedEntities : Matched entity events
Mage_Catalog_Model_Category_Indexer_Product::$_matchedEntities
Mage_Catalog_Model_Product_Indexer_Price::$_matchedEntities : Matched Entities instruction array
Mage_Catalog_Model_Product_Indexer_Eav::$_matchedEntities
Mage_Catalog_Model_Product_Indexer_Flat::$_matchedEntities : Index math Entities array
Mage_Tag_Model_Indexer_Summary::$_matchedEntities

Inherited Variables

Inherited from Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::$_cacheTag
Mage_Core_Model_Abstract::$_dataSaveAllowed
Mage_Core_Model_Abstract::$_eventObject
Mage_Core_Model_Abstract::$_eventPrefix
Mage_Core_Model_Abstract::$_isObjectNew
Mage_Core_Model_Abstract::$_resource
Mage_Core_Model_Abstract::$_resourceCollectionName
Mage_Core_Model_Abstract::$_resourceName

Methods

callEventHandler (line 135)

Try dynamicly detect and call event hanler from resource model.

Handler name will be generated from event entity and type code

access: public

Mage_Index_Model_Indexer_Abstract callEventHandler (Mage_Index_Model_Event $event)

Mage_Index_Model_Event $event

getDescription (line 47)

Get Indexer description

abstract:
access: public

string getDescription ()

Redefined in descendants as:

Mage_CatalogInventory_Model_Indexer_Stock::getDescription() : Retrieve Indexer description
Mage_CatalogSearch_Model_Indexer_Fulltext::getDescription() : Retrieve Indexer description
Mage_Catalog_Model_Indexer_Url::getDescription() : Get Indexer description
Mage_Catalog_Model_Category_Indexer_Flat::getDescription() : Retrieve Indexer description
Mage_Catalog_Model_Category_Indexer_Product::getDescription() : Get Indexer description
Mage_Catalog_Model_Product_Indexer_Price::getDescription() : Retrieve Indexer description
Mage_Catalog_Model_Product_Indexer_Eav::getDescription() : Retrieve Indexer description
Mage_Catalog_Model_Product_Indexer_Flat::getDescription() : Retrieve Indexer description
Mage_Tag_Model_Indexer_Summary::getDescription() : Retrieve Indexer description

getName (line 40)

Get Indexer name

abstract:
access: public

string getName ()

Redefined in descendants as:

Mage_CatalogInventory_Model_Indexer_Stock::getName() : Retrieve Indexer name
Mage_CatalogSearch_Model_Indexer_Fulltext::getName() : Retrieve Indexer name
Mage_Catalog_Model_Indexer_Url::getName() : Get Indexer name
Mage_Catalog_Model_Category_Indexer_Flat::getName() : Retrieve Indexer name
Mage_Catalog_Model_Category_Indexer_Product::getName() : Get Indexer name
Mage_Catalog_Model_Product_Indexer_Price::getName() : Retrieve Indexer name
Mage_Catalog_Model_Product_Indexer_Eav::getName() : Retrieve Indexer name
Mage_Catalog_Model_Product_Indexer_Flat::getName() : Retrieve Indexer name
Mage_Tag_Model_Indexer_Summary::getName() : Retrieve Indexer name

matchEntityAndType (line 110)

Check if indexer matched specific entity and action type

access: public

bool matchEntityAndType (string $entity, string $type)

string $entity
string $type

matchEvent (line 96)

Check if event can be matched by process

access: public

bool matchEvent (Mage_Index_Model_Event $event)

Mage_Index_Model_Event $event

Redefined in descendants as:

Mage_CatalogInventory_Model_Indexer_Stock::matchEvent() : Check if event can be matched by process.
Mage_CatalogSearch_Model_Indexer_Fulltext::matchEvent() : Check if event can be matched by process Overwrote for check is flat catalog product is enabled and specific save attribute, store, store_group
Mage_Catalog_Model_Indexer_Url::matchEvent() : Check if event can be matched by process.
Mage_Catalog_Model_Category_Indexer_Flat::matchEvent() : Check if event can be matched by process Overwrote for check is flat catalog category is enabled and specific save category, store, store_group
Mage_Catalog_Model_Category_Indexer_Product::matchEvent() : Check if event can be matched by process.
Mage_Catalog_Model_Product_Indexer_Price::matchEvent() : Check if event can be matched by process.
Mage_Catalog_Model_Product_Indexer_Flat::matchEvent() : Check if event can be matched by process Overwrote for check is flat catalog product is enabled and specific save attribute, store, store_group

processEvent (line 82)

Process event

access: public

Mage_Index_Model_Indexer_Abstract processEvent (Mage_Index_Model_Event $event)

Mage_Index_Model_Event $event

register (line 68)

Register data required by process in event object

access: public

void register (Mage_Index_Model_Event $event)

Mage_Index_Model_Event $event

reindexAll (line 123)

Rebuild all index data

access: public

void reindexAll ()

Redefined in descendants as:

Mage_CatalogSearch_Model_Indexer_Fulltext::reindexAll() : Rebuild all index data
Mage_Catalog_Model_Indexer_Url::reindexAll() : Rebuild all index data
Mage_Catalog_Model_Category_Indexer_Flat::reindexAll() : Rebuild all index data
Mage_Catalog_Model_Product_Indexer_Flat::reindexAll() : Rebuild all index data

_processEvent (line 61)

Process event based on event state data

abstract:
access: protected

void _processEvent (Mage_Index_Model_Event $event)

Mage_Index_Model_Event $event

Redefined in descendants as:

Mage_CatalogInventory_Model_Indexer_Stock::_processEvent() : Process event
Mage_CatalogSearch_Model_Indexer_Fulltext::_processEvent() : Process event
Mage_Catalog_Model_Indexer_Url::_processEvent() : Process event
Mage_Catalog_Model_Category_Indexer_Flat::_processEvent() : Process event
Mage_Catalog_Model_Category_Indexer_Product::_processEvent() : Process event data and save to index
Mage_Catalog_Model_Product_Indexer_Price::_processEvent() : Process event
Mage_Catalog_Model_Product_Indexer_Eav::_processEvent() : Process event
Mage_Catalog_Model_Product_Indexer_Flat::_processEvent() : Process event
Mage_Tag_Model_Indexer_Summary::_processEvent() : Process event

_registerEvent (line 54)

Register indexer required data inside event object

abstract:
access: protected

void _registerEvent (Mage_Index_Model_Event $event)

Mage_Index_Model_Event $event

Redefined in descendants as:

Mage_CatalogInventory_Model_Indexer_Stock::_registerEvent() : Register data required by process in event object
Mage_CatalogSearch_Model_Indexer_Fulltext::_registerEvent() : Register data required by process in event object
Mage_Catalog_Model_Indexer_Url::_registerEvent() : Register data required by process in event object
Mage_Catalog_Model_Category_Indexer_Flat::_registerEvent() : Register data required by process in event object
Mage_Catalog_Model_Category_Indexer_Product::_registerEvent() : Register data required by process in event object Check if category ids was changed
Mage_Catalog_Model_Product_Indexer_Price::_registerEvent() : Register data required by process in event object
Mage_Catalog_Model_Product_Indexer_Eav::_registerEvent() : Register data required by process in event object
Mage_Catalog_Model_Product_Indexer_Flat::_registerEvent() : Register data required by process in event object
Mage_Tag_Model_Indexer_Summary::_registerEvent() : Register data required by process in event object

Inherited Methods

Inherited From Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::afterCommitCallback()
Mage_Core_Model_Abstract::afterLoad()
Mage_Core_Model_Abstract::cleanModelCache()
Mage_Core_Model_Abstract::clearInstance()
Mage_Core_Model_Abstract::delete()
Mage_Core_Model_Abstract::getCacheIdTags()
Mage_Core_Model_Abstract::getCacheTags()
Mage_Core_Model_Abstract::getCollection()
Mage_Core_Model_Abstract::getEntityId()
Mage_Core_Model_Abstract::getId()
Mage_Core_Model_Abstract::getIdFieldName()
Mage_Core_Model_Abstract::getResource()
Mage_Core_Model_Abstract::getResourceCollection()
Mage_Core_Model_Abstract::getResourceName()
Mage_Core_Model_Abstract::isObjectNew()
Mage_Core_Model_Abstract::load()
Mage_Core_Model_Abstract::save()
Mage_Core_Model_Abstract::setId()
Mage_Core_Model_Abstract::_afterDelete()
Mage_Core_Model_Abstract::_afterDeleteCommit()
Mage_Core_Model_Abstract::_afterLoad()
Mage_Core_Model_Abstract::_afterSave()
Mage_Core_Model_Abstract::_afterSaveCommit()
Mage_Core_Model_Abstract::_beforeDelete()
Mage_Core_Model_Abstract::_beforeLoad()
Mage_Core_Model_Abstract::_beforeSave()
Mage_Core_Model_Abstract::_clearData()
Mage_Core_Model_Abstract::_clearReferences()
Mage_Core_Model_Abstract::_getEventData()
Mage_Core_Model_Abstract::_getResource()
Mage_Core_Model_Abstract::_hasModelChanged()
Mage_Core_Model_Abstract::_init()
Mage_Core_Model_Abstract::_protectFromNonAdmin()
Mage_Core_Model_Abstract::_setResourceModel()

Class Mage_Index_Model_Indexer_Abstract

Inherited Variables

Inherited Methods