別のモジュールで定義されたルートを変更するにはどうすればよいですか?


14

言い換えると、Drupl 8のhook_menu_alter()と同等のものは何ですか?

Drupal 8はまだhook_menu()を使用しますが、私が見ることができるように、フックによって返される情報は、Drupal 7で返されるフックとは異なります。たとえば、user_menu()でユーザーに指定される定義は次のとおりです。

  $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;
    }
  }

回答:


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()どちらも使用されません。

他のモジュールから定義されたルートを変更するために必要な手順は次のとおりです。

  • サービスを定義する

    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_pageに変更されますuser.page
  • そのルートの要件がから_access: 'TRUE'に変更されました_user_is_logged_in: 'TRUE'
  • ルートのコントローラーを設定するプロパティがから_contentに変更されました_controller

複数のルートを一致させたい場合、$ matched変数をfalseに設定し、それらを一度に1つずつ繰り返すよりもエレガントな方法があり$collection->get()ますか?明らかな方法はありません。
ウィリアムタレル

@WilliamTurrellでArrayIteratorオブジェクトを取得できますRouteCollection::getIterator()。これにより、のすべてのアイテムを簡単に反復処理でき$collectionます。あなたはまた、すべてのルート得ることができる$collectionとのRouteCollection::all()配列を返します。
kiamlaluno
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.