Como altero a rota definida por outro módulo?

14

Em outras palavras, qual é o equivalente do Drupl 8 de hook_menu_alter () ?

O Drupal 8 ainda usa hook_menu () , mas, pelo que posso ver, as informações retornadas pelo gancho são diferentes daquelas que o gancho retornou no Drupal 7. Por exemplo, a definição dada em user_menu () para user é a seguinte.

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

A propriedade route_name é vinculada a uma entrada no arquivo user.routing.yml .

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

Isso é diferente do que foi feito com o Symphony, e me confunde sobre como um módulo pode alterar a rota definida por outro usuário.

A única função que ainda está chamando hook_menu_alter()é menu_router_build () , mas essa função ainda contém código que precisa ser atualizado, pois ainda está usando o agora descontinuado 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
fonte

Respostas:

6

Consulte Alterando rotas existentes e adicionando novas rotas baseadas em rotas dinâmicas ; funcionou muito bem para mim remover / pesquisar manipulado pelo módulo Pesquisar. No meu caso, usei o seguinte código.

<?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
fonte
12

Permitir que as visualizações substituam os itens de roteamento existentes, apenas usa a funcionalidade existente.

Se você deseja alterar as informações anexadas a uma rota, não o menu, como o controlador usado real ou os requisitos (permissão / função etc.), você pode usar um evento fornecido pelo 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');
    }
  }

  }

Além disso, você deve registrar um serviço com a tag 'event_subscriber' para esta classe.

Daniel Wehner
fonte
Há detalhes para configurar o registro de serviço em Alterando rotas existentes e adicionando novas rotas baseadas em rotas dinâmicas .
colan
7

Desde que fiz essa pergunta, o núcleo do Drupal 8 mudou e alguns dos problemas sobre rotas foram corrigidos.

hook_menu()não é mais usado no Drupal 8; as rotas que um módulo usa são definidas em um arquivo .routing.yml (por exemplo, user.routing.yml ). Alter hooks ainda são usados, mas como hook_menu()não são mais usados ​​no núcleo do Drupal, hook_menu_alter()também não são usados.

As etapas necessárias para alterar uma rota definida de outros módulos são as seguintes:

  • Definir um serviço

    services:
      mymodule.route_subscriber:
        class: Drupal\mymodule\Routing\RouteSubscriber
        tags:
          - { name: event_subscriber }
  • Crie uma classe que estenda a 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');
        }
      }
    
    }

Observe que, em comparação com as versões anteriores do Drupal 8, alguns detalhes são alterados.

  • O nome da rota é alterado de user_pageparauser.page
  • Os requisitos para essa rota foram alterados de _access: 'TRUE'para_user_is_logged_in: 'TRUE'
  • A propriedade para definir o controlador de uma rota alterada de _contentpara_controller
kiamlaluno
fonte
Se você deseja combinar várias rotas, existe uma maneira mais elegante do que definir uma variável $ correspondida como false e iterar por todas elas uma de cada vez $collection->get()? Não vejo métodos óbvios.
William Turrell
@WilliamTurrell Você pode obter um ArrayIteratorobjeto com RouteCollection::getIterator(); isso tornaria mais fácil a iteração sobre todos os itens $collection. Você também pode obter todas as rotas $collectioncom RouteCollection::all(), o que retorna uma matriz.
Kiamlaluno