-
Notifications
You must be signed in to change notification settings - Fork 9.3k
/
BlockRepository.php
210 lines (190 loc) · 6.33 KB
/
BlockRepository.php
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Cms\Model;
use Magento\Cms\Api\BlockRepositoryInterface;
use Magento\Cms\Api\Data;
use Magento\Cms\Model\ResourceModel\Block as ResourceBlock;
use Magento\Cms\Model\ResourceModel\Block\CollectionFactory as BlockCollectionFactory;
use Magento\Framework\Api\DataObjectHelper;
use Magento\Framework\Api\SearchCriteria\CollectionProcessorInterface;
use Magento\Framework\Exception\CouldNotDeleteException;
use Magento\Framework\Exception\CouldNotSaveException;
use Magento\Framework\Exception\NoSuchEntityException;
use Magento\Framework\Reflection\DataObjectProcessor;
use Magento\Store\Model\StoreManagerInterface;
/**
* Class BlockRepository
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
*/
class BlockRepository implements BlockRepositoryInterface
{
/**
* @var ResourceBlock
*/
protected $resource;
/**
* @var BlockFactory
*/
protected $blockFactory;
/**
* @var BlockCollectionFactory
*/
protected $blockCollectionFactory;
/**
* @var Data\BlockSearchResultsInterfaceFactory
*/
protected $searchResultsFactory;
/**
* @var DataObjectHelper
*/
protected $dataObjectHelper;
/**
* @var DataObjectProcessor
*/
protected $dataObjectProcessor;
/**
* @var \Magento\Cms\Api\Data\BlockInterfaceFactory
*/
protected $dataBlockFactory;
/**
* @var \Magento\Store\Model\StoreManagerInterface
*/
private $storeManager;
/**
* @var CollectionProcessorInterface
*/
private $collectionProcessor;
/**
* @param ResourceBlock $resource
* @param BlockFactory $blockFactory
* @param Data\BlockInterfaceFactory $dataBlockFactory
* @param BlockCollectionFactory $blockCollectionFactory
* @param Data\BlockSearchResultsInterfaceFactory $searchResultsFactory
* @param DataObjectHelper $dataObjectHelper
* @param DataObjectProcessor $dataObjectProcessor
* @param StoreManagerInterface $storeManager
* @param CollectionProcessorInterface $collectionProcessor
*/
public function __construct(
ResourceBlock $resource,
BlockFactory $blockFactory,
\Magento\Cms\Api\Data\BlockInterfaceFactory $dataBlockFactory,
BlockCollectionFactory $blockCollectionFactory,
Data\BlockSearchResultsInterfaceFactory $searchResultsFactory,
DataObjectHelper $dataObjectHelper,
DataObjectProcessor $dataObjectProcessor,
StoreManagerInterface $storeManager,
CollectionProcessorInterface $collectionProcessor = null
) {
$this->resource = $resource;
$this->blockFactory = $blockFactory;
$this->blockCollectionFactory = $blockCollectionFactory;
$this->searchResultsFactory = $searchResultsFactory;
$this->dataObjectHelper = $dataObjectHelper;
$this->dataBlockFactory = $dataBlockFactory;
$this->dataObjectProcessor = $dataObjectProcessor;
$this->storeManager = $storeManager;
$this->collectionProcessor = $collectionProcessor ?: $this->getCollectionProcessor();
}
/**
* Save Block data
*
* @param \Magento\Cms\Api\Data\BlockInterface $block
* @return Block
* @throws CouldNotSaveException
*/
public function save(Data\BlockInterface $block)
{
if (empty($block->getStoreId())) {
$block->setStoreId($this->storeManager->getStore()->getId());
}
try {
$this->resource->save($block);
} catch (\Exception $exception) {
throw new CouldNotSaveException(__($exception->getMessage()));
}
return $block;
}
/**
* Load Block data by given Block Identity
*
* @param string $blockId
* @return Block
* @throws \Magento\Framework\Exception\NoSuchEntityException
*/
public function getById($blockId)
{
$block = $this->blockFactory->create();
$this->resource->load($block, $blockId);
if (!$block->getId()) {
throw new NoSuchEntityException(__('CMS Block with id "%1" does not exist.', $blockId));
}
return $block;
}
/**
* Load Block data collection by given search criteria
*
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
* @SuppressWarnings(PHPMD.NPathComplexity)
* @param \Magento\Framework\Api\SearchCriteriaInterface $criteria
* @return \Magento\Cms\Api\Data\BlockSearchResultsInterface
*/
public function getList(\Magento\Framework\Api\SearchCriteriaInterface $criteria)
{
/** @var \Magento\Cms\Model\ResourceModel\Block\Collection $collection */
$collection = $this->blockCollectionFactory->create();
$this->collectionProcessor->process($criteria, $collection);
/** @var Data\BlockSearchResultsInterface $searchResults */
$searchResults = $this->searchResultsFactory->create();
$searchResults->setSearchCriteria($criteria);
$searchResults->setItems($collection->getItems());
$searchResults->setTotalCount($collection->getSize());
return $searchResults;
}
/**
* Delete Block
*
* @param \Magento\Cms\Api\Data\BlockInterface $block
* @return bool
* @throws CouldNotDeleteException
*/
public function delete(Data\BlockInterface $block)
{
try {
$this->resource->delete($block);
} catch (\Exception $exception) {
throw new CouldNotDeleteException(__($exception->getMessage()));
}
return true;
}
/**
* Delete Block by given Block Identity
*
* @param string $blockId
* @return bool
* @throws CouldNotDeleteException
* @throws NoSuchEntityException
*/
public function deleteById($blockId)
{
return $this->delete($this->getById($blockId));
}
/**
* Retrieve collection processor
*
* @deprecated 101.1.0
* @return CollectionProcessorInterface
*/
private function getCollectionProcessor()
{
if (!$this->collectionProcessor) {
$this->collectionProcessor = \Magento\Framework\App\ObjectManager::getInstance()->get(
'Magento\Cms\Model\Api\SearchCriteria\BlockCollectionProcessor'
);
}
return $this->collectionProcessor;
}
}