Class Mage_Index_Model_Process

Enter description here ...

Varien_Object

Mage_Index_Model_Process

Package: Mage\Index
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Index/Model/Process.php

Methods summary
`protected`	# `_construct( )` Initialize resource Initialize resource
`protected Mage_Index_Model_Process`	# `_setEventNamespace( Mage_Index_Model_Event $event )` Set indexer class name as data namespace for event object Set indexer class name as data namespace for event object Parameters `$event` `Mage_Index_Model_Event` $event Returns `Mage_Index_Model_Process`
`protected Mage_Index_Model_Process`	# `_resetEventNamespace( Mage_Index_Model_Event $event )` Remove indexer namespace from event Remove indexer namespace from event Parameters `$event` `Mage_Index_Model_Event` $event Returns `Mage_Index_Model_Process`
`public Mage_Index_Model_Process`	# `register( Mage_Index_Model_Event $event )` Register data required by process in event object Register data required by process in event object Parameters `$event` `Mage_Index_Model_Event` $event Returns `Mage_Index_Model_Process`
`public boolean`	# `matchEvent( Mage_Index_Model_Event $event )` Check if event can be matched by process Check if event can be matched by process Parameters `$event` `Mage_Index_Model_Event` $event Returns `boolean`
`public boolean`	# `matchEntityAndType( string $entity, string $type )` Check if specific entity and action type is matched Check if specific entity and action type is matched Parameters `$entity` `string` $entity `$type` `string` $type Returns `boolean`
`public`	# `reindexAll( )` Reindex all data what this process responsible is Reindex all data what this process responsible is
`public Mage_Index_Model_Process`	# `reindexEverything( )` Reindex all data what this process responsible is Check and using depends processes Reindex all data what this process responsible is Check and using depends processes Returns `Mage_Index_Model_Process`
`public Mage_Index_Model_Process`	# `processEvent( Mage_Index_Model_Event $event )` Process event with assigned indexer object Process event with assigned indexer object Parameters `$event` `Mage_Index_Model_Event` $event Returns `Mage_Index_Model_Process`
`public Mage_Index_Model_Indexer_Abstract`	# `getIndexer( )` Get Indexer strategy object Get Indexer strategy object Returns `Mage_Index_Model_Indexer_Abstract`
`public Mage_Index_Model_Process`	# `indexEvents( null\|string $entity = null, null\|string $type = null )` Index pending events addressed to the process Index pending events addressed to the process Parameters `$entity` `null\|string` $entity `$type` `null\|string` $type Returns `Mage_Index_Model_Process`
`protected Mage_Index_Model_Process`	# `_processEventsCollection( Mage_Index_Model_Resource_Event_Collection $eventsCollection, boolean $skipUnmatched = true )` Process all events of the collection Process all events of the collection Parameters `$eventsCollection` `Mage_Index_Model_Resource_Event_Collection` $eventsCollection `$skipUnmatched` `boolean` $skipUnmatched Returns `Mage_Index_Model_Process`
`public Mage_Index_Model_Process`	# `updateEventStatus( Mage_Index_Model_Event $event, string $status )` Update status process/event association Update status process/event association Parameters `$event` `Mage_Index_Model_Event` $event `$status` `string` $status Returns `Mage_Index_Model_Process`
`protected resource`	# `_getLockFile( )` Get lock file resource Get lock file resource Returns `resource`
`public Mage_Index_Model_Process`	# `lock( )` Lock process without blocking. This method allow protect multiple process runing and fast lock validation. Lock process without blocking. This method allow protect multiple process runing and fast lock validation. Returns `Mage_Index_Model_Process`
`public Mage_Index_Model_Process`	# `lockAndBlock( )` Lock and block process. If new instance of the process will try validate locking state script will wait until process will be unlocked Lock and block process. If new instance of the process will try validate locking state script will wait until process will be unlocked Returns `Mage_Index_Model_Process`
`public Mage_Index_Model_Process`	# `unlock( )` Unlock process Unlock process Returns `Mage_Index_Model_Process`
`public boolean`	# `isLocked( )` Check if process is locked Check if process is locked Returns `boolean`
`public`	# `__destruct( )` Close file resource if it was opened Close file resource if it was opened
`public Mage_Index_Model_Process`	# `changeStatus( string $status )` Change process status Change process status Parameters `$status` `string` $status Returns `Mage_Index_Model_Process`
`public array`	# `getModesOptions( )` Get list of process mode options Get list of process mode options Returns `array`
`public array`	# `getStatusesOptions( )` Get list of process status options Get list of process status options Returns `array`
`public array`	# `getUpdateRequiredOptions( )` Get list of "Update Required" options Get list of "Update Required" options Returns `array`
`public array`	# `getDepends( )` Retrieve depend indexer codes Retrieve depend indexer codes Returns `array`
`public Mage_Index_Model_Process`	# `disableIndexerKeys( )` Disable keys in index table Disable keys in index table Returns `Mage_Index_Model_Process`
`public Mage_Index_Model_Process`	# `enableIndexerKeys( )` Enable keys in index table Enable keys in index table Returns `Mage_Index_Model_Process`
`public Mage_Index_Model_Process`	# `safeProcessEvent( Mage_Index_Model_Event $event )` Process event with locks checking Process event with locks checking Parameters `$event` `Mage_Index_Model_Event` $event Returns `Mage_Index_Model_Process`
`public Mage_Index_Model_Resource_Event_Collection`	# `getUnprocessedEventsCollection( )` Get unprocessed events collection Get unprocessed events collection Returns `Mage_Index_Model_Resource_Event_Collection`

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

Constants summary
`string`	`XML_PATH_INDEXER_DATA`	`'global/index/indexer'`	#
`string`	`STATUS_RUNNING`	`'working'`	# Process statuses Process statuses
`string`	`STATUS_PENDING`	`'pending'`	#
`string`	`STATUS_REQUIRE_REINDEX`	`'require_reindex'`	#
`string`	`EVENT_STATUS_NEW`	`'new'`	# Process event statuses Process event statuses
`string`	`EVENT_STATUS_DONE`	`'done'`	#
`string`	`EVENT_STATUS_ERROR`	`'error'`	#
`string`	`EVENT_STATUS_WORKING`	`'working'`	#
`string`	`MODE_MANUAL`	`'manual'`	# Process modes Process mode allow disable automatic process events processing Process modes Process mode allow disable automatic process events processing
`string`	`MODE_REAL_TIME`	`'real_time'`	#

Properties summary
`protected Mage_Index_Model_Indexer_Abstract`	`$_indexer`	`null`	# Indexer stategy object Indexer stategy object
`protected mixed`	`$_isLocked`	`null`	# Process lock properties Process lock properties
`protected mixed`	`$_lockFile`	`null`	#

Properties inherited from Mage_Core_Model_Abstract
`$_cacheTag, $_dataSaveAllowed, $_eventObject, $_eventPrefix, $_isObjectNew, $_resource, $_resourceCollectionName, $_resourceName`

Packages

Classes

Class Mage_Index_Model_Process

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Returns