Docs For Class Mage_Index_Model

Description

Magento

NOTICE OF LICENSE

This source file is subject to the Open Software License (OSL 3.0) that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://opensource.org/licenses/osl-3.0.php If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.

DISCLAIMER

Do not edit or add to this file if you wish to upgrade Magento to newer versions in the future. If you wish to customize Magento for your needs please refer to http://www.magentocommerce.com for more information.

author: Magento Core Team <[email protected]>
copyright: Copyright (c) 2010 Magento Inc. (http://www.magentocommerce.com)
license: Open Software License (OSL 3.0)

Located in /Index/Model/Process.php (line 27)

Varien_Object
   |
   --Mage_Core_Model_Abstract
      |
      --Mage_Index_Model_Process

Class Constant Summary

EVENT_STATUS_DONE = 'done'

EVENT_STATUS_ERROR = 'error'

EVENT_STATUS_NEW = 'new'

EVENT_STATUS_WORKING = 'working'

MODE_MANUAL = 'manual'

MODE_REAL_TIME = 'real_time'

STATUS_PENDING = 'pending'

STATUS_REQUIRE_REINDEX = 'require_reindex'

STATUS_RUNNING = 'working'

XML_PATH_INDEXER_DATA = 'global/index/indexer'

Variable Summary

Mage_Index_Model_Indexer_Abstract $_indexer

mixed $_isLocked

mixed $_lockFile

Method Summary

Mage_Index_Model_Process changeStatus (string $status)

void __destruct ()

array getDepends ()

Mage_Index_Model_Indexer_Abstract getIndexer ()

array getModesOptions ()

array getStatusesOptions ()

Mage_Index_Model_Process indexEvents ([null|string $entity = null], [null|string $type = null])

bool isLocked ()

Mage_Index_Model_Process lock ()

Mage_Index_Model_Process lockAndBlock ()

bool matchEvent (Mage_Index_Model_Event $event)

Mage_Index_Model_Process processEvent (Mage_Index_Model_Event $event)

void register (Mage_Index_Model_Event $event)

unknown_type reindexAll ()

Mage_Index_Model_Process reindexEverything ()

Mage_Index_Model_Process unlock ()

Mage_Index_Model_Process updateEventStatus (Mage_Index_Model_Event $event, string $status)

void _construct ()

resource _getLockFile ()

Mage_Index_Model_Process _resetEventNamespace ( $event)

Mage_Index_Model_Process _setEventNamespace (Mage_Index_Model_Event $event)

Variables

Mage_Index_Model_Indexer_Abstract $_indexer = null (line 57)

Indexer stategy object

access: protected

mixed $_isLocked = null (line 62)

Process lock properties

access: protected

mixed $_lockFile = null (line 63)

access: protected

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

changeStatus (line 385)

Change process status

access: public

Mage_Index_Model_Process changeStatus (string $status)

string $status

Destructor __destruct (line 372)

Close file resource if it was opened

access: public

void __destruct ()

getDepends (line 423)

Retrieve depend indexer codes

access: public

array getDepends ()

getIndexer (line 198)

Get Indexer strategy object

access: public

Mage_Index_Model_Indexer_Abstract getIndexer ()

getModesOptions (line 396)

Get list of process mode options

access: public

array getModesOptions ()

getStatusesOptions (line 409)

Get list of process status options

access: public

array getStatusesOptions ()

indexEvents (line 227)

Index pending events addressed to the process

access: public

Mage_Index_Model_Process indexEvents ([null|string $entity = null], [null|string $type = null])

null|string $entity
null|string $type

isLocked (line 355)

Check if process is locked

access: public

bool isLocked ()

lock (line 317)

Lock process without blocking.

This method allow protect multiple process runing and fast lock validation.

access: public

Mage_Index_Model_Process lock ()

lockAndBlock (line 331)

Lock and block process.

If new instance of the process will try validate locking state script will wait until process will be unlocked

access: public

Mage_Index_Model_Process lockAndBlock ()

matchEvent (line 122)

Check if event can be matched by process

access: public

bool matchEvent (Mage_Index_Model_Event $event)

Mage_Index_Model_Event $event

processEvent (line 176)

Process event with assigned indexer object

access: public

Mage_Index_Model_Process processEvent (Mage_Index_Model_Event $event)

Mage_Index_Model_Event $event

register (line 104)

Register data required by process in event object

access: public

void register (Mage_Index_Model_Event $event)

Mage_Index_Model_Event $event

reindexAll (line 132)

Reindex all data what this process responsible is

access: public

unknown_type reindexAll ()

reindexEverything (line 150)

Reindex all data what this process responsible is Check and using depends processes

access: public

Mage_Index_Model_Process reindexEverything ()

unlock (line 343)

Unlock process

access: public

Mage_Index_Model_Process unlock ()

updateEventStatus (line 285)

Update status process/event association

access: public

Mage_Index_Model_Process updateEventStatus (Mage_Index_Model_Event $event, string $status)

Mage_Index_Model_Event $event
string $status

_construct (line 68)

Initialize resource

access: protected

void _construct ()

_getLockFile (line 296)

Get lock file resource

access: protected

resource _getLockFile ()

_resetEventNamespace (line 92)

Remove indexer namespace from event

access: protected

Mage_Index_Model_Process _resetEventNamespace ( $event)

$event

_setEventNamespace (line 79)

Set indexer class name as data namespace for event object

access: protected

Mage_Index_Model_Process _setEventNamespace (Mage_Index_Model_Event $event)

Mage_Index_Model_Event $event

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 Constants

EVENT_STATUS_DONE = 'done' (line 41)

EVENT_STATUS_ERROR = 'error' (line 42)

EVENT_STATUS_NEW = 'new' (line 40)

Process event statuses

EVENT_STATUS_WORKING = 'working' (line 43)

MODE_MANUAL = 'manual' (line 49)

Process modes

Process mode allow disable automatic process events processing

MODE_REAL_TIME = 'real_time' (line 50)

STATUS_PENDING = 'pending' (line 34)

STATUS_REQUIRE_REINDEX = 'require_reindex' (line 35)

STATUS_RUNNING = 'working' (line 33)

Process statuses

XML_PATH_INDEXER_DATA = 'global/index/indexer' (line 29)

Class Mage_Index_Model_Process

Inherited Variables

Inherited Methods