Jak zmienić trasę zdefiniowaną przez inny moduł?

14

Innymi słowy, jaki jest odpowiednik Drupl 8 funkcji hook_menu_alter () ?

Drupal 8 nadal używa hook_menu () , ale dla tego, co widzę, informacje zwracane przez hook są inne niż te, które zwracają w Drupal 7. Na przykład definicja podana w user_menu () dla użytkownika jest następująca.

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

Właściwość route_name prowadzi do pozycji w pliku user.routing.yml .

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

Różni się to od tego, co zrobiono z Symphony, i dezorientuje mnie, jak moduł może zmienić trasę zdefiniowaną przez innego użytkownika.

Jedyną funkcją, która wciąż się wywołuje,hook_menu_alter() jest menu_router_build () , ale ta funkcja nadal zawiera kod, który należy zaktualizować, ponieważ nadal używa on przestarzałego 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;
    }
  }
kiamlaluno
źródło

Odpowiedzi:

6

Zobacz Zmiana istniejących tras i dodawanie nowych tras na podstawie dynamicznych ; ładnie działało dla mnie usuwanie / wyszukiwanie obsługiwane przez moduł wyszukiwania. W moim przypadku użyłem następującego kodu.

<?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');
  }

}
tzm
źródło
12

Zezwalaj widokom na zastępowanie istniejących elementów routingu, po prostu korzysta z istniejących funkcji.

Jeśli chcesz zmienić informacje dołączone do trasy, a nie menu, takie jak aktualnie używany kontroler lub wymagania (uprawnienia / rola itp.), Możesz użyć zdarzenia dostarczonego przez 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');
    }
  }

  }

Dodatkowo musisz zarejestrować usługę z tagiem „event_subscriber” dla tej klasy.

Daniel Wehner
źródło
Szczegółowe informacje na temat konfigurowania rejestracji usługi można znaleźć w części Zmiana istniejących tras i dodawanie nowych tras na podstawie dynamicznych .
colan
7

Ponieważ zadałem to pytanie, rdzeń Drupala 8 zmienił się, a niektóre problemy dotyczące tras zostały naprawione.

hook_menu()nie jest już używany z Drupala 8; trasy używane przez moduł są zdefiniowane w pliku .routing.yml (np. user.routing.yml ). Haczyki Alter są nadal używane, ale ponieważ hook_menu()nie są już używane z rdzenia Drupala, hook_menu_alter()nie są używane.

Kroki niezbędne do zmiany trasy zdefiniowanej w innych modułach są następujące:

  • Zdefiniuj usługę

    services:
      mymodule.route_subscriber:
        class: Drupal\mymodule\Routing\RouteSubscriber
        tags:
          - { name: event_subscriber }
  • Utwórz klasę, która ją rozszerza 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');
        }
      }
    
    }

Zauważ, że w porównaniu z wcześniejszymi wersjami Drupala 8 niektóre szczegóły zostały zmienione.

  • Nazwa trasy została zmieniona z user_pagenauser.page
  • Wymagania dla tej trasy zmieniły się z _access: 'TRUE'na_user_is_logged_in: 'TRUE'
  • Właściwość do ustawienia kontrolera trasy zmieniona z _contentna_controller
kiamlaluno
źródło
Jeśli chcesz dopasować wiele tras, czy istnieje bardziej elegancki sposób niż ustawienie zmiennej $ dopasowanej na wartość false, a następnie iterowanie po nich wszystkich jednocześnie $collection->get()? Nie widzę żadnych oczywistych metod.
William Turrell,
@WilliamTurrell Możesz uzyskać ArrayIteratorobiekt za pomocą RouteCollection::getIterator(); ułatwiłoby to iterację wszystkich elementów w $collection. Możesz także pobrać wszystkie trasy za $collectionpomocą RouteCollection::all(), co zwraca tablicę.
kiamlaluno