Overview

Packages

  • currencysymbol
  • MAbout
  • Mage
    • Admin
    • Adminhtml
    • AdminNotification
    • Api
    • Api2
    • Authorizenet
    • Backup
    • Bundle
    • Captcha
    • Catalog
    • CatalogIndex
    • CatalogInventory
    • CatalogRule
    • CatalogSearch
    • Centinel
    • Checkout
    • Cms
    • Compiler
    • Connect
    • Contacts
    • Core
    • Cron
    • CurrencySymbol
    • Customer
    • Dataflow
    • Directory
    • DirtectPost
    • Downloadable
    • Eav
    • GiftMessage
    • GoogleAnalytics
    • GoogleBase
    • GoogleCheckout
    • ImportExport
    • Index
    • Install
    • Log
    • Media
    • Newsletter
    • Oauth
    • Page
    • PageCache
    • Paygate
    • Payment
    • Paypal
    • PaypalUk
    • Persistent
    • Poll
    • ProductAlert
    • Rating
    • Reports
    • Review
    • Rss
    • Rule
    • Sales
    • SalesRule
    • Sedfriend
    • Sendfriend
    • Shipping
    • Sitemap
    • Tag
    • Tax
    • Usa
    • Weee
    • Widget
    • Wishlist
    • XmlConnect
  • None
  • Phoenix
    • Moneybookers
  • PHP
  • Zend
    • Date
    • Mime
    • XmlRpc

Classes

  • Mage_Index_Adminhtml_ProcessController
  • Mage_Index_Block_Adminhtml_Notifications
  • Mage_Index_Block_Adminhtml_Process
  • Mage_Index_Block_Adminhtml_Process_Edit
  • Mage_Index_Block_Adminhtml_Process_Edit_Form
  • Mage_Index_Block_Adminhtml_Process_Edit_Tab_Main
  • Mage_Index_Block_Adminhtml_Process_Edit_Tabs
  • Mage_Index_Block_Adminhtml_Process_Grid
  • Mage_Index_Block_Adminhtml_Process_Grid_Massaction
  • Mage_Index_Helper_Data
  • Mage_Index_Model_Event
  • Mage_Index_Model_Indexer
  • Mage_Index_Model_Indexer_Abstract
  • Mage_Index_Model_Mysql4_Abstract
  • Mage_Index_Model_Mysql4_Event
  • Mage_Index_Model_Mysql4_Event_Collection
  • Mage_Index_Model_Mysql4_Process
  • Mage_Index_Model_Mysql4_Process_Collection
  • Mage_Index_Model_Mysql4_Setup
  • Mage_Index_Model_Observer
  • Mage_Index_Model_Process
  • Mage_Index_Model_Resource_Abstract
  • Mage_Index_Model_Resource_Event
  • Mage_Index_Model_Resource_Event_Collection
  • Mage_Index_Model_Resource_Helper_Mysql4
  • Mage_Index_Model_Resource_Process
  • Mage_Index_Model_Resource_Process_Collection
  • Mage_Index_Model_Resource_Setup
  • Overview
  • Package
  • Class
  • Tree

Class Mage_Index_Model_Indexer

Indexer strategy

Package: Mage\Index
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Located at code/core/Mage/Index/Model/Indexer.php
Methods summary
public
# __construct( )

Class constructor. Initialize index processes based on configuration

Class constructor. Initialize index processes based on configuration

public Mage_Index_Model_Resource_Process_Collection
# getProcessesCollection( )

Get collection of all available processes

Get collection of all available processes

Returns

Mage_Index_Model_Resource_Process_Collection
public Mage_Index_Model_Process
# getProcessById( integer $processId )

Get index process by specific id

Get index process by specific id

Parameters

$processId
integer
$processId

Returns

Mage_Index_Model_Process
| false
public Mage_Index_Model_Process
# getProcessByCode( string $code )

Get index process by specific code

Get index process by specific code

Parameters

$code
string
$code

Returns

Mage_Index_Model_Process
| false
public Mage_Index_Model_Indexer
# indexEvents( null $entity = null, null $type = null )

Indexing all pending events. Events set can be limited by event entity and type

Indexing all pending events. Events set can be limited by event entity and type

Parameters

$entity
null
| string $entity
$type
null
| string $type

Returns

Mage_Index_Model_Indexer
public Mage_Index_Model_Indexer
# indexEvent( Mage_Index_Model_Event $event )

Index one event by all processes

Index one event by all processes

Parameters

$event
Mage_Index_Model_Event
$event

Returns

Mage_Index_Model_Indexer
public
# registerEvent( Mage_Index_Model_Event $event )

Register event in each indexing process process

Register event in each indexing process process

Parameters

$event
Mage_Index_Model_Event
$event
public Mage_Index_Model_Event
# logEvent( Varien_Object $entity, string $entityType, string $eventType, boolean $doSave = true )

Create new event log and register event in all processes

Create new event log and register event in all processes

Parameters

$entity
Varien_Object
$entity
$entityType
string
$entityType
$eventType
string
$eventType
$doSave
boolean
$doSave

Returns

Mage_Index_Model_Event
public Mage_Index_Model_Indexer
# processEntityAction( Varien_Object $entity, string $entityType, string $eventType )

Create new event log and register event in all processes. Initiate events indexing procedure.

Create new event log and register event in all processes. Initiate events indexing procedure.

Parameters

$entity
Varien_Object
$entity
$entityType
string
$entityType
$eventType
string
$eventType

Returns

Mage_Index_Model_Indexer
protected Mage_Index_Model_Indexer
# _runAll( string $method, array $args )

Run all processes method with parameters Run by depends priority Not recursive call is not implement

Run all processes method with parameters Run by depends priority Not recursive call is not implement

Parameters

$method
string
$method
$args
array
$args

Returns

Mage_Index_Model_Indexer
protected Mage_Index_Model_Indexer
# _changeKeyStatus( boolean $enable = true )

Enable/Disable keys in index tables

Enable/Disable keys in index tables

Parameters

$enable
boolean
$enable

Returns

Mage_Index_Model_Indexer
protected boolean
# _changeProcessKeyStatus( mixed|Mage_Index_Model_Process $process, boolean $enable = true )

Check if the event will be processed and disable/enable keys in index tables

Check if the event will be processed and disable/enable keys in index tables

Parameters

$process
mixed|Mage_Index_Model_Process
$process
$enable
boolean
$enable

Returns

boolean
public Mage_Index_Model_Indexer
# allowTableChanges( )

Allow DDL operations while indexing

Allow DDL operations while indexing

Returns

Mage_Index_Model_Indexer
public Mage_Index_Model_Indexer
# disallowTableChanges( )

Disallow DDL operations while indexing

Disallow DDL operations while indexing

Returns

Mage_Index_Model_Indexer
protected string
# _getEventTypeName( null|string $entityType = null, null|string $eventType = null )

Get event type name

Get event type name

Parameters

$entityType
null|string
$entityType
$eventType
null|string
$eventType

Returns

string
Properties summary
protected Mage_Index_Model_Resource_Process_Collection $_processesCollection
#

Collection of available processes

Collection of available processes

protected boolean $_allowTableChanges true
#

Whether table changes are allowed

Whether table changes are allowed

protected null|Mage_Index_Model_Event|array $_currentEvent null
#

Current processing event(s) In array case it should be array(Entity type, Event type)

Current processing event(s) In array case it should be array(Entity type, Event type)

Magento 1.7.0.2 API documentation generated by ApiGen 2.8.0