¿Cómo modifico la ruta definida por otro módulo?


14

En otras palabras, ¿cuál es el equivalente de Drupl 8 de hook_menu_alter () ?

Drupal 8 todavía usa hook_menu () , pero por lo que puedo ver, la información devuelta por el gancho es diferente de la que devolvió el gancho en Drupal 7. Por ejemplo, la definición dada en user_menu () para el usuario es la siguiente.

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

La propiedad route_name se vincula a una entrada en el archivo user.routing.yml .

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

Esto es diferente de lo que se hizo con Symphony, y me confunde acerca de cómo un módulo puede alterar la ruta definida por otro usuario.

La única función que todavía está invocando hook_menu_alter()es menu_router_build () , pero esa función aún contiene código que necesita ser actualizado, ya que todavía está usando el ahora obsoleto 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;
    }
  }

Respuestas:


6

Consulte Alterar rutas existentes y agregar nuevas rutas basadas en dinámicas ; funcionó muy bien para mí eliminar / buscar manejado por el módulo de búsqueda. En mi caso, utilicé el siguiente 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');
  }

}

12

Permitir que las vistas anulen los elementos de enrutamiento existentes solo usa la funcionalidad existente.

Si desea cambiar la información adjunta a una ruta, no el menú, como el controlador utilizado real o los requisitos (permiso / función, etc.), puede utilizar un evento proporcionado por 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');
    }
  }

  }

Además, debe registrar un servicio con la etiqueta 'event_subscriber' para esta clase.


Hay detalles para configurar el registro del servicio en Alterar rutas existentes y agregar nuevas rutas basadas en las dinámicas .
colan

7

Desde que hice esta pregunta, el núcleo de Drupal 8 cambió, y algunos de los problemas sobre las rutas se han solucionado.

hook_menu()ya no se usa desde Drupal 8; Las rutas que utiliza un módulo se definen en un archivo .routing.yml (por ejemplo, user.routing.yml ). Todavía se usan los ganchos de alteración, pero como ya hook_menu()no se usa desde el núcleo de Drupal, hook_menu_alter()tampoco se usa.

Los pasos necesarios para alterar una ruta definida desde otros módulos son los siguientes:

  • Definir un servicio.

    services:
      mymodule.route_subscriber:
        class: Drupal\mymodule\Routing\RouteSubscriber
        tags:
          - { name: event_subscriber }
  • Crea una clase que extienda la RouteSubscriberBaseclase.

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

Tenga en cuenta que, en comparación con las versiones anteriores de Drupal 8, se modifican algunos detalles.

  • El nombre de la ruta cambia de user_pageauser.page
  • Los requisitos para esa ruta cambiaron de _access: 'TRUE'a_user_is_logged_in: 'TRUE'
  • La propiedad para establecer el controlador de una ruta cambió de _contenta_controller

Si desea hacer coincidir múltiples rutas, ¿hay una manera más elegante que establecer una variable $ coincidente en falso, y luego iterar a través de todas ellas una a la vez con $collection->get()? No puedo ver ningún método obvio.
William Turrell

@WilliamTurrell Puede obtener un ArrayIteratorobjeto con RouteCollection::getIterator(); eso facilitaría la iteración sobre todos los elementos en $collection. También puede obtener todas las rutas $collectioncon RouteCollection::all(), que devuelve una matriz.
kiamlaluno
Al usar nuestro sitio, usted reconoce que ha leído y comprende nuestra Política de Cookies y Política de Privacidad.
Licensed under cc by-sa 3.0 with attribution required.