Inheritance diagram for DependencyDecorator:

Public Member Functions
	__construct (IndexerInterface $indexer, DependencyInfoProviderInterface $dependencyInfoProvider, IndexerRegistry $indexerRegistry)

	__call (string $method, array $args)

	__sleep ()

	__clone ()

	getId ()

	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)

Detailed Description

The decorator, which implements logic of the dependency between the indexers.

@SuppressWarnings(PHPMD.TooManyPublicMethods)

Definition at line 21 of file DependencyDecorator.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	IndexerInterface	$indexer,
		DependencyInfoProviderInterface	$dependencyInfoProvider,
		IndexerRegistry	$indexerRegistry
	)

Parameters

IndexerInterface	$indexer
DependencyInfoProviderInterface	$dependencyInfoProvider
IndexerRegistry	$indexerRegistry

Definition at line 43 of file DependencyDecorator.php.

       {
         $this->indexer = $indexer;
         $this->dependencyInfoProvider = $dependencyInfoProvider;
         $this->indexerRegistry = $indexerRegistry;
     }

Member Function Documentation

◆ __call()

__call	(	string	$method,
		array	$args
	)

Definition at line 56 of file DependencyDecorator.php.

     {
         return call_user_func_array([$this->indexer, $method], $args);
     }

◆ __clone()

__clone ( )

Definition at line 72 of file DependencyDecorator.php.

     {
         $this->indexer = clone $this->indexer;
     }

◆ __sleep()

__sleep ( )

Returns: array

Definition at line 64 of file DependencyDecorator.php.

     {
         return ['indexer', 'dependencyInfoProvider', 'indexerRegistry'];
     }

◆ getActionClass()

getActionClass ( )

Return indexer action class

Returns: string

Implements IndexerInterface.

Definition at line 96 of file DependencyDecorator.php.

                                     : string
     {
         return $this->indexer->getActionClass();
     }

◆ getDescription()

getDescription ( )

Return indexer description

Returns: string

Implements IndexerInterface.

Definition at line 112 of file DependencyDecorator.php.

                                     : string
     {
         return $this->indexer->getDescription();
     }

◆ getFields()

getFields ( )

Return indexer fields

Returns: array

Implements IndexerInterface.

Definition at line 120 of file DependencyDecorator.php.

                                : array
     {
         return $this->indexer->getFields();
     }

◆ getHandlers()

getHandlers ( )

Return indexer handlers

Returns: array

Implements IndexerInterface.

Definition at line 136 of file DependencyDecorator.php.

                                  : array
     {
         return $this->indexer->getHandlers();
     }

◆ getId()

getId ( )

Return indexer ID

Returns: string

Implements IndexerInterface.

Definition at line 80 of file DependencyDecorator.php.

                            : string
     {
         return $this->indexer->getId();
     }

◆ getLatestUpdated()

getLatestUpdated ( )

Return indexer or mview latest updated time

Returns: string

Implements IndexerInterface.

Definition at line 238 of file DependencyDecorator.php.

                                       : string
     {
         return $this->indexer->getLatestUpdated();
     }

◆ getSources()

getSources ( )

Return indexer sources

Returns: array

Implements IndexerInterface.

Definition at line 128 of file DependencyDecorator.php.

                                 : array
     {
         return $this->indexer->getSources();
     }

◆ getState()

getState ( )

Return related state object

Returns: StateInterface

Implements IndexerInterface.

Definition at line 161 of file DependencyDecorator.php.

                               : StateInterface
     {
         return $this->indexer->getState();
     }

◆ getStatus()

getStatus ( )

Return indexer status

Returns: string

Implements IndexerInterface.

Definition at line 230 of file DependencyDecorator.php.

                                : string
     {
         return $this->indexer->getStatus();
     }

◆ getTitle()

getTitle ( )

Return indexer title

Returns: string

Implements IndexerInterface.

Definition at line 104 of file DependencyDecorator.php.

                               : string
     {
         return $this->indexer->getTitle();
     }

◆ getView()

getView ( )

Return related view object

Returns: \Magento\Framework\Mview\ViewInterface

Implements IndexerInterface.

Definition at line 153 of file DependencyDecorator.php.

                              : ViewInterface
     {
         return $this->indexer->getView();
     }

◆ getViewId()

getViewId ( )

Return indexer's view ID

Returns: string

Implements IndexerInterface.

Definition at line 88 of file DependencyDecorator.php.

                                : string
     {
         return $this->indexer->getViewId();
     }

◆ invalidate()

invalidate ( )

Set indexer invalid

Returns: void

Implements IndexerInterface.

Definition at line 218 of file DependencyDecorator.php.

     {
         $this->indexer->invalidate();
         $dependentIndexerIds = $this->dependencyInfoProvider->getIndexerIdsToRunAfter($this->indexer->getId());
         foreach ($dependentIndexerIds as $indexerId) {
             $this->indexerRegistry->get($indexerId)->invalidate();
         }
     }

◆ isInvalid()

isInvalid ( )

Check whether indexer is invalid

Returns: bool

Implements IndexerInterface.

Definition at line 202 of file DependencyDecorator.php.

                                : bool
     {
         return $this->indexer->isInvalid();
     }

◆ isScheduled()

isScheduled ( )

Check whether indexer is run by schedule

Returns: bool

Implements IndexerInterface.

Definition at line 178 of file DependencyDecorator.php.

                                  : bool
     {
         return $this->indexer->isScheduled();
     }

◆ isValid()

isValid ( )

Check whether indexer is valid

Returns: bool

Implements IndexerInterface.

Definition at line 194 of file DependencyDecorator.php.

                              : bool
     {
         return $this->indexer->isValid();
     }

◆ isWorking()

isWorking ( )

Check whether indexer is working

Returns: bool

Implements IndexerInterface.

Definition at line 210 of file DependencyDecorator.php.

                                : bool
     {
         return $this->indexer->isWorking();
     }

◆ load()

load ( $indexerId )

Fill indexer data from config

Parameters

string $indexerId

Returns: IndexerInterface

Exceptions

Implements IndexerInterface.

Definition at line 144 of file DependencyDecorator.php.

                                     : self
     {
         $this->indexer->load($indexerId);
         return $this;
     }

◆ reindexAll()

reindexAll ( )

Regenerate full index

Returns: void

Exceptions

Implements IndexerInterface.

Definition at line 246 of file DependencyDecorator.php.

     {
         $this->indexer->reindexAll();
     }

◆ reindexList()

reindexList ( $ids )

Regenerate rows in index by ID list

Parameters

int[] $ids

Returns: void

Deprecated:

See also: \Magento\Framework\Indexer\ActionInterface::executeList

Implements IndexerInterface.

Definition at line 269 of file DependencyDecorator.php.

     {
         $this->indexer->reindexList($ids);
         $dependentIndexerIds = $this->dependencyInfoProvider->getIndexerIdsToRunAfter($this->indexer->getId());
         foreach ($dependentIndexerIds as $indexerId) {
             $dependentIndexer = $this->indexerRegistry->get($indexerId);
             if (!$dependentIndexer->isScheduled()) {
                 $dependentIndexer->reindexList($ids);
             }
         }
     }

◆ reindexRow()

reindexRow ( $id )

Regenerate one row in index by ID

Parameters

int $id

Returns: void

Deprecated:

See also: \Magento\Framework\Indexer\ActionInterface::executeList

Implements IndexerInterface.

Definition at line 254 of file DependencyDecorator.php.

     {
         $this->indexer->reindexRow($id);
         $dependentIndexerIds = $this->dependencyInfoProvider->getIndexerIdsToRunAfter($this->indexer->getId());
         foreach ($dependentIndexerIds as $indexerId) {
             $dependentIndexer = $this->indexerRegistry->get($indexerId);
             if (!$dependentIndexer->isScheduled()) {
                 $dependentIndexer->reindexRow($id);
             }
         }
     }

◆ setScheduled()

setScheduled ( $scheduled )

Turn scheduled mode on/off

Parameters

bool $scheduled

Returns: void

Implements IndexerInterface.

Definition at line 186 of file DependencyDecorator.php.

     {
         $this->indexer->setScheduled($scheduled);
     }

◆ setState()

setState ( StateInterface $state )

Set indexer state object

Parameters

StateInterface $state

Returns: IndexerInterface

Implements IndexerInterface.

Definition at line 169 of file DependencyDecorator.php.

                                                    : self
     {
         $this->indexer->setState($state);
         return $this;
     }

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

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __call()

◆ __clone()

◆ __sleep()

◆ getActionClass()

◆ getDescription()

◆ getFields()

◆ getHandlers()

◆ getId()

◆ getLatestUpdated()

◆ getSources()

◆ getState()

◆ getStatus()

◆ getTitle()

◆ getView()

◆ getViewId()

◆ invalidate()

◆ isInvalid()

◆ isScheduled()

◆ isValid()

◆ isWorking()

◆ load()

◆ reindexAll()

◆ reindexList()

◆ reindexRow()

◆ setScheduled()

◆ setState()