add Civi::router facade over CRM_Core_Menu

CRM/Admin/Form/Setting.php

@@ -116,7 +116,7 @@ public function rebuildMenu() {
     $config = CRM_Core_Config::singleton(TRUE, TRUE);
 
     // rebuild menu items
-    CRM_Core_Menu::store();
+    \Civi::router()->rebuild();;
   }
 
 }

CRM/Core/Invoke.php

@@ -141,7 +141,7 @@ public static function getItem($args) {
     else {
       $path = $args;
     }
-    $item = CRM_Core_Menu::get($path);
+    $item = \Civi::router()->get($path);
 
     return $item;
   }
@@ -242,7 +242,7 @@ public static function runItem($item) {
       return $result;
     }
 
-    CRM_Core_Menu::store();
+    \Civi::router()->rebuild();;
     CRM_Core_Session::setStatus(ts('Menu has been rebuilt'), ts('Complete'), 'success');
     return CRM_Utils_System::redirect();
   }

CRM/Core/Menu.php

@@ -332,6 +332,9 @@ public static function isPublicRoute(string $path): bool {
     return FALSE;
   }
 
+  /**
+   * @internal
+   */
   public static function clear() {
     // Take the rebuild lock: TRUNCATE is a writer too, and clearing the table out from under an
     // in-flight self::store() would leave it holding only the rows that store() inserts after the
@@ -360,6 +363,7 @@ private static function clearMenu() {
 
   /**
    * This function recomputes menu from xml and populates civicrm_menu.
+   * @internal
    */
   public static function store() {
     // Take the rebuild lock: without it, concurrent rebuilds collide on the (path, domain_id)
@@ -622,6 +626,7 @@ public static function fillComponentIds(&$menu, $path) {
   }
 
   /**
+   * @internal
    * @param string $path
    *   Path of menu item to retrieve.
    *

CRM/Utils/GuzzleMiddleware.php

@@ -186,7 +186,7 @@ protected static function filterUri(\Psr\Http\Message\UriInterface $oldUri) {
     }
 
     if ($scheme === 'route') {
-      $menu = CRM_Core_Menu::get($hostPath);
+      $menu = \Civi::router()->get($hostPath);
       $scheme = ($menu && !empty($menu['is_public'])) ? 'frontend' : 'backend';
     }
 

CRM/Utils/System/DrupalBase.php

@@ -707,7 +707,7 @@ public function isFrontEndPage() {
     $path = CRM_Utils_System::currentPath() ?? '';
 
     // Get the menu for above URL.
-    $item = CRM_Core_Menu::get($path);
+    $item = \Civi::router()->get($path);
     // In case the URL is not a civicrm page (a drupal page) we set the FE theme to TRUE - covering the corner case
     return (empty($item) || !empty($item['is_public']));
   }

Civi.php

@@ -259,6 +259,13 @@ public static function resources() {
     return CRM_Core_Resources::singleton();
   }
 
+  /**
+   * @return Civi\Core\Router
+   */
+  public static function router() {
+    return \Civi::service('civi.router');
+  }
+
   /**
    * Obtain the contact's personal settings.
    *

Civi/Core/Rebuilder.php

@@ -22,7 +22,6 @@
 use CRM_Core_DAO;
 use CRM_Core_DAO_AllCoreTables;
 use CRM_Core_ManagedEntities;
-use CRM_Core_Menu;
 use CRM_Core_OptionGroup;
 use CRM_Core_Resources;
 use CRM_Core_Session;
@@ -184,7 +183,7 @@ public function execute(): void {
       $session->reset(2);
     }
     if (!empty($targets['router'])) {
-      CRM_Core_Menu::store();
+      \Civi::router()->rebuild();;
     }
     if (!empty($targets['navigation'])) {
       Civi::cache('navigation')->flush();

Civi/Core/Router.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Civi\Core;
+
+use Civi\Core\Service\AutoService;
+
+/**
+ * @service civi.router
+ */
+class Router extends AutoService {
+
+  /**
+   * Clear the routing table.
+   *
+   * It will be rebuilt on next access
+   */
+  public function clear(): void {
+    \CRM_Core_Menu::clear();
+  }
+
+  /**
+   * Rebuild the routing table.
+   *
+   * This is costly so please consider using `clear` instead
+   */
+  public function rebuild(): void {
+    \CRM_Core_Menu::store();
+  }
+
+  /**
+   * Get route for a path from the routing table.
+   *
+   * @param string $path e.g. civicrm/mailing/subscribe
+   *
+   * @return ?array best matching route, or NULL
+   */
+  public function get(string $path): ?array {
+    return \CRM_Core_Menu::get($path);
+  }
+
+}

ext/afform/core/Civi/Api4/Action/Afform/Revert.php

@@ -37,7 +37,7 @@ protected function processBatch(Result $result, array $items) {
       \CRM_Core_ManagedEntities::singleton()->reconcile(E::LONG_NAME);
     }
     if ($this->flushMenu) {
-      \CRM_Core_Menu::clear();
+      \Civi::router()->clear();;
     }
   }
 

ext/afform/core/Civi/Api4/Utils/AfformSaveTrait.php

@@ -73,7 +73,7 @@ protected function writeRecord($item) {
     }
 
     if (Utils::shouldClearMenuCache($item, $orig ?? [])) {
-      \CRM_Core_Menu::clear();
+      \Civi::router()->clear();;
     }
 
     $item['module_name'] = _afform_angular_module_name($item['name'], 'camel');

ext/afform/core/afform.php

@@ -459,7 +459,7 @@ function afform_civicrm_post($op, $entityName, $id, $object, $params) {
       // Adding a new custom field to an empty field group may auto-generate afforms with menu routes.
       // @see Civi\Api4\Action\CustomGroup\GetAfforms::getCustomGroupAfforms
       if ($op === 'create' && $entityName === 'CustomField') {
-        \CRM_Core_Menu::clear();
+        \Civi::router()->clear();;
       }
     }
   }

ext/civi_contribute/Civi/Api4/Service/ContributionTasksProvider.php

@@ -34,7 +34,7 @@ public function addContributionTasks(GenericHookEvent $event): void {
     foreach (\CRM_Contribute_Task::tasks() as $id => $task) {
       if (!empty($task['url'])) {
         $path = explode('?', $task['url'], 2)[0];
-        $menu = \CRM_Core_Menu::get($path);
+        $menu = \Civi::router()->get($path);
         $key = $menu ? \CRM_Core_Key::get($menu['page_callback'], TRUE) : '';
 
         $event->tasks['Contribution']['contribution.' . $id] = [

ext/civi_member/Civi/Api4/Service/MembershipTasksProvider.php

@@ -33,7 +33,7 @@ public function addMembershipTasks(GenericHookEvent $event): void {
     foreach (\CRM_Member_Task::tasks() as $id => $task) {
       if (!empty($task['url'])) {
         $path = explode('?', $task['url'], 2)[0];
-        $menu = \CRM_Core_Menu::get($path);
+        $menu = \Civi::router()->get($path);
         $key = $menu ? \CRM_Core_Key::get($menu['page_callback'], TRUE) : '';
 
         $event->tasks['Membership']['membership.' . $id] = [

ext/oembed/Civi/Oembed/Oembed.php

@@ -20,7 +20,7 @@ public function create(string $path, array $query = [], array $options = []): ar
     $options = $this->normalizeOptions($options);
     $query = $this->findPropagatedParams($query);
 
-    $route = \CRM_Core_Menu::get($path);
+    $route = \Civi::router()->get($path);
     $result = [
       'type' => 'rich',
       'version' => '1.0',

ext/search_kit/Civi/Api4/Action/SearchDisplay/AbstractRunAction.php

@@ -780,7 +780,7 @@ private function getQfKey(string $pathExpr): ?string {
 
     $result = NULL;
     if ($routeName = parse_url($pathExpr, PHP_URL_PATH)) {
-      if ($routeItem = \CRM_Core_Menu::get($routeName)) {
+      if ($routeItem = \Civi::router()->get($routeName)) {
         if (!empty($routeItem['page_callback'])) {
           $result = \CRM_Core_Key::get($routeItem['page_callback']);
         }

tests/phpunit/CRM/Core/MenuTest.php

@@ -70,8 +70,8 @@ public function testReadXML_IDS(): void {
    * stored and loaded.
    */
   public function testModuleData(): void {
-    CRM_Core_Menu::clear();
-    $item = CRM_Core_Menu::get('civicrm/case');
+    \Civi::router()->clear();
+    $item = \Civi::router()->get('civicrm/case');
     $this->assertFalse(isset($item['ids_arguments']['exceptions']));
     $this->assertFalse(isset($item['whimsy']));
 
@@ -80,8 +80,8 @@ public function testModuleData(): void {
       $items['civicrm/case']['whimsy'] = 'godliness';
     });
 
-    CRM_Core_Menu::clear();
-    $item = CRM_Core_Menu::get('civicrm/case');
+    \Civi::router()->clear();
+    $item = \Civi::router()->get('civicrm/case');
     $this->assertTrue(in_array('foobar', $item['ids_arguments']['exceptions']));
     $this->assertEquals('godliness', $item['whimsy']);
   }