Como crio guias de usuário personalizadas?

9

Estou tentando criar uma nova guia personalizada que aparece em todas as rotas que são descendentes da entidade. {Entity_type} .canonical. Tentei estender a classe DeriverBase, substituindo especificamente o método getDerivativeDefinitions. Criei a própria guia estendendo LocalTaskDefault e substituindo o método getRouteParameters. A guia aparece quando você visita um caminho de usuário padrão do Drupal, como www.mysite.com/user/1/ ou www.mysite.com/user/1/edit. No entanto, quando adicionamos nossas novas rotas de usuário personalizadas, como www.mysite.com/user/1/subscribe, nenhuma guia é exibida. Existe uma maneira especial de definir tarefas do menu local em rotas personalizadas? Uma amostra do 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;
}

Agradecemos antecipadamente qualquer ajuda.

tflanagan
fonte
Parece muito próximo do que o devel está fazendo com sua tarefa / route / local, sugiro que você dê uma olhada em como está implementando isso.
Berdir
@Berdir que foi o ponto de partida, mas ainda sinto falta de algo.
precisa saber é
Você tentou adicionar o arquivo 'yourmodule.links.task.yml' com as configurações da sua guia personalizada?
Andrew

Respostas:

7

Conforme sugerido por Berdir, você pode ver o módulo Devel e como ele está implementando isso. O código a seguir foi "extraído" de Devel

1) Crie as rotas

Crie o arquivo mymodule.routing.yml dentro e dentro de defina um retorno de chamada de rota (que é usado para criar as rotas dinâmicas)

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

Crie a classe MyModuleRoutes para gerar suas rotas dinâmicas em 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) Crie as tarefas locais dinâmicas

Crie o arquivo mymodule.links.task.yml e defina um deriver dentro

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

Crie a classe MyModuleLocalTasks para gerar suas rotas dinâmicas em 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) Crie o controlador

Crie a classe MyModuleController em 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
fonte
3
Isso foi muito semelhante ao que acabei implementando. Passar no RouteMatchInterface $ route_match foi a solução para o meu problema. A partir daí, meu objeto de entidade estava disponível para o meu controlador.
precisa saber é