ViewInterface Interface Reference

Inheritance diagram for ViewInterface:

Public Member Functions
	getId ()
	getActionClass ()
	getGroup ()
	getSubscriptions ()
	load ($viewId)
	subscribe ()
	unsubscribe ()
	update ()
	suspend ()
	resume ()
	clearChangelog ()
	getState ()
	setState (View\StateInterface $state)
	isEnabled ()
	isIdle ()
	isWorking ()
	isSuspended ()
	getUpdated ()
	getChangelog ()

Detailed Description

Interface \Magento\Framework\Mview\ViewInterface

Definition at line 12 of file ViewInterface.php.

Member Function Documentation

clearChangelog()

clearChangelog

(

)

Clear precessed changelog entries

Returns

void

Implemented in View.

getActionClass()

getActionClass

(

)

Return view action class

Returns

string

Implemented in View.

getChangelog()

getChangelog

(

)

Retrieve linked changelog

Returns

View\ChangelogInterface

Implemented in View.

getGroup()

getGroup

(

)

Return view group

Returns

string

Implemented in View.

getId()

getId

(

)

Return view ID

Returns

string

Implemented in View.

getState()

getState

(

)

Return related state object

Returns

View\StateInterface

Implemented in View.

getSubscriptions()

getSubscriptions

(

)

Return view subscriptions

Returns

array

Implemented in View.

getUpdated()

getUpdated

(

)

Return view updated datetime

Returns

string

Implemented in View.

isEnabled()

isEnabled

(

)

Check whether view is enabled

Returns

bool

Implemented in View.

isIdle()

isIdle

(

)

Check whether view is idle

Returns

bool

Implemented in View.

isSuspended()

isSuspended

(

)

Check whether view is paused

Returns

bool

Implemented in View.

isWorking()

isWorking

(

)

Check whether view is working

Returns

bool

Implemented in View.

load()

load

(

$viewId

)

Fill view data from config

Parameters

string

$viewId

Returns

ViewInterface

Exceptions

Implemented in View.

resume()

resume

(

)

Resume view updates

Returns

void

Implemented in View.

setState()

setState

(

View\StateInterface

$state

)

Set view state object

Parameters

View\StateInterface

$state

Returns

ViewInterface

Implemented in View.

subscribe()

subscribe

(

)

Create subscriptions

Exceptions

suspend()

suspend

(

)

Pause view updates and set version ID to changelog's end

Returns

void

Implemented in View.

unsubscribe()

unsubscribe

(

)

Remove subscriptions

Exceptions

update()

update

(

)

Materialize view by IDs in changelog

Returns

void

Exceptions

Implemented in View.

---

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

• vendor/magento/framework/Mview/ViewInterface.php