Block.php 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141
  1. <?php
  2. /**
  3. * Copyright © Magento, Inc. All rights reserved.
  4. * See COPYING.txt for license details.
  5. */
  6. declare(strict_types=1);
  7. namespace Magento\Cms\Block\Widget;
  8. use Magento\Framework\DataObject\IdentityInterface;
  9. use Magento\Framework\Exception\NoSuchEntityException;
  10. use Magento\Cms\Model\Block as CmsBlock;
  11. use Magento\Widget\Block\BlockInterface;
  12. /**
  13. * Cms Static Block Widget
  14. *
  15. * @author Magento Core Team <core@magentocommerce.com>
  16. */
  17. class Block extends \Magento\Framework\View\Element\Template implements BlockInterface, IdentityInterface
  18. {
  19. /**
  20. * @var \Magento\Cms\Model\Template\FilterProvider
  21. */
  22. protected $_filterProvider;
  23. /**
  24. * Storage for used widgets
  25. *
  26. * @var array
  27. */
  28. protected static $_widgetUsageMap = [];
  29. /**
  30. * Block factory
  31. *
  32. * @var \Magento\Cms\Model\BlockFactory
  33. */
  34. protected $_blockFactory;
  35. /**
  36. * @var CmsBlock
  37. */
  38. private $block;
  39. /**
  40. * @param \Magento\Framework\View\Element\Template\Context $context
  41. * @param \Magento\Cms\Model\Template\FilterProvider $filterProvider
  42. * @param \Magento\Cms\Model\BlockFactory $blockFactory
  43. * @param array $data
  44. */
  45. public function __construct(
  46. \Magento\Framework\View\Element\Template\Context $context,
  47. \Magento\Cms\Model\Template\FilterProvider $filterProvider,
  48. \Magento\Cms\Model\BlockFactory $blockFactory,
  49. array $data = []
  50. ) {
  51. parent::__construct($context, $data);
  52. $this->_filterProvider = $filterProvider;
  53. $this->_blockFactory = $blockFactory;
  54. }
  55. /**
  56. * Prepare block text and determine whether block output enabled or not.
  57. *
  58. * Prevent blocks recursion if needed.
  59. *
  60. * @return $this
  61. */
  62. protected function _beforeToHtml()
  63. {
  64. parent::_beforeToHtml();
  65. $blockId = $this->getData('block_id');
  66. $blockHash = get_class($this) . $blockId;
  67. if (isset(self::$_widgetUsageMap[$blockHash])) {
  68. return $this;
  69. }
  70. self::$_widgetUsageMap[$blockHash] = true;
  71. $block = $this->getBlock();
  72. if ($block && $block->isActive()) {
  73. try {
  74. $storeId = $this->getData('store_id') ?? $this->_storeManager->getStore()->getId();
  75. $this->setText(
  76. $this->_filterProvider->getBlockFilter()->setStoreId($storeId)->filter($block->getContent())
  77. );
  78. } catch (NoSuchEntityException $e) {
  79. }
  80. }
  81. unset(self::$_widgetUsageMap[$blockHash]);
  82. return $this;
  83. }
  84. /**
  85. * Get identities of the Cms Block
  86. *
  87. * @return array
  88. */
  89. public function getIdentities()
  90. {
  91. $block = $this->getBlock();
  92. if ($block) {
  93. return $block->getIdentities();
  94. }
  95. return [];
  96. }
  97. /**
  98. * Get block
  99. *
  100. * @return CmsBlock|null
  101. */
  102. private function getBlock(): ?CmsBlock
  103. {
  104. if ($this->block) {
  105. return $this->block;
  106. }
  107. $blockId = $this->getData('block_id');
  108. if ($blockId) {
  109. try {
  110. $storeId = $this->_storeManager->getStore()->getId();
  111. /** @var \Magento\Cms\Model\Block $block */
  112. $block = $this->_blockFactory->create();
  113. $block->setStoreId($storeId)->load($blockId);
  114. $this->block = $block;
  115. return $block;
  116. } catch (NoSuchEntityException $e) {
  117. }
  118. }
  119. return null;
  120. }
  121. }