| Current Path : /var/www/clients/client3/web2/web/vendor/magento/framework/Indexer/SaveHandler/ |
| Current File : /var/www/clients/client3/web2/web/vendor/magento/framework/Indexer/SaveHandler/IndexerInterface.php |
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
/**
* Index Engine Interface
*/
namespace Magento\Framework\Indexer\SaveHandler;
use Magento\Framework\Search\Request\Dimension;
/**
* Indexer persistence handler
*
* @api
* @since 100.0.2
*/
interface IndexerInterface
{
/**
* Add entities data to index
*
* @param Dimension[] $dimensions
* @param \Traversable $documents
* @return IndexerInterface
*/
public function saveIndex($dimensions, \Traversable $documents);
/**
* Remove entities data from index
*
* @param Dimension[] $dimensions
* @param \Traversable $documents
* @return IndexerInterface
*/
public function deleteIndex($dimensions, \Traversable $documents);
/**
* Remove all data from index
*
* @param Dimension[] $dimensions
* @return IndexerInterface
*/
public function cleanIndex($dimensions);
/**
* Define if engine is available
*
* @param Dimension[] $dimensions
* @return bool
*/
public function isAvailable($dimensions = []);
}