annotate core/lib/Drupal/Core/EventSubscriber/MenuRouterRebuildSubscriber.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents af1871eacc83
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\Core\EventSubscriber;
Chris@0 4
Chris@0 5 use Drupal\Core\Cache\Cache;
Chris@18 6 use Drupal\Core\Database\ReplicaKillSwitch;
Chris@0 7 use Drupal\Core\Lock\LockBackendInterface;
Chris@0 8 use Drupal\Core\Menu\MenuLinkManagerInterface;
Chris@0 9 use Drupal\Core\Routing\RoutingEvents;
Chris@0 10 use Symfony\Component\EventDispatcher\Event;
Chris@18 11 use Drupal\Core\Database\Connection;
Chris@0 12 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
Chris@0 13
Chris@0 14 /**
Chris@0 15 * Rebuilds the default menu links and runs menu-specific code if necessary.
Chris@0 16 */
Chris@0 17 class MenuRouterRebuildSubscriber implements EventSubscriberInterface {
Chris@0 18
Chris@0 19 /**
Chris@0 20 * @var \Drupal\Core\Lock\LockBackendInterface
Chris@0 21 */
Chris@0 22 protected $lock;
Chris@0 23
Chris@0 24 /**
Chris@0 25 * The menu link plugin manager.
Chris@0 26 *
Chris@0 27 * @var \Drupal\Core\Menu\MenuLinkManagerInterface
Chris@0 28 */
Chris@0 29 protected $menuLinkManager;
Chris@0 30
Chris@0 31 /**
Chris@18 32 * The replica kill switch.
Chris@18 33 *
Chris@18 34 * @var \Drupal\Core\Database\ReplicaKillSwitch
Chris@18 35 */
Chris@18 36 protected $replicaKillSwitch;
Chris@18 37
Chris@18 38 /**
Chris@18 39 * The database connection.
Chris@18 40 *
Chris@18 41 * @var \Drupal\Core\Database\Connection
Chris@18 42 */
Chris@18 43 protected $connection;
Chris@18 44
Chris@18 45 /**
Chris@0 46 * Constructs the MenuRouterRebuildSubscriber object.
Chris@0 47 *
Chris@0 48 * @param \Drupal\Core\Lock\LockBackendInterface $lock
Chris@0 49 * The lock backend.
Chris@0 50 * @param \Drupal\Core\Menu\MenuLinkManagerInterface $menu_link_manager
Chris@0 51 * The menu link plugin manager.
Chris@18 52 * @param \Drupal\Core\Database\Connection $connection
Chris@18 53 * The database connection.
Chris@18 54 * @param \Drupal\Core\Database\ReplicaKillSwitch $replica_kill_switch
Chris@18 55 * The replica kill switch.
Chris@0 56 */
Chris@18 57 public function __construct(LockBackendInterface $lock, MenuLinkManagerInterface $menu_link_manager, Connection $connection, ReplicaKillSwitch $replica_kill_switch) {
Chris@0 58 $this->lock = $lock;
Chris@0 59 $this->menuLinkManager = $menu_link_manager;
Chris@18 60 $this->connection = $connection;
Chris@18 61 $this->replicaKillSwitch = $replica_kill_switch;
Chris@0 62 }
Chris@0 63
Chris@0 64 /**
Chris@0 65 * Rebuilds the menu links and deletes the local_task cache tag.
Chris@0 66 *
Chris@0 67 * @param \Symfony\Component\EventDispatcher\Event $event
Chris@0 68 * The event object.
Chris@0 69 */
Chris@0 70 public function onRouterRebuild(Event $event) {
Chris@0 71 $this->menuLinksRebuild();
Chris@0 72 Cache::invalidateTags(['local_task']);
Chris@0 73 }
Chris@0 74
Chris@0 75 /**
Chris@0 76 * Perform menu-specific rebuilding.
Chris@0 77 */
Chris@0 78 protected function menuLinksRebuild() {
Chris@0 79 if ($this->lock->acquire(__FUNCTION__)) {
Chris@18 80 $transaction = $this->connection->startTransaction();
Chris@0 81 try {
Chris@0 82 // Ensure the menu links are up to date.
Chris@0 83 $this->menuLinkManager->rebuild();
Chris@0 84 // Ignore any database replicas temporarily.
Chris@18 85 $this->replicaKillSwitch->trigger();
Chris@0 86 }
Chris@0 87 catch (\Exception $e) {
Chris@0 88 $transaction->rollBack();
Chris@0 89 watchdog_exception('menu', $e);
Chris@0 90 }
Chris@0 91
Chris@0 92 $this->lock->release(__FUNCTION__);
Chris@0 93 }
Chris@0 94 else {
Chris@0 95 // Wait for another request that is already doing this work.
Chris@0 96 // We choose to block here since otherwise the router item may not
Chris@0 97 // be available during routing resulting in a 404.
Chris@0 98 $this->lock->wait(__FUNCTION__);
Chris@0 99 }
Chris@0 100 }
Chris@0 101
Chris@0 102 /**
Chris@0 103 * {@inheritdoc}
Chris@0 104 */
Chris@0 105 public static function getSubscribedEvents() {
Chris@0 106 // Run after CachedRouteRebuildSubscriber.
Chris@0 107 $events[RoutingEvents::FINISHED][] = ['onRouterRebuild', 100];
Chris@0 108 return $events;
Chris@0 109 }
Chris@0 110
Chris@0 111 }