¿Cómo creo pestañas de usuario personalizadas?

9

Estoy intentando crear una nueva pestaña personalizada que aparece en todas las rutas que son descendientes de la entidad. {Entity_type} .canonical. Intenté extender la clase DeriverBase, anulando específicamente el método getDerivativeDefinitions. Creé la pestaña misma extendiendo LocalTaskDefault y anulando el método getRouteParameters. La pestaña aparece cuando visita una ruta de usuario estándar de Drupal como www.mysite.com/user/1/ o www.mysite.com/user/1/edit. Sin embargo, cuando agregamos nuestras nuevas rutas de usuario personalizadas, como www.mysite.com/user/1/subscribe, no aparecen pestañas. ¿Existe una forma especial de definir tareas de menú local en rutas personalizadas? Una muestra del código:

 $this->derivatives['recurly.subscription_tab'] = [
  'title' => $this->t('Subscription'),
  'weight' => 5,
  'route_name' => 'recurly.subscription_list',
  'base_route' => "entity.$entity_type.canonical",
];

foreach ($this->derivatives as &$entry) {
  $entry += $base_plugin_definition;
}

Gracias de antemano por cualquier ayuda.

tflanagan
fuente
Suena muy cerca de lo que está haciendo devel con su / ruta de desarrollo / tarea local, le sugiero que eche un vistazo a cómo está implementando eso.
Berdir
@Berdir ese fue el punto de partida, pero todavía parece que me falta algo.
tflanagan
¿Intentó agregar el archivo 'yourmodule.links.task.yml' con la configuración de su pestaña personalizada?
Andrew

Respuestas:

7

Según lo sugerido por Berdir, puede ver el módulo Devel y cómo está implementando eso. El siguiente código fue "extraído" de Devel

1) Crea las rutas

Cree el archivo mymodule.routing.yml dentro y defina una devolución de llamada de ruta (que se utiliza para crear las rutas dinámicas)

route_callbacks:
  - '\Drupal\mymodule\Routing\MyModuleRoutes::routes'

Cree la clase MyModuleRoutes para generar sus rutas dinámicas en src / Routing

<?php

namespace Drupal\mymodule\Routing;

use Drupal\Core\DependencyInjection\ContainerInjectionInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\Routing\Route;
use Symfony\Component\Routing\RouteCollection;

class MyModuleRoutes implements ContainerInjectionInterface {

  public function __construct(EntityTypeManagerInterface $entity_type_manager) {
    $this->entityTypeManager = $entity_type_manager;
  }

  public static function create(ContainerInterface $container) {
    return new static(
      $container->get('entity_type.manager')
    );
  }

  public function routes() {
    $collection = new RouteCollection();

    foreach ($this->entityTypeManager->getDefinitions() as $entity_type_id => $entity_type) {
      if ($entity_type->hasLinkTemplate('canonical')) {
        $route = new Route("/mymodule/$entity_type_id/{{$entity_type_id}}");
        $route
          ->addDefaults([
            '_controller' => '\Drupal\mymodule\Controller\MyModuleController::doStuff',
            '_title' => 'My module route title',
          ])
          ->addRequirements([
            '_permission' => 'access mymodule permission',
          ])
          ->setOption('_mymodule_entity_type_id', $entity_type_id)
          ->setOption('parameters', [
            $entity_type_id => ['type' => 'entity:' . $entity_type_id],
          ]);

        $collection->add("entity.$entity_type_id.mymodule", $route);
      }
    }

    return $collection;
  }

}

2) Crear las tareas locales dinámicas

Cree el archivo mymodule.links.task.yml y dentro defina un derivador

mymodule.tasks:
  class: \Drupal\Core\Menu\LocalTaskDefault
  deriver: \Drupal\mymodule\Plugin\Derivative\MyModuleLocalTasks

Cree la clase MyModuleLocalTasks para generar sus rutas dinámicas en src / Plugin / Derivative

<?php

namespace Drupal\mymodule\Plugin\Derivative;

use Drupal\Component\Plugin\Derivative\DeriverBase;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Plugin\Discovery\ContainerDeriverInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

class MyModuleLocalTasks extends DeriverBase implements ContainerDeriverInterface {

  protected $entityTypeManager;

  public function __construct(EntityTypeManagerInterface $entity_type_manager) {
    $this->entityTypeManager = $entity_type_manager;
  }

  public static function create(ContainerInterface $container, $base_plugin_id) {
    return new static(
      $container->get('entity_type.manager')
    );
  }

  public function getDerivativeDefinitions($base_plugin_definition) {
    $this->derivatives = array();

    foreach ($this->entityTypeManager->getDefinitions() as $entity_type_id => $entity_type) {
      if ($entity_type->hasLinkTemplate('canonical')) {
        $this->derivatives["$entity_type_id.mymodule_tab"] = [
          'route_name' => "entity.$entity_type_id.mymodule",
          'title' => t('Mymodule title'),
          'base_route' => "entity.$entity_type_id.canonical",
          'weight' => 100,
        ] + $base_plugin_definition;
      }
    }

    return $this->derivatives;
  }

}

3) Crear el controlador

Cree la clase MyModuleController en src / Controller

namespace Drupal\mymodule\Controller;

use Drupal\Core\Controller\ControllerBase;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Routing\RouteMatchInterface;

class MyModuleController extends ControllerBase {

  public function doStuff(RouteMatchInterface $route_match) {
    $output = [];

    $parameter_name = $route_match->getRouteObject()->getOption('_mymodule_entity_type_id');
    $entity = $route_match->getParameter($parameter_name);

    if ($entity && $entity instanceof EntityInterface) {
      $output = ['#markup' => $entity->label()];
    }

    return $output;
  }

}
marco
fuente
3
Esto fue muy similar a lo que terminé implementando. Pasar el RouteMatchInterface $ route_match fue la solución a mi problema. Desde allí, mi objeto de entidad estaba disponible para mi controlador.
tflanagan