BlockRepository.php 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211
  1. <?php
  2. /**
  3. * Copyright © Magento, Inc. All rights reserved.
  4. * See COPYING.txt for license details.
  5. */
  6. namespace Magento\Cms\Model;
  7. use Magento\Cms\Api\BlockRepositoryInterface;
  8. use Magento\Cms\Api\Data;
  9. use Magento\Cms\Model\ResourceModel\Block as ResourceBlock;
  10. use Magento\Cms\Model\ResourceModel\Block\CollectionFactory as BlockCollectionFactory;
  11. use Magento\Framework\Api\DataObjectHelper;
  12. use Magento\Framework\Api\SearchCriteria\CollectionProcessorInterface;
  13. use Magento\Framework\Exception\CouldNotDeleteException;
  14. use Magento\Framework\Exception\CouldNotSaveException;
  15. use Magento\Framework\Exception\NoSuchEntityException;
  16. use Magento\Framework\Reflection\DataObjectProcessor;
  17. use Magento\Store\Model\StoreManagerInterface;
  18. /**
  19. * Class BlockRepository
  20. * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  21. */
  22. class BlockRepository implements BlockRepositoryInterface
  23. {
  24. /**
  25. * @var ResourceBlock
  26. */
  27. protected $resource;
  28. /**
  29. * @var BlockFactory
  30. */
  31. protected $blockFactory;
  32. /**
  33. * @var BlockCollectionFactory
  34. */
  35. protected $blockCollectionFactory;
  36. /**
  37. * @var Data\BlockSearchResultsInterfaceFactory
  38. */
  39. protected $searchResultsFactory;
  40. /**
  41. * @var DataObjectHelper
  42. */
  43. protected $dataObjectHelper;
  44. /**
  45. * @var DataObjectProcessor
  46. */
  47. protected $dataObjectProcessor;
  48. /**
  49. * @var \Magento\Cms\Api\Data\BlockInterfaceFactory
  50. */
  51. protected $dataBlockFactory;
  52. /**
  53. * @var \Magento\Store\Model\StoreManagerInterface
  54. */
  55. private $storeManager;
  56. /**
  57. * @var CollectionProcessorInterface
  58. */
  59. private $collectionProcessor;
  60. /**
  61. * @param ResourceBlock $resource
  62. * @param BlockFactory $blockFactory
  63. * @param Data\BlockInterfaceFactory $dataBlockFactory
  64. * @param BlockCollectionFactory $blockCollectionFactory
  65. * @param Data\BlockSearchResultsInterfaceFactory $searchResultsFactory
  66. * @param DataObjectHelper $dataObjectHelper
  67. * @param DataObjectProcessor $dataObjectProcessor
  68. * @param StoreManagerInterface $storeManager
  69. * @param CollectionProcessorInterface $collectionProcessor
  70. */
  71. public function __construct(
  72. ResourceBlock $resource,
  73. BlockFactory $blockFactory,
  74. \Magento\Cms\Api\Data\BlockInterfaceFactory $dataBlockFactory,
  75. BlockCollectionFactory $blockCollectionFactory,
  76. Data\BlockSearchResultsInterfaceFactory $searchResultsFactory,
  77. DataObjectHelper $dataObjectHelper,
  78. DataObjectProcessor $dataObjectProcessor,
  79. StoreManagerInterface $storeManager,
  80. CollectionProcessorInterface $collectionProcessor = null
  81. ) {
  82. $this->resource = $resource;
  83. $this->blockFactory = $blockFactory;
  84. $this->blockCollectionFactory = $blockCollectionFactory;
  85. $this->searchResultsFactory = $searchResultsFactory;
  86. $this->dataObjectHelper = $dataObjectHelper;
  87. $this->dataBlockFactory = $dataBlockFactory;
  88. $this->dataObjectProcessor = $dataObjectProcessor;
  89. $this->storeManager = $storeManager;
  90. $this->collectionProcessor = $collectionProcessor ?: $this->getCollectionProcessor();
  91. }
  92. /**
  93. * Save Block data
  94. *
  95. * @param \Magento\Cms\Api\Data\BlockInterface $block
  96. * @return Block
  97. * @throws CouldNotSaveException
  98. */
  99. public function save(Data\BlockInterface $block)
  100. {
  101. if (empty($block->getStoreId())) {
  102. $block->setStoreId($this->storeManager->getStore()->getId());
  103. }
  104. try {
  105. $this->resource->save($block);
  106. } catch (\Exception $exception) {
  107. throw new CouldNotSaveException(__($exception->getMessage()));
  108. }
  109. return $block;
  110. }
  111. /**
  112. * Load Block data by given Block Identity
  113. *
  114. * @param string $blockId
  115. * @return Block
  116. * @throws \Magento\Framework\Exception\NoSuchEntityException
  117. */
  118. public function getById($blockId)
  119. {
  120. $block = $this->blockFactory->create();
  121. $this->resource->load($block, $blockId);
  122. if (!$block->getId()) {
  123. throw new NoSuchEntityException(__('The CMS block with the "%1" ID doesn\'t exist.', $blockId));
  124. }
  125. return $block;
  126. }
  127. /**
  128. * Load Block data collection by given search criteria
  129. *
  130. * @SuppressWarnings(PHPMD.CyclomaticComplexity)
  131. * @SuppressWarnings(PHPMD.NPathComplexity)
  132. * @param \Magento\Framework\Api\SearchCriteriaInterface $criteria
  133. * @return \Magento\Cms\Api\Data\BlockSearchResultsInterface
  134. */
  135. public function getList(\Magento\Framework\Api\SearchCriteriaInterface $criteria)
  136. {
  137. /** @var \Magento\Cms\Model\ResourceModel\Block\Collection $collection */
  138. $collection = $this->blockCollectionFactory->create();
  139. $this->collectionProcessor->process($criteria, $collection);
  140. /** @var Data\BlockSearchResultsInterface $searchResults */
  141. $searchResults = $this->searchResultsFactory->create();
  142. $searchResults->setSearchCriteria($criteria);
  143. $searchResults->setItems($collection->getItems());
  144. $searchResults->setTotalCount($collection->getSize());
  145. return $searchResults;
  146. }
  147. /**
  148. * Delete Block
  149. *
  150. * @param \Magento\Cms\Api\Data\BlockInterface $block
  151. * @return bool
  152. * @throws CouldNotDeleteException
  153. */
  154. public function delete(Data\BlockInterface $block)
  155. {
  156. try {
  157. $this->resource->delete($block);
  158. } catch (\Exception $exception) {
  159. throw new CouldNotDeleteException(__($exception->getMessage()));
  160. }
  161. return true;
  162. }
  163. /**
  164. * Delete Block by given Block Identity
  165. *
  166. * @param string $blockId
  167. * @return bool
  168. * @throws CouldNotDeleteException
  169. * @throws NoSuchEntityException
  170. */
  171. public function deleteById($blockId)
  172. {
  173. return $this->delete($this->getById($blockId));
  174. }
  175. /**
  176. * Retrieve collection processor
  177. *
  178. * @deprecated 102.0.0
  179. * @return CollectionProcessorInterface
  180. */
  181. private function getCollectionProcessor()
  182. {
  183. if (!$this->collectionProcessor) {
  184. $this->collectionProcessor = \Magento\Framework\App\ObjectManager::getInstance()->get(
  185. 'Magento\Cms\Model\Api\SearchCriteria\BlockCollectionProcessor'
  186. );
  187. }
  188. return $this->collectionProcessor;
  189. }
  190. }