3 namespace Drupal\layout_builder\Plugin\Derivative;
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;
14 * Provides local task definitions for the layout builder user interface.
16 * @todo Remove this in https://www.drupal.org/project/drupal/issues/2936655.
20 class LayoutBuilderLocalTaskDeriver extends DeriverBase implements ContainerDeriverInterface {
22 use StringTranslationTrait;
25 * The entity type manager.
27 * @var \Drupal\Core\Entity\EntityTypeManagerInterface
29 protected $entityTypeManager;
32 * Constructs a new LayoutBuilderLocalTaskDeriver.
34 * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
35 * The entity type manager.
37 public function __construct(EntityTypeManagerInterface $entity_type_manager) {
38 $this->entityTypeManager = $entity_type_manager;
44 public static function create(ContainerInterface $container, $base_plugin_id) {
46 $container->get('entity_type.manager')
53 public function getDerivativeDefinitions($base_plugin_definition) {
54 foreach ($this->getEntityTypesForOverrides() as $entity_type_id => $entity_type) {
56 $this->derivatives["layout_builder.overrides.$entity_type_id.view"] = $base_plugin_definition + [
57 'route_name' => "layout_builder.overrides.$entity_type_id.view",
59 'title' => $this->t('Layout'),
60 'base_route' => "entity.$entity_type_id.canonical",
61 'cache_contexts' => ['layout_builder_is_active:' . $entity_type_id],
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],
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",
74 'cache_contexts' => ['layout_builder_is_active:' . $entity_type_id],
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",
83 'cache_contexts' => ['layout_builder_is_active:' . $entity_type_id],
87 foreach ($this->getEntityTypesForDefaults() as $entity_type_id => $entity_type) {
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",
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",
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'),
103 'parent_id' => "layout_builder_ui:layout_builder.defaults.$entity_type_id.view",
107 return $this->derivatives;
111 * Returns an array of entity types relevant for defaults.
113 * @return \Drupal\Core\Entity\EntityTypeInterface[]
114 * An array of entity types.
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');
123 * Returns an array of entity types relevant for overrides.
125 * @return \Drupal\Core\Entity\EntityTypeInterface[]
126 * An array of entity types.
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');