diff --git a/core/modules/layout_builder/config/schema/layout_builder.schema.yml b/core/modules/layout_builder/config/schema/layout_builder.schema.yml index b870007e33..682caa78c4 100644 --- a/core/modules/layout_builder/config/schema/layout_builder.schema.yml +++ b/core/modules/layout_builder/config/schema/layout_builder.schema.yml @@ -5,3 +5,42 @@ core.entity_view_display.*.*.*.third_party.layout_builder: allow_custom: type: boolean label: 'Allow a customized layout' + sections: + type: sequence + sequence: + type: layout_builder.section + +layout_builder.section: + type: mapping + label: 'Layout section' + mapping: + layout_id: + type: string + label: 'Layout ID' + layout_settings: + type: layout_plugin.settings.[%parent.layout_id] + label: 'Layout settings' + components: + type: sequence + label: 'Components' + sequence: + type: layout_builder.component + +layout_builder.component: + type: mapping + label: 'Component' + mapping: + configuration: + type: block.settings.[id] + region: + type: string + label: 'Region' + uuid: + type: uuid + label: 'UUID' + weight: + type: integer + label: 'Weight' + additional: + type: ignore + label: 'Additional data' diff --git a/core/modules/layout_builder/layout_builder.info.yml b/core/modules/layout_builder/layout_builder.info.yml index e985911464..d4ce72e0ff 100644 --- a/core/modules/layout_builder/layout_builder.info.yml +++ b/core/modules/layout_builder/layout_builder.info.yml @@ -7,3 +7,5 @@ core: 8.x dependencies: - layout_discovery - contextual + # @todo Discuss removing in https://www.drupal.org/project/drupal/issues/2935999. + - field_ui diff --git a/core/modules/layout_builder/layout_builder.install b/core/modules/layout_builder/layout_builder.install new file mode 100644 index 0000000000..44001abc8d --- /dev/null +++ b/core/modules/layout_builder/layout_builder.install @@ -0,0 +1,35 @@ +getThirdPartySettings('field_layout'); + if (isset($field_layout['id'])) { + $field_layout += ['settings' => []]; + $display->appendSection(new Section($field_layout['id'], $field_layout['settings'])); + } + + // Sort the components by weight. + $components = $display->get('content'); + uasort($components, 'Drupal\Component\Utility\SortArray::sortByWeightElement'); + foreach ($components as $name => $component) { + $display->setComponent($name, $component); + } + $display->save(); + } + Cache::invalidateTags(['rendered']); +} diff --git a/core/modules/layout_builder/layout_builder.module b/core/modules/layout_builder/layout_builder.module index 895145d984..80339c1f70 100644 --- a/core/modules/layout_builder/layout_builder.module +++ b/core/modules/layout_builder/layout_builder.module @@ -5,17 +5,14 @@ * Provides hook implementations for Layout Builder. */ -use Drupal\Core\Entity\Display\EntityViewDisplayInterface; -use Drupal\Core\Entity\EntityInterface; use Drupal\Core\Entity\FieldableEntityInterface; use Drupal\Core\Form\FormStateInterface; -use Drupal\Core\Plugin\Context\Context; -use Drupal\Core\Plugin\Context\ContextDefinition; use Drupal\Core\Routing\RouteMatchInterface; -use Drupal\Core\StringTranslation\TranslatableMarkup; use Drupal\Core\Url; -use Drupal\field\Entity\FieldConfig; -use Drupal\field\Entity\FieldStorageConfig; +use Drupal\field\FieldConfigInterface; +use Drupal\layout_builder\Entity\LayoutBuilderEntityViewDisplay; +use Drupal\layout_builder\Entity\LayoutBuilderEntityViewDisplayStorage; +use Drupal\layout_builder\Form\LayoutBuilderEntityViewDisplayForm; /** * Implements hook_help(). @@ -52,17 +49,18 @@ function layout_builder_entity_type_alter(array &$entity_types) { $entity_type->setLinkTemplate('layout-builder', $entity_type->getLinkTemplate('canonical') . '/layout'); } } + $entity_types['entity_view_display'] + ->setClass(LayoutBuilderEntityViewDisplay::class) + ->setStorageClass(LayoutBuilderEntityViewDisplayStorage::class) + ->setFormClass('edit', LayoutBuilderEntityViewDisplayForm::class); } /** - * Removes the Layout Builder field both visually and from the #fields handling. - * - * This prevents any interaction with this field. It is rendered directly - * in layout_builder_entity_view_alter(). - * - * @internal + * Implements hook_form_FORM_ID_alter() for \Drupal\field_ui\Form\EntityFormDisplayEditForm. */ -function _layout_builder_hide_layout_field(array &$form) { +function layout_builder_form_entity_form_display_edit_form_alter(&$form, FormStateInterface $form_state) { + // Hides the Layout Builder field. It is rendered directly in + // \Drupal\layout_builder\Entity\LayoutBuilderEntityViewDisplay::buildMultiple(). unset($form['fields']['layout_builder__layout']); $key = array_search('layout_builder__layout', $form['#fields']); if ($key !== FALSE) { @@ -71,140 +69,23 @@ function _layout_builder_hide_layout_field(array &$form) { } /** - * Implements hook_form_FORM_ID_alter() for \Drupal\field_ui\Form\EntityFormDisplayEditForm. + * Implements hook_field_config_insert(). */ -function layout_builder_form_entity_form_display_edit_form_alter(&$form, FormStateInterface $form_state) { - _layout_builder_hide_layout_field($form); +function layout_builder_field_config_insert(FieldConfigInterface $field_config) { + // Clear the sample entity for this entity type and bundle. + /** @var \Drupal\Core\TempStore\SharedTempStore $tempstore */ + $tempstore = \Drupal::service('tempstore.shared')->get('layout_builder.sample_entity'); + $tempstore->delete($field_config->getTargetEntityTypeId() . '.' . $field_config->getTargetBundle()); + \Drupal::service('plugin.manager.block')->clearCachedDefinitions(); } /** - * Implements hook_form_FORM_ID_alter() for \Drupal\field_ui\Form\EntityViewDisplayEditForm. + * Implements hook_field_config_delete(). */ -function layout_builder_form_entity_view_display_edit_form_alter(&$form, FormStateInterface $form_state) { - /** @var \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display */ - $display = $form_state->getFormObject()->getEntity(); - $entity_type = \Drupal::entityTypeManager()->getDefinition($display->getTargetEntityTypeId()); - - _layout_builder_hide_layout_field($form); - - // @todo Expand to work for all view modes in - // https://www.drupal.org/node/2907413. - if (!in_array($display->getMode(), ['full', 'default'], TRUE)) { - return; - } - - $form['layout'] = [ - '#type' => 'details', - '#open' => TRUE, - '#title' => t('Layout options'), - '#tree' => TRUE, - ]; - // @todo Unchecking this box is a destructive action, this should be made - // clear to the user in https://www.drupal.org/node/2914484. - $form['layout']['allow_custom'] = [ - '#type' => 'checkbox', - '#title' => t('Allow each @entity to have its layout customized.', [ - '@entity' => $entity_type->getSingularLabel(), - ]), - '#default_value' => $display->getThirdPartySetting('layout_builder', 'allow_custom', FALSE), - ]; - - $form['#entity_builders'][] = 'layout_builder_form_entity_view_display_edit_entity_builder'; -} - -/** - * Entity builder for layout options on the entity view display form. - * - * @see layout_builder_form_entity_view_display_edit_form_alter() - */ -function layout_builder_form_entity_view_display_edit_entity_builder($entity_type_id, EntityViewDisplayInterface $display, &$form, FormStateInterface &$form_state) { - $new_value = (bool) $form_state->getValue(['layout', 'allow_custom'], FALSE); - $display->setThirdPartySetting('layout_builder', 'allow_custom', $new_value); -} - -/** - * Implements hook_ENTITY_TYPE_presave(). - */ -function layout_builder_entity_view_display_presave(EntityViewDisplayInterface $display) { - $original_value = isset($display->original) ? $display->original->getThirdPartySetting('layout_builder', 'allow_custom', FALSE) : FALSE; - $new_value = $display->getThirdPartySetting('layout_builder', 'allow_custom', FALSE); - if ($original_value !== $new_value) { - $entity_type_id = $display->getTargetEntityTypeId(); - $bundle = $display->getTargetBundle(); - - if ($new_value) { - layout_builder_add_layout_section_field($entity_type_id, $bundle); - } - elseif ($field = FieldConfig::loadByName($entity_type_id, $bundle, 'layout_builder__layout')) { - $field->delete(); - } - } -} - -/** - * Adds a layout section field to a given bundle. - * - * @param string $entity_type_id - * The entity type ID. - * @param string $bundle - * The bundle. - * @param string $field_name - * (optional) The name for the layout section field. Defaults to - * 'layout_builder__layout'. - * - * @return \Drupal\field\FieldConfigInterface - * A layout section field. - */ -function layout_builder_add_layout_section_field($entity_type_id, $bundle, $field_name = 'layout_builder__layout') { - $field = FieldConfig::loadByName($entity_type_id, $bundle, $field_name); - if (!$field) { - $field_storage = FieldStorageConfig::loadByName($entity_type_id, $field_name); - if (!$field_storage) { - $field_storage = FieldStorageConfig::create([ - 'entity_type' => $entity_type_id, - 'field_name' => $field_name, - 'type' => 'layout_section', - ]); - $field_storage->save(); - } - - $field = FieldConfig::create([ - 'field_storage' => $field_storage, - 'bundle' => $bundle, - 'label' => t('Layout'), - ]); - $field->save(); - } - return $field; -} - -/** - * Implements hook_entity_view_alter(). - */ -function layout_builder_entity_view_alter(array &$build, EntityInterface $entity, EntityViewDisplayInterface $display) { - if ($display->getThirdPartySetting('layout_builder', 'allow_custom', FALSE) && !$entity->layout_builder__layout->isEmpty()) { - $contexts = \Drupal::service('context.repository')->getAvailableContexts(); - // @todo Use EntityContextDefinition after resolving - // https://www.drupal.org/node/2932462. - $contexts['layout_builder.entity'] = new Context(new ContextDefinition("entity:{$entity->getEntityTypeId()}", new TranslatableMarkup('@entity being viewed', ['@entity' => $entity->getEntityType()->getLabel()])), $entity); - $sections = $entity->layout_builder__layout->getSections(); - foreach ($sections as $delta => $section) { - $build['_layout_builder'][$delta] = $section->toRenderArray($contexts); - } - - // If field layout is active, that is all that needs to be removed. - if (\Drupal::moduleHandler()->moduleExists('field_layout') && isset($build['_field_layout'])) { - unset($build['_field_layout']); - return; - } - - /** @var \Drupal\Core\Field\FieldDefinitionInterface[] $field_definitions */ - $field_definitions = \Drupal::service('entity_field.manager')->getFieldDefinitions($display->getTargetEntityTypeId(), $display->getTargetBundle()); - // Remove all display-configurable fields. - foreach (array_keys($display->getComponents()) as $name) { - if ($name !== 'layout_builder__layout' && isset($field_definitions[$name]) && $field_definitions[$name]->isDisplayConfigurable('view')) { - unset($build[$name]); - } - } - } +function layout_builder_field_config_delete(FieldConfigInterface $field_config) { + // Clear the sample entity for this entity type and bundle. + /** @var \Drupal\Core\TempStore\SharedTempStore $tempstore */ + $tempstore = \Drupal::service('tempstore.shared')->get('layout_builder.sample_entity'); + $tempstore->delete($field_config->getTargetEntityTypeId() . '.' . $field_config->getTargetBundle()); + \Drupal::service('plugin.manager.block')->clearCachedDefinitions(); } diff --git a/core/modules/layout_builder/layout_builder.routing.yml b/core/modules/layout_builder/layout_builder.routing.yml index 085eb30111..5b7f87a4a7 100644 --- a/core/modules/layout_builder/layout_builder.routing.yml +++ b/core/modules/layout_builder/layout_builder.routing.yml @@ -115,6 +115,3 @@ layout_builder.move_block: parameters: section_storage: layout_builder_tempstore: TRUE - -route_callbacks: - - 'layout_builder.routes:getRoutes' diff --git a/core/modules/layout_builder/layout_builder.services.yml b/core/modules/layout_builder/layout_builder.services.yml index db6a1c13b3..6f5f3e2c60 100644 --- a/core/modules/layout_builder/layout_builder.services.yml +++ b/core/modules/layout_builder/layout_builder.services.yml @@ -6,21 +6,23 @@ services: class: Drupal\layout_builder\Access\LayoutSectionAccessCheck tags: - { name: access_check, applies_to: _has_layout_section } + plugin.manager.layout_builder.section_storage: + class: Drupal\layout_builder\SectionStorage\SectionStorageManager + parent: default_plugin_manager layout_builder.routes: class: Drupal\layout_builder\Routing\LayoutBuilderRoutes - arguments: ['@entity_type.manager', '@entity_field.manager'] + arguments: ['@plugin.manager.layout_builder.section_storage'] + tags: + - { name: event_subscriber } layout_builder.route_enhancer: class: Drupal\layout_builder\Routing\LayoutBuilderRouteEnhancer tags: - { name: route_enhancer } layout_builder.param_converter: class: Drupal\layout_builder\Routing\LayoutTempstoreParamConverter - arguments: ['@layout_builder.tempstore_repository', '@class_resolver'] + arguments: ['@layout_builder.tempstore_repository', '@plugin.manager.layout_builder.section_storage'] tags: - { name: paramconverter, priority: 10 } - layout_builder.section_storage_param_converter.overrides: - class: Drupal\layout_builder\Routing\SectionStorageOverridesParamConverter - arguments: ['@entity.manager'] cache_context.layout_builder_is_active: class: Drupal\layout_builder\Cache\LayoutBuilderIsActiveCacheContext arguments: ['@current_route_match'] diff --git a/core/modules/layout_builder/src/Annotation/SectionStorage.php b/core/modules/layout_builder/src/Annotation/SectionStorage.php new file mode 100644 index 0000000000..42f4a47fe6 --- /dev/null +++ b/core/modules/layout_builder/src/Annotation/SectionStorage.php @@ -0,0 +1,32 @@ +definition); + } + +} diff --git a/core/modules/layout_builder/src/Cache/LayoutBuilderIsActiveCacheContext.php b/core/modules/layout_builder/src/Cache/LayoutBuilderIsActiveCacheContext.php index c632f4b33a..3c3bc25c40 100644 --- a/core/modules/layout_builder/src/Cache/LayoutBuilderIsActiveCacheContext.php +++ b/core/modules/layout_builder/src/Cache/LayoutBuilderIsActiveCacheContext.php @@ -4,8 +4,8 @@ use Drupal\Core\Cache\CacheableMetadata; use Drupal\Core\Cache\Context\CalculatedCacheContextInterface; -use Drupal\Core\Entity\Entity\EntityViewDisplay; use Drupal\Core\Routing\RouteMatchInterface; +use Drupal\layout_builder\OverridesSectionStorageInterface; /** * Determines whether Layout Builder is active for a given entity type or not. @@ -49,7 +49,7 @@ public function getContext($entity_type_id = NULL) { } $display = $this->getDisplay($entity_type_id); - return ($display && $display->getThirdPartySetting('layout_builder', 'allow_custom', FALSE)) ? '1' : '0'; + return ($display && $display->isOverridable()) ? '1' : '0'; } /** @@ -72,15 +72,15 @@ public function getCacheableMetadata($entity_type_id = NULL) { * * @param string $entity_type_id * The entity type ID. - * @param string $view_mode - * (optional) The view mode that should be used to render the entity. * - * @return \Drupal\Core\Entity\Display\EntityViewDisplayInterface|null + * @return \Drupal\layout_builder\Entity\LayoutEntityDisplayInterface|null * The entity view display, if it exists. */ - protected function getDisplay($entity_type_id, $view_mode = 'full') { + protected function getDisplay($entity_type_id) { if ($entity = $this->routeMatch->getParameter($entity_type_id)) { - return EntityViewDisplay::collectRenderDisplay($entity, $view_mode); + if ($entity instanceof OverridesSectionStorageInterface) { + return $entity->getDefaultSectionStorage(); + } } } diff --git a/core/modules/layout_builder/src/Controller/LayoutBuilderController.php b/core/modules/layout_builder/src/Controller/LayoutBuilderController.php index 3f3b95e49b..4acf94538f 100644 --- a/core/modules/layout_builder/src/Controller/LayoutBuilderController.php +++ b/core/modules/layout_builder/src/Controller/LayoutBuilderController.php @@ -3,11 +3,13 @@ namespace Drupal\layout_builder\Controller; use Drupal\Core\DependencyInjection\ContainerInjectionInterface; +use Drupal\Core\Messenger\MessengerInterface; use Drupal\Core\Plugin\PluginFormInterface; use Drupal\Core\StringTranslation\StringTranslationTrait; use Drupal\Core\Url; use Drupal\layout_builder\Context\LayoutBuilderContextTrait; use Drupal\layout_builder\LayoutTempstoreRepositoryInterface; +use Drupal\layout_builder\OverridesSectionStorageInterface; use Drupal\layout_builder\Section; use Drupal\layout_builder\SectionStorageInterface; use Symfony\Component\DependencyInjection\ContainerInterface; @@ -30,14 +32,24 @@ class LayoutBuilderController implements ContainerInjectionInterface { */ protected $layoutTempstoreRepository; + /** + * The messenger service. + * + * @var \Drupal\Core\Messenger\MessengerInterface + */ + protected $messenger; + /** * LayoutBuilderController constructor. * * @param \Drupal\layout_builder\LayoutTempstoreRepositoryInterface $layout_tempstore_repository * The layout tempstore repository. + * @param \Drupal\Core\Messenger\MessengerInterface $messenger + * The messenger service. */ - public function __construct(LayoutTempstoreRepositoryInterface $layout_tempstore_repository) { + public function __construct(LayoutTempstoreRepositoryInterface $layout_tempstore_repository, MessengerInterface $messenger) { $this->layoutTempstoreRepository = $layout_tempstore_repository; + $this->messenger = $messenger; } /** @@ -45,7 +57,8 @@ public function __construct(LayoutTempstoreRepositoryInterface $layout_tempstore */ public static function create(ContainerInterface $container) { return new static( - $container->get('layout_builder.tempstore_repository') + $container->get('layout_builder.tempstore_repository'), + $container->get('messenger') ); } @@ -101,9 +114,16 @@ public function layout(SectionStorageInterface $section_storage, $is_rebuilding * Indicates if the layout is rebuilding. */ protected function prepareLayout(SectionStorageInterface $section_storage, $is_rebuilding) { - // For a new layout, begin with a single section of one column. + // Only add sections if the layout is new and empty. if (!$is_rebuilding && $section_storage->count() === 0) { $sections = []; + // If this is an empty override, copy the sections from the corresponding + // default. + if ($section_storage instanceof OverridesSectionStorageInterface) { + $sections = $section_storage->getDefaultSectionStorage()->getSections(); + } + + // For an empty layout, begin with a single section of one column. if (!$sections) { $sections[] = new Section('layout_onecol'); } @@ -277,6 +297,14 @@ protected function buildAdministrativeSection(SectionStorageInterface $section_s public function saveLayout(SectionStorageInterface $section_storage) { $section_storage->save(); $this->layoutTempstoreRepository->delete($section_storage); + + if ($section_storage instanceof OverridesSectionStorageInterface) { + $this->messenger->addMessage($this->t('The layout override has been saved.')); + } + else { + $this->messenger->addMessage($this->t('The layout has been saved.')); + } + return new RedirectResponse($section_storage->getCanonicalUrl()->setAbsolute()->toString()); } @@ -291,7 +319,38 @@ public function saveLayout(SectionStorageInterface $section_storage) { */ public function cancelLayout(SectionStorageInterface $section_storage) { $this->layoutTempstoreRepository->delete($section_storage); + + $this->messenger->addMessage($this->t('The changes to the layout have been discarded.')); + return new RedirectResponse($section_storage->getCanonicalUrl()->setAbsolute()->toString()); } + /** + * Reverts the overridden layout to the defaults. + * + * @param \Drupal\layout_builder\SectionStorageInterface $section_storage + * The section storage. + * + * @return \Symfony\Component\HttpFoundation\RedirectResponse + * A redirect response. + */ + public function revertLayout(SectionStorageInterface $section_storage) { + if (!$section_storage instanceof OverridesSectionStorageInterface) { + throw new \InvalidArgumentException(sprintf('The section storage with type "%s" and ID "%s" does not provide overrides', $section_storage->getStorageType(), $section_storage->getStorageId())); + } + + // Remove all sections. + while ($section_storage->count()) { + $section_storage->removeSection(0); + } + $section_storage->save(); + $this->layoutTempstoreRepository->delete($section_storage); + + $this->messenger->addMessage($this->t('The layout has been reverted back to defaults.')); + + // @todo Decide if this is the correct URL to return in + // https://www.drupal.org/project/drupal/issues/2936501. + return new RedirectResponse($section_storage->getLayoutBuilderUrl()->setAbsolute()->toString()); + } + } diff --git a/core/modules/layout_builder/src/Entity/LayoutBuilderEntityViewDisplay.php b/core/modules/layout_builder/src/Entity/LayoutBuilderEntityViewDisplay.php new file mode 100644 index 0000000000..103431ba2f --- /dev/null +++ b/core/modules/layout_builder/src/Entity/LayoutBuilderEntityViewDisplay.php @@ -0,0 +1,277 @@ +getThirdPartySetting('layout_builder', 'allow_custom', FALSE); + } + + /** + * {@inheritdoc} + */ + public function setOverridable($overridable = TRUE) { + $this->setThirdPartySetting('layout_builder', 'allow_custom', $overridable); + return $this; + } + + /** + * {@inheritdoc} + */ + public function getSections() { + return $this->getThirdPartySetting('layout_builder', 'sections', []); + } + + /** + * {@inheritdoc} + */ + protected function setSections(array $sections) { + $this->setThirdPartySetting('layout_builder', 'sections', array_values($sections)); + return $this; + } + + /** + * {@inheritdoc} + */ + public function preSave(EntityStorageInterface $storage) { + parent::preSave($storage); + + $original_value = isset($this->original) ? $this->original->isOverridable() : FALSE; + $new_value = $this->isOverridable(); + if ($original_value !== $new_value) { + $entity_type_id = $this->getTargetEntityTypeId(); + $bundle = $this->getTargetBundle(); + + if ($new_value) { + $this->addSectionField($entity_type_id, $bundle, 'layout_builder__layout'); + } + elseif ($field = FieldConfig::loadByName($entity_type_id, $bundle, 'layout_builder__layout')) { + $field->delete(); + } + } + } + + /** + * Adds a layout section field to a given bundle. + * + * @param string $entity_type_id + * The entity type ID. + * @param string $bundle + * The bundle. + * @param string $field_name + * The name for the layout section field. + */ + protected function addSectionField($entity_type_id, $bundle, $field_name) { + $field = FieldConfig::loadByName($entity_type_id, $bundle, $field_name); + if (!$field) { + $field_storage = FieldStorageConfig::loadByName($entity_type_id, $field_name); + if (!$field_storage) { + $field_storage = FieldStorageConfig::create([ + 'entity_type' => $entity_type_id, + 'field_name' => $field_name, + 'type' => 'layout_section', + 'locked' => TRUE, + ]); + $field_storage->save(); + } + + $field = FieldConfig::create([ + 'field_storage' => $field_storage, + 'bundle' => $bundle, + 'label' => t('Layout'), + ]); + $field->save(); + } + } + + /** + * {@inheritdoc} + */ + protected function getDefaultRegion() { + if ($this->hasSection(0)) { + return $this->getSection(0)->getDefaultRegion(); + } + + return parent::getDefaultRegion(); + } + + /** + * Wraps the context repository service. + * + * @return \Drupal\Core\Plugin\Context\ContextRepositoryInterface + * The context repository service. + */ + protected function contextRepository() { + return \Drupal::service('context.repository'); + } + + /** + * {@inheritdoc} + */ + public function buildMultiple(array $entities) { + $build_list = parent::buildMultiple($entities); + + foreach ($entities as $id => $entity) { + $sections = $this->getRuntimeSections($entity); + if ($sections) { + foreach ($build_list[$id] as $name => $build_part) { + $field_definition = $this->getFieldDefinition($name); + if ($field_definition && $field_definition->isDisplayConfigurable($this->displayContext)) { + unset($build_list[$id][$name]); + } + } + + // Bypass ::getActiveContexts() in order to use the runtime entity, not + // a sample entity. + $contexts = $this->contextRepository()->getAvailableContexts(); + // @todo Use EntityContextDefinition after resolving + // https://www.drupal.org/node/2932462. + $contexts['layout_builder.entity'] = new Context(new ContextDefinition("entity:{$entity->getEntityTypeId()}", new TranslatableMarkup('@entity being viewed', ['@entity' => $entity->getEntityType()->getLabel()])), $entity); + foreach ($sections as $delta => $section) { + $build_list[$id]['_layout_builder'][$delta] = $section->toRenderArray($contexts); + } + } + } + + return $build_list; + } + + /** + * {@inheritdoc} + */ + public function getSampleEntity($entity_type_id, $bundle_id) { + /** @var \Drupal\Core\TempStore\SharedTempStore $tempstore */ + $tempstore = \Drupal::service('tempstore.shared')->get('layout_builder.sample_entity'); + if ($entity = $tempstore->get("$entity_type_id.$bundle_id")) { + return $entity; + } + + $entity_storage = $this->entityTypeManager()->getStorage($entity_type_id); + if (!$entity_storage instanceof ContentEntityStorageInterface) { + throw new \InvalidArgumentException(sprintf('The "%s" entity storage is not supported', $entity_type_id)); + } + + $entity = $entity_storage->createWithSampleValues($bundle_id); + // Mark the sample entity as being a preview. + $entity->in_preview = TRUE; + $tempstore->set("$entity_type_id.$bundle_id", $entity); + return $entity; + } + + /** + * Gets the runtime sections for a given entity. + * + * @param \Drupal\Core\Entity\FieldableEntityInterface $entity + * The entity. + * + * @return \Drupal\layout_builder\Section[] + * The sections. + */ + protected function getRuntimeSections(FieldableEntityInterface $entity) { + if ($this->isOverridable() && !$entity->get('layout_builder__layout')->isEmpty()) { + return $entity->get('layout_builder__layout')->getSections(); + } + + return $this->getSections(); + } + + /** + * {@inheritdoc} + */ + public function onDependencyRemoval(array $dependencies) { + $return = parent::onDependencyRemoval($dependencies); + foreach ($dependencies['config'] as $config_entity) { + if (!$config_entity instanceof FieldDefinitionInterface) { + continue; + } + + $id = 'field_block:' . $this->getTargetEntityTypeId() . ':' . $config_entity->getName(); + foreach ($this->getSections() as $delta => $section) { + foreach ($section->getComponents() as $uuid => $component) { + if ($component->getPluginId() === $id) { + $section->removeComponent($uuid); + $return = TRUE; + } + } + } + } + return $return; + } + + /** + * {@inheritdoc} + */ + public function setComponent($name, array $options = []) { + parent::setComponent($name, $options); + + // @todo Remove workaround for EntityViewBuilder::getSingleFieldDisplay() in + // https://www.drupal.org/project/drupal/issues/2936464. + if ($this->isNew()) { + return $this; + } + + // Retrieve the updated options after the parent:: call. + $options = $this->content[$name]; + // Provide backwards compatibility by converting to a section component. + $field_definition = $this->getFieldDefinition($name); + if ($field_definition && $field_definition->isDisplayConfigurable('view') && isset($options['type'])) { + $configuration = []; + $configuration['id'] = 'field_block:' . $this->getTargetEntityTypeId() . ':' . $name; + $configuration['label_display'] = FALSE; + $keys = array_flip(['type', 'label', 'settings', 'third_party_settings']); + $configuration['formatter'] = array_intersect_key($options, $keys); + $configuration['context_mapping']['entity'] = 'layout_builder.entity'; + + $section = $this->getDefaultSection(); + $region = isset($options['region']) ? $options['region'] : $section->getDefaultRegion(); + $new_component = (new SectionComponent(\Drupal::service('uuid')->generate(), $region, $configuration)); + $section->appendComponent($new_component); + } + return $this; + } + + /** + * Gets a default section. + * + * @return \Drupal\layout_builder\Section + * The default section. + */ + protected function getDefaultSection() { + // If no section exists, append a new one. + if (!$this->hasSection(0)) { + $this->appendSection(new Section('layout_onecol')); + } + + // Return the first section. + return $this->getSection(0); + } + +} diff --git a/core/modules/layout_builder/src/Entity/LayoutBuilderEntityViewDisplayStorage.php b/core/modules/layout_builder/src/Entity/LayoutBuilderEntityViewDisplayStorage.php new file mode 100644 index 0000000000..e86df9daf8 --- /dev/null +++ b/core/modules/layout_builder/src/Entity/LayoutBuilderEntityViewDisplayStorage.php @@ -0,0 +1,60 @@ +toArray(); + }, $record['third_party_settings']['layout_builder']['sections']); + } + return $record; + } + + /** + * {@inheritdoc} + */ + protected function mapFromStorageRecords(array $records) { + foreach ($records as $id => &$record) { + if (!empty($record['third_party_settings']['layout_builder']['sections'])) { + $sections = &$record['third_party_settings']['layout_builder']['sections']; + foreach ($sections as $section_delta => $section) { + $sections[$section_delta] = new Section( + $section['layout_id'], + $section['layout_settings'], + array_map(function (array $component) { + return (new SectionComponent( + $component['uuid'], + $component['region'], + $component['configuration'], + $component['additional'] + ))->setWeight($component['weight']); + }, $section['components']) + ); + } + } + } + return parent::mapFromStorageRecords($records); + } + +} diff --git a/core/modules/layout_builder/src/Entity/LayoutEntityDisplayInterface.php b/core/modules/layout_builder/src/Entity/LayoutEntityDisplayInterface.php new file mode 100644 index 0000000000..ac6dae2aea --- /dev/null +++ b/core/modules/layout_builder/src/Entity/LayoutEntityDisplayInterface.php @@ -0,0 +1,49 @@ +get($delta)) { - /** @var \Drupal\layout_builder\Plugin\Field\FieldType\LayoutSectionItem $item */ - $item = $this->createItem($delta); - $item->section = $section; - - $start = array_slice($this->list, 0, $delta); - $end = array_slice($this->list, $delta); - $this->list = array_merge($start, [$item], $end); - } - else { - $this->appendSection($section); - } - return $this; - } - - /** - * {@inheritdoc} - */ - public function appendSection(Section $section) { - $this->appendItem()->section = $section; - return $this; - } + use SectionStorageTrait; /** * {@inheritdoc} @@ -60,77 +32,18 @@ public function getSections() { /** * {@inheritdoc} */ - public function getSection($delta) { + protected function setSections(array $sections) { + $this->list = []; + $sections = array_values($sections); /** @var \Drupal\layout_builder\Plugin\Field\FieldType\LayoutSectionItem $item */ - if (!$item = $this->get($delta)) { - throw new \OutOfBoundsException(sprintf('Invalid delta "%s" for the "%s" entity', $delta, $this->getEntity()->label())); + foreach ($sections as $section) { + $item = $this->appendItem(); + $item->section = $section; } - return $item->section; - } - - /** - * {@inheritdoc} - */ - public function removeSection($delta) { - $this->removeItem($delta); return $this; } - /** - * {@inheritdoc} - */ - public function getContexts() { - $entity = $this->getEntity(); - // @todo Use EntityContextDefinition after resolving - // https://www.drupal.org/node/2932462. - $contexts['layout_builder.entity'] = new Context(new ContextDefinition("entity:{$entity->getEntityTypeId()}", new TranslatableMarkup('@entity being viewed', ['@entity' => $entity->getEntityType()->getLabel()])), $entity); - return $contexts; - } - - /** - * {@inheritdoc} - */ - public function getStorageType() { - return 'overrides'; - } - - /** - * {@inheritdoc} - */ - public function getStorageId() { - $entity = $this->getEntity(); - return $entity->getEntityTypeId() . ':' . $entity->id(); - } - - /** - * {@inheritdoc} - */ - public function label() { - return $this->getEntity()->label(); - } - - /** - * {@inheritdoc} - */ - public function save() { - return $this->getEntity()->save(); - } - - /** - * {@inheritdoc} - */ - public function getCanonicalUrl() { - return $this->getEntity()->toUrl('canonical'); - } - - /** - * {@inheritdoc} - */ - public function getLayoutBuilderUrl() { - return $this->getEntity()->toUrl('layout-builder'); - } - /** * {@inheritdoc} */ diff --git a/core/modules/layout_builder/src/Form/AddBlockForm.php b/core/modules/layout_builder/src/Form/AddBlockForm.php index 83effd6226..704d136ba9 100644 --- a/core/modules/layout_builder/src/Form/AddBlockForm.php +++ b/core/modules/layout_builder/src/Form/AddBlockForm.php @@ -2,8 +2,9 @@ namespace Drupal\layout_builder\Form; -use Drupal\layout_builder\Section; +use Drupal\Core\Form\FormStateInterface; use Drupal\layout_builder\SectionComponent; +use Drupal\layout_builder\SectionStorageInterface; /** * Provides a form to add a block. @@ -27,10 +28,32 @@ protected function submitLabel() { } /** - * {@inheritdoc} + * Builds the form for the block. + * + * @param array $form + * An associative array containing the structure of the form. + * @param \Drupal\Core\Form\FormStateInterface $form_state + * The current state of the form. + * @param \Drupal\layout_builder\SectionStorageInterface $section_storage + * The section storage being configured. + * @param int $delta + * The delta of the section. + * @param string $region + * The region of the block. + * @param string|null $plugin_id + * The plugin ID of the block to add. + * + * @return array + * The form array. */ - protected function submitBlock(Section $section, $region, $uuid, array $configuration) { - $section->appendComponent(new SectionComponent($uuid, $region, $configuration)); + public function buildForm(array $form, FormStateInterface $form_state, SectionStorageInterface $section_storage = NULL, $delta = NULL, $region = NULL, $plugin_id = NULL) { + // Only generate a new component once per form submission. + if (!$component = $form_state->getTemporaryValue('layout_builder__component')) { + $component = new SectionComponent($this->uuidGenerator->generate(), $region, ['id' => $plugin_id]); + $section_storage->getSection($delta)->appendComponent($component); + $form_state->setTemporaryValue('layout_builder__component', $component); + } + return $this->doBuildForm($form, $form_state, $section_storage, $delta, $component); } } diff --git a/core/modules/layout_builder/src/Form/ConfigureBlockFormBase.php b/core/modules/layout_builder/src/Form/ConfigureBlockFormBase.php index b75e88f083..e1103e9e44 100644 --- a/core/modules/layout_builder/src/Form/ConfigureBlockFormBase.php +++ b/core/modules/layout_builder/src/Form/ConfigureBlockFormBase.php @@ -17,7 +17,7 @@ use Drupal\layout_builder\Context\LayoutBuilderContextTrait; use Drupal\layout_builder\Controller\LayoutRebuildTrait; use Drupal\layout_builder\LayoutTempstoreRepositoryInterface; -use Drupal\layout_builder\Section; +use Drupal\layout_builder\SectionComponent; use Drupal\layout_builder\SectionStorageInterface; use Symfony\Component\DependencyInjection\ContainerInterface; @@ -59,7 +59,7 @@ * * @var \Drupal\Component\Uuid\UuidInterface */ - protected $uuid; + protected $uuidGenerator; /** * The plugin form manager. @@ -82,6 +82,13 @@ */ protected $region; + /** + * The UUID of the component. + * + * @var string + */ + protected $uuid; + /** * The section storage. * @@ -109,7 +116,7 @@ public function __construct(LayoutTempstoreRepositoryInterface $layout_tempstore $this->layoutTempstoreRepository = $layout_tempstore_repository; $this->contextRepository = $context_repository; $this->blockManager = $block_manager; - $this->uuid = $uuid; + $this->uuidGenerator = $uuid; $this->classResolver = $class_resolver; $this->pluginFormFactory = $plugin_form_manager; } @@ -128,25 +135,6 @@ public static function create(ContainerInterface $container) { ); } - /** - * Prepares the block plugin based on the block ID. - * - * @param string $block_id - * Either a block ID, or the plugin ID used to create a new block. - * @param array $configuration - * The block configuration. - * - * @return \Drupal\Core\Block\BlockPluginInterface - * The block plugin. - */ - protected function prepareBlock($block_id, array $configuration) { - if (!isset($configuration['uuid'])) { - $configuration['uuid'] = $this->uuid->generate(); - } - - return $this->blockManager->createInstance($block_id, $configuration); - } - /** * Builds the form for the block. * @@ -158,21 +146,17 @@ protected function prepareBlock($block_id, array $configuration) { * The section storage being configured. * @param int $delta * The delta of the section. - * @param string $region - * The region of the block. - * @param string|null $plugin_id - * The plugin ID of the block to add. - * @param array $configuration - * (optional) The array of configuration for the block. + * @param \Drupal\layout_builder\SectionComponent $component + * The section component containing the block. * * @return array * The form array. */ - public function buildForm(array $form, FormStateInterface $form_state, SectionStorageInterface $section_storage = NULL, $delta = NULL, $region = NULL, $plugin_id = NULL, array $configuration = []) { + public function doBuildForm(array $form, FormStateInterface $form_state, SectionStorageInterface $section_storage = NULL, $delta = NULL, SectionComponent $component = NULL) { $this->sectionStorage = $section_storage; $this->delta = $delta; - $this->region = $region; - $this->block = $this->prepareBlock($plugin_id, $configuration); + $this->uuid = $component->getUuid(); + $this->block = $component->getPlugin(); $form_state->setTemporaryValue('gathered_contexts', $this->getAvailableContexts($section_storage)); @@ -204,20 +188,6 @@ public function buildForm(array $form, FormStateInterface $form_state, SectionSt */ abstract protected function submitLabel(); - /** - * Handles the submission of a block. - * - * @param \Drupal\layout_builder\Section $section - * The layout section. - * @param string $region - * The region name. - * @param string $uuid - * The UUID of the block. - * @param array $configuration - * The block configuration. - */ - abstract protected function submitBlock(Section $section, $region, $uuid, array $configuration); - /** * {@inheritdoc} */ @@ -242,7 +212,7 @@ public function submitForm(array &$form, FormStateInterface $form_state) { $configuration = $this->block->getConfiguration(); $section = $this->sectionStorage->getSection($this->delta); - $this->submitBlock($section, $this->region, $configuration['uuid'], $configuration); + $section->getComponent($this->uuid)->setConfiguration($configuration); $this->layoutTempstoreRepository->set($this->sectionStorage); $form_state->setRedirectUrl($this->sectionStorage->getLayoutBuilderUrl()); diff --git a/core/modules/layout_builder/src/Form/LayoutBuilderEntityViewDisplayForm.php b/core/modules/layout_builder/src/Form/LayoutBuilderEntityViewDisplayForm.php new file mode 100644 index 0000000000..32b378681b --- /dev/null +++ b/core/modules/layout_builder/src/Form/LayoutBuilderEntityViewDisplayForm.php @@ -0,0 +1,110 @@ +sectionStorage = $section_storage; + return parent::buildForm($form, $form_state); + } + + /** + * {@inheritdoc} + */ + public function form(array $form, FormStateInterface $form_state) { + $form = parent::form($form, $form_state); + + // Hide the table of fields. + $form['fields']['#access'] = FALSE; + $form['#fields'] = []; + $form['#extra'] = []; + + $form['manage_layout'] = [ + '#type' => 'link', + '#title' => $this->t('Manage layout'), + '#weight' => -10, + '#attributes' => ['class' => ['button']], + '#url' => $this->sectionStorage->getLayoutBuilderUrl(), + ]; + + // @todo Expand to work for all view modes in + // https://www.drupal.org/node/2907413. + if ($this->entity->getMode() === 'default') { + $form['layout'] = [ + '#type' => 'details', + '#open' => TRUE, + '#title' => $this->t('Layout options'), + '#tree' => TRUE, + ]; + + $entity_type = $this->entityTypeManager->getDefinition($this->entity->getTargetEntityTypeId()); + // @todo Unchecking this box is a destructive action, this should be made + // clear to the user in https://www.drupal.org/node/2914484. + $form['layout']['allow_custom'] = [ + '#type' => 'checkbox', + '#title' => $this->t('Allow each @entity to have its layout customized.', [ + '@entity' => $entity_type->getSingularLabel(), + ]), + '#default_value' => $this->entity->isOverridable(), + ]; + + $form['#entity_builders'][] = '::entityFormEntityBuild'; + } + return $form; + } + + /** + * Entity builder for layout options on the entity view display form. + */ + public function entityFormEntityBuild($entity_type_id, LayoutEntityDisplayInterface $display, &$form, FormStateInterface &$form_state) { + $new_value = (bool) $form_state->getValue(['layout', 'allow_custom'], FALSE); + $display->setOverridable($new_value); + } + + /** + * {@inheritdoc} + */ + protected function buildFieldRow(FieldDefinitionInterface $field_definition, array $form, FormStateInterface $form_state) { + // Intentionally empty. + } + + /** + * {@inheritdoc} + */ + protected function buildExtraFieldRow($field_id, $extra_field) { + // Intentionally empty. + } + +} diff --git a/core/modules/layout_builder/src/Form/UpdateBlockForm.php b/core/modules/layout_builder/src/Form/UpdateBlockForm.php index afca0d25c9..c00b406eb2 100644 --- a/core/modules/layout_builder/src/Form/UpdateBlockForm.php +++ b/core/modules/layout_builder/src/Form/UpdateBlockForm.php @@ -2,9 +2,7 @@ namespace Drupal\layout_builder\Form; -use Drupal\Component\Plugin\ConfigurablePluginInterface; use Drupal\Core\Form\FormStateInterface; -use Drupal\layout_builder\Section; use Drupal\layout_builder\SectionStorageInterface; /** @@ -36,19 +34,13 @@ public function getFormId() { * The region of the block. * @param string $uuid * The UUID of the block being updated. - * @param array $configuration - * (optional) The array of configuration for the block. * * @return array * The form array. */ - public function buildForm(array $form, FormStateInterface $form_state, SectionStorageInterface $section_storage = NULL, $delta = NULL, $region = NULL, $uuid = NULL, array $configuration = []) { - $plugin = $section_storage->getSection($delta)->getComponent($uuid)->getPlugin(); - if ($plugin instanceof ConfigurablePluginInterface) { - $configuration = $plugin->getConfiguration(); - } - - return parent::buildForm($form, $form_state, $section_storage, $delta, $region, $plugin->getPluginId(), $configuration); + public function buildForm(array $form, FormStateInterface $form_state, SectionStorageInterface $section_storage = NULL, $delta = NULL, $region = NULL, $uuid = NULL) { + $component = $section_storage->getSection($delta)->getComponent($uuid); + return $this->doBuildForm($form, $form_state, $section_storage, $delta, $component); } /** @@ -58,11 +50,4 @@ protected function submitLabel() { return $this->t('Update'); } - /** - * {@inheritdoc} - */ - protected function submitBlock(Section $section, $region, $uuid, array $configuration) { - $section->getComponent($uuid)->setConfiguration($configuration); - } - } diff --git a/core/modules/layout_builder/src/LayoutTempstoreRepository.php b/core/modules/layout_builder/src/LayoutTempstoreRepository.php index 0fa9d738bf..39725afc7e 100644 --- a/core/modules/layout_builder/src/LayoutTempstoreRepository.php +++ b/core/modules/layout_builder/src/LayoutTempstoreRepository.php @@ -71,7 +71,7 @@ public function delete(SectionStorageInterface $section_storage) { * The tempstore. */ protected function getTempstore(SectionStorageInterface $section_storage) { - $collection = 'layout_builder.' . $section_storage->getStorageType(); + $collection = 'layout_builder.section_storage.' . $section_storage->getStorageType(); return $this->tempStoreFactory->get($collection); } diff --git a/core/modules/layout_builder/src/OverridesSectionStorageInterface.php b/core/modules/layout_builder/src/OverridesSectionStorageInterface.php new file mode 100644 index 0000000000..0d6fd2b056 --- /dev/null +++ b/core/modules/layout_builder/src/OverridesSectionStorageInterface.php @@ -0,0 +1,26 @@ +getConfiguration()['formatter']; - $build = $this->getEntity()->get($this->fieldName)->view($display_settings); + $entity = $this->getEntity(); + $build = $entity->get($this->fieldName)->view($display_settings); + if (!empty($entity->in_preview) && !Element::getVisibleChildren($build)) { + $build['content']['#markup'] = new TranslatableMarkup('Placeholder for the "@field" field', ['@field' => $this->getFieldDefinition()->getLabel()]); + } CacheableMetadata::createFromObject($this)->applyTo($build); return $build; } diff --git a/core/modules/layout_builder/src/Plugin/Derivative/LayoutBuilderLocalTaskDeriver.php b/core/modules/layout_builder/src/Plugin/Derivative/LayoutBuilderLocalTaskDeriver.php index 0aacc0d052..76f6ce3646 100644 --- a/core/modules/layout_builder/src/Plugin/Derivative/LayoutBuilderLocalTaskDeriver.php +++ b/core/modules/layout_builder/src/Plugin/Derivative/LayoutBuilderLocalTaskDeriver.php @@ -12,6 +12,8 @@ /** * Provides local task definitions for the layout builder user interface. * + * @todo Remove this in https://www.drupal.org/project/drupal/issues/2936655. + * * @internal */ class LayoutBuilderLocalTaskDeriver extends DeriverBase implements ContainerDeriverInterface { @@ -48,30 +50,53 @@ public static function create(ContainerInterface $container, $base_plugin_id) { * {@inheritdoc} */ public function getDerivativeDefinitions($base_plugin_definition) { - foreach (array_keys($this->getEntityTypes()) as $entity_type_id) { - $this->derivatives["entity.$entity_type_id.layout_builder"] = $base_plugin_definition + [ - 'route_name' => "entity.$entity_type_id.layout_builder", + foreach ($this->getEntityTypes() as $entity_type_id => $entity_type) { + // Overrides. + $this->derivatives["layout_builder.overrides.$entity_type_id.view"] = $base_plugin_definition + [ + 'route_name' => "layout_builder.overrides.$entity_type_id.view", 'weight' => 15, 'title' => $this->t('Layout'), 'base_route' => "entity.$entity_type_id.canonical", - 'entity_type_id' => $entity_type_id, 'cache_contexts' => ['layout_builder_is_active:' . $entity_type_id], ]; - $this->derivatives["entity.$entity_type_id.layout_builder_save"] = $base_plugin_definition + [ - 'route_name' => "entity.$entity_type_id.layout_builder_save", + $this->derivatives["layout_builder.overrides.$entity_type_id.save"] = $base_plugin_definition + [ + 'route_name' => "layout_builder.overrides.$entity_type_id.save", 'title' => $this->t('Save Layout'), - 'parent_id' => "layout_builder_ui:entity.$entity_type_id.layout_builder", - 'entity_type_id' => $entity_type_id, + 'parent_id' => "layout_builder_ui:layout_builder.overrides.$entity_type_id.view", 'cache_contexts' => ['layout_builder_is_active:' . $entity_type_id], ]; - $this->derivatives["entity.$entity_type_id.layout_builder_cancel"] = $base_plugin_definition + [ - 'route_name' => "entity.$entity_type_id.layout_builder_cancel", + $this->derivatives["layout_builder.overrides.$entity_type_id.cancel"] = $base_plugin_definition + [ + 'route_name' => "layout_builder.overrides.$entity_type_id.cancel", 'title' => $this->t('Cancel Layout'), - 'parent_id' => "layout_builder_ui:entity.$entity_type_id.layout_builder", - 'entity_type_id' => $entity_type_id, + 'parent_id' => "layout_builder_ui:layout_builder.overrides.$entity_type_id.view", 'weight' => 5, 'cache_contexts' => ['layout_builder_is_active:' . $entity_type_id], ]; + $this->derivatives["layout_builder.overrides.$entity_type_id.revert"] = $base_plugin_definition + [ + 'route_name' => "layout_builder.overrides.$entity_type_id.revert", + 'title' => $this->t('Revert to defaults'), + 'parent_id' => "layout_builder_ui:layout_builder.overrides.$entity_type_id.view", + 'weight' => 10, + 'cache_contexts' => ['layout_builder_is_active:' . $entity_type_id], + ]; + + // Defaults. + $this->derivatives["layout_builder.defaults.$entity_type_id.view"] = $base_plugin_definition + [ + 'route_name' => "layout_builder.defaults.$entity_type_id.view", + 'title' => $this->t('Manage layout'), + 'base_route' => "layout_builder.defaults.$entity_type_id.view", + ]; + $this->derivatives["layout_builder.defaults.$entity_type_id.save"] = $base_plugin_definition + [ + 'route_name' => "layout_builder.defaults.$entity_type_id.save", + 'title' => $this->t('Save Layout'), + 'parent_id' => "layout_builder_ui:layout_builder.defaults.$entity_type_id.view", + ]; + $this->derivatives["layout_builder.defaults.$entity_type_id.cancel"] = $base_plugin_definition + [ + 'route_name' => "layout_builder.defaults.$entity_type_id.cancel", + 'title' => $this->t('Cancel Layout'), + 'weight' => 5, + 'parent_id' => "layout_builder_ui:layout_builder.defaults.$entity_type_id.view", + ]; } return $this->derivatives; diff --git a/core/modules/layout_builder/src/Plugin/SectionStorage/DefaultsSectionStorage.php b/core/modules/layout_builder/src/Plugin/SectionStorage/DefaultsSectionStorage.php new file mode 100644 index 0000000000..c53211a29c --- /dev/null +++ b/core/modules/layout_builder/src/Plugin/SectionStorage/DefaultsSectionStorage.php @@ -0,0 +1,264 @@ +entityTypeManager = $entity_type_manager; + $this->entityTypeBundleInfo = $entity_type_bundle_info; + } + + /** + * {@inheritdoc} + */ + public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) { + return new static( + $configuration, + $plugin_id, + $plugin_definition, + $container->get('entity_type.manager'), + $container->get('entity_type.bundle.info') + ); + } + + /** + * {@inheritdoc} + */ + public function setSectionList(SectionListInterface $section_list) { + if (!$section_list instanceof LayoutEntityDisplayInterface) { + throw new \InvalidArgumentException('Defaults expect a display-based section list'); + } + + return parent::setSectionList($section_list); + } + + /** + * Gets the entity storing the overrides. + * + * @return \Drupal\layout_builder\Entity\LayoutEntityDisplayInterface + * The entity storing the defaults. + */ + protected function getDisplay() { + return $this->sectionList; + } + + /** + * {@inheritdoc} + */ + public function getStorageId() { + return $this->getDisplay()->id(); + } + + /** + * {@inheritdoc} + */ + public function getCanonicalUrl() { + return Url::fromRoute("entity.entity_view_display.{$this->getDisplay()->getTargetEntityTypeId()}.view_mode", $this->getRouteParameters()); + } + + /** + * {@inheritdoc} + */ + public function getLayoutBuilderUrl() { + return Url::fromRoute("layout_builder.{$this->getStorageType()}.{$this->getDisplay()->getTargetEntityTypeId()}.view", $this->getRouteParameters()); + } + + /** + * {@inheritdoc} + */ + protected function getRouteParameters() { + $route_parameters = []; + + $display = $this->getDisplay(); + $entity_type = $this->entityTypeManager->getDefinition($display->getTargetEntityTypeId()); + $bundle_parameter_key = $entity_type->getBundleEntityType() ?: 'bundle'; + $route_parameters[$bundle_parameter_key] = $display->getTargetBundle(); + + $route_parameters['view_mode_name'] = $display->getMode(); + return $route_parameters; + } + + /** + * {@inheritdoc} + */ + public function alterRoutes(RouteCollection $collection) { + foreach ($this->getEntityTypes() as $entity_type_id => $entity_type) { + // Try to get the route from the current collection. + if (!$entity_route = $collection->get($entity_type->get('field_ui_base_route'))) { + continue; + } + + $path = $entity_route->getPath() . '/display-layout/{view_mode_name}'; + + $defaults = []; + $defaults['entity_type_id'] = $entity_type_id; + // If the entity type has no bundles and it doesn't use {bundle} in its + // admin path, use the entity type. + if (strpos($path, '{bundle}') === FALSE) { + if (!$entity_type->hasKey('bundle')) { + $defaults['bundle'] = $entity_type_id; + } + else { + $defaults['bundle_key'] = $entity_type->getBundleEntityType(); + } + } + + $requirements = []; + $requirements['_field_ui_view_mode_access'] = 'administer ' . $entity_type_id . ' display'; + + $options = $entity_route->getOptions(); + $options['_admin_route'] = FALSE; + + $this->buildRoute($collection, $this->getPluginDefinition(), $entity_type_id, $path, $defaults, $requirements, $options); + + $route_names = [ + "entity.entity_view_display.{$entity_type_id}.default", + "entity.entity_view_display.{$entity_type_id}.view_mode", + ]; + foreach ($route_names as $route_name) { + if (!$route = $collection->get($route_name)) { + continue; + } + + $route->addDefaults([ + 'section_storage_type' => $this->getStorageType(), + 'section_storage' => '', + ] + $defaults); + $parameters['section_storage']['layout_builder_tempstore'] = TRUE; + $parameters = NestedArray::mergeDeep($parameters, $route->getOption('parameters') ?: []); + $route->setOption('parameters', $parameters); + } + } + } + + /** + * Returns an array of relevant entity types. + * + * @return \Drupal\Core\Entity\EntityTypeInterface[] + * An array of entity types. + */ + protected function getEntityTypes() { + return array_filter($this->entityTypeManager->getDefinitions(), function (EntityTypeInterface $entity_type) { + return $entity_type->hasLinkTemplate('layout-builder') && $entity_type->get('field_ui_base_route'); + }); + } + + /** + * {@inheritdoc} + */ + public function convert($value, $definition, $name, array $defaults) { + if (!$value) { + // If a bundle is not provided but a value corresponding to the bundle key + // is, use that for the bundle value. + if (empty($defaults['bundle']) && isset($defaults['bundle_key']) && !empty($defaults[$defaults['bundle_key']])) { + $defaults['bundle'] = $defaults[$defaults['bundle_key']]; + } + + if (empty($defaults['entity_type_id']) && empty($defaults['bundle']) && empty($defaults['view_mode_name'])) { + return NULL; + } + + $value = $defaults['entity_type_id'] . '.' . $defaults['bundle'] . '.' . $defaults['view_mode_name']; + } + + $storage = $this->entityTypeManager->getStorage('entity_view_display'); + // If the display does not exist, create a new one. + if (!$display = $storage->load($value)) { + list($entity_type_id, $bundle, $view_mode) = explode('.', $value); + $display = $storage->create([ + 'targetEntityType' => $entity_type_id, + 'bundle' => $bundle, + 'mode' => $view_mode, + 'status' => TRUE, + ]); + } + return $display; + } + + /** + * {@inheritdoc} + */ + public function getContexts() { + $display = $this->getDisplay(); + $entity = $display->getSampleEntity($display->getTargetEntityTypeId(), $display->getTargetBundle()); + $context_label = new TranslatableMarkup('@entity being viewed', ['@entity' => $entity->getEntityType()->getLabel()]); + + // @todo Use EntityContextDefinition after resolving + // https://www.drupal.org/node/2932462. + $contexts = []; + $contexts['layout_builder.entity'] = new Context(new ContextDefinition("entity:{$entity->getEntityTypeId()}", $context_label), $entity); + return $contexts; + } + + /** + * {@inheritdoc} + */ + public function label() { + $display = $this->getDisplay(); + $bundle_info = $this->entityTypeBundleInfo->getBundleInfo($display->getTargetEntityTypeId()); + $bundle_label = $bundle_info[$display->getTargetBundle()]['label']; + $target_entity_type = $this->entityTypeManager->getDefinition($display->getTargetEntityTypeId()); + return new TranslatableMarkup('@bundle @label', ['@bundle' => $bundle_label, '@label' => $target_entity_type->getPluralLabel()]); + } + + /** + * {@inheritdoc} + */ + public function save() { + return $this->getDisplay()->save(); + } + +} diff --git a/core/modules/layout_builder/src/Plugin/SectionStorage/OverridesSectionStorage.php b/core/modules/layout_builder/src/Plugin/SectionStorage/OverridesSectionStorage.php new file mode 100644 index 0000000000..82d7aa2a6e --- /dev/null +++ b/core/modules/layout_builder/src/Plugin/SectionStorage/OverridesSectionStorage.php @@ -0,0 +1,234 @@ +entityTypeManager = $entity_type_manager; + $this->entityFieldManager = $entity_field_manager; + } + + /** + * {@inheritdoc} + */ + public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) { + return new static( + $configuration, + $plugin_id, + $plugin_definition, + $container->get('entity_type.manager'), + $container->get('entity_field.manager') + ); + } + + /** + * {@inheritdoc} + */ + public function setSectionList(SectionListInterface $section_list) { + if (!$section_list instanceof FieldItemListInterface) { + throw new \InvalidArgumentException('Overrides expect a field-based section list'); + } + + return parent::setSectionList($section_list); + } + + /** + * Gets the entity storing the overrides. + * + * @return \Drupal\Core\Entity\FieldableEntityInterface + * The entity storing the overrides. + */ + protected function getEntity() { + return $this->sectionList->getEntity(); + } + + /** + * {@inheritdoc} + */ + public function getStorageId() { + $entity = $this->getEntity(); + return $entity->getEntityTypeId() . ':' . $entity->id(); + } + + /** + * {@inheritdoc} + */ + public function convert($value, $definition, $name, array $defaults) { + if (strpos($value, ':') !== FALSE) { + list($entity_type_id, $entity_id) = explode(':', $value); + } + elseif (isset($defaults['entity_type_id']) && !empty($defaults[$defaults['entity_type_id']])) { + $entity_type_id = $defaults['entity_type_id']; + $entity_id = $defaults[$entity_type_id]; + } + else { + return NULL; + } + + $entity = $this->entityTypeManager->getStorage($entity_type_id)->load($entity_id); + if ($entity instanceof FieldableEntityInterface && $entity->hasField('layout_builder__layout')) { + return $entity->get('layout_builder__layout'); + } + } + + /** + * {@inheritdoc} + */ + public function alterRoutes(RouteCollection $collection) { + foreach ($this->getEntityTypes() as $entity_type_id => $entity_type) { + $defaults = []; + $defaults['entity_type_id'] = $entity_type_id; + + $requirements = []; + if ($this->hasIntegerId($entity_type)) { + $requirements[$entity_type_id] = '\d+'; + } + + $options = []; + // Ensure that upcasting is run in the correct order. + $options['parameters']['section_storage'] = []; + $options['parameters'][$entity_type_id]['type'] = 'entity:' . $entity_type_id; + + $template = $entity_type->getLinkTemplate('layout-builder'); + $this->buildRoute($collection, $this->getPluginDefinition(), $entity_type_id, $template, $defaults, $requirements, $options); + } + } + + /** + * Determines if this entity type's ID is stored as an integer. + * + * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type + * An entity type. + * + * @return bool + * TRUE if this entity type's ID key is always an integer, FALSE otherwise. + */ + protected function hasIntegerId(EntityTypeInterface $entity_type) { + $field_storage_definitions = $this->entityFieldManager->getFieldStorageDefinitions($entity_type->id()); + return $field_storage_definitions[$entity_type->getKey('id')]->getType() === 'integer'; + } + + /** + * Returns an array of relevant entity types. + * + * @return \Drupal\Core\Entity\EntityTypeInterface[] + * An array of entity types. + */ + protected function getEntityTypes() { + return array_filter($this->entityTypeManager->getDefinitions(), function (EntityTypeInterface $entity_type) { + return $entity_type->hasLinkTemplate('layout-builder'); + }); + } + + /** + * {@inheritdoc} + */ + public function getDefaultSectionStorage() { + return LayoutBuilderEntityViewDisplay::collectRenderDisplay($this->getEntity(), 'default'); + } + + /** + * {@inheritdoc} + */ + public function getCanonicalUrl() { + return $this->getEntity()->toUrl('canonical'); + } + + /** + * {@inheritdoc} + */ + public function getLayoutBuilderUrl() { + return Url::fromRoute("layout_builder.{$this->getStorageType()}.{$this->getEntity()->getEntityTypeId()}.view", $this->getRouteParameters()); + } + + /** + * {@inheritdoc} + */ + protected function getRouteParameters() { + $route_parameters = []; + $entity = $this->getEntity(); + $route_parameters[$entity->getEntityTypeId()] = $entity->id(); + return $route_parameters; + } + + /** + * {@inheritdoc} + */ + public function getContexts() { + $entity = $this->getEntity(); + // @todo Use EntityContextDefinition after resolving + // https://www.drupal.org/node/2932462. + $contexts['layout_builder.entity'] = new Context(new ContextDefinition("entity:{$entity->getEntityTypeId()}", new TranslatableMarkup('@entity being viewed', ['@entity' => $entity->getEntityType()->getLabel()])), $entity); + return $contexts; + } + + /** + * {@inheritdoc} + */ + public function label() { + return $this->getEntity()->label(); + } + + /** + * {@inheritdoc} + */ + public function save() { + return $this->getEntity()->save(); + } + +} diff --git a/core/modules/layout_builder/src/Plugin/SectionStorage/SectionStorageBase.php b/core/modules/layout_builder/src/Plugin/SectionStorage/SectionStorageBase.php new file mode 100644 index 0000000000..4f71279a7d --- /dev/null +++ b/core/modules/layout_builder/src/Plugin/SectionStorage/SectionStorageBase.php @@ -0,0 +1,90 @@ +sectionList = $section_list; + return $this; + } + + /** + * {@inheritdoc} + */ + public function getStorageType() { + return $this->getPluginId(); + } + + /** + * {@inheritdoc} + */ + public function count() { + return $this->sectionList->count(); + } + + /** + * {@inheritdoc} + */ + public function getSections() { + return $this->sectionList->getSections(); + } + + /** + * {@inheritdoc} + */ + public function getSection($delta) { + return $this->sectionList->getSection($delta); + } + + /** + * {@inheritdoc} + */ + public function appendSection(Section $section) { + $this->sectionList->appendSection($section); + return $this; + } + + /** + * {@inheritdoc} + */ + public function insertSection($delta, Section $section) { + $this->sectionList->insertSection($delta, $section); + return $this; + } + + /** + * {@inheritdoc} + */ + public function removeSection($delta) { + $this->sectionList->removeSection($delta); + return $this; + } + +} diff --git a/core/modules/layout_builder/src/Routing/LayoutBuilderRoutes.php b/core/modules/layout_builder/src/Routing/LayoutBuilderRoutes.php index 563021ed57..fae21a9f9e 100644 --- a/core/modules/layout_builder/src/Routing/LayoutBuilderRoutes.php +++ b/core/modules/layout_builder/src/Routing/LayoutBuilderRoutes.php @@ -2,156 +2,55 @@ namespace Drupal\layout_builder\Routing; -use Drupal\Core\Entity\EntityFieldManagerInterface; -use Drupal\Core\Entity\EntityTypeInterface; -use Drupal\Core\Entity\EntityTypeManagerInterface; -use Symfony\Component\Routing\Route; +use Drupal\Core\Routing\RouteBuildEvent; +use Drupal\Core\Routing\RoutingEvents; +use Drupal\layout_builder\SectionStorage\SectionStorageManagerInterface; +use Symfony\Component\EventDispatcher\EventSubscriberInterface; /** * Provides routes for the Layout Builder UI. * * @internal */ -class LayoutBuilderRoutes { +class LayoutBuilderRoutes implements EventSubscriberInterface { /** - * The entity type manager. + * The section storage manager. * - * @var \Drupal\Core\Entity\EntityTypeManagerInterface + * @var \Drupal\layout_builder\SectionStorage\SectionStorageManagerInterface */ - protected $entityTypeManager; - - /** - * The entity field manager. - * - * @var \Drupal\Core\Entity\EntityFieldManagerInterface - */ - protected $entityFieldManager; + protected $sectionStorageManager; /** * Constructs a new LayoutBuilderRoutes. * - * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager - * The entity type manager. - * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager - * The entity field manager. + * @param \Drupal\layout_builder\SectionStorage\SectionStorageManagerInterface $section_storage_manager + * The section storage manager. */ - public function __construct(EntityTypeManagerInterface $entity_type_manager, EntityFieldManagerInterface $entity_field_manager) { - $this->entityTypeManager = $entity_type_manager; - $this->entityFieldManager = $entity_field_manager; + public function __construct(SectionStorageManagerInterface $section_storage_manager) { + $this->sectionStorageManager = $section_storage_manager; } /** - * Generates layout builder routes. + * Alters existing routes for a specific collection. * - * @return \Symfony\Component\Routing\Route[] - * An array of route objects. + * @param \Drupal\Core\Routing\RouteBuildEvent $event + * The route build event. */ - public function getRoutes() { - $routes = []; - - foreach ($this->getEntityTypes() as $entity_type_id => $entity_type) { - $defaults = []; - $defaults['entity_type_id'] = $entity_type_id; - - $requirements = []; - if ($this->hasIntegerId($entity_type)) { - $requirements[$entity_type_id] = '\d+'; - } - - $options = []; - $options['parameters']['section_storage']['layout_builder_tempstore'] = TRUE; - $options['parameters'][$entity_type_id]['type'] = 'entity:' . $entity_type_id; - - $template = $entity_type->getLinkTemplate('layout-builder'); - $routes += $this->buildRoute('overrides', 'entity.' . $entity_type_id, $template, $defaults, $requirements, $options); + public function onAlterRoutes(RouteBuildEvent $event) { + $collection = $event->getRouteCollection(); + foreach ($this->sectionStorageManager->getDefinitions() as $plugin_id => $definition) { + $this->sectionStorageManager->loadEmpty($plugin_id)->alterRoutes($collection); } - return $routes; } /** - * Builds the layout routes for the given values. - * - * @param string $type - * The section storage type. - * @param string $route_name_prefix - * The prefix to use for the route name. - * @param string $path - * The path patten for the routes. - * @param array $defaults - * An array of default parameter values. - * @param array $requirements - * An array of requirements for parameters. - * @param array $options - * An array of options. - * - * @return \Symfony\Component\Routing\Route[] - * An array of route objects. + * {@inheritdoc} */ - protected function buildRoute($type, $route_name_prefix, $path, array $defaults, array $requirements, array $options) { - $routes = []; - - $defaults['section_storage_type'] = $type; - // Provide an empty value to allow the section storage to be upcast. - $defaults['section_storage'] = ''; - // Trigger the layout builder access check. - $requirements['_has_layout_section'] = 'true'; - // Trigger the layout builder RouteEnhancer. - $options['_layout_builder'] = TRUE; - - $main_defaults = $defaults; - $main_defaults['is_rebuilding'] = FALSE; - $main_defaults['_controller'] = '\Drupal\layout_builder\Controller\LayoutBuilderController::layout'; - $main_defaults['_title_callback'] = '\Drupal\layout_builder\Controller\LayoutBuilderController::title'; - $route = (new Route($path)) - ->setDefaults($main_defaults) - ->setRequirements($requirements) - ->setOptions($options); - $routes["{$route_name_prefix}.layout_builder"] = $route; - - $save_defaults = $defaults; - $save_defaults['_controller'] = '\Drupal\layout_builder\Controller\LayoutBuilderController::saveLayout'; - $route = (new Route("$path/save")) - ->setDefaults($save_defaults) - ->setRequirements($requirements) - ->setOptions($options); - $routes["{$route_name_prefix}.layout_builder_save"] = $route; - - $cancel_defaults = $defaults; - $cancel_defaults['_controller'] = '\Drupal\layout_builder\Controller\LayoutBuilderController::cancelLayout'; - $route = (new Route("$path/cancel")) - ->setDefaults($cancel_defaults) - ->setRequirements($requirements) - ->setOptions($options); - $routes["{$route_name_prefix}.layout_builder_cancel"] = $route; - - return $routes; - } - - /** - * Determines if this entity type's ID is stored as an integer. - * - * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type - * An entity type. - * - * @return bool - * TRUE if this entity type's ID key is always an integer, FALSE otherwise. - */ - protected function hasIntegerId(EntityTypeInterface $entity_type) { - $field_storage_definitions = $this->entityFieldManager->getFieldStorageDefinitions($entity_type->id()); - return $field_storage_definitions[$entity_type->getKey('id')]->getType() === 'integer'; - } - - /** - * Returns an array of relevant entity types. - * - * @return \Drupal\Core\Entity\EntityTypeInterface[] - * An array of entity types. - */ - protected function getEntityTypes() { - return array_filter($this->entityTypeManager->getDefinitions(), function (EntityTypeInterface $entity_type) { - return $entity_type->hasLinkTemplate('layout-builder'); - }); + public static function getSubscribedEvents() { + // Run after \Drupal\field_ui\Routing\RouteSubscriber. + $events[RoutingEvents::ALTER] = ['onAlterRoutes', -110]; + return $events; } } diff --git a/core/modules/layout_builder/src/Routing/LayoutBuilderRoutesTrait.php b/core/modules/layout_builder/src/Routing/LayoutBuilderRoutesTrait.php new file mode 100644 index 0000000000..1ca24646f7 --- /dev/null +++ b/core/modules/layout_builder/src/Routing/LayoutBuilderRoutesTrait.php @@ -0,0 +1,90 @@ +id(); + $defaults['section_storage_type'] = $type; + // Provide an empty value to allow the section storage to be upcast. + $defaults['section_storage'] = ''; + // Trigger the layout builder access check. + $requirements['_has_layout_section'] = 'true'; + // Trigger the layout builder RouteEnhancer. + $options['_layout_builder'] = TRUE; + // Trigger the layout builder param converter. + $parameters['section_storage']['layout_builder_tempstore'] = TRUE; + // Merge the passed in options in after Layout Builder's parameters. + $options = NestedArray::mergeDeep(['parameters' => $parameters], $options); + + $main_defaults = $defaults; + $main_defaults['is_rebuilding'] = FALSE; + $main_defaults['_controller'] = '\Drupal\layout_builder\Controller\LayoutBuilderController::layout'; + $main_defaults['_title_callback'] = '\Drupal\layout_builder\Controller\LayoutBuilderController::title'; + $route = (new Route($path)) + ->setDefaults($main_defaults) + ->setRequirements($requirements) + ->setOptions($options); + $collection->add("layout_builder.$type.$route_name_prefix.view", $route); + + $save_defaults = $defaults; + $save_defaults['_controller'] = '\Drupal\layout_builder\Controller\LayoutBuilderController::saveLayout'; + $route = (new Route("$path/save")) + ->setDefaults($save_defaults) + ->setRequirements($requirements) + ->setOptions($options); + $collection->add("layout_builder.$type.$route_name_prefix.save", $route); + + $cancel_defaults = $defaults; + $cancel_defaults['_controller'] = '\Drupal\layout_builder\Controller\LayoutBuilderController::cancelLayout'; + $route = (new Route("$path/cancel")) + ->setDefaults($cancel_defaults) + ->setRequirements($requirements) + ->setOptions($options); + $collection->add("layout_builder.$type.$route_name_prefix.cancel", $route); + + if (is_subclass_of($definition->getClass(), OverridesSectionStorageInterface::class)) { + $revert_defaults = $defaults; + $revert_defaults['_controller'] = '\Drupal\layout_builder\Controller\LayoutBuilderController::revertLayout'; + $route = (new Route("$path/revert")) + ->setDefaults($revert_defaults) + ->setRequirements($requirements) + ->setOptions($options); + $collection->add("layout_builder.$type.$route_name_prefix.revert", $route); + } + } + +} diff --git a/core/modules/layout_builder/src/Routing/LayoutTempstoreParamConverter.php b/core/modules/layout_builder/src/Routing/LayoutTempstoreParamConverter.php index 228a786764..263b767f72 100644 --- a/core/modules/layout_builder/src/Routing/LayoutTempstoreParamConverter.php +++ b/core/modules/layout_builder/src/Routing/LayoutTempstoreParamConverter.php @@ -2,9 +2,9 @@ namespace Drupal\layout_builder\Routing; -use Drupal\Core\DependencyInjection\ClassResolverInterface; use Drupal\Core\ParamConverter\ParamConverterInterface; use Drupal\layout_builder\LayoutTempstoreRepositoryInterface; +use Drupal\layout_builder\SectionStorage\SectionStorageManagerInterface; use Symfony\Component\Routing\Route; /** @@ -22,59 +22,33 @@ class LayoutTempstoreParamConverter implements ParamConverterInterface { protected $layoutTempstoreRepository; /** - * The class resolver. + * The section storage manager. * - * @var \Drupal\Core\DependencyInjection\ClassResolverInterface + * @var \Drupal\layout_builder\SectionStorage\SectionStorageManagerInterface */ - protected $classResolver; + protected $sectionStorageManager; /** * Constructs a new LayoutTempstoreParamConverter. * * @param \Drupal\layout_builder\LayoutTempstoreRepositoryInterface $layout_tempstore_repository * The layout tempstore repository. - * @param \Drupal\Core\DependencyInjection\ClassResolverInterface $class_resolver - * The class resolver. + * @param \Drupal\layout_builder\SectionStorage\SectionStorageManagerInterface $section_storage_manager + * The section storage manager. */ - public function __construct(LayoutTempstoreRepositoryInterface $layout_tempstore_repository, ClassResolverInterface $class_resolver) { + public function __construct(LayoutTempstoreRepositoryInterface $layout_tempstore_repository, SectionStorageManagerInterface $section_storage_manager) { $this->layoutTempstoreRepository = $layout_tempstore_repository; - $this->classResolver = $class_resolver; + $this->sectionStorageManager = $section_storage_manager; } /** * {@inheritdoc} */ public function convert($value, $definition, $name, array $defaults) { - if ($converter = $this->getParamConverterFromDefaults($defaults)) { - if ($object = $converter->convert($value, $definition, $name, $defaults)) { - // Pass the result of the storage param converter through the - // tempstore repository. - return $this->layoutTempstoreRepository->get($object); - } - } - } - - /** - * Gets a param converter based on the provided defaults. - * - * @param array $defaults - * The route defaults array. - * - * @return \Drupal\layout_builder\Routing\SectionStorageParamConverterInterface|null - * A section storage param converter if found, NULL otherwise. - */ - protected function getParamConverterFromDefaults(array $defaults) { - // If a storage type was specified, get the corresponding param converter. - if (isset($defaults['section_storage_type'])) { - try { - $converter = $this->classResolver->getInstanceFromDefinition('layout_builder.section_storage_param_converter.' . $defaults['section_storage_type']); - } - catch (\InvalidArgumentException $e) { - $converter = NULL; - } - - if ($converter instanceof SectionStorageParamConverterInterface) { - return $converter; + if (isset($defaults['section_storage_type']) && $this->sectionStorageManager->hasDefinition($defaults['section_storage_type'])) { + if ($section_storage = $this->sectionStorageManager->loadFromRoute($defaults['section_storage_type'], $value, $definition, $name, $defaults)) { + // Pass the plugin through the tempstore repository. + return $this->layoutTempstoreRepository->get($section_storage); } } } diff --git a/core/modules/layout_builder/src/Routing/SectionStorageOverridesParamConverter.php b/core/modules/layout_builder/src/Routing/SectionStorageOverridesParamConverter.php deleted file mode 100644 index 8d8ae58059..0000000000 --- a/core/modules/layout_builder/src/Routing/SectionStorageOverridesParamConverter.php +++ /dev/null @@ -1,70 +0,0 @@ -getEntityIdFromDefaults($value, $defaults); - $entity_type_id = $this->getEntityTypeFromDefaults($definition, $name, $defaults); - if (!$entity_id || !$entity_type_id) { - return NULL; - } - - $entity = parent::convert($entity_id, $definition, $name, $defaults); - if ($entity instanceof FieldableEntityInterface && $entity->hasField('layout_builder__layout')) { - return $entity->get('layout_builder__layout'); - } - } - - /** - * Determines the entity ID given a parameter value and route defaults. - * - * @param string $value - * The parameter value. - * @param array $defaults - * The route defaults array. - * - * @return string|null - * The entity ID if it exists, NULL otherwise. - */ - protected function getEntityIdFromDefaults($value, array $defaults) { - $entity_id = NULL; - // Layout Builder routes will have this parameter in the form of - // 'entity_type_id:entity_id'. - if (strpos($value, ':') !== FALSE) { - list(, $entity_id) = explode(':', $value); - } - // Overridden routes have the entity ID available in the defaults. - elseif (isset($defaults['entity_type_id']) && !empty($defaults[$defaults['entity_type_id']])) { - $entity_id = $defaults[$defaults['entity_type_id']]; - } - return $entity_id; - } - - /** - * {@inheritdoc} - */ - protected function getEntityTypeFromDefaults($definition, $name, array $defaults) { - // Layout Builder routes will have this parameter in the form of - // 'entity_type_id:entity_id'. - if (isset($defaults[$name]) && strpos($defaults[$name], ':') !== FALSE) { - list($entity_type_id) = explode(':', $defaults[$name], 2); - return $entity_type_id; - } - // Overridden routes have the entity type ID available in the defaults. - elseif (isset($defaults['entity_type_id'])) { - return $defaults['entity_type_id']; - } - } - -} diff --git a/core/modules/layout_builder/src/Routing/SectionStorageParamConverterInterface.php b/core/modules/layout_builder/src/Routing/SectionStorageParamConverterInterface.php deleted file mode 100644 index 955b673513..0000000000 --- a/core/modules/layout_builder/src/Routing/SectionStorageParamConverterInterface.php +++ /dev/null @@ -1,34 +0,0 @@ -layoutPluginManager()->getDefinition($this->getLayoutId())->getDefaultRegion(); + } + /** * Returns the components of the section. * @@ -307,4 +317,23 @@ protected function layoutPluginManager() { return \Drupal::service('plugin.manager.core.layout'); } + /** + * Returns an array representation of the section. + * + * @internal + * This is intended for use by a storage mechanism for sections. + * + * @return array + * An array representation of the section component. + */ + public function toArray() { + return [ + 'layout_id' => $this->getLayoutId(), + 'layout_settings' => $this->getLayoutSettings(), + 'components' => array_map(function (SectionComponent $component) { + return $component->toArray(); + }, $this->getComponents()), + ]; + } + } diff --git a/core/modules/layout_builder/src/SectionComponent.php b/core/modules/layout_builder/src/SectionComponent.php index 6a0c238c70..c7b46ef1c9 100644 --- a/core/modules/layout_builder/src/SectionComponent.php +++ b/core/modules/layout_builder/src/SectionComponent.php @@ -242,7 +242,7 @@ public function setConfiguration(array $configuration) { * @throws \Drupal\Component\Plugin\Exception\PluginException * Thrown if the plugin ID cannot be found. */ - protected function getPluginId() { + public function getPluginId() { if (empty($this->configuration['id'])) { throw new PluginException(sprintf('No plugin ID specified for component with "%s" UUID', $this->uuid)); } @@ -306,4 +306,23 @@ protected function currentUser() { return \Drupal::currentUser(); } + /** + * Returns an array representation of the section component. + * + * @internal + * This is intended for use by a storage mechanism for section components. + * + * @return array + * An array representation of the section component. + */ + public function toArray() { + return [ + 'uuid' => $this->getUuid(), + 'region' => $this->getRegion(), + 'configuration' => $this->getConfiguration(), + 'additional' => $this->additional, + 'weight' => $this->getWeight(), + ]; + } + } diff --git a/core/modules/layout_builder/src/SectionStorageInterface.php b/core/modules/layout_builder/src/SectionListInterface.php similarity index 54% copy from core/modules/layout_builder/src/SectionStorageInterface.php copy to core/modules/layout_builder/src/SectionListInterface.php index 13217d82b4..8df586a7aa 100644 --- a/core/modules/layout_builder/src/SectionStorageInterface.php +++ b/core/modules/layout_builder/src/SectionListInterface.php @@ -12,13 +12,13 @@ * * @see \Drupal\layout_builder\Section */ -interface SectionStorageInterface extends \Countable { +interface SectionListInterface extends \Countable { /** * Gets the layout sections. * * @return \Drupal\layout_builder\Section[] - * An array of sections. + * A sequentially and numerically keyed array of section objects. */ public function getSections(); @@ -61,6 +61,9 @@ public function insertSection($delta, Section $section); /** * Removes the section at the given delta. * + * As sections are stored sequentially and numerically this will re-key every + * subsequent section, shifting them forward. + * * @param int $delta * The delta of the section. * @@ -68,63 +71,4 @@ public function insertSection($delta, Section $section); */ public function removeSection($delta); - /** - * Provides any available contexts for the object using the sections. - * - * @return \Drupal\Core\Plugin\Context\ContextInterface[] - * The array of context objects. - */ - public function getContexts(); - - /** - * Returns an identifier for this storage. - * - * @return string - * The unique identifier for this storage. - */ - public function getStorageId(); - - /** - * Returns the type of this storage. - * - * Used in conjunction with the storage ID. - * - * @return string - * The type of storage. - */ - public function getStorageType(); - - /** - * Gets the label for the object using the sections. - * - * @return string - * The label, or NULL if there is no label defined. - */ - public function label(); - - /** - * Saves the sections. - * - * @return int - * SAVED_NEW or SAVED_UPDATED is returned depending on the operation - * performed. - */ - public function save(); - - /** - * Returns a URL for viewing the object using the sections. - * - * @return \Drupal\Core\Url - * The URL object. - */ - public function getCanonicalUrl(); - - /** - * Returns a URL to edit the sections in the Layout Builder UI. - * - * @return \Drupal\Core\Url - * The URL object. - */ - public function getLayoutBuilderUrl(); - } diff --git a/core/modules/layout_builder/src/SectionStorage/SectionStorageDefinition.php b/core/modules/layout_builder/src/SectionStorage/SectionStorageDefinition.php new file mode 100644 index 0000000000..61b975a471 --- /dev/null +++ b/core/modules/layout_builder/src/SectionStorage/SectionStorageDefinition.php @@ -0,0 +1,75 @@ + $value) { + $this->set($property, $value); + } + } + + /** + * Gets any arbitrary property. + * + * @param string $property + * The property to retrieve. + * + * @return mixed + * The value for that property, or NULL if the property does not exist. + */ + public function get($property) { + if (property_exists($this, $property)) { + $value = isset($this->{$property}) ? $this->{$property} : NULL; + } + else { + $value = isset($this->additional[$property]) ? $this->additional[$property] : NULL; + } + return $value; + } + + /** + * Sets a value to an arbitrary property. + * + * @param string $property + * The property to use for the value. + * @param mixed $value + * The value to set. + * + * @return $this + */ + public function set($property, $value) { + if (property_exists($this, $property)) { + $this->{$property} = $value; + } + else { + $this->additional[$property] = $value; + } + return $this; + } + +} diff --git a/core/modules/layout_builder/src/SectionStorage/SectionStorageManager.php b/core/modules/layout_builder/src/SectionStorage/SectionStorageManager.php new file mode 100644 index 0000000000..03c7401ca1 --- /dev/null +++ b/core/modules/layout_builder/src/SectionStorage/SectionStorageManager.php @@ -0,0 +1,64 @@ +alterInfo('layout_builder_section_storage'); + $this->setCacheBackend($cache_backend, 'layout_builder_section_storage_plugins'); + } + + /** + * {@inheritdoc} + */ + public function loadEmpty($id) { + return $this->createInstance($id); + } + + /** + * {@inheritdoc} + */ + public function loadFromObject($id, SectionListInterface $section_list) { + return $this->createInstance($id)->setSectionList($section_list); + } + + /** + * {@inheritdoc} + */ + public function loadFromRoute($id, $value, $definition, $name, array $defaults) { + $plugin = $this->createInstance($id); + if ($section_list = $plugin->convert($value, $definition, $name, $defaults)) { + return $plugin->setSectionList($section_list); + } + } + +} diff --git a/core/modules/layout_builder/src/SectionStorage/SectionStorageManagerInterface.php b/core/modules/layout_builder/src/SectionStorage/SectionStorageManagerInterface.php new file mode 100644 index 0000000000..732de503ff --- /dev/null +++ b/core/modules/layout_builder/src/SectionStorage/SectionStorageManagerInterface.php @@ -0,0 +1,63 @@ +getSections()); + } + + /** + * {@inheritdoc} + */ + public function getSection($delta) { + if (!$this->hasSection($delta)) { + throw new \OutOfBoundsException(sprintf('Invalid delta "%s"', $delta)); + } + + return $this->getSections()[$delta]; + } + + /** + * Sets the section for the given delta on the display. + * + * @param int $delta + * The delta of the section. + * @param \Drupal\layout_builder\Section $section + * The layout section. + * + * @return $this + */ + protected function setSection($delta, Section $section) { + $sections = $this->getSections(); + $sections[$delta] = $section; + $this->setSections($sections); + return $this; + } + + /** + * {@inheritdoc} + */ + public function appendSection(Section $section) { + $delta = $this->count(); + + $this->setSection($delta, $section); + return $this; + } + + /** + * {@inheritdoc} + */ + public function insertSection($delta, Section $section) { + if ($this->hasSection($delta)) { + // @todo Use https://www.drupal.org/node/66183 once resolved. + $start = array_slice($this->getSections(), 0, $delta); + $end = array_slice($this->getSections(), $delta); + $this->setSections(array_merge($start, [$section], $end)); + } + else { + $this->appendSection($section); + } + return $this; + } + + /** + * {@inheritdoc} + */ + public function removeSection($delta) { + $sections = $this->getSections(); + unset($sections[$delta]); + $this->setSections($sections); + return $this; + } + + /** + * Indicates if there is a section at the specified delta. + * + * @param int $delta + * The delta of the section. + * + * @return bool + * TRUE if there is a section for this delta, FALSE otherwise. + */ + protected function hasSection($delta) { + return isset($this->getSections()[$delta]); + } + +} diff --git a/core/modules/layout_builder/src/SectionStorageInterface.php b/core/modules/layout_builder/src/SectionStorageInterface.php index 13217d82b4..e3036f20c5 100644 --- a/core/modules/layout_builder/src/SectionStorageInterface.php +++ b/core/modules/layout_builder/src/SectionStorageInterface.php @@ -2,79 +2,18 @@ namespace Drupal\layout_builder; +use Drupal\Component\Plugin\PluginInspectionInterface; +use Symfony\Component\Routing\RouteCollection; + /** - * Defines the interface for an object that stores layout sections. + * Defines an interface for Section Storage type plugins. * * @internal * Layout Builder is currently experimental and should only be leveraged by * experimental modules and development releases of contributed modules. * See https://www.drupal.org/core/experimental for more information. - * - * @see \Drupal\layout_builder\Section */ -interface SectionStorageInterface extends \Countable { - - /** - * Gets the layout sections. - * - * @return \Drupal\layout_builder\Section[] - * An array of sections. - */ - public function getSections(); - - /** - * Gets a domain object for the layout section. - * - * @param int $delta - * The delta of the section. - * - * @return \Drupal\layout_builder\Section - * The layout section. - */ - public function getSection($delta); - - /** - * Appends a new section to the end of the list. - * - * @param \Drupal\layout_builder\Section $section - * The section to append. - * - * @return $this - */ - public function appendSection(Section $section); - - /** - * Inserts a new section at a given delta. - * - * If a section exists at the given index, the section at that position and - * others after it are shifted backward. - * - * @param int $delta - * The delta of the section. - * @param \Drupal\layout_builder\Section $section - * The section to insert. - * - * @return $this - */ - public function insertSection($delta, Section $section); - - /** - * Removes the section at the given delta. - * - * @param int $delta - * The delta of the section. - * - * @return $this - */ - public function removeSection($delta); - - /** - * Provides any available contexts for the object using the sections. - * - * @return \Drupal\Core\Plugin\Context\ContextInterface[] - * The array of context objects. - */ - public function getContexts(); +interface SectionStorageInterface extends SectionListInterface, PluginInspectionInterface { /** * Returns an identifier for this storage. @@ -94,6 +33,70 @@ public function getStorageId(); */ public function getStorageType(); + /** + * Sets the section list on the storage. + * + * @param \Drupal\layout_builder\SectionListInterface $section_list + * The section list. + * + * @return $this + * + * @internal + * This should only be called during section storage instantiation. + */ + public function setSectionList(SectionListInterface $section_list); + + /** + * Alters the route collection during route building. + * + * @param \Symfony\Component\Routing\RouteCollection $collection + * The route collection. + */ + public function alterRoutes(RouteCollection $collection); + + /** + * Returns a URL for viewing the object using the sections. + * + * @return \Drupal\Core\Url + * The URL object. + */ + public function getCanonicalUrl(); + + /** + * Returns a URL to edit the sections in the Layout Builder UI. + * + * @return \Drupal\Core\Url + * The URL object. + */ + public function getLayoutBuilderUrl(); + + /** + * Configures the plugin based on route values. + * + * @param mixed $value + * The raw value. + * @param mixed $definition + * The parameter definition provided in the route options. + * @param string $name + * The name of the parameter. + * @param array $defaults + * The route defaults array. + * + * @return \Drupal\layout_builder\SectionStorageInterface + * The section storage if it could be loaded, or NULL otherwise. + * + * @see \Drupal\Core\ParamConverter\ParamConverterInterface::convert() + */ + public function convert($value, $definition, $name, array $defaults); + + /** + * Provides any available contexts for the object using the sections. + * + * @return \Drupal\Core\Plugin\Context\ContextInterface[] + * The array of context objects. + */ + public function getContexts(); + /** * Gets the label for the object using the sections. * @@ -111,20 +114,4 @@ public function label(); */ public function save(); - /** - * Returns a URL for viewing the object using the sections. - * - * @return \Drupal\Core\Url - * The URL object. - */ - public function getCanonicalUrl(); - - /** - * Returns a URL to edit the sections in the Layout Builder UI. - * - * @return \Drupal\Core\Url - * The URL object. - */ - public function getLayoutBuilderUrl(); - } diff --git a/core/modules/layout_builder/tests/src/Functional/LayoutSectionTest.php b/core/modules/layout_builder/tests/src/Functional/LayoutSectionTest.php index b2b5f9c781..e70b3a1940 100644 --- a/core/modules/layout_builder/tests/src/Functional/LayoutSectionTest.php +++ b/core/modules/layout_builder/tests/src/Functional/LayoutSectionTest.php @@ -2,8 +2,8 @@ namespace Drupal\Tests\layout_builder\Functional; -use Drupal\Core\Entity\Entity\EntityViewDisplay; use Drupal\language\Entity\ConfigurableLanguage; +use Drupal\layout_builder\Entity\LayoutBuilderEntityViewDisplay; use Drupal\layout_builder\Section; use Drupal\layout_builder\SectionComponent; use Drupal\Tests\BrowserTestBase; @@ -18,7 +18,7 @@ class LayoutSectionTest extends BrowserTestBase { /** * {@inheritdoc} */ - public static $modules = ['layout_builder', 'node', 'block_test']; + public static $modules = ['field_ui', 'layout_builder', 'node', 'block_test']; /** * The name of the layout section field. @@ -40,13 +40,15 @@ protected function setUp() { 'type' => 'bundle_without_section_field', ]); - layout_builder_add_layout_section_field('node', 'bundle_with_section_field'); - $display = EntityViewDisplay::load('node.bundle_with_section_field.default'); - $display->setThirdPartySetting('layout_builder', 'allow_custom', TRUE); - $display->save(); + LayoutBuilderEntityViewDisplay::load('node.bundle_with_section_field.default') + ->setOverridable() + ->save(); $this->drupalLogin($this->drupalCreateUser([ 'configure any layout', + 'administer node display', + 'administer node fields', + 'administer content types', ], 'foobar')); } @@ -167,10 +169,11 @@ public function providerTestLayoutSectionFormatter() { public function testLayoutSectionFormatter($layout_data, $expected_selector, $expected_content, $expected_cache_contexts, $expected_cache_tags, $expected_dynamic_cache) { $node = $this->createSectionNode($layout_data); - $this->drupalGet($node->toUrl('canonical')); + $canonical_url = $node->toUrl('canonical'); + $this->drupalGet($canonical_url); $this->assertLayoutSection($expected_selector, $expected_content, $expected_cache_contexts, $expected_cache_tags, $expected_dynamic_cache); - $this->drupalGet($node->toUrl('layout-builder')); + $this->drupalGet($canonical_url->toString() . '/layout'); $this->assertLayoutSection($expected_selector, $expected_content, $expected_cache_contexts, $expected_cache_tags, 'UNCACHEABLE'); } @@ -253,7 +256,7 @@ public function testLayoutPageTitle() { $this->drupalPlaceBlock('page_title_block'); $node = $this->createSectionNode([]); - $this->drupalGet($node->toUrl('layout-builder')); + $this->drupalGet($node->toUrl('canonical')->toString() . '/layout'); $this->assertSession()->titleEquals('Edit layout for The node title | Drupal'); $this->assertEquals('Edit layout for The node title', $this->cssSelect('h1.page-title')[0]->getText()); } @@ -272,10 +275,50 @@ public function testLayoutUrlNoSectionField() { ], ]); $node->save(); - $this->drupalGet($node->toUrl('layout-builder')); + + $this->drupalGet($node->toUrl('canonical')->toString() . '/layout'); $this->assertSession()->statusCodeEquals(404); } + /** + * Tests that deleting a field removes it from the layout. + */ + public function testLayoutDeletingField() { + $assert_session = $this->assertSession(); + + LayoutBuilderEntityViewDisplay::load('node.bundle_with_section_field.default') + ->setComponent('body', ['type' => 'text_default']) + ->save(); + + $this->drupalGet('/admin/structure/types/manage/bundle_with_section_field/display-layout/default'); + $assert_session->statusCodeEquals(200); + + // Delete the field from both bundles. + $this->drupalGet('/admin/structure/types/manage/bundle_with_section_field/fields/node.bundle_with_section_field.body/delete'); + $this->submitForm([], 'Delete'); + $this->drupalGet('/admin/structure/types/manage/bundle_without_section_field/fields/node.bundle_without_section_field.body/delete'); + $this->submitForm([], 'Delete'); + + $this->drupalGet('/admin/structure/types/manage/bundle_with_section_field/display-layout/default'); + $assert_session->statusCodeEquals(200); + } + + /** + * Tests that deleting a bundle removes the layout. + */ + public function testLayoutDeletingBundle() { + $assert_session = $this->assertSession(); + + $display = LayoutBuilderEntityViewDisplay::load('node.bundle_with_section_field.default'); + $this->assertInstanceOf(LayoutBuilderEntityViewDisplay::class, $display); + + $this->drupalPostForm('/admin/structure/types/manage/bundle_with_section_field/delete', [], 'Delete'); + $assert_session->statusCodeEquals(200); + + $display = LayoutBuilderEntityViewDisplay::load('node.bundle_with_section_field.default'); + $this->assertNull($display); + } + /** * Asserts the output of a layout section. * diff --git a/core/modules/layout_builder/tests/src/Kernel/LayoutBuilderCompatibilityTestBase.php b/core/modules/layout_builder/tests/src/Kernel/LayoutBuilderCompatibilityTestBase.php index 6c376fa7cf..d5a4cd0b8a 100644 --- a/core/modules/layout_builder/tests/src/Kernel/LayoutBuilderCompatibilityTestBase.php +++ b/core/modules/layout_builder/tests/src/Kernel/LayoutBuilderCompatibilityTestBase.php @@ -42,6 +42,7 @@ protected function setUp() { $this->installEntitySchema('entity_test_base_field_display'); $this->installConfig(['filter']); + $this->installSchema('system', ['key_value_expire']); // Set up a non-admin user that is allowed to view test entities. \Drupal::currentUser()->setAccount($this->createUser(['uid' => 2], ['view test entity'])); @@ -68,7 +69,7 @@ protected function setUp() { 'status' => TRUE, ]); $this->display - ->setComponent('test_field_display_configurable', ['region' => 'content', 'weight' => 5]) + ->setComponent('test_field_display_configurable', ['weight' => 5]) ->save(); // Create an entity with fields that are configurable and non-configurable. @@ -92,7 +93,7 @@ protected function installLayoutBuilder() { $this->refreshServices(); $this->display = $this->reloadEntity($this->display); - $this->display->setThirdPartySetting('layout_builder', 'allow_custom', TRUE)->save(); + $this->display->setOverridable()->save(); $this->entity = $this->reloadEntity($this->entity); } diff --git a/core/modules/layout_builder/tests/src/Kernel/LayoutBuilderEntityViewDisplayTest.php b/core/modules/layout_builder/tests/src/Kernel/LayoutBuilderEntityViewDisplayTest.php new file mode 100644 index 0000000000..700e3a9cf4 --- /dev/null +++ b/core/modules/layout_builder/tests/src/Kernel/LayoutBuilderEntityViewDisplayTest.php @@ -0,0 +1,43 @@ + 'entity_test', + 'bundle' => 'entity_test', + 'mode' => 'default', + 'status' => TRUE, + 'third_party_settings' => [ + 'layout_builder' => [ + 'sections' => $section_data, + ], + ], + ]); + $display->save(); + return $display; + } + + /** + * Tests that configuration schema enforces valid values. + */ + public function testInvalidConfiguration() { + $this->setExpectedException(SchemaIncompleteException::class); + $this->sectionStorage->getSection(0)->getComponent('first-uuid')->setConfiguration(['bar' => 'baz']); + $this->sectionStorage->save(); + } + +} diff --git a/core/modules/layout_builder/tests/src/Kernel/LayoutBuilderInstallTest.php b/core/modules/layout_builder/tests/src/Kernel/LayoutBuilderInstallTest.php index 3873af81b0..fa646df1c9 100644 --- a/core/modules/layout_builder/tests/src/Kernel/LayoutBuilderInstallTest.php +++ b/core/modules/layout_builder/tests/src/Kernel/LayoutBuilderInstallTest.php @@ -2,6 +2,8 @@ namespace Drupal\Tests\layout_builder\Kernel; +use Drupal\field\Entity\FieldConfig; +use Drupal\field\Entity\FieldStorageConfig; use Drupal\layout_builder\Section; /** @@ -49,6 +51,40 @@ public function testCompatibility() { $this->entity->get('layout_builder__layout')->removeSection(0); $this->entity->save(); $this->assertFieldAttributes($this->entity, $expected_fields); + + // Test that adding a new field after Layout Builder has been installed will + // add the new field to the default region of the first section. + $field_storage = FieldStorageConfig::create([ + 'entity_type' => 'entity_test_base_field_display', + 'field_name' => 'test_field_display_post_install', + 'type' => 'text', + ]); + $field_storage->save(); + FieldConfig::create([ + 'field_storage' => $field_storage, + 'bundle' => 'entity_test_base_field_display', + 'label' => 'FieldConfig with configurable display', + ])->save(); + + $this->entity = $this->reloadEntity($this->entity); + $this->entity->test_field_display_post_install = 'Test string'; + $this->entity->save(); + + $this->display = $this->reloadEntity($this->display); + $this->display + ->setComponent('test_field_display_post_install', ['weight' => 50]) + ->save(); + $new_expected_fields = [ + 'field field--name-name field--type-string field--label-hidden field__item', + 'field field--name-test-field-display-configurable field--type-boolean field--label-above', + 'clearfix text-formatted field field--name-test-display-configurable field--type-text field--label-above', + 'clearfix text-formatted field field--name-test-field-display-post-install field--type-text field--label-above', + 'clearfix text-formatted field field--name-test-display-non-configurable field--type-text field--label-above', + 'clearfix text-formatted field field--name-test-display-multiple field--type-text field--label-above', + ]; + $this->assertFieldAttributes($this->entity, $new_expected_fields); + $this->assertNotEmpty($this->cssSelect('.layout--onecol')); + $this->assertText('Test string'); } } diff --git a/core/modules/layout_builder/tests/src/Kernel/LayoutSectionItemListTest.php b/core/modules/layout_builder/tests/src/Kernel/LayoutSectionItemListTest.php index f3a6e6f950..af8395f173 100644 --- a/core/modules/layout_builder/tests/src/Kernel/LayoutSectionItemListTest.php +++ b/core/modules/layout_builder/tests/src/Kernel/LayoutSectionItemListTest.php @@ -3,6 +3,7 @@ namespace Drupal\Tests\layout_builder\Kernel; use Drupal\entity_test\Entity\EntityTestBaseFieldDisplay; +use Drupal\layout_builder\Entity\LayoutBuilderEntityViewDisplay; /** * Tests the field type for Layout Sections. @@ -26,7 +27,12 @@ class LayoutSectionItemListTest extends SectionStorageTestBase { */ protected function getSectionStorage(array $section_data) { $this->installEntitySchema('entity_test_base_field_display'); - layout_builder_add_layout_section_field('entity_test_base_field_display', 'entity_test_base_field_display'); + LayoutBuilderEntityViewDisplay::create([ + 'targetEntityType' => 'entity_test_base_field_display', + 'bundle' => 'entity_test_base_field_display', + 'mode' => 'default', + 'status' => TRUE, + ])->setOverridable()->save(); array_map(function ($row) { return ['section' => $row]; diff --git a/core/modules/layout_builder/tests/src/Kernel/SectionStorageTestBase.php b/core/modules/layout_builder/tests/src/Kernel/SectionStorageTestBase.php index 97c1fba713..d89bd59cca 100644 --- a/core/modules/layout_builder/tests/src/Kernel/SectionStorageTestBase.php +++ b/core/modules/layout_builder/tests/src/Kernel/SectionStorageTestBase.php @@ -20,6 +20,7 @@ 'layout_test', 'user', 'entity_test', + 'system', ]; /** @@ -35,6 +36,8 @@ protected function setUp() { parent::setUp(); + $this->installSchema('system', ['key_value_expire']); + $section_data = [ new Section('layout_test_plugin', [], [ 'first-uuid' => new SectionComponent('first-uuid', 'content'), @@ -83,7 +86,7 @@ public function testGetSection() { * @covers ::getSection */ public function testGetSectionInvalidDelta() { - $this->setExpectedException(\OutOfBoundsException::class, 'Invalid delta "2" for the "The test entity"'); + $this->setExpectedException(\OutOfBoundsException::class, 'Invalid delta "2"'); $this->sectionStorage->getSection(2); } diff --git a/core/modules/layout_builder/tests/src/Unit/DefaultsSectionStorageTest.php b/core/modules/layout_builder/tests/src/Unit/DefaultsSectionStorageTest.php new file mode 100644 index 0000000000..5922479ada --- /dev/null +++ b/core/modules/layout_builder/tests/src/Unit/DefaultsSectionStorageTest.php @@ -0,0 +1,135 @@ +entityTypeManager = $this->prophesize(EntityTypeManagerInterface::class); + $entity_type_bundle_info = $this->prophesize(EntityTypeBundleInfoInterface::class); + $this->plugin = new DefaultsSectionStorage([], '', [], $this->entityTypeManager->reveal(), $entity_type_bundle_info->reveal()); + } + + /** + * @covers ::convert + * + * @dataProvider providerTestConvert + */ + public function testConvert($success, $expected_entity_id, $value, array $defaults) { + if ($expected_entity_id) { + $entity_storage = $this->prophesize(EntityStorageInterface::class); + $entity_storage->load($expected_entity_id)->willReturn('the_return_value'); + + $this->entityTypeManager->getDefinition('entity_view_display')->willReturn(new EntityType(['id' => 'entity_view_display'])); + $this->entityTypeManager->getStorage('entity_view_display')->willReturn($entity_storage->reveal()); + } + else { + $this->entityTypeManager->getDefinition('entity_view_display')->shouldNotBeCalled(); + $this->entityTypeManager->getStorage('entity_view_display')->shouldNotBeCalled(); + } + + $result = $this->plugin->convert($value, [], 'the_parameter_name', $defaults); + if ($success) { + $this->assertEquals('the_return_value', $result); + } + else { + $this->assertNull($result); + } + } + + /** + * Provides data for ::testConvert(). + */ + public function providerTestConvert() { + $data = []; + $data['with value'] = [ + TRUE, + 'some_value', + 'some_value', + [], + ]; + $data['empty value, without bundle'] = [ + TRUE, + 'my_entity_type.bundle_name.default', + '', + [ + 'entity_type_id' => 'my_entity_type', + 'view_mode_name' => 'default', + 'bundle_key' => 'my_bundle', + 'my_bundle' => 'bundle_name', + ], + ]; + $data['empty value, with bundle'] = [ + TRUE, + 'my_entity_type.bundle_name.default', + '', + [ + 'entity_type_id' => 'my_entity_type', + 'view_mode_name' => 'default', + 'bundle' => 'bundle_name', + ], + ]; + $data['without value, empty defaults'] = [ + FALSE, + NULL, + '', + [], + ]; + return $data; + } + + /** + * @covers ::convert + */ + public function testConvertCreate() { + $expected = 'the_return_value'; + $value = 'foo.bar.baz'; + $expected_create_values = [ + 'targetEntityType' => 'foo', + 'bundle' => 'bar', + 'mode' => 'baz', + 'status' => TRUE, + ]; + $entity_storage = $this->prophesize(EntityStorageInterface::class); + $entity_storage->load($value)->willReturn(NULL); + $entity_storage->create($expected_create_values)->willReturn($expected); + + $this->entityTypeManager->getDefinition('entity_view_display')->willReturn(new EntityType(['id' => 'entity_view_display'])); + $this->entityTypeManager->getStorage('entity_view_display')->willReturn($entity_storage->reveal()); + + $result = $this->plugin->convert($value, [], 'the_parameter_name', [], 'the_parameter_name', []); + $this->assertSame($expected, $result); + } + +} diff --git a/core/modules/layout_builder/tests/src/Unit/LayoutBuilderRoutesTest.php b/core/modules/layout_builder/tests/src/Unit/LayoutBuilderRoutesTest.php index e209f6ad43..0861401873 100644 --- a/core/modules/layout_builder/tests/src/Unit/LayoutBuilderRoutesTest.php +++ b/core/modules/layout_builder/tests/src/Unit/LayoutBuilderRoutesTest.php @@ -2,13 +2,21 @@ namespace Drupal\Tests\layout_builder\Unit; +use Drupal\Core\DependencyInjection\ContainerBuilder; use Drupal\Core\Entity\EntityFieldManagerInterface; use Drupal\Core\Entity\EntityType; +use Drupal\Core\Entity\EntityTypeBundleInfoInterface; use Drupal\Core\Entity\EntityTypeManagerInterface; use Drupal\Core\Field\FieldStorageDefinitionInterface; +use Drupal\Core\Routing\RouteBuildEvent; +use Drupal\layout_builder\Plugin\SectionStorage\DefaultsSectionStorage; +use Drupal\layout_builder\Plugin\SectionStorage\OverridesSectionStorage; use Drupal\layout_builder\Routing\LayoutBuilderRoutes; +use Drupal\layout_builder\SectionStorage\SectionStorageDefinition; +use Drupal\layout_builder\SectionStorage\SectionStorageManagerInterface; use Drupal\Tests\UnitTestCase; use Symfony\Component\Routing\Route; +use Symfony\Component\Routing\RouteCollection; /** * @coversDefaultClass \Drupal\layout_builder\Routing\LayoutBuilderRoutes @@ -17,6 +25,13 @@ */ class LayoutBuilderRoutesTest extends UnitTestCase { + /** + * The Layout Builder route builder. + * + * @var \Drupal\layout_builder\SectionStorage\SectionStorageManagerInterface + */ + protected $sectionStorageManager; + /** * The Layout Builder route builder. * @@ -75,19 +90,24 @@ protected function setUp() { $entity_field_manager->getFieldStorageDefinitions('with_integer_id')->willReturn(['id' => $integer_id->reveal()]); $entity_field_manager->getFieldStorageDefinitions('with_field_ui_route')->willReturn(['id' => $integer_id->reveal()]); $entity_field_manager->getFieldStorageDefinitions('with_bundle_parameter')->willReturn(['id' => $integer_id->reveal()]); + $entity_type_bundle_info = $this->prophesize(EntityTypeBundleInfoInterface::class); - $this->routeBuilder = new LayoutBuilderRoutes($entity_type_manager->reveal(), $entity_field_manager->reveal()); + $container = new ContainerBuilder(); + $container->set('entity_type.manager', $entity_type_manager->reveal()); + $container->set('entity_field.manager', $entity_field_manager->reveal()); + $container->set('entity_type.bundle.info', $entity_type_bundle_info->reveal()); + \Drupal::setContainer($container); + + $this->sectionStorageManager = $this->prophesize(SectionStorageManagerInterface::class); + $this->routeBuilder = new LayoutBuilderRoutes($this->sectionStorageManager->reveal()); } /** - * @covers ::getRoutes - * @covers ::buildRoute - * @covers ::hasIntegerId - * @covers ::getEntityTypes + * @covers ::onAlterRoutes */ - public function testGetRoutes() { + public function testOnAlterRoutesOverrides() { $expected = [ - 'entity.with_link_template.layout_builder' => new Route( + 'layout_builder.overrides.with_link_template.view' => new Route( '/entity/{entity}/layout', [ 'entity_type_id' => 'with_link_template', @@ -108,7 +128,7 @@ public function testGetRoutes() { '_layout_builder' => TRUE, ] ), - 'entity.with_link_template.layout_builder_save' => new Route( + 'layout_builder.overrides.with_link_template.save' => new Route( '/entity/{entity}/layout/save', [ 'entity_type_id' => 'with_link_template', @@ -127,7 +147,7 @@ public function testGetRoutes() { '_layout_builder' => TRUE, ] ), - 'entity.with_link_template.layout_builder_cancel' => new Route( + 'layout_builder.overrides.with_link_template.cancel' => new Route( '/entity/{entity}/layout/cancel', [ 'entity_type_id' => 'with_link_template', @@ -146,7 +166,26 @@ public function testGetRoutes() { '_layout_builder' => TRUE, ] ), - 'entity.with_integer_id.layout_builder' => new Route( + 'layout_builder.overrides.with_link_template.revert' => new Route( + '/entity/{entity}/layout/revert', + [ + 'entity_type_id' => 'with_link_template', + 'section_storage_type' => 'overrides', + 'section_storage' => '', + '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::revertLayout', + ], + [ + '_has_layout_section' => 'true', + ], + [ + 'parameters' => [ + 'section_storage' => ['layout_builder_tempstore' => TRUE], + 'with_link_template' => ['type' => 'entity:with_link_template'], + ], + '_layout_builder' => TRUE, + ] + ), + 'layout_builder.overrides.with_integer_id.view' => new Route( '/entity/{entity}/layout', [ 'entity_type_id' => 'with_integer_id', @@ -168,7 +207,7 @@ public function testGetRoutes() { '_layout_builder' => TRUE, ] ), - 'entity.with_integer_id.layout_builder_save' => new Route( + 'layout_builder.overrides.with_integer_id.save' => new Route( '/entity/{entity}/layout/save', [ 'entity_type_id' => 'with_integer_id', @@ -188,7 +227,7 @@ public function testGetRoutes() { '_layout_builder' => TRUE, ] ), - 'entity.with_integer_id.layout_builder_cancel' => new Route( + 'layout_builder.overrides.with_integer_id.cancel' => new Route( '/entity/{entity}/layout/cancel', [ 'entity_type_id' => 'with_integer_id', @@ -208,7 +247,27 @@ public function testGetRoutes() { '_layout_builder' => TRUE, ] ), - 'entity.with_field_ui_route.layout_builder' => new Route( + 'layout_builder.overrides.with_integer_id.revert' => new Route( + '/entity/{entity}/layout/revert', + [ + 'entity_type_id' => 'with_integer_id', + 'section_storage_type' => 'overrides', + 'section_storage' => '', + '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::revertLayout', + ], + [ + '_has_layout_section' => 'true', + 'with_integer_id' => '\d+', + ], + [ + 'parameters' => [ + 'section_storage' => ['layout_builder_tempstore' => TRUE], + 'with_integer_id' => ['type' => 'entity:with_integer_id'], + ], + '_layout_builder' => TRUE, + ] + ), + 'layout_builder.overrides.with_field_ui_route.view' => new Route( '/entity/{entity}/layout', [ 'entity_type_id' => 'with_field_ui_route', @@ -230,7 +289,7 @@ public function testGetRoutes() { '_layout_builder' => TRUE, ] ), - 'entity.with_field_ui_route.layout_builder_save' => new Route( + 'layout_builder.overrides.with_field_ui_route.save' => new Route( '/entity/{entity}/layout/save', [ 'entity_type_id' => 'with_field_ui_route', @@ -250,7 +309,7 @@ public function testGetRoutes() { '_layout_builder' => TRUE, ] ), - 'entity.with_field_ui_route.layout_builder_cancel' => new Route( + 'layout_builder.overrides.with_field_ui_route.cancel' => new Route( '/entity/{entity}/layout/cancel', [ 'entity_type_id' => 'with_field_ui_route', @@ -270,7 +329,27 @@ public function testGetRoutes() { '_layout_builder' => TRUE, ] ), - 'entity.with_bundle_key.layout_builder' => new Route( + 'layout_builder.overrides.with_field_ui_route.revert' => new Route( + '/entity/{entity}/layout/revert', + [ + 'entity_type_id' => 'with_field_ui_route', + 'section_storage_type' => 'overrides', + 'section_storage' => '', + '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::revertLayout', + ], + [ + '_has_layout_section' => 'true', + 'with_field_ui_route' => '\d+', + ], + [ + 'parameters' => [ + 'section_storage' => ['layout_builder_tempstore' => TRUE], + 'with_field_ui_route' => ['type' => 'entity:with_field_ui_route'], + ], + '_layout_builder' => TRUE, + ] + ), + 'layout_builder.overrides.with_bundle_key.view' => new Route( '/entity/{entity}/layout', [ 'entity_type_id' => 'with_bundle_key', @@ -292,7 +371,7 @@ public function testGetRoutes() { '_layout_builder' => TRUE, ] ), - 'entity.with_bundle_key.layout_builder_save' => new Route( + 'layout_builder.overrides.with_bundle_key.save' => new Route( '/entity/{entity}/layout/save', [ 'entity_type_id' => 'with_bundle_key', @@ -312,7 +391,7 @@ public function testGetRoutes() { '_layout_builder' => TRUE, ] ), - 'entity.with_bundle_key.layout_builder_cancel' => new Route( + 'layout_builder.overrides.with_bundle_key.cancel' => new Route( '/entity/{entity}/layout/cancel', [ 'entity_type_id' => 'with_bundle_key', @@ -332,7 +411,27 @@ public function testGetRoutes() { '_layout_builder' => TRUE, ] ), - 'entity.with_bundle_parameter.layout_builder' => new Route( + 'layout_builder.overrides.with_bundle_key.revert' => new Route( + '/entity/{entity}/layout/revert', + [ + 'entity_type_id' => 'with_bundle_key', + 'section_storage_type' => 'overrides', + 'section_storage' => '', + '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::revertLayout', + ], + [ + '_has_layout_section' => 'true', + 'with_bundle_key' => '\d+', + ], + [ + 'parameters' => [ + 'section_storage' => ['layout_builder_tempstore' => TRUE], + 'with_bundle_key' => ['type' => 'entity:with_bundle_key'], + ], + '_layout_builder' => TRUE, + ] + ), + 'layout_builder.overrides.with_bundle_parameter.view' => new Route( '/entity/{entity}/layout', [ 'entity_type_id' => 'with_bundle_parameter', @@ -354,7 +453,7 @@ public function testGetRoutes() { '_layout_builder' => TRUE, ] ), - 'entity.with_bundle_parameter.layout_builder_save' => new Route( + 'layout_builder.overrides.with_bundle_parameter.save' => new Route( '/entity/{entity}/layout/save', [ 'entity_type_id' => 'with_bundle_parameter', @@ -374,7 +473,7 @@ public function testGetRoutes() { '_layout_builder' => TRUE, ] ), - 'entity.with_bundle_parameter.layout_builder_cancel' => new Route( + 'layout_builder.overrides.with_bundle_parameter.cancel' => new Route( '/entity/{entity}/layout/cancel', [ 'entity_type_id' => 'with_bundle_parameter', @@ -394,9 +493,258 @@ public function testGetRoutes() { '_layout_builder' => TRUE, ] ), + 'layout_builder.overrides.with_bundle_parameter.revert' => new Route( + '/entity/{entity}/layout/revert', + [ + 'entity_type_id' => 'with_bundle_parameter', + 'section_storage_type' => 'overrides', + 'section_storage' => '', + '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::revertLayout', + ], + [ + '_has_layout_section' => 'true', + 'with_bundle_parameter' => '\d+', + ], + [ + 'parameters' => [ + 'section_storage' => ['layout_builder_tempstore' => TRUE], + 'with_bundle_parameter' => ['type' => 'entity:with_bundle_parameter'], + ], + '_layout_builder' => TRUE, + ] + ), + ]; + + $definitions = []; + $definitions['overrides'] = new SectionStorageDefinition([ + 'id' => 'overrides', + 'class' => OverridesSectionStorage::class, + ]); + $this->sectionStorageManager->getDefinitions()->willReturn($definitions); + $this->sectionStorageManager->loadEmpty('overrides')->willReturn(OverridesSectionStorage::create(\Drupal::getContainer(), [], '', $definitions['overrides'])); + + $collection = new RouteCollection(); + $event = new RouteBuildEvent($collection); + $this->routeBuilder->onAlterRoutes($event); + $this->assertEquals($expected, $event->getRouteCollection()->all()); + } + + /** + * @covers ::onAlterRoutes + */ + public function testOnAlterRoutesDefaults() { + $collection = new RouteCollection(); + $collection->add('known', new Route('/admin/entity/whatever')); + $collection->add('with_bundle', new Route('/admin/entity/{bundle}')); + $event = new RouteBuildEvent($collection); + + $expected = [ + 'known' => new Route('/admin/entity/whatever'), + 'with_bundle' => new Route('/admin/entity/{bundle}'), + 'layout_builder.defaults.with_field_ui_route.view' => new Route( + '/admin/entity/whatever/display-layout/{view_mode_name}', + [ + 'entity_type_id' => 'with_field_ui_route', + 'bundle' => 'with_field_ui_route', + 'section_storage_type' => 'defaults', + 'section_storage' => '', + 'is_rebuilding' => FALSE, + '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::layout', + '_title_callback' => '\Drupal\layout_builder\Controller\LayoutBuilderController::title', + ], + [ + '_field_ui_view_mode_access' => 'administer with_field_ui_route display', + '_has_layout_section' => 'true', + ], + [ + 'parameters' => [ + 'section_storage' => ['layout_builder_tempstore' => TRUE], + ], + '_layout_builder' => TRUE, + '_admin_route' => FALSE, + ] + ), + 'layout_builder.defaults.with_field_ui_route.save' => new Route( + '/admin/entity/whatever/display-layout/{view_mode_name}/save', + [ + 'entity_type_id' => 'with_field_ui_route', + 'bundle' => 'with_field_ui_route', + 'section_storage_type' => 'defaults', + 'section_storage' => '', + '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::saveLayout', + ], + [ + '_field_ui_view_mode_access' => 'administer with_field_ui_route display', + '_has_layout_section' => 'true', + ], + [ + 'parameters' => [ + 'section_storage' => ['layout_builder_tempstore' => TRUE], + ], + '_layout_builder' => TRUE, + '_admin_route' => FALSE, + ] + ), + 'layout_builder.defaults.with_field_ui_route.cancel' => new Route( + '/admin/entity/whatever/display-layout/{view_mode_name}/cancel', + [ + 'entity_type_id' => 'with_field_ui_route', + 'bundle' => 'with_field_ui_route', + 'section_storage_type' => 'defaults', + 'section_storage' => '', + '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::cancelLayout', + ], + [ + '_field_ui_view_mode_access' => 'administer with_field_ui_route display', + '_has_layout_section' => 'true', + ], + [ + 'parameters' => [ + 'section_storage' => ['layout_builder_tempstore' => TRUE], + ], + '_layout_builder' => TRUE, + '_admin_route' => FALSE, + ] + ), + 'layout_builder.defaults.with_bundle_key.view' => new Route( + '/admin/entity/whatever/display-layout/{view_mode_name}', + [ + 'entity_type_id' => 'with_bundle_key', + 'bundle_key' => 'my_bundle_type', + 'section_storage_type' => 'defaults', + 'section_storage' => '', + 'is_rebuilding' => FALSE, + '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::layout', + '_title_callback' => '\Drupal\layout_builder\Controller\LayoutBuilderController::title', + ], + [ + '_field_ui_view_mode_access' => 'administer with_bundle_key display', + '_has_layout_section' => 'true', + ], + [ + 'parameters' => [ + 'section_storage' => ['layout_builder_tempstore' => TRUE], + ], + '_layout_builder' => TRUE, + '_admin_route' => FALSE, + ] + ), + 'layout_builder.defaults.with_bundle_key.save' => new Route( + '/admin/entity/whatever/display-layout/{view_mode_name}/save', + [ + 'entity_type_id' => 'with_bundle_key', + 'bundle_key' => 'my_bundle_type', + 'section_storage_type' => 'defaults', + 'section_storage' => '', + '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::saveLayout', + ], + [ + '_field_ui_view_mode_access' => 'administer with_bundle_key display', + '_has_layout_section' => 'true', + ], + [ + 'parameters' => [ + 'section_storage' => ['layout_builder_tempstore' => TRUE], + ], + '_layout_builder' => TRUE, + '_admin_route' => FALSE, + ] + ), + 'layout_builder.defaults.with_bundle_key.cancel' => new Route( + '/admin/entity/whatever/display-layout/{view_mode_name}/cancel', + [ + 'entity_type_id' => 'with_bundle_key', + 'bundle_key' => 'my_bundle_type', + 'section_storage_type' => 'defaults', + 'section_storage' => '', + '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::cancelLayout', + ], + [ + '_field_ui_view_mode_access' => 'administer with_bundle_key display', + '_has_layout_section' => 'true', + ], + [ + 'parameters' => [ + 'section_storage' => ['layout_builder_tempstore' => TRUE], + ], + '_layout_builder' => TRUE, + '_admin_route' => FALSE, + ] + ), + 'layout_builder.defaults.with_bundle_parameter.view' => new Route( + '/admin/entity/{bundle}/display-layout/{view_mode_name}', + [ + 'entity_type_id' => 'with_bundle_parameter', + 'section_storage_type' => 'defaults', + 'section_storage' => '', + 'is_rebuilding' => FALSE, + '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::layout', + '_title_callback' => '\Drupal\layout_builder\Controller\LayoutBuilderController::title', + ], + [ + '_field_ui_view_mode_access' => 'administer with_bundle_parameter display', + '_has_layout_section' => 'true', + ], + [ + 'parameters' => [ + 'section_storage' => ['layout_builder_tempstore' => TRUE], + ], + '_layout_builder' => TRUE, + '_admin_route' => FALSE, + ] + ), + 'layout_builder.defaults.with_bundle_parameter.save' => new Route( + '/admin/entity/{bundle}/display-layout/{view_mode_name}/save', + [ + 'entity_type_id' => 'with_bundle_parameter', + 'section_storage_type' => 'defaults', + 'section_storage' => '', + '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::saveLayout', + ], + [ + '_field_ui_view_mode_access' => 'administer with_bundle_parameter display', + '_has_layout_section' => 'true', + ], + [ + 'parameters' => [ + 'section_storage' => ['layout_builder_tempstore' => TRUE], + ], + '_layout_builder' => TRUE, + '_admin_route' => FALSE, + ] + ), + 'layout_builder.defaults.with_bundle_parameter.cancel' => new Route( + '/admin/entity/{bundle}/display-layout/{view_mode_name}/cancel', + [ + 'entity_type_id' => 'with_bundle_parameter', + 'section_storage_type' => 'defaults', + 'section_storage' => '', + '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::cancelLayout', + ], + [ + '_field_ui_view_mode_access' => 'administer with_bundle_parameter display', + '_has_layout_section' => 'true', + ], + [ + 'parameters' => [ + 'section_storage' => ['layout_builder_tempstore' => TRUE], + ], + '_layout_builder' => TRUE, + '_admin_route' => FALSE, + ] + ), ]; - $this->assertEquals($expected, $this->routeBuilder->getRoutes()); + $definitions = []; + $definitions['defaults'] = new SectionStorageDefinition([ + 'id' => 'defaults', + 'class' => DefaultsSectionStorage::class, + ]); + $this->sectionStorageManager->getDefinitions()->willReturn($definitions); + $this->sectionStorageManager->loadEmpty('defaults')->willReturn(DefaultsSectionStorage::create(\Drupal::getContainer(), [], '', $definitions['defaults'])); + + $this->routeBuilder->onAlterRoutes($event); + $this->assertEquals($expected, $event->getRouteCollection()->all()); } } diff --git a/core/modules/layout_builder/tests/src/Unit/LayoutTempstoreParamConverterTest.php b/core/modules/layout_builder/tests/src/Unit/LayoutTempstoreParamConverterTest.php index 3c3c9f4065..5f8dc051e3 100644 --- a/core/modules/layout_builder/tests/src/Unit/LayoutTempstoreParamConverterTest.php +++ b/core/modules/layout_builder/tests/src/Unit/LayoutTempstoreParamConverterTest.php @@ -2,10 +2,9 @@ namespace Drupal\Tests\layout_builder\Unit; -use Drupal\Core\DependencyInjection\ClassResolverInterface; use Drupal\layout_builder\LayoutTempstoreRepositoryInterface; use Drupal\layout_builder\Routing\LayoutTempstoreParamConverter; -use Drupal\layout_builder\Routing\SectionStorageParamConverterInterface; +use Drupal\layout_builder\SectionStorage\SectionStorageManagerInterface; use Drupal\layout_builder\SectionStorageInterface; use Drupal\Tests\UnitTestCase; @@ -18,23 +17,23 @@ class LayoutTempstoreParamConverterTest extends UnitTestCase { /** * @covers ::convert - * @covers ::getParamConverterFromDefaults */ public function testConvert() { $layout_tempstore_repository = $this->prophesize(LayoutTempstoreRepositoryInterface::class); - $class_resolver = $this->prophesize(ClassResolverInterface::class); - $param_converter = $this->prophesize(SectionStorageParamConverterInterface::class); - $converter = new LayoutTempstoreParamConverter($layout_tempstore_repository->reveal(), $class_resolver->reveal()); + $section_storage_manager = $this->prophesize(SectionStorageManagerInterface::class); + $converter = new LayoutTempstoreParamConverter($layout_tempstore_repository->reveal(), $section_storage_manager->reveal()); - $value = 'some_value'; - $definition = ['layout_builder_tempstore' => TRUE]; - $name = 'the_parameter_name'; - $defaults = ['section_storage_type' => 'my_type']; $section_storage = $this->prophesize(SectionStorageInterface::class); + + $value = 'some_value'; + $definition = ['layout_builder_tempstore' => TRUE]; + $name = 'the_parameter_name'; + $defaults = ['section_storage_type' => 'my_type']; $expected = 'the_return_value'; - $class_resolver->getInstanceFromDefinition('layout_builder.section_storage_param_converter.my_type')->willReturn($param_converter->reveal()); - $param_converter->convert($value, $definition, $name, $defaults)->willReturn($section_storage->reveal()); + $section_storage_manager->hasDefinition('my_type')->willReturn(TRUE); + $section_storage_manager->loadFromRoute('my_type', $value, $definition, $name, $defaults)->willReturn($section_storage); + $layout_tempstore_repository->get($section_storage->reveal())->willReturn($expected); $result = $converter->convert($value, $definition, $name, $defaults); @@ -43,19 +42,19 @@ public function testConvert() { /** * @covers ::convert - * @covers ::getParamConverterFromDefaults */ public function testConvertNoType() { $layout_tempstore_repository = $this->prophesize(LayoutTempstoreRepositoryInterface::class); - $class_resolver = $this->prophesize(ClassResolverInterface::class); - $converter = new LayoutTempstoreParamConverter($layout_tempstore_repository->reveal(), $class_resolver->reveal()); + $section_storage_manager = $this->prophesize(SectionStorageManagerInterface::class); + $converter = new LayoutTempstoreParamConverter($layout_tempstore_repository->reveal(), $section_storage_manager->reveal()); $value = 'some_value'; $definition = ['layout_builder_tempstore' => TRUE]; $name = 'the_parameter_name'; $defaults = ['section_storage_type' => NULL]; - $class_resolver->getInstanceFromDefinition()->shouldNotBeCalled(); + $section_storage_manager->hasDefinition()->shouldNotBeCalled(); + $section_storage_manager->loadFromRoute()->shouldNotBeCalled(); $layout_tempstore_repository->get()->shouldNotBeCalled(); $result = $converter->convert($value, $definition, $name, $defaults); @@ -64,19 +63,19 @@ public function testConvertNoType() { /** * @covers ::convert - * @covers ::getParamConverterFromDefaults */ public function testConvertInvalidConverter() { $layout_tempstore_repository = $this->prophesize(LayoutTempstoreRepositoryInterface::class); - $class_resolver = $this->prophesize(ClassResolverInterface::class); - $converter = new LayoutTempstoreParamConverter($layout_tempstore_repository->reveal(), $class_resolver->reveal()); + $section_storage_manager = $this->prophesize(SectionStorageManagerInterface::class); + $converter = new LayoutTempstoreParamConverter($layout_tempstore_repository->reveal(), $section_storage_manager->reveal()); $value = 'some_value'; $definition = ['layout_builder_tempstore' => TRUE]; $name = 'the_parameter_name'; $defaults = ['section_storage_type' => 'invalid']; - $class_resolver->getInstanceFromDefinition('layout_builder.section_storage_param_converter.invalid')->willThrow(\InvalidArgumentException::class); + $section_storage_manager->hasDefinition('invalid')->willReturn(FALSE); + $section_storage_manager->loadFromRoute()->shouldNotBeCalled(); $layout_tempstore_repository->get()->shouldNotBeCalled(); $result = $converter->convert($value, $definition, $name, $defaults); diff --git a/core/modules/layout_builder/tests/src/Unit/LayoutTempstoreRepositoryTest.php b/core/modules/layout_builder/tests/src/Unit/LayoutTempstoreRepositoryTest.php index b7702c1184..0c74d01763 100644 --- a/core/modules/layout_builder/tests/src/Unit/LayoutTempstoreRepositoryTest.php +++ b/core/modules/layout_builder/tests/src/Unit/LayoutTempstoreRepositoryTest.php @@ -2,11 +2,11 @@ namespace Drupal\Tests\layout_builder\Unit; +use Drupal\Core\TempStore\SharedTempStore; +use Drupal\Core\TempStore\SharedTempStoreFactory; use Drupal\layout_builder\LayoutTempstoreRepository; use Drupal\layout_builder\SectionStorageInterface; use Drupal\Tests\UnitTestCase; -use Drupal\Core\TempStore\SharedTempStore; -use Drupal\Core\TempStore\SharedTempStoreFactory; /** * @coversDefaultClass \Drupal\layout_builder\LayoutTempstoreRepository @@ -26,7 +26,7 @@ public function testGetEmptyTempstore() { $tempstore->get('my_storage_id')->shouldBeCalled(); $tempstore_factory = $this->prophesize(SharedTempStoreFactory::class); - $tempstore_factory->get('layout_builder.my_storage_type')->willReturn($tempstore->reveal()); + $tempstore_factory->get('layout_builder.section_storage.my_storage_type')->willReturn($tempstore->reveal()); $repository = new LayoutTempstoreRepository($tempstore_factory->reveal()); @@ -46,7 +46,7 @@ public function testGetLoadedTempstore() { $tempstore = $this->prophesize(SharedTempStore::class); $tempstore->get('my_storage_id')->willReturn(['section_storage' => $tempstore_section_storage->reveal()]); $tempstore_factory = $this->prophesize(SharedTempStoreFactory::class); - $tempstore_factory->get('layout_builder.my_storage_type')->willReturn($tempstore->reveal()); + $tempstore_factory->get('layout_builder.section_storage.my_storage_type')->willReturn($tempstore->reveal()); $repository = new LayoutTempstoreRepository($tempstore_factory->reveal()); @@ -67,7 +67,7 @@ public function testGetInvalidEntry() { $tempstore->get('my_storage_id')->willReturn(['section_storage' => 'this_is_not_an_entity']); $tempstore_factory = $this->prophesize(SharedTempStoreFactory::class); - $tempstore_factory->get('layout_builder.my_storage_type')->willReturn($tempstore->reveal()); + $tempstore_factory->get('layout_builder.section_storage.my_storage_type')->willReturn($tempstore->reveal()); $repository = new LayoutTempstoreRepository($tempstore_factory->reveal()); diff --git a/core/modules/layout_builder/tests/src/Unit/SectionStorageOverridesParamConverterTest.php b/core/modules/layout_builder/tests/src/Unit/OverridesSectionStorageTest.php similarity index 63% rename from core/modules/layout_builder/tests/src/Unit/SectionStorageOverridesParamConverterTest.php rename to core/modules/layout_builder/tests/src/Unit/OverridesSectionStorageTest.php index f0c01468e5..0ffad1874d 100644 --- a/core/modules/layout_builder/tests/src/Unit/SectionStorageOverridesParamConverterTest.php +++ b/core/modules/layout_builder/tests/src/Unit/OverridesSectionStorageTest.php @@ -2,34 +2,35 @@ namespace Drupal\Tests\layout_builder\Unit; -use Drupal\Core\Entity\EntityManagerInterface; +use Drupal\Core\Entity\EntityFieldManagerInterface; use Drupal\Core\Entity\EntityStorageInterface; use Drupal\Core\Entity\EntityType; +use Drupal\Core\Entity\EntityTypeManagerInterface; use Drupal\Core\Entity\FieldableEntityInterface; -use Drupal\layout_builder\Routing\SectionStorageOverridesParamConverter; +use Drupal\layout_builder\Plugin\SectionStorage\OverridesSectionStorage; use Drupal\Tests\UnitTestCase; use Prophecy\Argument; /** - * @coversDefaultClass \Drupal\layout_builder\Routing\SectionStorageOverridesParamConverter + * @coversDefaultClass \Drupal\layout_builder\Plugin\SectionStorage\OverridesSectionStorage * * @group layout_builder */ -class SectionStorageOverridesParamConverterTest extends UnitTestCase { +class OverridesSectionStorageTest extends UnitTestCase { /** - * The converter. + * The plugin. * - * @var \Drupal\layout_builder\Routing\SectionStorageOverridesParamConverter + * @var \Drupal\layout_builder\Plugin\SectionStorage\OverridesSectionStorage */ - protected $converter; + protected $plugin; /** - * The entity manager. + * The entity type manager. * - * @var \Drupal\Core\Entity\EntityManagerInterface + * @var \Drupal\Core\Entity\EntityTypeManagerInterface */ - protected $entityManager; + protected $entityTypeManager; /** * {@inheritdoc} @@ -37,14 +38,13 @@ class SectionStorageOverridesParamConverterTest extends UnitTestCase { protected function setUp() { parent::setUp(); - $this->entityManager = $this->prophesize(EntityManagerInterface::class); - $this->converter = new SectionStorageOverridesParamConverter($this->entityManager->reveal()); + $this->entityTypeManager = $this->prophesize(EntityTypeManagerInterface::class); + $entity_field_manager = $this->prophesize(EntityFieldManagerInterface::class); + $this->plugin = new OverridesSectionStorage([], '', [], $this->entityTypeManager->reveal(), $entity_field_manager->reveal()); } /** * @covers ::convert - * @covers ::getEntityTypeFromDefaults - * @covers ::getEntityIdFromDefaults * * @dataProvider providerTestConvert */ @@ -64,15 +64,15 @@ public function testConvert($success, $expected_entity_type_id, $value, array $d $entity_with_layout->get('layout_builder__layout')->willReturn('the_return_value'); $entity_storage->load('entity_with_layout')->willReturn($entity_with_layout->reveal()); - $this->entityManager->getDefinition($expected_entity_type_id)->willReturn(new EntityType(['id' => 'entity_view_display'])); - $this->entityManager->getStorage($expected_entity_type_id)->willReturn($entity_storage->reveal()); + $this->entityTypeManager->getDefinition($expected_entity_type_id)->willReturn(new EntityType(['id' => 'entity_view_display'])); + $this->entityTypeManager->getStorage($expected_entity_type_id)->willReturn($entity_storage->reveal()); } else { - $this->entityManager->getDefinition(Argument::any())->shouldNotBeCalled(); - $this->entityManager->getStorage(Argument::any())->shouldNotBeCalled(); + $this->entityTypeManager->getDefinition(Argument::any())->shouldNotBeCalled(); + $this->entityTypeManager->getStorage(Argument::any())->shouldNotBeCalled(); } - $result = $this->converter->convert($value, [], 'the_parameter_name', $defaults); + $result = $this->plugin->convert($value, [], 'the_parameter_name', $defaults); if ($success) { $this->assertEquals('the_return_value', $result); }