Comment modifier l'itinéraire défini par un autre module?

14

En d'autres termes, quel est l'équivalent Drupl 8 de hook_menu_alter () ?

Drupal 8 utilise toujours hook_menu () , mais pour ce que je peux voir, les informations renvoyées par le hook sont différentes de celles renvoyées par Drupal 7. Par exemple, la définition donnée dans user_menu () pour user est la suivante.

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

La propriété route_name est liée à une entrée du fichier user.routing.yml .

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

C'est différent de ce qui a été fait avec Symphony, et cela m'embrouille sur la façon dont un module peut modifier l'itinéraire défini par un autre utilisateur.

La seule fonction qui invoque toujours hook_menu_alter()est menu_router_build () , mais cette fonction contient toujours du code qui doit être mis à jour, car il utilise toujours le désormais obsolète 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
la source

Réponses:

6

Voir Modification des itinéraires existants et ajout de nouveaux itinéraires basés sur des itinéraires dynamiques ; cela a bien fonctionné pour moi de supprimer / rechercher géré par le module de recherche. Dans mon cas, j'ai utilisé le code suivant.

<?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
la source
12

Autoriser les vues à remplacer les éléments de routage existants utilise uniquement les fonctionnalités existantes.

Si vous souhaitez modifier les informations attachées à un itinéraire, pas le menu, comme le contrôleur réellement utilisé, ou les exigences (autorisation / rôle, etc.), vous pouvez utiliser un événement fourni par 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');
    }
  }

  }

De plus, vous devez enregistrer un service avec la balise 'event_subscriber' pour cette classe.

Daniel Wehner
la source
Il y a des détails pour configurer l'enregistrement du service dans Modifier les itinéraires existants et ajouter de nouveaux itinéraires basés sur les itinéraires dynamiques .
colan
7

Depuis que j'ai posé cette question, le noyau de Drupal 8 a changé et certains des problèmes concernant les itinéraires ont été corrigés.

hook_menu()n'est plus utilisé depuis Drupal 8; les itinéraires utilisés par un module sont définis dans un fichier .routing.yml (par exemple user.routing.yml ). Des crochets Alter sont toujours utilisés, mais comme ils hook_menu()ne sont plus utilisés depuis le noyau Drupal,hook_menu_alter() ne sont pas non plus utilisés.

Les étapes nécessaires pour modifier un itinéraire défini à partir d'autres modules sont les suivantes:

  • Définir un service

    services:
      mymodule.route_subscriber:
        class: Drupal\mymodule\Routing\RouteSubscriber
        tags:
          - { name: event_subscriber }
  • Créez une classe qui étend la RouteSubscriberBaseclasse.

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

Notez que par rapport aux versions précédentes de Drupal 8, certains détails ont été modifiés.

  • Le nom de l'itinéraire passe de user_pageàuser.page
  • Les exigences pour cet itinéraire sont passées de _access: 'TRUE'à_user_is_logged_in: 'TRUE'
  • La propriété permettant de définir le contrôleur d'un itinéraire est passée de _contentà_controller
kiamlaluno
la source
Si vous souhaitez faire correspondre plusieurs itinéraires, y a-t-il un moyen plus élégant que de définir une variable $ $ sur false, puis de les parcourir tous un à la fois avec $collection->get()? Je ne vois aucune méthode évidente.
William Turrell
@WilliamTurrell Vous pouvez obtenir un ArrayIteratorobjet avec RouteCollection::getIterator(); cela faciliterait l'itération de tous les éléments de $collection. Vous pouvez également obtenir toutes les routes $collectionavec RouteCollection::all(), ce qui renvoie un tableau.
kiamlaluno