123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152 |
- <?php
- /**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
- */
- namespace Magento\Framework\Mview;
- /**
- * Interface \Magento\Framework\Mview\ViewInterface
- *
- */
- interface ViewInterface
- {
- /**
- * Return view ID
- *
- * @return string
- */
- public function getId();
- /**
- * Return view action class
- *
- * @return string
- */
- public function getActionClass();
- /**
- * Return view group
- *
- * @return string
- */
- public function getGroup();
- /**
- * Return view subscriptions
- *
- * @return array
- */
- public function getSubscriptions();
- /**
- * Fill view data from config
- *
- * @param string $viewId
- * @return ViewInterface
- * @throws \InvalidArgumentException
- */
- public function load($viewId);
- /**
- * Create subscriptions
- *
- * @throws \Exception
- * @return ViewInterface
- */
- public function subscribe();
- /**
- * Remove subscriptions
- *
- * @throws \Exception
- * @return ViewInterface
- */
- public function unsubscribe();
- /**
- * Materialize view by IDs in changelog
- *
- * @return void
- * @throws \Exception
- */
- public function update();
- /**
- * Pause view updates and set version ID to changelog's end
- *
- * @return void
- */
- public function suspend();
- /**
- * Resume view updates
- *
- * @return void
- */
- public function resume();
- /**
- * Clear precessed changelog entries
- *
- * @return void
- */
- public function clearChangelog();
- /**
- * Return related state object
- *
- * @return View\StateInterface
- */
- public function getState();
- /**
- * Set view state object
- *
- * @param View\StateInterface $state
- * @return ViewInterface
- */
- public function setState(View\StateInterface $state);
- /**
- * Check whether view is enabled
- *
- * @return bool
- */
- public function isEnabled();
- /**
- * Check whether view is idle
- *
- * @return bool
- */
- public function isIdle();
- /**
- * Check whether view is working
- *
- * @return bool
- */
- public function isWorking();
- /**
- * Check whether view is paused
- *
- * @return bool
- */
- public function isSuspended();
- /**
- * Return view updated datetime
- *
- * @return string
- */
- public function getUpdated();
- /**
- * Retrieve linked changelog
- *
- * @return View\ChangelogInterface
- */
- public function getChangelog();
- }
|