Class Mage_Index_Model_Event

Description
Description | Vars (details) | Methods (details) Constants (details)

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.

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

Varien_Object
   |
   --Mage_Core_Model_Abstract
      |
      --Mage_Index_Model_Event
Class Constant Summary
Description | Constants (details) Vars (details) | | Methods (details)
TYPE_DELETE = 'delete'
TYPE_MASS_ACTION = 'mass_action'
TYPE_REINDEX = 'reindex'
TYPE_SAVE = 'save'
Variable Summary
Description | Vars (details) | Methods (details) Constants (details)
string $_dataNamespace
mixed $_process
array $_processIds
Method Summary
Description | Constants (details) Vars (details) | Methods (details)
Mage_Index_Model_Event addNewData (array $key, [null $value = null])
Mage_Index_Model_Event addOldData (array $key, [null $value = null])
Mage_Index_Model_Event addProcessId ($processId $processId, [ $status = Mage_Index_Model_Process::EVENT_STATUS_NEW])
string getEntity ()
array getNewData ([ $useNamespace = true])
array getOldData ([ $useNamespace = true])
Mage_Index_Model_Process getProcess ()
array getProcessIds ()
string getType ()
Mage_Index_Model_Event mergePreviousData (array $data)
Mage_Index_Model_Event resetData ()
void setDataNamespace ( $namespace)
void setProcess (null|Mage_Index_Model_Process $process)
Mage_Index_Model_Event _beforeSave ()
void _construct ()
Variables
Description | Vars (details) Constants (details) | Methods (details)
string $_dataNamespace = null (line 48)

New and old data namespace. Used for separate processes data

  • access: protected
mixed $_process = null (line 53)

Process object which currently working with event

  • access: protected
array $_processIds = null (line 41)

Array of related processes ids

  • 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
Description | Vars (details) Constants (details) Methods (details)
addNewData (line 232)

Add new values to new data array (overwrite if value with same key exist)

  • access: public
Mage_Index_Model_Event addNewData (array $key, [null $value = null])
  • array $key: | string $data
  • null $value: | mixed $value
addOldData (line 206)

Add new values to old data array (overwrite if value with same key exist)

  • access: public
Mage_Index_Model_Event addOldData (array $key, [null $value = null])
  • array $key: | string $data
  • null $value: | mixed $value
addProcessId (line 120)

Add process id to event object

  • access: public
Mage_Index_Model_Event addProcessId ($processId $processId, [ $status = Mage_Index_Model_Process::EVENT_STATUS_NEW])
  • $processId $processId
  • $status
getEntity (line 256)

Get event entity code.

Entity code declare what kind of data object related with event (product, category etc.)

  • access: public
string getEntity ()
getNewData (line 185)

Get event new data array

  • access: public
array getNewData ([ $useNamespace = true])
  • $useNamespace
getOldData (line 166)

Get event old data array

  • access: public
array getOldData ([ $useNamespace = true])
  • $useNamespace
getProcess (line 79)

Get related process object

  • return: | null
  • access: public
Mage_Index_Model_Process getProcess ()
getProcessIds (line 131)

Get event process ids

  • access: public
array getProcessIds ()
getType (line 267)

Get event action type.

Data related on self::TYPE_* constants

  • access: public
string getType ()
mergePreviousData (line 143)

Merge previous event data to object.

Used for events duplicated protection

  • access: public
Mage_Index_Model_Event mergePreviousData (array $data)
  • array $data
resetData (line 98)

Reset old and new data arrays

  • access: public
Mage_Index_Model_Event resetData ()
setDataNamespace (line 87)

Specify namespace for old and new data

  • access: public
void setDataNamespace ( $namespace)
  • $namespace
setProcess (line 68)

Specify process object

  • access: public
void setProcess (null|Mage_Index_Model_Process $process)
_beforeSave (line 277)

Serelaize old and new data arrays before saving

  • access: protected
Mage_Index_Model_Event _beforeSave ()
Redefinition of:
Mage_Core_Model_Abstract::_beforeSave()
Processing object before save data
_construct (line 58)

Initialize resource

  • access: protected
void _construct ()

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
Description | Constants (details) Vars (details) | Methods (details)
TYPE_DELETE = 'delete' (line 33)
TYPE_MASS_ACTION = 'mass_action' (line 34)
TYPE_REINDEX = 'reindex' (line 35)
TYPE_SAVE = 'save' (line 32)

Predefined event types

Documentation generated on Fri, 11 Feb 2011 17:02:20 +0200 by phpDocumentor 1.4.3