Inheritance diagram for Indexer:

Public Member Functions
	__construct (ConfigInterface $config, ActionFactory $actionFactory, StructureFactory $structureFactory, \Magento\Framework\Mview\ViewInterface $view, Indexer\StateFactory $stateFactory, Indexer\CollectionFactory $indexersFactory, array $data=[])

	getId ()

	setId ($id)

	setIdFieldName ($name)

	getIdFieldName ()

	getViewId ()

	getActionClass ()

	getTitle ()

	getDescription ()

	getFields ()

	getSources ()

	getHandlers ()

	load ($indexerId)

	getView ()

	getState ()

	setState (StateInterface $state)

	isScheduled ()

	setScheduled ($scheduled)

	isValid ()

	isInvalid ()

	isWorking ()

	invalidate ()

	getStatus ()

	getLatestUpdated ()

	reindexAll ()

	reindexRow ($id)

	reindexList ($ids)

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Protected Member Functions
	getActionInstance ()

	getStructureInstance ()

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$_idFieldName = 'indexer_id'

	$config

	$actionFactory

	$structureFactory

	$view

	$stateFactory

	$state

	$indexersFactory

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 19 of file Indexer.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	ConfigInterface	$config,
		ActionFactory	$actionFactory,
		StructureFactory	$structureFactory,
		\Magento\Framework\Mview\ViewInterface	$view,
		Indexer\StateFactory	$stateFactory,
		Indexer\CollectionFactory	$indexersFactory,
		array	$data = `[]`
	)

Parameters

ConfigInterface	$config
ActionFactory	$actionFactory
StructureFactory	$structureFactory
\Magento\Framework\Mview\ViewInterface	$view
Indexer\StateFactory	$stateFactory
Indexer\CollectionFactory	$indexersFactory
array	$data

Definition at line 70 of file Indexer.php.

       {
         $this->config = $config;
         $this->actionFactory = $actionFactory;
         $this->structureFactory = $structureFactory;
         $this->view = $view;
         $this->stateFactory = $stateFactory;
         $this->indexersFactory = $indexersFactory;
         parent::__construct($data);
     }

Member Function Documentation

◆ getActionClass()

getActionClass ( )

Return indexer action class

Returns: string

Implements IndexerInterface.

Definition at line 155 of file Indexer.php.

     {
         return $this->getData('action_class');
     }

◆ getActionInstance()

getActionInstance ( )

protected

Return indexer action instance

Returns: ActionInterface

Exceptions

Definition at line 373 of file Indexer.php.

     {
         return $this->actionFactory->create(
             $this->getActionClass(),
             [
                 'indexStructure' => $this->getStructureInstance(),
                 'data' => $this->getData(),
             ]
         );
     }

◆ getDescription()

getDescription ( )

Return indexer description

Returns: string

Implements IndexerInterface.

Definition at line 175 of file Indexer.php.

     {
         return $this->getData('description');
     }

◆ getFields()

getFields ( )

Return indexer fields

Returns: array

Implements IndexerInterface.

Definition at line 185 of file Indexer.php.

     {
         return $this->getData('fields');
     }

◆ getHandlers()

getHandlers ( )

Return indexer handlers

Returns: array

Implements IndexerInterface.

Definition at line 205 of file Indexer.php.

     {
         return $this->getData('handlers');
     }

◆ getId()

getId ( )

Return ID

@codeCoverageIgnore

Returns: string

Implements IndexerInterface.

Definition at line 95 of file Indexer.php.

     {
         return $this->getData($this->_idFieldName);
     }

◆ getIdFieldName()

getIdFieldName ( )

Id field name getter

@codeCoverageIgnore

Returns: string

Definition at line 135 of file Indexer.php.

     {
         return $this->_idFieldName;
     }

◆ getLatestUpdated()

getLatestUpdated ( )

Return indexer or mview latest updated time

Returns: string

Implements IndexerInterface.

Definition at line 352 of file Indexer.php.

     {
         if ($this->getView()->isEnabled() && $this->getView()->getUpdated()) {
             if (!$this->getState()->getUpdated()) {
                 return $this->getView()->getUpdated();
             }
             $indexerUpdatedDate = new \DateTime($this->getState()->getUpdated());
             $viewUpdatedDate = new \DateTime($this->getView()->getUpdated());
             if ($viewUpdatedDate > $indexerUpdatedDate) {
                 return $this->getView()->getUpdated();
             }
         }
         return $this->getState()->getUpdated();
     }

◆ getSources()

getSources ( )

Return indexer sources

Returns: array

Implements IndexerInterface.

Definition at line 195 of file Indexer.php.

     {
         return $this->getData('sources');
     }

◆ getState()

getState ( )

Return related state object

Returns: StateInterface

Implements IndexerInterface.

Definition at line 248 of file Indexer.php.

     {
         if (!$this->state) {
             $this->state = $this->stateFactory->create();
             $this->state->loadByIndexer($this->getId());
         }
         return $this->state;
     }

◆ getStatus()

getStatus ( )

Return indexer status

Returns: string

Implements IndexerInterface.

Definition at line 342 of file Indexer.php.

     {
         return $this->getState()->getStatus();
     }

◆ getStructureInstance()

getStructureInstance ( )

protected

Return indexer structure instance

Returns: IndexStructureInterface

Definition at line 389 of file Indexer.php.

     {
         if (!$this->getData('structure')) {
             return null;
         }
         return $this->structureFactory->create($this->getData('structure'));
     }

◆ getTitle()

getTitle ( )

Return indexer title

Returns: string

Implements IndexerInterface.

Definition at line 165 of file Indexer.php.

     {
         return $this->getData('title');
     }

◆ getView()

getView ( )

Return related view object

Returns: \Magento\Framework\Mview\ViewInterface

Implements IndexerInterface.

Definition at line 235 of file Indexer.php.

     {
         if (!$this->view->getId()) {
             $this->view->load($this->getViewId());
         }
         return $this->view;
     }

◆ getViewId()

getViewId ( )

Return indexer's view ID

Returns: string

Implements IndexerInterface.

Definition at line 145 of file Indexer.php.

     {
         return $this->getData('view_id');
     }

◆ invalidate()

invalidate ( )

Set indexer invalid

Returns: void

Implements IndexerInterface.

Definition at line 330 of file Indexer.php.

     {
         $state = $this->getState();
         $state->setStatus(StateInterface::STATUS_INVALID);
         $state->save();
     }

◆ isInvalid()

isInvalid ( )

Check whether indexer is invalid

Returns: bool

Implements IndexerInterface.

Definition at line 310 of file Indexer.php.

     {
         return $this->getState()->getStatus() == StateInterface::STATUS_INVALID;
     }

◆ isScheduled()

isScheduled ( )

Check whether indexer is run by schedule

Returns: bool

Implements IndexerInterface.

Definition at line 274 of file Indexer.php.

     {
         return $this->getView()->isEnabled();
     }

◆ isValid()

isValid ( )

Check whether indexer is valid

Returns: bool

Implements IndexerInterface.

Definition at line 300 of file Indexer.php.

     {
         return $this->getState()->getStatus() == StateInterface::STATUS_VALID;
     }

◆ isWorking()

isWorking ( )

Check whether indexer is working

Returns: bool

Implements IndexerInterface.

Definition at line 320 of file Indexer.php.

     {
         return $this->getState()->getStatus() == StateInterface::STATUS_WORKING;
     }

◆ load()

load ( $indexerId )

Fill indexer data from config

Parameters

string $indexerId

Returns: IndexerInterface

Exceptions

Implements IndexerInterface.

Definition at line 217 of file Indexer.php.

     {
         $indexer = $this->config->getIndexer($indexerId);
         if (empty($indexer) || empty($indexer['indexer_id']) || $indexer['indexer_id'] != $indexerId) {
             throw new \InvalidArgumentException("{$indexerId} indexer does not exist.");
         }
 
         $this->setId($indexerId);
         $this->setData($indexer);
 
         return $this;
     }

◆ reindexAll()

reindexAll ( )

Regenerate full index

Returns: void

Exceptions

Implements IndexerInterface.

Definition at line 403 of file Indexer.php.

     {
         if ($this->getState()->getStatus() != StateInterface::STATUS_WORKING) {
             $state = $this->getState();
             $state->setStatus(StateInterface::STATUS_WORKING);
             $state->save();
             if ($this->getView()->isEnabled()) {
                 $this->getView()->suspend();
             }
             try {
                 $this->getActionInstance()->executeFull();
                 $state->setStatus(StateInterface::STATUS_VALID);
                 $state->save();
                 $this->getView()->resume();
             } catch (\Throwable $exception) {
                 $state->setStatus(StateInterface::STATUS_INVALID);
                 $state->save();
                 $this->getView()->resume();
                 throw $exception;
             }
         }
     }

◆ reindexList()

reindexList ( $ids )

Regenerate rows in index by ID list

Parameters

int[] $ids

Returns: void

Implements IndexerInterface.

Definition at line 444 of file Indexer.php.

     {
         $this->getActionInstance()->executeList($ids);
         $this->getState()->save();
     }

◆ reindexRow()

reindexRow ( $id )

Regenerate one row in index by ID

Parameters

int $id

Returns: void

Implements IndexerInterface.

Definition at line 432 of file Indexer.php.

     {
         $this->getActionInstance()->executeRow($id);
         $this->getState()->save();
     }

◆ setId()

setId ( $id )

Set ID

@codeCoverageIgnore

Parameters

string $id

Returns: $this

Definition at line 108 of file Indexer.php.

     {
         $this->setData($this->_idFieldName, $id);
         return $this;
     }

◆ setIdFieldName()

setIdFieldName ( $name )

Id field name setter

@codeCoverageIgnore

Parameters

string $name

Returns: $this

Definition at line 122 of file Indexer.php.

     {
         $this->_idFieldName = $name;
         return $this;
     }

◆ setScheduled()

setScheduled ( $scheduled )

Turn scheduled mode on/off

Parameters

bool $scheduled

Returns: void

Implements IndexerInterface.

Definition at line 285 of file Indexer.php.

     {
         if ($scheduled) {
             $this->getView()->subscribe();
         } else {
             $this->getView()->unsubscribe();
         }
         $this->getState()->save();
     }

◆ setState()

setState ( StateInterface $state )

Set indexer state object

Parameters

StateInterface $state

Returns: IndexerInterface

Implements IndexerInterface.

Definition at line 263 of file Indexer.php.

     {
         $this->state = $state;
         return $this;
     }

Field Documentation

◆ $_idFieldName

$_idFieldName = 'indexer_id'

protected

Definition at line 24 of file Indexer.php.

◆ $actionFactory

$actionFactory

protected

Definition at line 34 of file Indexer.php.

◆ $config

$config

protected

Definition at line 29 of file Indexer.php.

◆ $indexersFactory

$indexersFactory

protected

Definition at line 59 of file Indexer.php.

◆ $state

$state

protected

Definition at line 54 of file Indexer.php.

◆ $stateFactory

$stateFactory

protected

Definition at line 49 of file Indexer.php.

◆ $structureFactory

$structureFactory

protected

Definition at line 39 of file Indexer.php.

◆ $view

$view

protected

Definition at line 44 of file Indexer.php.

The documentation for this class was generated from the following file:

vendor/magento/module-indexer/Model/Indexer.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getActionClass()

◆ getActionInstance()

◆ getDescription()

◆ getFields()

◆ getHandlers()

◆ getId()

◆ getIdFieldName()

◆ getLatestUpdated()

◆ getSources()

◆ getState()

◆ getStatus()

◆ getStructureInstance()

◆ getTitle()

◆ getView()

◆ getViewId()

◆ invalidate()

◆ isInvalid()

◆ isScheduled()

◆ isValid()

◆ isWorking()

◆ load()

◆ reindexAll()

◆ reindexList()

◆ reindexRow()

◆ setId()

◆ setIdFieldName()

◆ setScheduled()

◆ setState()

Field Documentation

◆ $_idFieldName

◆ $actionFactory

◆ $config

◆ $indexersFactory

◆ $state

◆ $stateFactory

◆ $structureFactory

◆ $view