如何更改另一个模块定义的路由?


14

换句话说,hook_menu_alter()的Drupl 8等效项是什么?

Drupal 8仍然使用hook_menu(),但是对于我所看到的,该钩子返回的信息与Drupal 7中返回的钩子不同。例如,user_menu()中为user 提供的定义如下。

  $items['user'] = array(
    'title' => 'User account',
    'title callback' => 'user_menu_title',
    'weight' => -10,
    'route_name' => 'user_page',
    'menu_name' => 'account',
  );

route_name属性链接到user.routing.yml文件中的条目。

user_page:
  pattern: '/user'
  defaults:
    _content: '\Drupal\user\Controller\UserController::userPage'
  requirements:
    _access: 'TRUE'

这与使用Symphony进行的操作不同,它使我困惑于模块如何更改另一个用户定义的路由。

仍在调用的唯一函数hook_menu_alter()menu_router_build(),但该函数仍包含需要更新的代码,因为它仍在使用现在不推荐使用的drupal_alter()

  // Alter the menu as defined in modules, keys are like user/%user.
  drupal_alter('menu', $callbacks);
  foreach ($callbacks as $path => $router_item) {
    // If the menu item is a default local task and incorrectly references a
    // route, remove it.
    // @todo This may be removed later depending on the outcome of
    // http://drupal.org/node/1889790
    if (isset($router_item['type']) && $router_item['type'] == MENU_DEFAULT_LOCAL_TASK) {
      unset($callbacks[$path]['route_name']);
    }
    // If the menu item references a route, normalize the route information
    // into the old structure. Note that routes are keyed by name, not path,
    // so the path of the route takes precedence.
    if (isset($router_item['route_name'])) {
      $router_item['page callback'] = 'USES_ROUTE';
      $router_item['access callback'] = TRUE;
      $new_path = _menu_router_translate_route($router_item['route_name']);

      unset($callbacks[$path]);
      $callbacks[$new_path] = $router_item;
    }
  }

Answers:


6

请参阅更改现有路线并根据动态路线添加新路线;对于我来说,删除由搜索模块处理的/ search效果很好。就我而言,我使用了以下代码。

<?php
/**
 * @file
 * Contains \Drupal\ua_sc_module\Routing\SearchAlterRouteSubscriber.
 */

namespace Drupal\ua_sc_module\Routing;

use Drupal\Core\Routing\RouteSubscriberBase;
use Symfony\Component\Routing\RouteCollection;

/**
 * Listens to the dynamic route events.
 */
class SearchAlterRouteSubscriber extends RouteSubscriberBase {

  /**
   * {@inheritdoc}
   */
  public function alterRoutes(RouteCollection $collection) {
    // Remove the /search route.
    $collection->remove('search.view');
  }

}

12

允许视图覆盖现有工艺路线项目仅使用现有功能。

如果要更改附加到路线的信息,而不是菜单(如实际使用的控制器)或要求(权限/角色等),可以使用Drupal提供的事件:

  <?php

  use Drupal\Core\Routing\RouteBuildEvent;
  use Drupal\Core\Routing\RoutingEvents;
  use Symfony\Component\EventDispatcher\EventSubscriberInterface;

  class RouteSubscriber implements EventSubscriberInterface {

   /**
    * {@inheritdoc}
    */
   public static function getSubscribedEvents() {
      $events[RoutingEvents::ALTER] = 'alterRoutes';
     return $events;
   }

  /**
   * Alters existing routes.
   *
   * @param \Drupal\Core\Routing\RouteBuildEvent $event
   *   The route building event.
   */
  public function alterRoutes(RouteBuildEvent $event) {
    // Fetch the collection which can be altered.
    $collection = $event->getRouteCollection();
    // The event is fired multiple times so ensure that the user_page route
    // is available.
    if ($route = $collection->get('user_page')) {
      // As example add a new requirement.
      $route->setRequirement('_role', 'anonymous');
    }
  }

  }

另外,您必须为此类注册带有标签“ event_subscriber”的服务。


在“ 更改现有路由并基于动态路由添加新路由”中有设置服务注册的详细信息。
科兰

7

自从我问了这个问题以来,Drupal 8的核心发生了变化,并且一些有关路由的问题已得到解决。

hook_menu()从Drupal 8中不再使用;模块使用的路由在.routing.yml文件中定义(例如user.routing.yml)。仍然使用Alter钩子,但由于hook_menu()Drupal核心hook_menu_alter()已不再使用Alter钩子,因此均未使用。

更改从其他模块定义的路由的必要步骤如下:

  • 定义服务

    services:
      mymodule.route_subscriber:
        class: Drupal\mymodule\Routing\RouteSubscriber
        tags:
          - { name: event_subscriber }
  • 创建一个扩展RouteSubscriberBase该类的类。

    namespace Drupal\mymodule\Routing;
    
    use Drupal\Core\Routing\RouteSubscriberBase;
    use Symfony\Component\Routing\RouteCollection;
    
    /**
     * Listens to the dynamic route events.
     */
    class RouteSubscriber extends RouteSubscriberBase {
    
      /**
       * {@inheritdoc}
       */
      protected function alterRoutes(RouteCollection $collection) {
        // Change the route associated with the user profile page (/user, /user/{uid}).
        if ($route = $collection->get('user.page')) {
          $route->setDefault('_controller', '\Drupal\mymodule\Controller\UserController::userPage');
        }
      }
    
    }

请注意,与早期的Drupal 8发行版相比,某些细节有所更改。

  • 路线名称从更改user_pageuser.page
  • 该路线的要求已从更改_access: 'TRUE'_user_is_logged_in: 'TRUE'
  • 设置路由控制器的属性已从更改_content_controller

如果要匹配多个路由,是否有比将$ matched变量设置为false然后用一次遍历所有路由更优雅的方法$collection->get()?我看不到任何明显的方法。
威廉·特雷尔

@WilliamTurrell您可以ArrayIterator使用RouteCollection::getIterator(); 获取对象;这样可以更轻松地迭代中的所有项目$collection。您也可以在所有的路线$collectionRouteCollection::all(),它返回一个数组。
kiamlaluno
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.