comparison core/modules/layout_builder/layout_builder.module @ 5:12f9dff5fda9 tip

Update to Drupal core 8.7.1

 /**
  * @file
  * Provides hook implementations for Layout Builder.
  */
 
+use Drupal\Core\Breadcrumb\Breadcrumb;
+use Drupal\Core\Cache\CacheableMetadata;
 use Drupal\Core\Entity\EntityInterface;
+use Drupal\Core\Entity\FieldableEntityInterface;
 use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\Link;
 use Drupal\Core\Render\Element;
 use Drupal\Core\Routing\RouteMatchInterface;
 use Drupal\Core\Url;
 use Drupal\field\FieldConfigInterface;
 use Drupal\layout_builder\Entity\LayoutBuilderEntityViewDisplay;
 use Drupal\layout_builder\Entity\LayoutBuilderEntityViewDisplayStorage;
+use Drupal\layout_builder\Form\DefaultsEntityForm;
 use Drupal\layout_builder\Form\LayoutBuilderEntityViewDisplayForm;
+use Drupal\layout_builder\Form\OverridesEntityForm;
 use Drupal\Core\Entity\Display\EntityViewDisplayInterface;
 use Drupal\layout_builder\Plugin\Block\ExtraFieldBlock;
 use Drupal\layout_builder\InlineBlockEntityOperations;
 use Drupal\Core\Session\AccountInterface;
 use Drupal\Core\Access\AccessResult;
 use Drupal\layout_builder\Plugin\SectionStorage\OverridesSectionStorage;
+use Drupal\layout_builder\QuickEditIntegration;
 
 /**
  * Implements hook_help().
  */
 function layout_builder_help($route_name, RouteMatchInterface $route_match) {

       $output .= '<p>' . t('To manage other areas of the page, use the <a href="@block-ui">block administration page</a>.', ['@block-ui' => Url::fromRoute('block.admin_display')->toString()]) . '</p>';
     }
     else {
       $output .= '<p>' . t('To manage other areas of the page, use the block administration page.') . '</p>';
     }
+    $output .= '<p>' . t('Forms and links inside the content of the layout builder tool have been disabled.') . '</p>';
     return $output;
   }
 
   switch ($route_name) {
     case 'help.page.layout_builder':
       $output = '<h3>' . t('About') . '</h3>';
-      $output .= '<p>' . t('Layout Builder provides layout building utility.') . '</p>';
-      $output .= '<p>' . t('For more information, see the <a href=":layout-builder-documentation">online documentation for the Layout Builder module</a>.', [':layout-builder-documentation' => 'https://www.drupal.org/docs/8/core/modules/layout_builder']) . '</p>';
+      $output .= '<p>' . t('Layout Builder allows you to use layouts to customize how content, custom blocks, and other <a href=":field_help" title="Field module help, with background on content entities">content entities</a> are displayed.', [':field_help' => Url::fromRoute('help.page', ['name' => 'field'])->toString()]) . '</p>';
+      $output .= '<p>' . t('For more information, see the <a href=":layout-builder-documentation">online documentation for the Layout Builder module</a>.', [':layout-builder-documentation' => 'https://www.drupal.org/docs/8/core/modules/layout-builder']) . '</p>';
+      $output .= '<h3>' . t('Uses') . '</h3>';
+      $output .= '<dl>';
+      $output .= '<dt>' . t('Default layouts') . '</dt>';
+      $output .= '<dd>' . t('Layout Builder can be selectively enabled on the "Manage Display" page in the <a href=":field_ui">Field UI</a>. This allows you to control the output of each type of display individually. For example, a "Basic page" might have view modes such as Full and Teaser, with each view mode having different layouts selected.', [':field_ui' => Url::fromRoute('help.page', ['name' => 'field_ui'])->toString()]) . '</dd>';
+      $output .= '<dt>' . t('Overridden layouts') . '</dt>';
+      $output .= '<dd>' . t('If enabled, each individual content item can have a custom layout. Once the layout for an individual content item is overridden, changes to the Default layout will no longer affect it. Overridden layouts may be reverted to return to matching and being synchronized to their Default layout.') . '</dd>';
+      $output .= '<dt>' . t('User permissions') . '</dt>';
+      $output .= '<dd>' . t('The Layout Builder module makes a number of permissions available, which can be set by role on the <a href=":permissions">permissions page</a>. For more information, see the <a href=":layout-builder-permissions">Configuring Layout Builder permissions</a> online documentation.', [
+        ':permissions' => Url::fromRoute('user.admin_permissions', [], ['fragment' => 'module-layout_builder'])->toString(),
+        ':layout-builder-permissions' => 'https://www.drupal.org/docs/8/core/modules/layout-builder/configuring-layout-builder-permissions',
+      ]) . '</dd>';
+      $output .= '</dl>';
       return $output;
   }
 }
 
 /**

 function layout_builder_entity_type_alter(array &$entity_types) {
   /** @var \Drupal\Core\Entity\EntityTypeInterface[] $entity_types */
   $entity_types['entity_view_display']
     ->setClass(LayoutBuilderEntityViewDisplay::class)
     ->setStorageClass(LayoutBuilderEntityViewDisplayStorage::class)
+    ->setFormClass('layout_builder', DefaultsEntityForm::class)
     ->setFormClass('edit', LayoutBuilderEntityViewDisplayForm::class);
+
+  // Ensure every fieldable entity type has a layout form.
+  foreach ($entity_types as $entity_type) {
+    if ($entity_type->entityClassImplements(FieldableEntityInterface::class)) {
+      $entity_type->setFormClass('layout_builder', OverridesEntityForm::class);
+    }
+  }
 }
 
 /**
  * Implements hook_form_FORM_ID_alter() for \Drupal\field_ui\Form\EntityFormDisplayEditForm.
  */

         // else it will be rendered twice.
         unset($build[$field_name]);
       }
     }
   }
+
+  $route_name = \Drupal::routeMatch()->getRouteName();
+
+  // If the entity is displayed within a Layout Builder block and the current
+  // route is in the Layout Builder UI, then remove all contextual link
+  // placeholders.
+  if ($display instanceof LayoutBuilderEntityViewDisplay && strpos($route_name, 'layout_builder.') === 0) {
+    unset($build['#contextual_links']);
+  }
+
+  if (\Drupal::moduleHandler()->moduleExists('quickedit')) {
+    /** @var \Drupal\layout_builder\QuickEditIntegration $quick_edit_integration */
+    $quick_edit_integration = \Drupal::classResolver(QuickEditIntegration::class);
+    $quick_edit_integration->entityViewAlter($build, $entity, $display);
+  }
+}
+
+/**
+ * Implements hook_entity_build_defaults_alter().
+ */
+function layout_builder_entity_build_defaults_alter(array &$build, EntityInterface $entity, $view_mode) {
+  // Contextual links are removed for entities viewed in Layout Builder's UI.
+  // The route.name.is_layout_builder_ui cache context accounts for this
+  // difference.
+  // @see layout_builder_entity_view_alter()
+  // @see \Drupal\layout_builder\Cache\LayoutBuilderUiCacheContext
+  $build['#cache']['contexts'][] = 'route.name.is_layout_builder_ui';
 }
 
 /**
  * Implements hook_builder_module_implements_alter().
  */

     $entity_operations->removeUnused();
   }
 }
 
 /**
+ * Implements hook_plugin_filter_TYPE__CONSUMER_alter().
+ */
+function layout_builder_plugin_filter_block__layout_builder_alter(array &$definitions, array $extra) {
+  // @todo Restore the page title block in https://www.drupal.org/node/2938129.
+  unset($definitions['page_title_block']);
+}
+
+/**
  * Implements hook_plugin_filter_TYPE_alter().
  */
 function layout_builder_plugin_filter_block_alter(array &$definitions, array $extra, $consumer) {
   // @todo Determine the 'inline_block' blocks should be allowed outside
   //   of layout_builder https://www.drupal.org/node/2979142.

     // If the operation is 'view' or this is reusable block or if this is
     // non-reusable that isn't used by this module then don't alter the access.
     return AccessResult::neutral();
   }
 
-  if ($account->hasPermission('configure any layout')) {
+  if ($account->hasPermission('create and edit custom blocks')) {
     return AccessResult::allowed();
   }
   return AccessResult::forbidden();
 }
 
 /**
  * Implements hook_plugin_filter_TYPE__CONSUMER_alter().
  */
 function layout_builder_plugin_filter_block__block_ui_alter(array &$definitions, array $extra) {
   foreach ($definitions as $id => $definition) {
-    // Filter out any layout_builder definition with required contexts.
-    if ($definition['provider'] === 'layout_builder' && !empty($definition['context'])) {
-      /** @var \Drupal\Core\Plugin\Context\ContextDefinitionInterface $context */
-      foreach ($definition['context'] as $context) {
-        if ($context->isRequired()) {
+    // Filter out any layout_builder-provided block that has required context
+    // definitions.
+    if ($definition['provider'] === 'layout_builder' && !empty($definition['context_definitions'])) {
+      /** @var \Drupal\Core\Plugin\Context\ContextDefinitionInterface $context_definition */
+      foreach ($definition['context_definitions'] as $context_definition) {
+        if ($context_definition->isRequired()) {
           unset($definitions[$id]);
           break;
         }
       }
     }
   }
 }
+
+/**
+ * Implements hook_plugin_filter_TYPE__CONSUMER_alter().
+ */
+function layout_builder_plugin_filter_layout__layout_builder_alter(array &$definitions, array $extra) {
+  // Remove layouts provide by layout discovery that are not needed because of
+  // layouts provided by this module.
+  $duplicate_layouts = [
+    'layout_twocol',
+    'layout_twocol_bricks',
+    'layout_threecol_25_50_25',
+    'layout_threecol_33_34_33',
+  ];
+
+  foreach ($duplicate_layouts as $duplicate_layout) {
+    /** @var \Drupal\Core\Layout\LayoutDefinition[] $definitions */
+    if (isset($definitions[$duplicate_layout])) {
+      if ($definitions[$duplicate_layout]->getProvider() === 'layout_discovery') {
+        unset($definitions[$duplicate_layout]);
+      }
+    }
+  }
+
+  // Move the one column layout to the top.
+  if (isset($definitions['layout_onecol']) && $definitions['layout_onecol']->getProvider() === 'layout_discovery') {
+    $one_col = $definitions['layout_onecol'];
+    unset($definitions['layout_onecol']);
+    $definitions = [
+      'layout_onecol' => $one_col,
+    ] + $definitions;
+  }
+}
+
+/**
+ * Implements hook_plugin_filter_TYPE_alter().
+ */
+function layout_builder_plugin_filter_layout_alter(array &$definitions, array $extra, $consumer) {
+  // Hide the blank layout plugin from listings.
+  unset($definitions['layout_builder_blank']);
+}
+
+/**
+ * Implements hook_system_breadcrumb_alter().
+ */
+function layout_builder_system_breadcrumb_alter(Breadcrumb &$breadcrumb, RouteMatchInterface $route_match, array $context) {
+  // Remove the extra 'Manage display' breadcrumb for Layout Builder defaults.
+  if ($route_match->getRouteObject()->hasOption('_layout_builder') && $route_match->getParameter('section_storage_type') === 'defaults') {
+    $links = array_filter($breadcrumb->getLinks(), function (Link $link) use ($route_match) {
+      $entity_type_id = $route_match->getParameter('entity_type_id');
+      return $link->getUrl()->getRouteName() !== "entity.entity_view_display.$entity_type_id.default";
+    });
+    // Links cannot be removed from an existing breadcrumb object. Create a new
+    // object but carry over the cacheable metadata.
+    $cacheability = CacheableMetadata::createFromObject($breadcrumb);
+    $breadcrumb = new Breadcrumb();
+    $breadcrumb->setLinks($links);
+    $breadcrumb->addCacheableDependency($cacheability);
+  }
+}
+
+/**
+ * Implements hook_quickedit_render_field().
+ */
+function layout_builder_quickedit_render_field(EntityInterface $entity, $field_name, $view_mode_id, $langcode) {
+  /** @var \Drupal\layout_builder\QuickEditIntegration $quick_edit_integration */
+  $quick_edit_integration = \Drupal::classResolver(QuickEditIntegration::class);
+  return $quick_edit_integration->quickEditRenderField($entity, $field_name, $view_mode_id, $langcode);
+}
+
+/**
+ * Implements hook_entity_translation_create().
+ */
+function layout_builder_entity_translation_create(EntityInterface $translation) {
+  /** @var \Drupal\Core\Entity\FieldableEntityInterface $translation */
+  if ($translation->hasField(OverridesSectionStorage::FIELD_NAME) && $translation->getFieldDefinition(OverridesSectionStorage::FIELD_NAME)->isTranslatable()) {
+    // When creating a new translation do not copy untranslated sections because
+    // per-language layouts are not supported.
+    $translation->set(OverridesSectionStorage::FIELD_NAME, []);
+  }
+}
+
+/**
+ * Implements hook_theme_registry_alter().
+ */
+function layout_builder_theme_registry_alter(&$theme_registry) {
+  // Move our preprocess to run after
+  // content_translation_preprocess_language_content_settings_table().
+  if (!empty($theme_registry['language_content_settings_table']['preprocess functions'])) {
+    $preprocess_functions = &$theme_registry['language_content_settings_table']['preprocess functions'];
+    $index = array_search('layout_builder_preprocess_language_content_settings_table', $preprocess_functions);
+    if ($index !== FALSE) {
+      unset($preprocess_functions[$index]);
+      $preprocess_functions[] = 'layout_builder_preprocess_language_content_settings_table';
+    }
+  }
+}
+
+/**
+ * Implements hook_preprocess_HOOK() for language-content-settings-table.html.twig.
+ */
+function layout_builder_preprocess_language_content_settings_table(&$variables) {
+  foreach ($variables['build']['#rows'] as &$row) {
+    if (isset($row['#field_name']) && $row['#field_name'] === OverridesSectionStorage::FIELD_NAME) {
+      // Rebuild the label to include a warning about using translations with
+      // layouts.
+      $row['data'][1]['data']['field'] = [
+        'label' => $row['data'][1]['data']['field'],
+        'description' => [
+          '#type' => 'container',
+          '#markup' => t('<strong>Warning</strong>: Layout Builder does not support translating layouts. (<a href="https://www.drupal.org/docs/8/core/modules/layout-builder/layout-builder-and-content-translation">online documentation</a>)'),
+          '#attributes' => [
+            'class' => ['layout-builder-translation-warning'],
+          ],
+        ],
+      ];
+    }
+  }
+}