Inheritance diagram for View:

Data Structures
class	ChangelogTest

Public Member Functions
	__construct (ConfigInterface $config, ActionFactory $actionFactory, View\StateInterface $state, View\ChangelogInterface $changelog, SubscriptionFactory $subscriptionFactory, array $data=[], array $changelogBatchSize=[])

	getId ()

	setId ($id)

	setIdFieldName ($name)

	getIdFieldName ()

	getActionClass ()

	getGroup ()

	getSubscriptions ()

	load ($viewId)

	update ()

	suspend ()

	resume ()

	clearChangelog ()

	getState ()

	setState (View\StateInterface $state)

	isEnabled ()

	isIdle ()

	isWorking ()

	isSuspended ()

	getUpdated ()

	getChangelog ()

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)

Public Member Functions inherited from ViewInterface
	subscribe ()

	unsubscribe ()

Data Fields
const	DEFAULT_BATCH_SIZE = 1000

Protected Attributes
	$_idFieldName = 'view_id'

	$config

	$actionFactory

	$changelog

	$subscriptionFactory

	$state

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

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

Detailed Description

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 15 of file View.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	ConfigInterface	$config,
		ActionFactory	$actionFactory,
		View\StateInterface	$state,
		View\ChangelogInterface	$changelog,
		SubscriptionFactory	$subscriptionFactory,
		array	$data = `[]`,
		array	$changelogBatchSize = `[]`
	)

Parameters

ConfigInterface	$config
ActionFactory	$actionFactory
View\StateInterface	$state
View\ChangelogInterface	$changelog
SubscriptionFactory	$subscriptionFactory
array	$data
array	$changelogBatchSize

Definition at line 71 of file View.php.

       {
         $this->config = $config;
         $this->actionFactory = $actionFactory;
         $this->state = $state;
         $this->changelog = $changelog;
         $this->subscriptionFactory = $subscriptionFactory;
         $this->changelogBatchSize = $changelogBatchSize;
         parent::__construct($data);
     }

Member Function Documentation

◆ clearChangelog()

clearChangelog ( )

Clear precessed changelog entries

Returns: void

Implements ViewInterface.

Definition at line 346 of file View.php.

     {
         if ($this->getState()->getMode() == View\StateInterface::MODE_ENABLED) {
             $this->getChangelog()->clear($this->getState()->getVersionId());
         }
     }

◆ getActionClass()

getActionClass ( )

Return view action class

Returns: string

Implements ViewInterface.

Definition at line 138 of file View.php.

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

◆ getChangelog()

getChangelog ( )

Retrieve linked changelog

Returns: View\ChangelogInterface

Implements ViewInterface.

Definition at line 433 of file View.php.

     {
         if (!$this->changelog->getViewId()) {
             $this->changelog->setViewId($this->getId());
         }
         return $this->changelog;
     }

◆ getGroup()

getGroup ( )

Return view group

Returns: string

Implements ViewInterface.

Definition at line 148 of file View.php.

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

◆ getId()

getId ( )

Return ID

Returns: string

Implements ViewInterface.

Definition at line 94 of file View.php.

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

◆ getIdFieldName()

getIdFieldName ( )

Id field name getter

Returns: string

Definition at line 128 of file View.php.

     {
         return $this->_idFieldName;
     }

◆ getState()

getState ( )

Return related state object

Returns: View\StateInterface

Implements ViewInterface.

Definition at line 358 of file View.php.

     {
         if (!$this->state->getViewId()) {
             $this->state->loadByView($this->getId());
         }
         return $this->state;
     }

◆ getSubscriptions()

getSubscriptions ( )

Return view subscriptions

Returns: array

Implements ViewInterface.

Definition at line 158 of file View.php.

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

◆ getUpdated()

getUpdated ( )

Return view updated datetime

Returns: string

Implements ViewInterface.

Definition at line 423 of file View.php.

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

◆ isEnabled()

isEnabled ( )

Check whether view is enabled

Returns: bool

Implements ViewInterface.

Definition at line 383 of file View.php.

     {
         return $this->getState()->getMode() == View\StateInterface::MODE_ENABLED;
     }

◆ isIdle()

isIdle ( )

Check whether view is idle

Returns: bool

Implements ViewInterface.

Definition at line 393 of file View.php.

     {
         return $this->getState()->getStatus() == \Magento\Framework\Mview\View\StateInterface::STATUS_IDLE;
     }

◆ isSuspended()

isSuspended ( )

Check whether view is suspended

Returns: bool

Implements ViewInterface.

Definition at line 413 of file View.php.

     {
         return $this->getState()->getStatus() == \Magento\Framework\Mview\View\StateInterface::STATUS_SUSPENDED;
     }

◆ isWorking()

isWorking ( )

Check whether view is working

Returns: bool

Implements ViewInterface.

Definition at line 403 of file View.php.

     {
         return $this->getState()->getStatus() == \Magento\Framework\Mview\View\StateInterface::STATUS_WORKING;
     }

◆ load()

load ( $viewId )

Fill view data from config

Parameters

string $viewId

Returns: ViewInterface

Exceptions

Implements ViewInterface.

Definition at line 170 of file View.php.

     {
         $view = $this->config->getView($viewId);
         if (empty($view) || empty($view['view_id']) || $view['view_id'] != $viewId) {
             throw new \InvalidArgumentException("{$viewId} view does not exist.");
         }
 
         $this->setId($viewId);
         $this->setData($view);
 
         return $this;
     }

◆ resume()

resume ( )

Resume view updates

Returns: void

Implements ViewInterface.

Definition at line 332 of file View.php.

     {
         $state = $this->getState();
         if ($state->getStatus() == View\StateInterface::STATUS_SUSPENDED) {
             $state->setStatus(View\StateInterface::STATUS_IDLE);
             $state->save();
         }
     }

◆ setId()

setId ( $id )

Set ID

Parameters

string $id

Returns: $this

Definition at line 105 of file View.php.

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

◆ setIdFieldName()

setIdFieldName ( $name )

Id field name setter

Parameters

string $name

Returns: $this

Definition at line 117 of file View.php.

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

◆ setState()

setState ( View\StateInterface $state )

Set view state object

Parameters

View\StateInterface $state

Returns: ViewInterface

Implements ViewInterface.

Definition at line 372 of file View.php.

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

◆ suspend()

suspend ( )

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

Returns: void

Implements ViewInterface.

Definition at line 317 of file View.php.

     {
         if ($this->getState()->getMode() == View\StateInterface::MODE_ENABLED) {
             $state = $this->getState();
             $state->setVersionId($this->getChangelog()->getVersion());
             $state->setStatus(View\StateInterface::STATUS_SUSPENDED);
             $state->save();
         }
     }

◆ update()

update ( )

Materialize view by IDs in changelog

Returns: void

Exceptions

Implements ViewInterface.

Definition at line 264 of file View.php.

     {
         if ($this->getState()->getStatus() == View\StateInterface::STATUS_IDLE) {
             try {
                 $currentVersionId = $this->getChangelog()->getVersion();
             } catch (ChangelogTableNotExistsException $e) {
                 return;
             }
             $lastVersionId = (int) $this->getState()->getVersionId();
             $action = $this->actionFactory->get($this->getActionClass());
 
             try {
                 $this->getState()->setStatus(View\StateInterface::STATUS_WORKING)->save();
 
                 $versionBatchSize = self::$maxVersionQueryBatch;
                 $batchSize = isset($this->changelogBatchSize[$this->getChangelog()->getViewId()])
                     ? $this->changelogBatchSize[$this->getChangelog()->getViewId()]
                     : self::DEFAULT_BATCH_SIZE;
 
                 for ($vsFrom = $lastVersionId; $vsFrom < $currentVersionId; $vsFrom += $versionBatchSize) {
                     // Don't go past the current version for atomicy.
                     $versionTo = min($currentVersionId, $vsFrom + $versionBatchSize);
                     $ids = $this->getChangelog()->getList($vsFrom, $versionTo);
 
                     // We run the actual indexer in batches.
                     // Chunked AFTER loading to avoid duplicates in separate chunks.
                     $chunks = array_chunk($ids, $batchSize);
                     foreach ($chunks as $ids) {
                         $action->execute($ids);
                     }
                 }
 
                 $this->getState()->loadByView($this->getId());
                 $statusToRestore = $this->getState()->getStatus() == View\StateInterface::STATUS_SUSPENDED
                     ? View\StateInterface::STATUS_SUSPENDED
                     : View\StateInterface::STATUS_IDLE;
                 $this->getState()->setVersionId($currentVersionId)->setStatus($statusToRestore)->save();
             } catch (\Exception $exception) {
                 $this->getState()->loadByView($this->getId());
                 $statusToRestore = $this->getState()->getStatus() == View\StateInterface::STATUS_SUSPENDED
                     ? View\StateInterface::STATUS_SUSPENDED
                     : View\StateInterface::STATUS_IDLE;
                 $this->getState()->setStatus($statusToRestore)->save();
                 throw $exception;
             }
         }
     }

Field Documentation

◆ $_idFieldName

$_idFieldName = 'view_id'

protected

Definition at line 30 of file View.php.

◆ $actionFactory

$actionFactory

protected

Definition at line 40 of file View.php.

◆ $changelog

$changelog

protected

Definition at line 45 of file View.php.

◆ $config

$config

protected

Definition at line 35 of file View.php.

◆ $state

$state

protected

Definition at line 55 of file View.php.

◆ $subscriptionFactory

$subscriptionFactory

protected

Definition at line 50 of file View.php.

◆ DEFAULT_BATCH_SIZE

const DEFAULT_BATCH_SIZE = 1000

Default batch size for partial reindex

Definition at line 20 of file View.php.

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

vendor/magento/framework/Mview/View.php

Data Structures

Public Member Functions

Data Fields

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ clearChangelog()

◆ getActionClass()

◆ getChangelog()

◆ getGroup()

◆ getId()

◆ getIdFieldName()

◆ getState()

◆ getSubscriptions()

◆ getUpdated()

◆ isEnabled()

◆ isIdle()

◆ isSuspended()

◆ isWorking()

◆ load()

◆ resume()

◆ setId()

◆ setIdFieldName()

◆ setState()

◆ suspend()

◆ update()

Field Documentation

◆ $_idFieldName

◆ $actionFactory

◆ $changelog

◆ $config

◆ $state

◆ $subscriptionFactory

◆ DEFAULT_BATCH_SIZE