class SetInlineBlockDependency
Same name in other branches
- 9 core/modules/layout_builder/src/EventSubscriber/SetInlineBlockDependency.php \Drupal\layout_builder\EventSubscriber\SetInlineBlockDependency
- 8.9.x core/modules/layout_builder/src/EventSubscriber/SetInlineBlockDependency.php \Drupal\layout_builder\EventSubscriber\SetInlineBlockDependency
- 11.x core/modules/layout_builder/src/EventSubscriber/SetInlineBlockDependency.php \Drupal\layout_builder\EventSubscriber\SetInlineBlockDependency
An event subscriber that returns an access dependency for inline blocks.
When used within the layout builder the access dependency for inline blocks will be explicitly set but if access is evaluated outside of the layout builder then the dependency may not have been set.
A known example of when the access dependency will not have been set is when determining 'view' or 'download' access to a file entity that is attached to a content block via a field that is using the private file system. The file access handler will evaluate access on the content block without setting the dependency.
@internal Tagged services are internal.
Hierarchy
- class \Drupal\layout_builder\EventSubscriber\SetInlineBlockDependency implements \Symfony\Component\EventDispatcher\EventSubscriberInterface uses \Drupal\layout_builder\LayoutEntityHelperTrait
Expanded class hierarchy of SetInlineBlockDependency
See also
\Drupal\file\FileAccessControlHandler::checkAccess()
\Drupal\block_content\BlockContentAccessControlHandler::checkAccess()
1 file declares its use of SetInlineBlockDependency
- LayoutBuilderServiceProvider.php in core/
modules/ layout_builder/ src/ LayoutBuilderServiceProvider.php
File
-
core/
modules/ layout_builder/ src/ EventSubscriber/ SetInlineBlockDependency.php, line 35
Namespace
Drupal\layout_builder\EventSubscriberView source
class SetInlineBlockDependency implements EventSubscriberInterface {
use LayoutEntityHelperTrait;
/**
* The entity type manager.
*
* @var \Drupal\Core\Entity\EntityTypeManagerInterface
*/
protected $entityTypeManager;
/**
* The database connection.
*
* @var \Drupal\Core\Database\Connection
*/
protected $database;
/**
* The inline block usage service.
*
* @var \Drupal\layout_builder\InlineBlockUsageInterface
*/
protected $usage;
/**
* Constructs SetInlineBlockDependency object.
*
* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
* The entity type manager.
* @param \Drupal\Core\Database\Connection $database
* The database connection.
* @param \Drupal\layout_builder\InlineBlockUsageInterface $usage
* The inline block usage service.
* @param \Drupal\layout_builder\SectionStorage\SectionStorageManagerInterface $section_storage_manager
* The section storage manager.
*/
public function __construct(EntityTypeManagerInterface $entity_type_manager, Connection $database, InlineBlockUsageInterface $usage, SectionStorageManagerInterface $section_storage_manager) {
$this->entityTypeManager = $entity_type_manager;
$this->database = $database;
$this->usage = $usage;
$this->sectionStorageManager = $section_storage_manager;
}
/**
* {@inheritdoc}
*/
public static function getSubscribedEvents() : array {
return [
BlockContentEvents::BLOCK_CONTENT_GET_DEPENDENCY => 'onGetDependency',
];
}
/**
* Handles the BlockContentEvents::INLINE_BLOCK_GET_DEPENDENCY event.
*
* @param \Drupal\block_content\Event\BlockContentGetDependencyEvent $event
* The event.
*/
public function onGetDependency(BlockContentGetDependencyEvent $event) {
if ($dependency = $this->getInlineBlockDependency($event->getBlockContentEntity())) {
$event->setAccessDependency($dependency);
}
}
/**
* Get the access dependency of an inline block.
*
* If the block is used in an entity that entity will be returned as the
* dependency.
*
* For revisionable entities the entity will only be returned if it is used in
* the latest revision of the entity. For inline blocks that are not used in
* the latest revision but are used in a previous revision the entity will not
* be returned because calling
* \Drupal\Core\Access\AccessibleInterface::access() will only check access on
* the latest revision. Therefore if the previous revision of the entity was
* returned as the dependency access would be granted to inline block
* regardless of whether the user has access to the revision in which the
* inline block was used.
*
* @param \Drupal\block_content\BlockContentInterface $block_content
* The block content entity.
*
* @return \Drupal\Core\Entity\EntityInterface|null
* Returns the layout dependency.
*
* @see \Drupal\block_content\BlockContentAccessControlHandler::checkAccess()
* @see \Drupal\layout_builder\EventSubscriber\BlockComponentRenderArray::onBuildRender()
*/
protected function getInlineBlockDependency(BlockContentInterface $block_content) {
$layout_entity_info = $this->usage
->getUsage($block_content->id());
if (empty($layout_entity_info)) {
// If the block does not have usage information then we cannot set a
// dependency. It may be used by another module besides layout builder.
return NULL;
}
$layout_entity_storage = $this->entityTypeManager
->getStorage($layout_entity_info->layout_entity_type);
$layout_entity = $layout_entity_storage->load($layout_entity_info->layout_entity_id);
if ($this->isLayoutCompatibleEntity($layout_entity)) {
if ($this->isBlockRevisionUsedInEntity($layout_entity, $block_content)) {
return $layout_entity;
}
}
return NULL;
}
/**
* Determines if a block content revision is used in an entity.
*
* @param \Drupal\Core\Entity\EntityInterface $layout_entity
* The layout entity.
* @param \Drupal\block_content\BlockContentInterface $block_content
* The block content revision.
*
* @return bool
* TRUE if the block content revision is used as an inline block in the
* layout entity.
*/
protected function isBlockRevisionUsedInEntity(EntityInterface $layout_entity, BlockContentInterface $block_content) {
$sections_blocks_revision_ids = $this->getInlineBlockRevisionIdsInSections($this->getEntitySections($layout_entity));
return in_array($block_content->getRevisionId(), $sections_blocks_revision_ids);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
LayoutEntityHelperTrait::$sectionStorageManager | protected | property | The section storage manager. | 1 |
LayoutEntityHelperTrait::getEntitySections | protected | function | Gets the sections for an entity if any. | |
LayoutEntityHelperTrait::getInlineBlockComponents | protected | function | Gets components that have Inline Block plugins. | |
LayoutEntityHelperTrait::getInlineBlockRevisionIdsInSections | protected | function | Gets revision IDs for layout sections. | |
LayoutEntityHelperTrait::getSectionStorageForEntity | protected | function | Gets the section storage for an entity. | |
LayoutEntityHelperTrait::isLayoutCompatibleEntity | protected | function | Determines if an entity can have a layout. | |
LayoutEntityHelperTrait::originalEntityUsesDefaultStorage | protected | function | Determines if the original entity used the default section storage. | |
LayoutEntityHelperTrait::sectionStorageManager | private | function | Gets the section storage manager. | 1 |
SetInlineBlockDependency::$database | protected | property | The database connection. | |
SetInlineBlockDependency::$entityTypeManager | protected | property | The entity type manager. | |
SetInlineBlockDependency::$usage | protected | property | The inline block usage service. | |
SetInlineBlockDependency::getInlineBlockDependency | protected | function | Get the access dependency of an inline block. | |
SetInlineBlockDependency::getSubscribedEvents | public static | function | ||
SetInlineBlockDependency::isBlockRevisionUsedInEntity | protected | function | Determines if a block content revision is used in an entity. | |
SetInlineBlockDependency::onGetDependency | public | function | Handles the BlockContentEvents::INLINE_BLOCK_GET_DEPENDENCY event. | |
SetInlineBlockDependency::__construct | public | function | Constructs SetInlineBlockDependency object. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.