class MenuRouterRebuildSubscriber
Same name in other branches
- 9 core/lib/Drupal/Core/EventSubscriber/MenuRouterRebuildSubscriber.php \Drupal\Core\EventSubscriber\MenuRouterRebuildSubscriber
- 8.9.x core/lib/Drupal/Core/EventSubscriber/MenuRouterRebuildSubscriber.php \Drupal\Core\EventSubscriber\MenuRouterRebuildSubscriber
- 10 core/lib/Drupal/Core/EventSubscriber/MenuRouterRebuildSubscriber.php \Drupal\Core\EventSubscriber\MenuRouterRebuildSubscriber
Rebuilds the default menu links and runs menu-specific code if necessary.
Hierarchy
- class \Drupal\Core\EventSubscriber\MenuRouterRebuildSubscriber implements \Symfony\Component\EventDispatcher\EventSubscriberInterface
Expanded class hierarchy of MenuRouterRebuildSubscriber
File
-
core/
lib/ Drupal/ Core/ EventSubscriber/ MenuRouterRebuildSubscriber.php, line 18
Namespace
Drupal\Core\EventSubscriberView source
class MenuRouterRebuildSubscriber implements EventSubscriberInterface {
/**
* Constructs the MenuRouterRebuildSubscriber object.
*
* @param \Drupal\Core\Lock\LockBackendInterface $lock
* The lock backend.
* @param \Drupal\Core\Menu\MenuLinkManagerInterface $menuLinkManager
* The menu link plugin manager.
* @param \Drupal\Core\Database\Connection $connection
* The database connection.
* @param \Drupal\Core\Database\ReplicaKillSwitch $replicaKillSwitch
* The replica kill switch.
* @param \Psr\Log\LoggerInterface $logger
* The logger.
*/
public function __construct(LockBackendInterface $lock, MenuLinkManagerInterface $menuLinkManager, Connection $connection, ReplicaKillSwitch $replicaKillSwitch, LoggerInterface $logger) {
}
/**
* Rebuilds the menu links and deletes the local_task cache tag.
*
* @param \Drupal\Component\EventDispatcher\Event $event
* The event object.
*/
public function onRouterRebuild($event) {
$this->menuLinksRebuild();
Cache::invalidateTags([
'local_task',
]);
}
/**
* Perform menu-specific rebuilding.
*/
protected function menuLinksRebuild() {
if ($this->lock
->acquire(__FUNCTION__)) {
try {
$transaction = $this->connection
->startTransaction();
// Ensure the menu links are up to date.
$this->menuLinkManager
->rebuild();
// Ignore any database replicas temporarily.
$this->replicaKillSwitch
->trigger();
} catch (\Exception $e) {
if (isset($transaction)) {
$transaction->rollBack();
}
Error::logException($this->logger, $e);
}
$this->lock
->release(__FUNCTION__);
}
else {
// Wait for another request that is already doing this work.
// We choose to block here since otherwise the router item may not
// be available during routing resulting in a 404.
$this->lock
->wait(__FUNCTION__);
}
}
/**
* {@inheritdoc}
*/
public static function getSubscribedEvents() : array {
// Run after CachedRouteRebuildSubscriber.
$events[RoutingEvents::FINISHED][] = [
'onRouterRebuild',
100,
];
return $events;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary |
---|---|---|---|
MenuRouterRebuildSubscriber::getSubscribedEvents | public static | function | |
MenuRouterRebuildSubscriber::menuLinksRebuild | protected | function | Perform menu-specific rebuilding. |
MenuRouterRebuildSubscriber::onRouterRebuild | public | function | Rebuilds the menu links and deletes the local_task cache tag. |
MenuRouterRebuildSubscriber::__construct | public | function | Constructs the MenuRouterRebuildSubscriber object. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.