Как мне создать пользовательские вкладки?

9

Я пытаюсь создать новую пользовательскую вкладку, которая появляется на всех маршрутах, которые являются потомками объекта. {Entity_type} .canonical. Я попытался расширить класс DeriverBase, особенно переопределяя метод getDerivativeDefinitions. Я создал вкладку, расширив LocalTaskDefault и переопределив метод getRouteParameters. Вкладка появляется, когда вы посещаете стандартный путь пользователя Drupal, такой как www.mysite.com/user/1/ или www.mysite.com/user/1/edit. Однако, когда мы добавляем наши новые пользовательские маршруты, такие как www.mysite.com/user/1/subscribe, вкладки не появляются. Есть ли особый способ определения локальных задач меню на пользовательских маршрутах? Образец кода:

 $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;
}

Спасибо заранее за любую помощь.

tflanagan
источник
Звучит очень похоже на то, что делает devel со своей задачей / devel route / local, я предлагаю вам посмотреть, как она это реализует.
Бердир
@Berdir был отправной точкой, но я все еще что-то упускаю.
tflanagan
Вы пытались добавить файл 'yourmodule.links.task.yml' с настройками для вашей пользовательской вкладки?
Андрей

Ответы:

7

По предложению Бердира, вы можете посмотреть на модуль Devel и на то, как он это реализует. Следующий код был "извлечен" из Devel

1) Создать маршруты

Создайте файл mymodule.routing.yml внутри и внутри определите обратный вызов маршрута (который используется для создания динамических маршрутов)

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

Создайте класс MyModuleRoutes для генерации ваших динамических маршрутов в 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) Создать динамические локальные задачи

Создайте файл mymodule.links.task.yml и внутри определите производный

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

Создайте класс MyModuleLocalTasks для генерации ваших динамических маршрутов в 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) Создать контроллер

Создайте класс MyModuleController в 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;
  }

}
марко
источник
3
Это было очень похоже на то, что я реализовал. Передача в RouteMatchInterface $ route_match была решением моей проблемы. Оттуда мой объект был доступен для моего контроллера.
августа