StateInterface Interface Reference

Inheritance diagram for StateInterface:

Public Member Functions
	getIndexerId ()
	setIndexerId ($value)
	getStatus ()
	getUpdated ()
	setUpdated ($value)
	loadByIndexer ($indexerId)
	setStatus ($status)

Data Fields
const	STATUS_WORKING = 'working'
const	STATUS_VALID = 'valid'
const	STATUS_INVALID = 'invalid'

Detailed Description

@api Retrieve status of the Indexer

Since

100.0.2

Definition at line 12 of file StateInterface.php.

Member Function Documentation

getIndexerId()

getIndexerId

(

)

Return indexer id

Returns

string

Implemented in State.

getStatus()

getStatus

(

)

Return status

Returns

string

Implemented in State.

getUpdated()

getUpdated

(

)

Return updated

Returns

string

Implemented in State.

loadByIndexer()

loadByIndexer

(

$indexerId

)

Fill object with state data by view ID

Parameters

string

$indexerId

Returns

$this

Implemented in State.

setIndexerId()

setIndexerId

(

$value

)

Set indexer id

Parameters

string

$value

Returns

$this

Implemented in State.

setStatus()

setStatus

(

$status

)

Status setter

Parameters

string

$status

Returns

$this

Implemented in State.

setUpdated()

setUpdated

(

$value

)

Set updated

Parameters

string

$value

Returns

$this

Implemented in State.

Field Documentation

STATUS_INVALID

const STATUS_INVALID = 'invalid'

Definition at line 19 of file StateInterface.php.

STATUS_VALID

const STATUS_VALID = 'valid'

Definition at line 18 of file StateInterface.php.

STATUS_WORKING

const STATUS_WORKING = 'working'

Indexer statuses

Definition at line 17 of file StateInterface.php.

---

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

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