|
Apache/2.4.41 (Ubuntu) Linux vmi616275.contaboserver.net 5.4.0-84-generic #94-Ubuntu SMP Thu Aug 26 20:27:37 UTC 2021 x86_64 uid=33(www-data) gid=33(www-data) groups=33(www-data) server ip : 62.171.164.128 | your ip : 127.0.0.1 safemode OFF > / home / a / home / dev2.destoffenstraat.com / vendor / magento / framework / Indexer / |
Filename | /home/a/home/dev2.destoffenstraat.com/vendor/magento/framework/Indexer/IndexerInterface.php |
Size | 3.45 kb |
Permission | rw-r--r-- |
Owner | root : root |
Create time | 21-Aug-2025 12:26 |
Last modified | 07-Jan-2021 21:08 |
Last accessed | 22-Aug-2025 21:44 |
Actions | edit | rename | delete | download (gzip) |
View | text | code | image |
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\Indexer;
/**
* Indexer
*
* @api
* @deprecated 102.0.0 Facade will be split
* @see \Magento\Framework\Indexer\ActionInterface
* @since 100.0.2
*/
interface IndexerInterface
{
/**
* Return indexer ID
*
* @return string
*/
public function getId();
/**
* Return indexer's view ID
*
* @return string
*/
public function getViewId();
/**
* Return indexer action class
*
* @return string
*/
public function getActionClass();
/**
* Return indexer title
*
* @return string
*/
public function getTitle();
/**
* Return indexer description
*
* @return string
*/
public function getDescription();
/**
* Return indexer fields
*
* @return array
*/
public function getFields();
/**
* Return indexer sources
*
* @return array
*/
public function getSources();
/**
* Return indexer handlers
*
* @return array
*/
public function getHandlers();
/**
* Fill indexer data from config
*
* @param string $indexerId
* @return IndexerInterface
* @throws \InvalidArgumentException
*/
public function load($indexerId);
/**
* Return related view object
*
* @return \Magento\Framework\Mview\ViewInterface
*/
public function getView();
/**
* Return related state object
*
* @return StateInterface
*/
public function getState();
/**
* Set indexer state object
*
* @param StateInterface $state
* @return IndexerInterface
*/
public function setState(StateInterface $state);
/**
* Check whether indexer is run by schedule
*
* @return bool
*/
public function isScheduled();
/**
* Turn scheduled mode on/off
*
* @param bool $scheduled
* @return void
*/
public function setScheduled($scheduled);
/**
* Check whether indexer is valid
*
* @return bool
*/
public function isValid();
/**
* Check whether indexer is invalid
*
* @return bool
*/
public function isInvalid();
/**
* Check whether indexer is working
*
* @return bool
*/
public function isWorking();
/**
* Set indexer invalid
*
* @return void
*/
public function invalidate();
/**
* Return indexer status
*
* @return string
*/
public function getStatus();
/**
* Return indexer or mview latest updated time
*
* @return string
*/
public function getLatestUpdated();
/**
* Regenerate full index
*
* @return void
* @throws \Exception
* @deprecated 102.0.0
* @see \Magento\Framework\Indexer\ActionInterface::executeFull
*/
public function reindexAll();
/**
* Regenerate one row in index by ID
*
* @param int $id
* @return void
* @deprecated 102.0.0
* @see \Magento\Framework\Indexer\ActionInterface::executeList
*/
public function reindexRow($id);
/**
* Regenerate rows in index by ID list
*
* @param int[] $ids
* @return void
* @deprecated 102.0.0
* @see \Magento\Framework\Indexer\ActionInterface::executeList
*/
public function reindexList($ids);
}
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\Indexer;
/**
* Indexer
*
* @api
* @deprecated 102.0.0 Facade will be split
* @see \Magento\Framework\Indexer\ActionInterface
* @since 100.0.2
*/
interface IndexerInterface
{
/**
* Return indexer ID
*
* @return string
*/
public function getId();
/**
* Return indexer's view ID
*
* @return string
*/
public function getViewId();
/**
* Return indexer action class
*
* @return string
*/
public function getActionClass();
/**
* Return indexer title
*
* @return string
*/
public function getTitle();
/**
* Return indexer description
*
* @return string
*/
public function getDescription();
/**
* Return indexer fields
*
* @return array
*/
public function getFields();
/**
* Return indexer sources
*
* @return array
*/
public function getSources();
/**
* Return indexer handlers
*
* @return array
*/
public function getHandlers();
/**
* Fill indexer data from config
*
* @param string $indexerId
* @return IndexerInterface
* @throws \InvalidArgumentException
*/
public function load($indexerId);
/**
* Return related view object
*
* @return \Magento\Framework\Mview\ViewInterface
*/
public function getView();
/**
* Return related state object
*
* @return StateInterface
*/
public function getState();
/**
* Set indexer state object
*
* @param StateInterface $state
* @return IndexerInterface
*/
public function setState(StateInterface $state);
/**
* Check whether indexer is run by schedule
*
* @return bool
*/
public function isScheduled();
/**
* Turn scheduled mode on/off
*
* @param bool $scheduled
* @return void
*/
public function setScheduled($scheduled);
/**
* Check whether indexer is valid
*
* @return bool
*/
public function isValid();
/**
* Check whether indexer is invalid
*
* @return bool
*/
public function isInvalid();
/**
* Check whether indexer is working
*
* @return bool
*/
public function isWorking();
/**
* Set indexer invalid
*
* @return void
*/
public function invalidate();
/**
* Return indexer status
*
* @return string
*/
public function getStatus();
/**
* Return indexer or mview latest updated time
*
* @return string
*/
public function getLatestUpdated();
/**
* Regenerate full index
*
* @return void
* @throws \Exception
* @deprecated 102.0.0
* @see \Magento\Framework\Indexer\ActionInterface::executeFull
*/
public function reindexAll();
/**
* Regenerate one row in index by ID
*
* @param int $id
* @return void
* @deprecated 102.0.0
* @see \Magento\Framework\Indexer\ActionInterface::executeList
*/
public function reindexRow($id);
/**
* Regenerate rows in index by ID list
*
* @param int[] $ids
* @return void
* @deprecated 102.0.0
* @see \Magento\Framework\Indexer\ActionInterface::executeList
*/
public function reindexList($ids);
}