IndexerInterface Interface Reference

Inheritance diagram for IndexerInterface:

Public Member Functions
	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

Indexer

@api

Deprecated:

Facade will be split

See also

\Magento\Framework\Indexer\ActionInterface

Since

100.0.2

Definition at line 16 of file IndexerInterface.php.

Member Function Documentation

getActionClass()

getActionClass

(

)

Return indexer action class

Returns

string

Implemented in Indexer, and DependencyDecorator.

getDescription()

getDescription

(

)

Return indexer description

Returns

string

Implemented in Indexer, and DependencyDecorator.

getFields()

getFields

(

)

Return indexer fields

Returns

array

Implemented in Indexer, and DependencyDecorator.

getHandlers()

getHandlers

(

)

Return indexer handlers

Returns

array

Implemented in Indexer, and DependencyDecorator.

getId()

getId

(

)

Return indexer ID

Returns

string

Implemented in Indexer, and DependencyDecorator.

getLatestUpdated()

getLatestUpdated

(

)

Return indexer or mview latest updated time

Returns

string

Implemented in Indexer, and DependencyDecorator.

getSources()

getSources

(

)

Return indexer sources

Returns

array

Implemented in Indexer, and DependencyDecorator.

getState()

getState

(

)

Return related state object

Returns

StateInterface

Implemented in Indexer, and DependencyDecorator.

getStatus()

getStatus

(

)

Return indexer status

Returns

string

Implemented in Indexer, and DependencyDecorator.

getTitle()

getTitle

(

)

Return indexer title

Returns

string

Implemented in Indexer, and DependencyDecorator.

getView()

getView

(

)

Return related view object

Returns

\Magento\Framework\Mview\ViewInterface

Implemented in Indexer, and DependencyDecorator.

getViewId()

getViewId

(

)

Return indexer's view ID

Returns

string

Implemented in Indexer, and DependencyDecorator.

invalidate()

invalidate

(

)

Set indexer invalid

Returns

void

Implemented in Indexer, and DependencyDecorator.

isInvalid()

isInvalid

(

)

Check whether indexer is invalid

Returns

bool

Implemented in Indexer, and DependencyDecorator.

isScheduled()

isScheduled

(

)

Check whether indexer is run by schedule

Returns

bool

Implemented in Indexer, and DependencyDecorator.

isValid()

isValid

(

)

Check whether indexer is valid

Returns

bool

Implemented in Indexer, and DependencyDecorator.

isWorking()

isWorking

(

)

Check whether indexer is working

Returns

bool

Implemented in Indexer, and DependencyDecorator.

load()

load

(

$indexerId

)

Fill indexer data from config

Parameters

string

$indexerId

Returns

IndexerInterface

Exceptions

Implemented in Indexer, and DependencyDecorator.

reindexAll()

reindexAll

(

)

Regenerate full index

Returns

void

Exceptions

Implemented in Indexer, and DependencyDecorator.

reindexList()

reindexList

(

$ids

)

Regenerate rows in index by ID list

Parameters

int[]

$ids

Returns

void

Deprecated:

See also

\Magento\Framework\Indexer\ActionInterface::executeList

Implemented in Indexer, and DependencyDecorator.

reindexRow()

reindexRow

(

$id

)

Regenerate one row in index by ID

Parameters

int

$id

Returns

void

Deprecated:

See also

\Magento\Framework\Indexer\ActionInterface::executeList

Implemented in Indexer, and DependencyDecorator.

setScheduled()

setScheduled

(

$scheduled

)

Turn scheduled mode on/off

Parameters

bool

$scheduled

Returns

void

Implemented in Indexer, and DependencyDecorator.

setState()

setState

(

StateInterface

$state

)

Set indexer state object

Parameters

StateInterface

$state

Returns

IndexerInterface

Implemented in Indexer, and DependencyDecorator.

---

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

• vendor/magento/framework/Indexer/IndexerInterface.php