www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/layout_builder/src/Plugin/Derivative/LayoutBuilderLocalTaskDeriver.php

   1 <?php
   2
   3 namespace Drupal\layout_builder\Plugin\Derivative;
   4
   5 use Drupal\Component\Plugin\Derivative\DeriverBase;
   6 use Drupal\Core\Entity\EntityTypeInterface;
   7 use Drupal\Core\Entity\EntityTypeManagerInterface;
   8 use Drupal\Core\Entity\FieldableEntityInterface;
   9 use Drupal\Core\Plugin\Discovery\ContainerDeriverInterface;
  10 use Drupal\Core\StringTranslation\StringTranslationTrait;
  11 use Symfony\Component\DependencyInjection\ContainerInterface;
  12
  13 /**
  14  * Provides local task definitions for the layout builder user interface.
  15  *
  16  * @todo Remove this in https://www.drupal.org/project/drupal/issues/2936655.
  17  *
  18  * @internal
  19  */
  20 class LayoutBuilderLocalTaskDeriver extends DeriverBase implements ContainerDeriverInterface {
  21
  22   use StringTranslationTrait;
  23
  24   /**
  25    * The entity type manager.
  26    *
  27    * @var \Drupal\Core\Entity\EntityTypeManagerInterface
  28    */
  29   protected $entityTypeManager;
  30
  31   /**
  32    * Constructs a new LayoutBuilderLocalTaskDeriver.
  33    *
  34    * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
  35    *   The entity type manager.
  36    */
  37   public function __construct(EntityTypeManagerInterface $entity_type_manager) {
  38     $this->entityTypeManager = $entity_type_manager;
  39   }
  40
  41   /**
  42    * {@inheritdoc}
  43    */
  44   public static function create(ContainerInterface $container, $base_plugin_id) {
  45     return new static(
  46       $container->get('entity_type.manager')
  47     );
  48   }
  49
  50   /**
  51    * {@inheritdoc}
  52    */
  53   public function getDerivativeDefinitions($base_plugin_definition) {
  54     foreach ($this->getEntityTypesForOverrides() as $entity_type_id => $entity_type) {
  55       // Overrides.
  56       $this->derivatives["layout_builder.overrides.$entity_type_id.view"] = $base_plugin_definition + [
  57         'route_name' => "layout_builder.overrides.$entity_type_id.view",
  58         'weight' => 15,
  59         'title' => $this->t('Layout'),
  60         'base_route' => "entity.$entity_type_id.canonical",
  61         'cache_contexts' => ['layout_builder_is_active:' . $entity_type_id],
  62       ];
  63       $this->derivatives["layout_builder.overrides.$entity_type_id.save"] = $base_plugin_definition + [
  64         'route_name' => "layout_builder.overrides.$entity_type_id.save",
  65         'title' => $this->t('Save Layout'),
  66         'parent_id' => "layout_builder_ui:layout_builder.overrides.$entity_type_id.view",
  67         'cache_contexts' => ['layout_builder_is_active:' . $entity_type_id],
  68       ];
  69       $this->derivatives["layout_builder.overrides.$entity_type_id.cancel"] = $base_plugin_definition + [
  70         'route_name' => "layout_builder.overrides.$entity_type_id.cancel",
  71         'title' => $this->t('Cancel Layout'),
  72         'parent_id' => "layout_builder_ui:layout_builder.overrides.$entity_type_id.view",
  73         'weight' => 5,
  74         'cache_contexts' => ['layout_builder_is_active:' . $entity_type_id],
  75       ];
  76       // @todo This link should be conditionally displayed, see
  77       //   https://www.drupal.org/node/2917777.
  78       $this->derivatives["layout_builder.overrides.$entity_type_id.revert"] = $base_plugin_definition + [
  79         'route_name' => "layout_builder.overrides.$entity_type_id.revert",
  80         'title' => $this->t('Revert to defaults'),
  81         'parent_id' => "layout_builder_ui:layout_builder.overrides.$entity_type_id.view",
  82         'weight' => 10,
  83         'cache_contexts' => ['layout_builder_is_active:' . $entity_type_id],
  84       ];
  85     }
  86
  87     foreach ($this->getEntityTypesForDefaults() as $entity_type_id => $entity_type) {
  88       // Defaults.
  89       $this->derivatives["layout_builder.defaults.$entity_type_id.view"] = $base_plugin_definition + [
  90         'route_name' => "layout_builder.defaults.$entity_type_id.view",
  91         'title' => $this->t('Manage layout'),
  92         'base_route' => "layout_builder.defaults.$entity_type_id.view",
  93       ];
  94       $this->derivatives["layout_builder.defaults.$entity_type_id.save"] = $base_plugin_definition + [
  95         'route_name' => "layout_builder.defaults.$entity_type_id.save",
  96         'title' => $this->t('Save Layout'),
  97         'parent_id' => "layout_builder_ui:layout_builder.defaults.$entity_type_id.view",
  98       ];
  99       $this->derivatives["layout_builder.defaults.$entity_type_id.cancel"] = $base_plugin_definition + [
 100         'route_name' => "layout_builder.defaults.$entity_type_id.cancel",
 101         'title' => $this->t('Cancel Layout'),
 102         'weight' => 5,
 103         'parent_id' => "layout_builder_ui:layout_builder.defaults.$entity_type_id.view",
 104       ];
 105     }
 106
 107     return $this->derivatives;
 108   }
 109
 110   /**
 111    * Returns an array of entity types relevant for defaults.
 112    *
 113    * @return \Drupal\Core\Entity\EntityTypeInterface[]
 114    *   An array of entity types.
 115    */
 116   protected function getEntityTypesForDefaults() {
 117     return array_filter($this->entityTypeManager->getDefinitions(), function (EntityTypeInterface $entity_type) {
 118       return $entity_type->entityClassImplements(FieldableEntityInterface::class) && $entity_type->hasViewBuilderClass() && $entity_type->get('field_ui_base_route');
 119     });
 120   }
 121
 122   /**
 123    * Returns an array of entity types relevant for overrides.
 124    *
 125    * @return \Drupal\Core\Entity\EntityTypeInterface[]
 126    *   An array of entity types.
 127    */
 128   protected function getEntityTypesForOverrides() {
 129     return array_filter($this->entityTypeManager->getDefinitions(), function (EntityTypeInterface $entity_type) {
 130       return $entity_type->entityClassImplements(FieldableEntityInterface::class) && $entity_type->hasViewBuilderClass() && $entity_type->hasLinkTemplate('canonical');
 131     });
 132   }
 133
 134 }