1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\CatalogRule\Model\Indexer;
use Magento\Framework\Mview\ActionInterface as MviewActionInterface;
use Magento\Framework\Indexer\ActionInterface as IndexerActionInterface;
use Magento\Framework\DataObject\IdentityInterface;
use Magento\Framework\Indexer\CacheContext;
/**
* Abstract class for CatalogRule indexers.
*/
abstract class AbstractIndexer implements IndexerActionInterface, MviewActionInterface, IdentityInterface
{
/**
* @var IndexBuilder
*/
protected $indexBuilder;
/**
* Application Event Dispatcher
*
* @var \Magento\Framework\Event\ManagerInterface
*/
protected $_eventManager;
/**
* @var \Magento\Framework\App\CacheInterface
*/
private $cacheManager;
/**
* @var \Magento\Framework\Indexer\CacheContext
*/
protected $cacheContext;
/**
* @param IndexBuilder $indexBuilder
* @param \Magento\Framework\Event\ManagerInterface $eventManager
*/
public function __construct(
IndexBuilder $indexBuilder,
\Magento\Framework\Event\ManagerInterface $eventManager
) {
$this->indexBuilder = $indexBuilder;
$this->_eventManager = $eventManager;
}
/**
* Execute materialization on ids entities
*
* @param int[] $ids
* @return void
*/
public function execute($ids)
{
$this->executeList($ids);
}
/**
* Execute full indexation
*
* @return void
*/
public function executeFull()
{
$this->indexBuilder->reindexFull();
$this->_eventManager->dispatch('clean_cache_by_tags', ['object' => $this]);
$this->getCacheManager()->clean($this->getIdentities());
}
/**
* Get affected cache tags
*
* @return array
* @codeCoverageIgnore
*/
public function getIdentities()
{
return [
\Magento\Catalog\Model\Category::CACHE_TAG,
\Magento\Catalog\Model\Product::CACHE_TAG,
\Magento\Framework\App\Cache\Type\Block::CACHE_TAG
];
}
/**
* Execute partial indexation by ID list
*
* @param int[] $ids
* @throws \Magento\Framework\Exception\LocalizedException
* @return void
*/
public function executeList(array $ids)
{
if (!$ids) {
throw new \Magento\Framework\Exception\LocalizedException(
__('Could not rebuild index for empty products array')
);
}
$this->doExecuteList($ids);
}
/**
* Execute partial indexation by ID list. Template method
*
* @param int[] $ids
* @return void
*/
abstract protected function doExecuteList($ids);
/**
* Execute partial indexation by ID
*
* @param int $id
* @throws \Magento\Framework\Exception\LocalizedException
* @return void
*/
public function executeRow($id)
{
if (!$id) {
throw new \Magento\Framework\Exception\LocalizedException(
__('We can\'t rebuild the index for an undefined product.')
);
}
$this->doExecuteRow($id);
}
/**
* Execute partial indexation by ID. Template method
*
* @param int $id
* @throws \Magento\Framework\Exception\LocalizedException
* @return void
*/
abstract protected function doExecuteRow($id);
/**
* Get cache manager
*
* @return \Magento\Framework\App\CacheInterface|mixed
* @deprecated 100.0.7
*/
private function getCacheManager()
{
if ($this->cacheManager === null) {
$this->cacheManager = \Magento\Framework\App\ObjectManager::getInstance()->get(
\Magento\Framework\App\CacheInterface::class
);
}
return $this->cacheManager;
}
/**
* Get cache context
*
* @return \Magento\Framework\Indexer\CacheContext
* @deprecated 100.0.7
*/
protected function getCacheContext()
{
if (!($this->cacheContext instanceof CacheContext)) {
return \Magento\Framework\App\ObjectManager::getInstance()->get(CacheContext::class);
} else {
return $this->cacheContext;
}
}
}