class MenuRouterRebuildSubscriber
Same name in other branches
- 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
- 11.x 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
1 string reference to 'MenuRouterRebuildSubscriber'
- core.services.yml in core/
core.services.yml - core/core.services.yml
1 service uses MenuRouterRebuildSubscriber
File
-
core/
lib/ Drupal/ Core/ EventSubscriber/ MenuRouterRebuildSubscriber.php, line 16
Namespace
Drupal\Core\EventSubscriberView source
class MenuRouterRebuildSubscriber implements EventSubscriberInterface {
/**
* @var \Drupal\Core\Lock\LockBackendInterface
*/
protected $lock;
/**
* The menu link plugin manager.
*
* @var \Drupal\Core\Menu\MenuLinkManagerInterface
*/
protected $menuLinkManager;
/**
* The replica kill switch.
*
* @var \Drupal\Core\Database\ReplicaKillSwitch
*/
protected $replicaKillSwitch;
/**
* The database connection.
*
* @var \Drupal\Core\Database\Connection
*/
protected $connection;
/**
* Constructs the MenuRouterRebuildSubscriber object.
*
* @param \Drupal\Core\Lock\LockBackendInterface $lock
* The lock backend.
* @param \Drupal\Core\Menu\MenuLinkManagerInterface $menu_link_manager
* The menu link plugin manager.
* @param \Drupal\Core\Database\Connection $connection
* The database connection.
* @param \Drupal\Core\Database\ReplicaKillSwitch $replica_kill_switch
* The replica kill switch.
*/
public function __construct(LockBackendInterface $lock, MenuLinkManagerInterface $menu_link_manager, Connection $connection, ReplicaKillSwitch $replica_kill_switch) {
$this->lock = $lock;
$this->menuLinkManager = $menu_link_manager;
$this->connection = $connection;
$this->replicaKillSwitch = $replica_kill_switch;
}
/**
* 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();
}
watchdog_exception('menu', $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() {
// Run after CachedRouteRebuildSubscriber.
$events[RoutingEvents::FINISHED][] = [
'onRouterRebuild',
100,
];
return $events;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary |
---|---|---|---|
MenuRouterRebuildSubscriber::$connection | protected | property | The database connection. |
MenuRouterRebuildSubscriber::$lock | protected | property | |
MenuRouterRebuildSubscriber::$menuLinkManager | protected | property | The menu link plugin manager. |
MenuRouterRebuildSubscriber::$replicaKillSwitch | protected | property | The replica kill switch. |
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.