diff --git a/core/modules/layout_builder/layout_builder.routing.yml b/core/modules/layout_builder/layout_builder.routing.yml index 9846553862..322e2301c1 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 38933073d9..6f5f3e2c60 100644 --- a/core/modules/layout_builder/layout_builder.services.yml +++ b/core/modules/layout_builder/layout_builder.services.yml @@ -6,9 +6,12 @@ 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: @@ -17,15 +20,9 @@ services: - { 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.defaults: - class: Drupal\layout_builder\Routing\SectionStorageDefaultsParamConverter - arguments: ['@entity.manager'] - 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/Entity/LayoutBuilderEntityViewDisplay.php b/core/modules/layout_builder/src/Entity/LayoutBuilderEntityViewDisplay.php index 9ed5f73ecb..6b62f6b418 100644 --- a/core/modules/layout_builder/src/Entity/LayoutBuilderEntityViewDisplay.php +++ b/core/modules/layout_builder/src/Entity/LayoutBuilderEntityViewDisplay.php @@ -12,11 +12,11 @@ use Drupal\Core\Plugin\Context\Context; use Drupal\Core\Plugin\Context\ContextDefinition; use Drupal\Core\StringTranslation\TranslatableMarkup; -use Drupal\Core\Url; use Drupal\field\Entity\FieldConfig; use Drupal\field\Entity\FieldStorageConfig; use Drupal\layout_builder\Section; use Drupal\layout_builder\SectionComponent; +use Drupal\layout_builder\SectionStorage\SectionStorageTrait; /** * Provides an entity view display entity that has a layout. @@ -28,6 +28,8 @@ */ class LayoutBuilderEntityViewDisplay extends BaseEntityViewDisplay implements LayoutEntityDisplayInterface { + use SectionStorageTrait; + /** * {@inheritdoc} */ @@ -51,104 +53,13 @@ public function getSections() { } /** - * Store the information for all sections. - * - * @param \Drupal\layout_builder\Section[] $sections - * The sections information. - * - * @return $this + * {@inheritdoc} */ protected function setSections(array $sections) { $this->setThirdPartySetting('layout_builder', 'sections', array_values($sections)); return $this; } - /** - * {@inheritdoc} - */ - public function count() { - return count($this->getSections()); - } - - /** - * {@inheritdoc} - */ - public function getSection($delta) { - if (!$this->hasSection($delta)) { - throw new \OutOfBoundsException(sprintf('Invalid delta "%s" for the "%s" entity', $delta, $this->id())); - } - - 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)) { - $sections = $this->getSections(); - // @todo Use https://www.drupal.org/node/66183 once resolved. - $start = array_slice($sections, 0, $delta); - $end = array_slice($sections, $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) { - $sections = $this->getSections(); - return isset($sections[$delta]); - } - /** * {@inheritdoc} */ @@ -258,29 +169,7 @@ public function buildMultiple(array $entities) { /** * {@inheritdoc} */ - public function getContexts() { - $entity = $this->getSampleEntity($this->getTargetEntityTypeId(), $this->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; - } - - /** - * Returns a sample entity. - * - * @param string $entity_type_id - * The entity type ID. - * @param string $bundle_id - * The bundle ID. - * - * @return \Drupal\Core\Entity\EntityInterface - * An entity. - */ - protected function getSampleEntity($entity_type_id, $bundle_id) { + 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")) { @@ -328,51 +217,6 @@ public function label() { return new TranslatableMarkup('@bundle @label', ['@bundle' => $bundle_label, '@label' => $target_entity_type->getPluralLabel()]); } - /** - * {@inheritdoc} - */ - public static function getStorageType() { - return 'defaults'; - } - - /** - * {@inheritdoc} - */ - public function getStorageId() { - return $this->id(); - } - - /** - * {@inheritdoc} - */ - public function getCanonicalUrl() { - return Url::fromRoute("entity.entity_view_display.{$this->getTargetEntityTypeId()}.view_mode", $this->getRouteParameters()); - } - - /** - * {@inheritdoc} - */ - public function getLayoutBuilderUrl() { - return Url::fromRoute("entity.entity_view_display.{$this->getTargetEntityTypeId()}.layout_builder", $this->getRouteParameters()); - } - - /** - * Returns the route parameters needed to build routes for this entity. - * - * @return string[] - * An array of route parameters. - */ - protected function getRouteParameters() { - $route_parameters = []; - - $entity_type = $this->entityTypeManager()->getDefinition($this->getTargetEntityTypeId()); - $bundle_parameter_key = $entity_type->getBundleEntityType() ?: 'bundle'; - $route_parameters[$bundle_parameter_key] = $this->getTargetBundle(); - - $route_parameters['view_mode_name'] = $this->getMode(); - return $route_parameters; - } - /** * {@inheritdoc} */ diff --git a/core/modules/layout_builder/src/Entity/LayoutEntityDisplayInterface.php b/core/modules/layout_builder/src/Entity/LayoutEntityDisplayInterface.php index 1affc53b39..ac6dae2aea 100644 --- a/core/modules/layout_builder/src/Entity/LayoutEntityDisplayInterface.php +++ b/core/modules/layout_builder/src/Entity/LayoutEntityDisplayInterface.php @@ -3,7 +3,7 @@ namespace Drupal\layout_builder\Entity; use Drupal\Core\Entity\Display\EntityDisplayInterface; -use Drupal\layout_builder\SectionStorageInterface; +use Drupal\layout_builder\SectionListInterface; /** * Provides an interface for entity displays that have layout. @@ -13,7 +13,7 @@ * experimental modules and development releases of contributed modules. * See https://www.drupal.org/core/experimental for more information. */ -interface LayoutEntityDisplayInterface extends EntityDisplayInterface, SectionStorageInterface { +interface LayoutEntityDisplayInterface extends EntityDisplayInterface, SectionListInterface { /** * Determines if the display allows custom overrides. @@ -33,4 +33,17 @@ public function isOverridable(); */ public function setOverridable($overridable = TRUE); + /** + * Returns a sample entity. + * + * @param string $entity_type_id + * The entity type ID. + * @param string $bundle_id + * The bundle ID. + * + * @return \Drupal\Core\Entity\EntityInterface + * An entity. + */ + public function getSampleEntity($entity_type_id, $bundle_id); + } diff --git a/core/modules/layout_builder/src/Field/LayoutSectionItemList.php b/core/modules/layout_builder/src/Field/LayoutSectionItemList.php index f67f90eba4..a2ceca1373 100644 --- a/core/modules/layout_builder/src/Field/LayoutSectionItemList.php +++ b/core/modules/layout_builder/src/Field/LayoutSectionItemList.php @@ -3,13 +3,8 @@ namespace Drupal\layout_builder\Field; use Drupal\Core\Field\FieldItemList; -use Drupal\Core\Plugin\Context\Context; -use Drupal\Core\Plugin\Context\ContextDefinition; -use Drupal\Core\StringTranslation\TranslatableMarkup; -use Drupal\layout_builder\Entity\LayoutBuilderEntityViewDisplay; -use Drupal\layout_builder\OverridesSectionStorageInterface; -use Drupal\layout_builder\Section; -use Drupal\layout_builder\SectionStorageInterface; +use Drupal\layout_builder\SectionListInterface; +use Drupal\layout_builder\SectionStorage\SectionStorageTrait; /** * Defines a item list class for layout section fields. @@ -18,35 +13,9 @@ * * @see \Drupal\layout_builder\Plugin\Field\FieldType\LayoutSectionItem */ -class LayoutSectionItemList extends FieldItemList implements SectionStorageInterface, OverridesSectionStorageInterface { +class LayoutSectionItemList extends FieldItemList implements SectionListInterface { - /** - * {@inheritdoc} - */ - public function insertSection($delta, Section $section) { - if ($this->get($delta)) { - /** @var \Drupal\layout_builder\Plugin\Field\FieldType\LayoutSectionItem $item */ - $item = $this->createItem($delta); - $item->section = $section; - - // @todo Use https://www.drupal.org/node/66183 once resolved. - $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} @@ -63,84 +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 static 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} - */ - public function getDefaultSectionStorage() { - return LayoutBuilderEntityViewDisplay::collectRenderDisplay($this->getEntity(), 'default'); - } - /** * {@inheritdoc} */ diff --git a/core/modules/layout_builder/src/Form/LayoutBuilderEntityViewDisplayForm.php b/core/modules/layout_builder/src/Form/LayoutBuilderEntityViewDisplayForm.php index 9fa20648ff..32b378681b 100644 --- a/core/modules/layout_builder/src/Form/LayoutBuilderEntityViewDisplayForm.php +++ b/core/modules/layout_builder/src/Form/LayoutBuilderEntityViewDisplayForm.php @@ -6,6 +6,7 @@ use Drupal\Core\Form\FormStateInterface; use Drupal\field_ui\Form\EntityViewDisplayEditForm; use Drupal\layout_builder\Entity\LayoutEntityDisplayInterface; +use Drupal\layout_builder\SectionStorageInterface; /** * Edit form for the LayoutBuilderEntityViewDisplay entity type. @@ -24,6 +25,21 @@ class LayoutBuilderEntityViewDisplayForm extends EntityViewDisplayEditForm { */ protected $entity; + /** + * The storage section. + * + * @var \Drupal\layout_builder\SectionStorageInterface + */ + protected $sectionStorage; + + /** + * {@inheritdoc} + */ + public function buildForm(array $form, FormStateInterface $form_state, SectionStorageInterface $section_storage = NULL) { + $this->sectionStorage = $section_storage; + return parent::buildForm($form, $form_state); + } + /** * {@inheritdoc} */ @@ -40,7 +56,7 @@ public function form(array $form, FormStateInterface $form_state) { '#title' => $this->t('Manage layout'), '#weight' => -10, '#attributes' => ['class' => ['button']], - '#url' => $this->entity->getLayoutBuilderUrl(), + '#url' => $this->sectionStorage->getLayoutBuilderUrl(), ]; // @todo Expand to work for all view modes in diff --git a/core/modules/layout_builder/src/Plugin/Derivative/LayoutBuilderLocalTaskDeriver.php b/core/modules/layout_builder/src/Plugin/Derivative/LayoutBuilderLocalTaskDeriver.php index 94160a7736..c2046c0fd4 100644 --- a/core/modules/layout_builder/src/Plugin/Derivative/LayoutBuilderLocalTaskDeriver.php +++ b/core/modules/layout_builder/src/Plugin/Derivative/LayoutBuilderLocalTaskDeriver.php @@ -52,59 +52,52 @@ public static function create(ContainerInterface $container, $base_plugin_id) { public function getDerivativeDefinitions($base_plugin_definition) { foreach ($this->getEntityTypes() as $entity_type_id => $entity_type) { // Overrides. - $this->derivatives["entity.$entity_type_id.layout_builder"] = $base_plugin_definition + [ - 'route_name' => "entity.$entity_type_id.layout_builder", + $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], ]; // @todo This link should be conditionally displayed, see // https://www.drupal.org/node/2917777. - $this->derivatives["entity.$entity_type_id.layout_builder_revert"] = $base_plugin_definition + [ - 'route_name' => "entity.$entity_type_id.layout_builder_revert", + $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: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' => 10, 'cache_contexts' => ['layout_builder_is_active:' . $entity_type_id], ]; // Defaults. - $this->derivatives["entity.entity_view_display.$entity_type_id.layout_builder"] = $base_plugin_definition + [ - 'route_name' => "entity.entity_view_display.$entity_type_id.layout_builder", + $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' => "entity.entity_view_display.$entity_type_id.layout_builder", - 'entity_type_id' => $entity_type_id, + 'base_route' => "layout_builder.defaults.$entity_type_id.view", ]; - $this->derivatives["entity.entity_view_display.$entity_type_id.layout_builder_save"] = $base_plugin_definition + [ - 'route_name' => "entity.entity_view_display.$entity_type_id.layout_builder_save", + $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:entity.entity_view_display.$entity_type_id.layout_builder", - 'entity_type_id' => $entity_type_id, + 'parent_id' => "layout_builder_ui:layout_builder.defaults.$entity_type_id.view", ]; - $this->derivatives["entity.entity_view_display.$entity_type_id.layout_builder_cancel"] = $base_plugin_definition + [ - 'route_name' => "entity.entity_view_display.$entity_type_id.layout_builder_cancel", + $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:entity.entity_view_display.$entity_type_id.layout_builder", - 'entity_type_id' => $entity_type_id, + 'parent_id' => "layout_builder_ui:layout_builder.defaults.$entity_type_id.view", ]; } 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..3e351181db --- /dev/null +++ b/core/modules/layout_builder/src/Plugin/SectionStorage/DefaultsSectionStorage.php @@ -0,0 +1,260 @@ +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->getSectionList(); + } + + /** + * {@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(), $path, $defaults, $requirements, $options, $entity_type_id); + + $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() { + return $this->getDisplay()->label(); + } + + /** + * {@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..df09f32cdc --- /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->getSectionList()->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(), $template, $defaults, $requirements, $options, $entity_type_id); + } + } + + /** + * 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..35b361d54c --- /dev/null +++ b/core/modules/layout_builder/src/Plugin/SectionStorage/SectionStorageBase.php @@ -0,0 +1,106 @@ +sectionList = $section_list; + return $this; + } + + /** + * Gets the section list. + * + * @return \Drupal\layout_builder\SectionListInterface + * The section list. + * + * @throws \RuntimeException + * Thrown if ::setSectionList() is not called first. + */ + protected function getSectionList() { + if (!$this->sectionList) { + throw new \RuntimeException(sprintf('%s::setSectionList() must be called first', static::class)); + } + return $this->sectionList; + } + + /** + * {@inheritdoc} + */ + public function getStorageType() { + return $this->getPluginId(); + } + + /** + * {@inheritdoc} + */ + public function count() { + return $this->getSectionList()->count(); + } + + /** + * {@inheritdoc} + */ + public function getSections() { + return $this->getSectionList()->getSections(); + } + + /** + * {@inheritdoc} + */ + public function getSection($delta) { + return $this->getSectionList()->getSection($delta); + } + + /** + * {@inheritdoc} + */ + public function appendSection(Section $section) { + $this->getSectionList()->appendSection($section); + return $this; + } + + /** + * {@inheritdoc} + */ + public function insertSection($delta, Section $section) { + $this->getSectionList()->insertSection($delta, $section); + return $this; + } + + /** + * {@inheritdoc} + */ + public function removeSection($delta) { + $this->getSectionList()->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 500a380a11..fae21a9f9e 100644 --- a/core/modules/layout_builder/src/Routing/LayoutBuilderRoutes.php +++ b/core/modules/layout_builder/src/Routing/LayoutBuilderRoutes.php @@ -2,14 +2,9 @@ namespace Drupal\layout_builder\Routing; -use Drupal\Component\Utility\NestedArray; -use Drupal\Core\Entity\EntityFieldManagerInterface; -use Drupal\Core\Entity\EntityTypeInterface; -use Drupal\Core\Entity\EntityTypeManagerInterface; use Drupal\Core\Routing\RouteBuildEvent; use Drupal\Core\Routing\RoutingEvents; -use Drupal\layout_builder\Entity\LayoutBuilderEntityViewDisplay; -use Drupal\layout_builder\Field\LayoutSectionItemList; +use Drupal\layout_builder\SectionStorage\SectionStorageManagerInterface; use Symfony\Component\EventDispatcher\EventSubscriberInterface; /** @@ -19,61 +14,21 @@ */ class LayoutBuilderRoutes implements EventSubscriberInterface { - use LayoutBuilderRoutesTrait; - /** - * 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; - } - - /** - * Generates layout builder routes. - * - * @return \Symfony\Component\Routing\Route[] - * An array of route objects. - */ - 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(LayoutSectionItemList::class, 'entity.' . $entity_type_id, $template, $defaults, $requirements, $options); - } - return $routes; + public function __construct(SectionStorageManagerInterface $section_storage_manager) { + $this->sectionStorageManager = $section_storage_manager; } /** @@ -84,70 +39,11 @@ public function getRoutes() { */ public function onAlterRoutes(RouteBuildEvent $event) { $collection = $event->getRouteCollection(); - foreach ($this->getEntityTypes() as $entity_type_id => $entity_type) { - if ($route_name = $entity_type->get('field_ui_base_route')) { - // Try to get the route from the current collection. - if (!$entity_route = $collection->get($route_name)) { - 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['parameters']['section_storage']['layout_builder_tempstore'] = TRUE; - // Merge the entity route options in after Layout Builder's. - $options = NestedArray::mergeDeep($options, $entity_route->getOptions()); - // Disable the admin route flag after merging in entity route options. - $options['_admin_route'] = FALSE; - - $routes = $this->buildRoute(LayoutBuilderEntityViewDisplay::class, 'entity.entity_view_display.' . $entity_type_id, $path, $defaults, $requirements, $options); - foreach ($routes as $name => $route) { - $collection->add($name, $route); - } - } + foreach ($this->sectionStorageManager->getDefinitions() as $plugin_id => $definition) { + $this->sectionStorageManager->loadEmpty($plugin_id)->alterRoutes($collection); } } - /** - * 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} */ diff --git a/core/modules/layout_builder/src/Routing/LayoutBuilderRoutesTrait.php b/core/modules/layout_builder/src/Routing/LayoutBuilderRoutesTrait.php index da9e1c1759..4a2a4431f1 100644 --- a/core/modules/layout_builder/src/Routing/LayoutBuilderRoutesTrait.php +++ b/core/modules/layout_builder/src/Routing/LayoutBuilderRoutesTrait.php @@ -2,9 +2,11 @@ namespace Drupal\layout_builder\Routing; +use Drupal\Component\Utility\NestedArray; use Drupal\layout_builder\OverridesSectionStorageInterface; -use Drupal\layout_builder\SectionStorageInterface; +use Drupal\layout_builder\SectionStorage\SectionStorageDefinition; use Symfony\Component\Routing\Route; +use Symfony\Component\Routing\RouteCollection; /** * Provides a trait for building routes for a Layout Builder UI. @@ -19,36 +21,41 @@ /** * Builds the layout routes for the given values. * - * @param string $class - * The class defining the section storage. - * @param string $route_name_prefix - * The prefix to use for the route name. + * @param \Symfony\Component\Routing\RouteCollection $collection + * The route collection. + * @param \Drupal\layout_builder\SectionStorage\SectionStorageDefinition $definition + * The definition of the section storage. * @param string $path * The path patten for the routes. * @param array $defaults - * An array of default parameter values. + * (optional) An array of default parameter values. * @param array $requirements - * An array of requirements for parameters. + * (optional) An array of requirements for parameters. * @param array $options - * An array of options. - * - * @return \Symfony\Component\Routing\Route[] - * An array of route objects. + * (optional) An array of options. + * @param string $route_name_prefix + * (optional) The prefix to use for the route name. */ - protected function buildRoute($class, $route_name_prefix, $path, array $defaults, array $requirements, array $options) { - $routes = []; - - if (!is_subclass_of($class, SectionStorageInterface::class)) { - return $routes; - } - - $defaults['section_storage_type'] = $class::getStorageType(); + protected function buildRoute(RouteCollection $collection, SectionStorageDefinition $definition, $path, array $defaults = [], array $requirements = [], array $options = [], $route_name_prefix = '') { + $type = $definition->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); + + if ($route_name_prefix) { + $route_name_prefix = "layout_builder.$type.$route_name_prefix"; + } + else { + $route_name_prefix = "layout_builder.$type"; + } $main_defaults = $defaults; $main_defaults['is_rebuilding'] = FALSE; @@ -58,7 +65,7 @@ protected function buildRoute($class, $route_name_prefix, $path, array $defaults ->setDefaults($main_defaults) ->setRequirements($requirements) ->setOptions($options); - $routes["{$route_name_prefix}.layout_builder"] = $route; + $collection->add("$route_name_prefix.view", $route); $save_defaults = $defaults; $save_defaults['_controller'] = '\Drupal\layout_builder\Controller\LayoutBuilderController::saveLayout'; @@ -66,7 +73,7 @@ protected function buildRoute($class, $route_name_prefix, $path, array $defaults ->setDefaults($save_defaults) ->setRequirements($requirements) ->setOptions($options); - $routes["{$route_name_prefix}.layout_builder_save"] = $route; + $collection->add("$route_name_prefix.save", $route); $cancel_defaults = $defaults; $cancel_defaults['_controller'] = '\Drupal\layout_builder\Controller\LayoutBuilderController::cancelLayout'; @@ -74,19 +81,17 @@ protected function buildRoute($class, $route_name_prefix, $path, array $defaults ->setDefaults($cancel_defaults) ->setRequirements($requirements) ->setOptions($options); - $routes["{$route_name_prefix}.layout_builder_cancel"] = $route; + $collection->add("$route_name_prefix.cancel", $route); - if (is_subclass_of($class, OverridesSectionStorageInterface::class)) { + if (is_subclass_of($definition->getClass(), OverridesSectionStorageInterface::class)) { $revert_defaults = $defaults; $revert_defaults['_form'] = '\Drupal\layout_builder\Form\RevertOverridesForm'; $route = (new Route("$path/revert")) ->setDefaults($revert_defaults) ->setRequirements($requirements) ->setOptions($options); - $routes["{$route_name_prefix}.layout_builder_revert"] = $route; + $collection->add("$route_name_prefix.revert", $route); } - - return $routes; } } 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/SectionStorageDefaultsParamConverter.php b/core/modules/layout_builder/src/Routing/SectionStorageDefaultsParamConverter.php deleted file mode 100644 index 2f886102c3..0000000000 --- a/core/modules/layout_builder/src/Routing/SectionStorageDefaultsParamConverter.php +++ /dev/null @@ -1,53 +0,0 @@ -entityManager->getStorage('entity_view_display')->create([ - 'targetEntityType' => $entity_type_id, - 'bundle' => $bundle, - 'mode' => $view_mode, - 'status' => TRUE, - ]); - } - return $display; - } - - /** - * {@inheritdoc} - */ - protected function getEntityTypeFromDefaults($definition, $name, array $defaults) { - return 'entity_view_display'; - } - -} 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 @@ - $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..674580fc6c --- /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 loadFromSectionList($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..be1c0d2b42 --- /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 cc1efaba2a..f7ca5a3350 100644 --- a/core/modules/layout_builder/src/SectionStorageInterface.php +++ b/core/modules/layout_builder/src/SectionStorageInterface.php @@ -2,82 +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[] - * A sequentially and numerically keyed array of section objects. - */ - 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. - * - * 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. - * - * @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. @@ -95,7 +31,71 @@ public function getStorageId(); * @return string * The type of storage. */ - public static function getStorageType(); + 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|null + * 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. @@ -114,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 e0dfdc7f42..0437c1ca85 100644 --- a/core/modules/layout_builder/tests/src/Functional/LayoutSectionTest.php +++ b/core/modules/layout_builder/tests/src/Functional/LayoutSectionTest.php @@ -169,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'); } @@ -255,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()); } @@ -274,7 +275,8 @@ public function testLayoutUrlNoSectionField() { ], ]); $node->save(); - $this->drupalGet($node->toUrl('layout-builder')); + + $this->drupalGet($node->toUrl('canonical')->toString() . '/layout'); $this->assertSession()->statusCodeEquals(404); } diff --git a/core/modules/layout_builder/tests/src/Kernel/LayoutBuilderEntityViewDisplayTest.php b/core/modules/layout_builder/tests/src/Kernel/LayoutBuilderEntityViewDisplayTest.php index 034a76628e..a554fb526f 100644 --- a/core/modules/layout_builder/tests/src/Kernel/LayoutBuilderEntityViewDisplayTest.php +++ b/core/modules/layout_builder/tests/src/Kernel/LayoutBuilderEntityViewDisplayTest.php @@ -31,14 +31,6 @@ protected function getSectionStorage(array $section_data) { return $display; } - /** - * @covers ::getSection - */ - public function testGetSectionInvalidDelta() { - $this->setExpectedException(\OutOfBoundsException::class, 'Invalid delta "2" for the "entity_test.entity_test.default"'); - $this->sectionStorage->getSection(2); - } - /** * Tests that configuration schema enforces valid values. */ diff --git a/core/modules/layout_builder/tests/src/Kernel/SectionStorageTestBase.php b/core/modules/layout_builder/tests/src/Kernel/SectionStorageTestBase.php index 151cf736f9..1879977633 100644 --- a/core/modules/layout_builder/tests/src/Kernel/SectionStorageTestBase.php +++ b/core/modules/layout_builder/tests/src/Kernel/SectionStorageTestBase.php @@ -83,7 +83,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..6048941a0e --- /dev/null +++ b/core/modules/layout_builder/tests/src/Unit/DefaultsSectionStorageTest.php @@ -0,0 +1,312 @@ +entityTypeManager = $this->prophesize(EntityTypeManagerInterface::class); + $entity_type_bundle_info = $this->prophesize(EntityTypeBundleInfoInterface::class); + + $definition = new SectionStorageDefinition([ + 'id' => 'defaults', + 'class' => DefaultsSectionStorage::class, + ]); + $this->plugin = new DefaultsSectionStorage([], '', $definition, $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', []); + $this->assertSame($expected, $result); + } + + /** + * @covers ::alterRoutes + * @covers ::getEntityTypes + */ + public function testAlterRoutes() { + $entity_types = []; + $entity_types['no_link_template'] = new EntityType(['id' => 'no_link_template']); + $entity_types['unknown_field_ui_route'] = new EntityType([ + 'id' => 'unknown_field_ui_route', + 'links' => ['layout-builder' => '/entity/{entity}/layout'], + 'entity_keys' => ['id' => 'id'], + 'field_ui_base_route' => 'unknown', + ]); + $entity_types['with_bundle_key'] = new EntityType([ + 'id' => 'with_bundle_key', + 'links' => ['layout-builder' => '/entity/{entity}/layout'], + 'entity_keys' => ['id' => 'id', 'bundle' => 'bundle'], + 'bundle_entity_type' => 'my_bundle_type', + 'field_ui_base_route' => 'known', + ]); + $entity_types['with_bundle_parameter'] = new EntityType([ + 'id' => 'with_bundle_parameter', + 'links' => ['layout-builder' => '/entity/{entity}/layout'], + 'entity_keys' => ['id' => 'id'], + 'field_ui_base_route' => 'with_bundle', + ]); + $this->entityTypeManager->getDefinitions()->willReturn($entity_types); + + $expected = [ + 'known' => new Route('/admin/entity/whatever', [], [], ['_admin_route' => TRUE]), + 'with_bundle' => new Route('/admin/entity/{bundle}'), + '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, + ] + ), + ]; + + $collection = new RouteCollection(); + $collection->add('known', new Route('/admin/entity/whatever', [], [], ['_admin_route' => TRUE])); + $collection->add('with_bundle', new Route('/admin/entity/{bundle}')); + + $this->plugin->alterRoutes($collection); + $this->assertEquals($expected, $collection->all()); + $this->assertSame(array_keys($expected), array_keys($collection->all())); + } + +} diff --git a/core/modules/layout_builder/tests/src/Unit/LayoutBuilderRoutesTest.php b/core/modules/layout_builder/tests/src/Unit/LayoutBuilderRoutesTest.php index 961b870429..14b385f927 100644 --- a/core/modules/layout_builder/tests/src/Unit/LayoutBuilderRoutesTest.php +++ b/core/modules/layout_builder/tests/src/Unit/LayoutBuilderRoutesTest.php @@ -2,13 +2,13 @@ namespace Drupal\Tests\layout_builder\Unit; -use Drupal\Core\Entity\EntityFieldManagerInterface; -use Drupal\Core\Entity\EntityType; -use Drupal\Core\Entity\EntityTypeManagerInterface; -use Drupal\Core\Field\FieldStorageDefinitionInterface; use Drupal\Core\Routing\RouteBuildEvent; use Drupal\layout_builder\Routing\LayoutBuilderRoutes; +use Drupal\layout_builder\SectionStorage\SectionStorageDefinition; +use Drupal\layout_builder\SectionStorage\SectionStorageManagerInterface; +use Drupal\layout_builder\SectionStorageInterface; use Drupal\Tests\UnitTestCase; +use Prophecy\Argument; use Symfony\Component\Routing\Route; use Symfony\Component\Routing\RouteCollection; @@ -19,6 +19,13 @@ */ class LayoutBuilderRoutesTest extends UnitTestCase { + /** + * The Layout Builder route builder. + * + * @var \Drupal\layout_builder\SectionStorage\SectionStorageManagerInterface + */ + protected $sectionStorageManager; + /** * The Layout Builder route builder. * @@ -32,685 +39,46 @@ class LayoutBuilderRoutesTest extends UnitTestCase { protected function setUp() { parent::setUp(); - $entity_types = []; - $entity_types['no_link_template'] = new EntityType(['id' => 'no_link_template']); - $entity_types['with_link_template'] = new EntityType([ - 'id' => 'with_link_template', - 'links' => ['layout-builder' => '/entity/{entity}/layout'], - 'entity_keys' => ['id' => 'id'], - 'field_ui_base_route' => 'unknown', - ]); - $entity_types['with_integer_id'] = new EntityType([ - 'id' => 'with_integer_id', - 'links' => ['layout-builder' => '/entity/{entity}/layout'], - 'entity_keys' => ['id' => 'id'], - ]); - $entity_types['with_field_ui_route'] = new EntityType([ - 'id' => 'with_field_ui_route', - 'links' => ['layout-builder' => '/entity/{entity}/layout'], - 'entity_keys' => ['id' => 'id'], - 'field_ui_base_route' => 'known', - ]); - $entity_types['with_bundle_key'] = new EntityType([ - 'id' => 'with_field_ui_route', - 'links' => ['layout-builder' => '/entity/{entity}/layout'], - 'entity_keys' => ['id' => 'id', 'bundle' => 'bundle'], - 'bundle_entity_type' => 'my_bundle_type', - 'field_ui_base_route' => 'known', - ]); - $entity_types['with_bundle_parameter'] = new EntityType([ - 'id' => 'with_bundle_parameter', - 'links' => ['layout-builder' => '/entity/{entity}/layout'], - 'entity_keys' => ['id' => 'id'], - 'field_ui_base_route' => 'with_bundle', - ]); - $entity_type_manager = $this->prophesize(EntityTypeManagerInterface::class); - $entity_type_manager->getDefinitions()->willReturn($entity_types); - - $string_id = $this->prophesize(FieldStorageDefinitionInterface::class); - $string_id->getType()->willReturn('string'); - $integer_id = $this->prophesize(FieldStorageDefinitionInterface::class); - $integer_id->getType()->willReturn('integer'); - $entity_field_manager = $this->prophesize(EntityFieldManagerInterface::class); - $entity_field_manager->getFieldStorageDefinitions('no_link_template')->shouldNotBeCalled(); - $entity_field_manager->getFieldStorageDefinitions('with_link_template')->willReturn(['id' => $string_id->reveal()]); - $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()]); - - $this->routeBuilder = new LayoutBuilderRoutes($entity_type_manager->reveal(), $entity_field_manager->reveal()); - } - - /** - * @covers ::getRoutes - * @covers ::buildRoute - * @covers ::hasIntegerId - * @covers ::getEntityTypes - */ - public function testGetRoutes() { - $expected = [ - 'entity.with_link_template.layout_builder' => new Route( - '/entity/{entity}/layout', - [ - 'entity_type_id' => 'with_link_template', - 'section_storage_type' => 'overrides', - 'section_storage' => '', - 'is_rebuilding' => FALSE, - '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::layout', - '_title_callback' => '\Drupal\layout_builder\Controller\LayoutBuilderController::title', - ], - [ - '_has_layout_section' => 'true', - ], - [ - 'parameters' => [ - 'section_storage' => ['layout_builder_tempstore' => TRUE], - 'with_link_template' => ['type' => 'entity:with_link_template'], - ], - '_layout_builder' => TRUE, - ] - ), - 'entity.with_link_template.layout_builder_save' => new Route( - '/entity/{entity}/layout/save', - [ - 'entity_type_id' => 'with_link_template', - 'section_storage_type' => 'overrides', - 'section_storage' => '', - '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::saveLayout', - ], - [ - '_has_layout_section' => 'true', - ], - [ - 'parameters' => [ - 'section_storage' => ['layout_builder_tempstore' => TRUE], - 'with_link_template' => ['type' => 'entity:with_link_template'], - ], - '_layout_builder' => TRUE, - ] - ), - 'entity.with_link_template.layout_builder_cancel' => new Route( - '/entity/{entity}/layout/cancel', - [ - 'entity_type_id' => 'with_link_template', - 'section_storage_type' => 'overrides', - 'section_storage' => '', - '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::cancelLayout', - ], - [ - '_has_layout_section' => 'true', - ], - [ - 'parameters' => [ - 'section_storage' => ['layout_builder_tempstore' => TRUE], - 'with_link_template' => ['type' => 'entity:with_link_template'], - ], - '_layout_builder' => TRUE, - ] - ), - 'entity.with_link_template.layout_builder_revert' => new Route( - '/entity/{entity}/layout/revert', - [ - 'entity_type_id' => 'with_link_template', - 'section_storage_type' => 'overrides', - 'section_storage' => '', - '_form' => '\Drupal\layout_builder\Form\RevertOverridesForm', - ], - [ - '_has_layout_section' => 'true', - ], - [ - 'parameters' => [ - 'section_storage' => ['layout_builder_tempstore' => TRUE], - 'with_link_template' => ['type' => 'entity:with_link_template'], - ], - '_layout_builder' => TRUE, - ] - ), - 'entity.with_integer_id.layout_builder' => new Route( - '/entity/{entity}/layout', - [ - 'entity_type_id' => 'with_integer_id', - 'section_storage_type' => 'overrides', - 'section_storage' => '', - 'is_rebuilding' => FALSE, - '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::layout', - '_title_callback' => '\Drupal\layout_builder\Controller\LayoutBuilderController::title', - ], - [ - '_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, - ] - ), - 'entity.with_integer_id.layout_builder_save' => new Route( - '/entity/{entity}/layout/save', - [ - 'entity_type_id' => 'with_integer_id', - 'section_storage_type' => 'overrides', - 'section_storage' => '', - '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::saveLayout', - ], - [ - '_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, - ] - ), - 'entity.with_integer_id.layout_builder_cancel' => new Route( - '/entity/{entity}/layout/cancel', - [ - 'entity_type_id' => 'with_integer_id', - 'section_storage_type' => 'overrides', - 'section_storage' => '', - '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::cancelLayout', - ], - [ - '_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, - ] - ), - 'entity.with_integer_id.layout_builder_revert' => new Route( - '/entity/{entity}/layout/revert', - [ - 'entity_type_id' => 'with_integer_id', - 'section_storage_type' => 'overrides', - 'section_storage' => '', - '_form' => '\Drupal\layout_builder\Form\RevertOverridesForm', - ], - [ - '_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, - ] - ), - 'entity.with_field_ui_route.layout_builder' => new Route( - '/entity/{entity}/layout', - [ - 'entity_type_id' => 'with_field_ui_route', - 'section_storage_type' => 'overrides', - 'section_storage' => '', - 'is_rebuilding' => FALSE, - '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::layout', - '_title_callback' => '\Drupal\layout_builder\Controller\LayoutBuilderController::title', - ], - [ - '_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, - ] - ), - 'entity.with_field_ui_route.layout_builder_save' => new Route( - '/entity/{entity}/layout/save', - [ - 'entity_type_id' => 'with_field_ui_route', - 'section_storage_type' => 'overrides', - 'section_storage' => '', - '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::saveLayout', - ], - [ - '_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, - ] - ), - 'entity.with_field_ui_route.layout_builder_cancel' => new Route( - '/entity/{entity}/layout/cancel', - [ - 'entity_type_id' => 'with_field_ui_route', - 'section_storage_type' => 'overrides', - 'section_storage' => '', - '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::cancelLayout', - ], - [ - '_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, - ] - ), - 'entity.with_field_ui_route.layout_builder_revert' => new Route( - '/entity/{entity}/layout/revert', - [ - 'entity_type_id' => 'with_field_ui_route', - 'section_storage_type' => 'overrides', - 'section_storage' => '', - '_form' => '\Drupal\layout_builder\Form\RevertOverridesForm', - ], - [ - '_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, - ] - ), - 'entity.with_bundle_key.layout_builder' => new Route( - '/entity/{entity}/layout', - [ - 'entity_type_id' => 'with_bundle_key', - 'section_storage_type' => 'overrides', - 'section_storage' => '', - 'is_rebuilding' => FALSE, - '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::layout', - '_title_callback' => '\Drupal\layout_builder\Controller\LayoutBuilderController::title', - ], - [ - '_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, - ] - ), - 'entity.with_bundle_key.layout_builder_save' => new Route( - '/entity/{entity}/layout/save', - [ - 'entity_type_id' => 'with_bundle_key', - 'section_storage_type' => 'overrides', - 'section_storage' => '', - '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::saveLayout', - ], - [ - '_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, - ] - ), - 'entity.with_bundle_key.layout_builder_cancel' => new Route( - '/entity/{entity}/layout/cancel', - [ - 'entity_type_id' => 'with_bundle_key', - 'section_storage_type' => 'overrides', - 'section_storage' => '', - '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::cancelLayout', - ], - [ - '_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, - ] - ), - 'entity.with_bundle_key.layout_builder_revert' => new Route( - '/entity/{entity}/layout/revert', - [ - 'entity_type_id' => 'with_bundle_key', - 'section_storage_type' => 'overrides', - 'section_storage' => '', - '_form' => '\Drupal\layout_builder\Form\RevertOverridesForm', - ], - [ - '_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, - ] - ), - 'entity.with_bundle_parameter.layout_builder' => new Route( - '/entity/{entity}/layout', - [ - 'entity_type_id' => 'with_bundle_parameter', - 'section_storage_type' => 'overrides', - 'section_storage' => '', - 'is_rebuilding' => FALSE, - '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::layout', - '_title_callback' => '\Drupal\layout_builder\Controller\LayoutBuilderController::title', - ], - [ - '_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, - ] - ), - 'entity.with_bundle_parameter.layout_builder_save' => new Route( - '/entity/{entity}/layout/save', - [ - 'entity_type_id' => 'with_bundle_parameter', - 'section_storage_type' => 'overrides', - 'section_storage' => '', - '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::saveLayout', - ], - [ - '_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, - ] - ), - 'entity.with_bundle_parameter.layout_builder_cancel' => new Route( - '/entity/{entity}/layout/cancel', - [ - 'entity_type_id' => 'with_bundle_parameter', - 'section_storage_type' => 'overrides', - 'section_storage' => '', - '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::cancelLayout', - ], - [ - '_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, - ] - ), - 'entity.with_bundle_parameter.layout_builder_revert' => new Route( - '/entity/{entity}/layout/revert', - [ - 'entity_type_id' => 'with_bundle_parameter', - 'section_storage_type' => 'overrides', - 'section_storage' => '', - '_form' => '\Drupal\layout_builder\Form\RevertOverridesForm', - ], - [ - '_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, - ] - ), - ]; - - $this->assertEquals($expected, $this->routeBuilder->getRoutes()); + $this->sectionStorageManager = $this->prophesize(SectionStorageManagerInterface::class); + $this->routeBuilder = new LayoutBuilderRoutes($this->sectionStorageManager->reveal()); } /** * @covers ::onAlterRoutes - * @covers ::buildRoute - * @covers ::hasIntegerId - * @covers ::getEntityTypes */ public function testOnAlterRoutes() { + $expected = [ + 'test_route1' => new Route('/test/path1'), + 'test_route_shared' => new Route('/test/path/shared2'), + 'test_route2' => new Route('/test/path2'), + ]; + + $section_storage_first = $this->prophesize(SectionStorageInterface::class); + $section_storage_first->alterRoutes(Argument::type(RouteCollection::class))->shouldBeCalled()->will(function ($args) { + /** @var \Symfony\Component\Routing\RouteCollection $collection */ + $collection = $args[0]; + $collection->add('test_route_shared', new Route('/test/path/shared1')); + $collection->add('test_route1', new Route('/test/path1')); + }); + $section_storage_second = $this->prophesize(SectionStorageInterface::class); + $section_storage_second->alterRoutes(Argument::type(RouteCollection::class))->shouldBeCalled()->will(function ($args) { + /** @var \Symfony\Component\Routing\RouteCollection $collection */ + $collection = $args[0]; + $collection->add('test_route_shared', new Route('/test/path/shared2')); + $collection->add('test_route2', new Route('/test/path2')); + }); + + $this->sectionStorageManager->loadEmpty('first')->willReturn($section_storage_first->reveal()); + $this->sectionStorageManager->loadEmpty('second')->willReturn($section_storage_second->reveal()); + $definitions['first'] = new SectionStorageDefinition(); + $definitions['second'] = new SectionStorageDefinition(); + $this->sectionStorageManager->getDefinitions()->willReturn($definitions); + $collection = new RouteCollection(); - $collection->add('known', new Route('/admin/entity/whatever', [], [], ['_admin_route' => TRUE])); - $collection->add('with_bundle', new Route('/admin/entity/{bundle}')); $event = new RouteBuildEvent($collection); - - $expected = [ - 'known' => new Route('/admin/entity/whatever', [], [], ['_admin_route' => TRUE]), - 'with_bundle' => new Route('/admin/entity/{bundle}'), - 'entity.entity_view_display.with_field_ui_route.layout_builder' => 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, - ] - ), - 'entity.entity_view_display.with_field_ui_route.layout_builder_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, - ] - ), - 'entity.entity_view_display.with_field_ui_route.layout_builder_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, - ] - ), - 'entity.entity_view_display.with_bundle_key.layout_builder' => 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, - ] - ), - 'entity.entity_view_display.with_bundle_key.layout_builder_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, - ] - ), - 'entity.entity_view_display.with_bundle_key.layout_builder_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, - ] - ), - 'entity.entity_view_display.with_bundle_parameter.layout_builder' => 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, - ] - ), - 'entity.entity_view_display.with_bundle_parameter.layout_builder_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, - ] - ), - 'entity.entity_view_display.with_bundle_parameter.layout_builder_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->routeBuilder->onAlterRoutes($event); - $this->assertEquals($expected, $event->getRouteCollection()->all()); + $this->assertEquals($expected, $collection->all()); + $this->assertSame(array_keys($expected), array_keys($collection->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 5d1f691271..0c74d01763 100644 --- a/core/modules/layout_builder/tests/src/Unit/LayoutTempstoreRepositoryTest.php +++ b/core/modules/layout_builder/tests/src/Unit/LayoutTempstoreRepositoryTest.php @@ -2,12 +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\Section; use Drupal\layout_builder\SectionStorageInterface; use Drupal\Tests\UnitTestCase; -use Drupal\Core\TempStore\SharedTempStore; -use Drupal\Core\TempStore\SharedTempStoreFactory; /** * @coversDefaultClass \Drupal\layout_builder\LayoutTempstoreRepository @@ -19,7 +18,9 @@ class LayoutTempstoreRepositoryTest extends UnitTestCase { * @covers ::get */ public function testGetEmptyTempstore() { - $section_storage = new TestSectionStorage(); + $section_storage = $this->prophesize(SectionStorageInterface::class); + $section_storage->getStorageType()->willReturn('my_storage_type'); + $section_storage->getStorageId()->willReturn('my_storage_id'); $tempstore = $this->prophesize(SharedTempStore::class); $tempstore->get('my_storage_id')->shouldBeCalled(); @@ -29,34 +30,38 @@ public function testGetEmptyTempstore() { $repository = new LayoutTempstoreRepository($tempstore_factory->reveal()); - $result = $repository->get($section_storage); - $this->assertSame($section_storage, $result); + $result = $repository->get($section_storage->reveal()); + $this->assertSame($section_storage->reveal(), $result); } /** * @covers ::get */ public function testGetLoadedTempstore() { - $section_storage = new TestSectionStorage(); + $section_storage = $this->prophesize(SectionStorageInterface::class); + $section_storage->getStorageType()->willReturn('my_storage_type'); + $section_storage->getStorageId()->willReturn('my_storage_id'); - $tempstore_section_storage = new TestSectionStorage(); + $tempstore_section_storage = $this->prophesize(SectionStorageInterface::class); $tempstore = $this->prophesize(SharedTempStore::class); - $tempstore->get('my_storage_id')->willReturn(['section_storage' => $tempstore_section_storage]); + $tempstore->get('my_storage_id')->willReturn(['section_storage' => $tempstore_section_storage->reveal()]); $tempstore_factory = $this->prophesize(SharedTempStoreFactory::class); $tempstore_factory->get('layout_builder.section_storage.my_storage_type')->willReturn($tempstore->reveal()); $repository = new LayoutTempstoreRepository($tempstore_factory->reveal()); - $result = $repository->get($section_storage); - $this->assertSame($tempstore_section_storage, $result); - $this->assertNotSame($section_storage, $result); + $result = $repository->get($section_storage->reveal()); + $this->assertSame($tempstore_section_storage->reveal(), $result); + $this->assertNotSame($section_storage->reveal(), $result); } /** * @covers ::get */ public function testGetInvalidEntry() { - $section_storage = new TestSectionStorage(); + $section_storage = $this->prophesize(SectionStorageInterface::class); + $section_storage->getStorageType()->willReturn('my_storage_type'); + $section_storage->getStorageId()->willReturn('my_storage_id'); $tempstore = $this->prophesize(SharedTempStore::class); $tempstore->get('my_storage_id')->willReturn(['section_storage' => 'this_is_not_an_entity']); @@ -67,85 +72,7 @@ public function testGetInvalidEntry() { $repository = new LayoutTempstoreRepository($tempstore_factory->reveal()); $this->setExpectedException(\UnexpectedValueException::class, 'The entry with storage type "my_storage_type" and ID "my_storage_id" is invalid'); - $repository->get($section_storage); + $repository->get($section_storage->reveal()); } } - -/** - * Provides a test implementation of section storage. - * - * @todo This works around https://github.com/phpspec/prophecy/issues/119. - */ -class TestSectionStorage implements SectionStorageInterface { - - /** - * {@inheritdoc} - */ - public static function getStorageType() { - return 'my_storage_type'; - } - - /** - * {@inheritdoc} - */ - public function getStorageId() { - return 'my_storage_id'; - } - - /** - * {@inheritdoc} - */ - public function count() {} - - /** - * {@inheritdoc} - */ - public function getSections() {} - - /** - * {@inheritdoc} - */ - public function getSection($delta) {} - - /** - * {@inheritdoc} - */ - public function appendSection(Section $section) {} - - /** - * {@inheritdoc} - */ - public function insertSection($delta, Section $section) {} - - /** - * {@inheritdoc} - */ - public function removeSection($delta) {} - - /** - * {@inheritdoc} - */ - public function getContexts() {} - - /** - * {@inheritdoc} - */ - public function label() {} - - /** - * {@inheritdoc} - */ - public function save() {} - - /** - * {@inheritdoc} - */ - public function getCanonicalUrl() {} - - /** - * {@inheritdoc} - */ - public function getLayoutBuilderUrl() {} - -} diff --git a/core/modules/layout_builder/tests/src/Unit/OverridesSectionStorageTest.php b/core/modules/layout_builder/tests/src/Unit/OverridesSectionStorageTest.php new file mode 100644 index 0000000000..f7979fc0d2 --- /dev/null +++ b/core/modules/layout_builder/tests/src/Unit/OverridesSectionStorageTest.php @@ -0,0 +1,335 @@ +entityTypeManager = $this->prophesize(EntityTypeManagerInterface::class); + $this->entityFieldManager = $this->prophesize(EntityFieldManagerInterface::class); + + $definition = new SectionStorageDefinition([ + 'id' => 'overrides', + 'class' => OverridesSectionStorage::class, + ]); + $this->plugin = new OverridesSectionStorage([], 'overrides', $definition, $this->entityTypeManager->reveal(), $this->entityFieldManager->reveal()); + } + + /** + * @covers ::convert + * + * @dataProvider providerTestConvert + */ + public function testConvert($success, $expected_entity_type_id, $value, array $defaults) { + $defaults['the_parameter_name'] = $value; + + if ($expected_entity_type_id) { + $entity_storage = $this->prophesize(EntityStorageInterface::class); + + $entity_without_layout = $this->prophesize(FieldableEntityInterface::class); + $entity_without_layout->hasField('layout_builder__layout')->willReturn(FALSE); + $entity_without_layout->get('layout_builder__layout')->shouldNotBeCalled(); + $entity_storage->load('entity_without_layout')->willReturn($entity_without_layout->reveal()); + + $entity_with_layout = $this->prophesize(FieldableEntityInterface::class); + $entity_with_layout->hasField('layout_builder__layout')->willReturn(TRUE); + $entity_with_layout->get('layout_builder__layout')->willReturn('the_return_value'); + $entity_storage->load('entity_with_layout')->willReturn($entity_with_layout->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->entityTypeManager->getDefinition(Argument::any())->shouldNotBeCalled(); + $this->entityTypeManager->getStorage(Argument::any())->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, with layout'] = [ + TRUE, + 'my_entity_type', + 'my_entity_type:entity_with_layout', + [], + ]; + $data['with value, without layout'] = [ + FALSE, + 'my_entity_type', + 'my_entity_type:entity_without_layout', + [], + ]; + $data['empty value, populated defaults'] = [ + TRUE, + 'my_entity_type', + '', + [ + 'entity_type_id' => 'my_entity_type', + 'my_entity_type' => 'entity_with_layout', + ], + ]; + $data['empty value, empty defaults'] = [ + FALSE, + NULL, + '', + [], + ]; + return $data; + } + + /** + * @covers ::alterRoutes + * @covers ::hasIntegerId + * @covers ::getEntityTypes + */ + public function testAlterRoutes() { + $entity_types = []; + + $entity_types['no_link_template'] = new EntityType(['id' => 'no_link_template']); + $this->entityFieldManager->getFieldStorageDefinitions('no_link_template')->shouldNotBeCalled(); + + $entity_types['with_string_id'] = new EntityType([ + 'id' => 'with_string_id', + 'links' => ['layout-builder' => '/entity/{entity}/layout'], + 'entity_keys' => ['id' => 'id'], + ]); + $string_id = $this->prophesize(FieldStorageDefinitionInterface::class); + $string_id->getType()->willReturn('string'); + $this->entityFieldManager->getFieldStorageDefinitions('with_string_id')->willReturn(['id' => $string_id->reveal()]); + + $entity_types['with_integer_id'] = new EntityType([ + 'id' => 'with_integer_id', + 'links' => ['layout-builder' => '/entity/{entity}/layout'], + 'entity_keys' => ['id' => 'id'], + ]); + $integer_id = $this->prophesize(FieldStorageDefinitionInterface::class); + $integer_id->getType()->willReturn('integer'); + $this->entityFieldManager->getFieldStorageDefinitions('with_integer_id')->willReturn(['id' => $integer_id->reveal()]); + + $this->entityTypeManager->getDefinitions()->willReturn($entity_types); + + $expected = [ + 'layout_builder.overrides.with_string_id.view' => new Route( + '/entity/{entity}/layout', + [ + 'entity_type_id' => 'with_string_id', + 'section_storage_type' => 'overrides', + 'section_storage' => '', + 'is_rebuilding' => FALSE, + '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::layout', + '_title_callback' => '\Drupal\layout_builder\Controller\LayoutBuilderController::title', + ], + [ + '_has_layout_section' => 'true', + ], + [ + 'parameters' => [ + 'section_storage' => ['layout_builder_tempstore' => TRUE], + 'with_string_id' => ['type' => 'entity:with_string_id'], + ], + '_layout_builder' => TRUE, + ] + ), + 'layout_builder.overrides.with_string_id.save' => new Route( + '/entity/{entity}/layout/save', + [ + 'entity_type_id' => 'with_string_id', + 'section_storage_type' => 'overrides', + 'section_storage' => '', + '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::saveLayout', + ], + [ + '_has_layout_section' => 'true', + ], + [ + 'parameters' => [ + 'section_storage' => ['layout_builder_tempstore' => TRUE], + 'with_string_id' => ['type' => 'entity:with_string_id'], + ], + '_layout_builder' => TRUE, + ] + ), + 'layout_builder.overrides.with_string_id.cancel' => new Route( + '/entity/{entity}/layout/cancel', + [ + 'entity_type_id' => 'with_string_id', + 'section_storage_type' => 'overrides', + 'section_storage' => '', + '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::cancelLayout', + ], + [ + '_has_layout_section' => 'true', + ], + [ + 'parameters' => [ + 'section_storage' => ['layout_builder_tempstore' => TRUE], + 'with_string_id' => ['type' => 'entity:with_string_id'], + ], + '_layout_builder' => TRUE, + ] + ), + 'layout_builder.overrides.with_string_id.revert' => new Route( + '/entity/{entity}/layout/revert', + [ + 'entity_type_id' => 'with_string_id', + 'section_storage_type' => 'overrides', + 'section_storage' => '', + '_form' => '\Drupal\layout_builder\Form\RevertOverridesForm', + ], + [ + '_has_layout_section' => 'true', + ], + [ + 'parameters' => [ + 'section_storage' => ['layout_builder_tempstore' => TRUE], + 'with_string_id' => ['type' => 'entity:with_string_id'], + ], + '_layout_builder' => TRUE, + ] + ), + 'layout_builder.overrides.with_integer_id.view' => new Route( + '/entity/{entity}/layout', + [ + 'entity_type_id' => 'with_integer_id', + 'section_storage_type' => 'overrides', + 'section_storage' => '', + 'is_rebuilding' => FALSE, + '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::layout', + '_title_callback' => '\Drupal\layout_builder\Controller\LayoutBuilderController::title', + ], + [ + '_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_integer_id.save' => new Route( + '/entity/{entity}/layout/save', + [ + 'entity_type_id' => 'with_integer_id', + 'section_storage_type' => 'overrides', + 'section_storage' => '', + '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::saveLayout', + ], + [ + '_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_integer_id.cancel' => new Route( + '/entity/{entity}/layout/cancel', + [ + 'entity_type_id' => 'with_integer_id', + 'section_storage_type' => 'overrides', + 'section_storage' => '', + '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::cancelLayout', + ], + [ + '_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_integer_id.revert' => new Route( + '/entity/{entity}/layout/revert', + [ + 'entity_type_id' => 'with_integer_id', + 'section_storage_type' => 'overrides', + 'section_storage' => '', + '_form' => '\Drupal\layout_builder\Form\RevertOverridesForm', + ], + [ + '_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, + ] + ), + ]; + + $collection = new RouteCollection(); + $this->plugin->alterRoutes($collection); + $this->assertEquals($expected, $collection->all()); + $this->assertSame(array_keys($expected), array_keys($collection->all())); + } + +} diff --git a/core/modules/layout_builder/tests/src/Unit/SectionStorageDefaultsParamConverterTest.php b/core/modules/layout_builder/tests/src/Unit/SectionStorageDefaultsParamConverterTest.php deleted file mode 100644 index 8afde9a055..0000000000 --- a/core/modules/layout_builder/tests/src/Unit/SectionStorageDefaultsParamConverterTest.php +++ /dev/null @@ -1,134 +0,0 @@ -entityManager = $this->prophesize(EntityManagerInterface::class); - $this->converter = new SectionStorageDefaultsParamConverter($this->entityManager->reveal()); - } - - /** - * @covers ::convert - * @covers ::getEntityTypeFromDefaults - * - * @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->entityManager->getDefinition('entity_view_display')->willReturn(new EntityType(['id' => 'entity_view_display'])); - $this->entityManager->getStorage('entity_view_display')->willReturn($entity_storage->reveal()); - } - else { - $this->entityManager->getDefinition('entity_view_display')->shouldNotBeCalled(); - $this->entityManager->getStorage('entity_view_display')->shouldNotBeCalled(); - } - - $result = $this->converter->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->entityManager->getDefinition('entity_view_display')->willReturn(new EntityType(['id' => 'entity_view_display'])); - $this->entityManager->getStorage('entity_view_display')->willReturn($entity_storage->reveal()); - - $result = $this->converter->convert($value, [], 'the_parameter_name', []); - $this->assertSame($expected, $result); - } - -} diff --git a/core/modules/layout_builder/tests/src/Unit/SectionStorageManagerTest.php b/core/modules/layout_builder/tests/src/Unit/SectionStorageManagerTest.php new file mode 100644 index 0000000000..857063dcab --- /dev/null +++ b/core/modules/layout_builder/tests/src/Unit/SectionStorageManagerTest.php @@ -0,0 +1,98 @@ +prophesize(CacheBackendInterface::class); + $module_handler = $this->prophesize(ModuleHandlerInterface::class); + $this->manager = new SectionStorageManager(new \ArrayObject(), $cache->reveal(), $module_handler->reveal()); + + $this->plugin = $this->prophesize(SectionStorageInterface::class); + + $factory = $this->prophesize(FactoryInterface::class); + $factory->createInstance('the_plugin_id', [])->willReturn($this->plugin->reveal()); + $reflection_property = new \ReflectionProperty($this->manager, 'factory'); + $reflection_property->setAccessible(TRUE); + $reflection_property->setValue($this->manager, $factory->reveal()); + } + + /** + * @covers ::loadEmpty + */ + public function testLoadEmpty() { + $result = $this->manager->loadEmpty('the_plugin_id'); + $this->assertInstanceOf(SectionStorageInterface::class, $result); + } + + /** + * @covers ::loadFromSectionList + */ + public function testLoadFromSectionList() { + $section_list = $this->prophesize(SectionListInterface::class); + $this->plugin->setSectionList($section_list->reveal())->will(function () { + return $this; + }); + + $result = $this->manager->loadFromSectionList('the_plugin_id', $section_list->reveal()); + $this->assertInstanceOf(SectionStorageInterface::class, $result); + } + + /** + * @covers ::loadFromRoute + */ + public function testLoadFromRoute() { + $section_list = $this->prophesize(SectionListInterface::class); + $this->plugin->convert('the_value', [], 'the_parameter_name', [])->willReturn($section_list->reveal()); + $this->plugin->setSectionList($section_list->reveal())->will(function () { + return $this; + }); + + $result = $this->manager->loadFromRoute('the_plugin_id', 'the_value', [], 'the_parameter_name', []); + $this->assertInstanceOf(SectionStorageInterface::class, $result); + } + + /** + * @covers ::loadFromRoute + */ + public function testLoadFromRouteNull() { + $this->plugin->convert('the_value', [], 'the_parameter_name', ['_route' => 'the_route_name'])->willReturn(NULL); + + $result = $this->manager->loadFromRoute('the_plugin_id', 'the_value', [], 'the_parameter_name', ['_route' => 'the_route_name']); + $this->assertNull($result); + } + +} diff --git a/core/modules/layout_builder/tests/src/Unit/SectionStorageOverridesParamConverterTest.php b/core/modules/layout_builder/tests/src/Unit/SectionStorageOverridesParamConverterTest.php deleted file mode 100644 index f0c01468e5..0000000000 --- a/core/modules/layout_builder/tests/src/Unit/SectionStorageOverridesParamConverterTest.php +++ /dev/null @@ -1,119 +0,0 @@ -entityManager = $this->prophesize(EntityManagerInterface::class); - $this->converter = new SectionStorageOverridesParamConverter($this->entityManager->reveal()); - } - - /** - * @covers ::convert - * @covers ::getEntityTypeFromDefaults - * @covers ::getEntityIdFromDefaults - * - * @dataProvider providerTestConvert - */ - public function testConvert($success, $expected_entity_type_id, $value, array $defaults) { - $defaults['the_parameter_name'] = $value; - - if ($expected_entity_type_id) { - $entity_storage = $this->prophesize(EntityStorageInterface::class); - - $entity_without_layout = $this->prophesize(FieldableEntityInterface::class); - $entity_without_layout->hasField('layout_builder__layout')->willReturn(FALSE); - $entity_without_layout->get('layout_builder__layout')->shouldNotBeCalled(); - $entity_storage->load('entity_without_layout')->willReturn($entity_without_layout->reveal()); - - $entity_with_layout = $this->prophesize(FieldableEntityInterface::class); - $entity_with_layout->hasField('layout_builder__layout')->willReturn(TRUE); - $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()); - } - else { - $this->entityManager->getDefinition(Argument::any())->shouldNotBeCalled(); - $this->entityManager->getStorage(Argument::any())->shouldNotBeCalled(); - } - - $result = $this->converter->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, with layout'] = [ - TRUE, - 'my_entity_type', - 'my_entity_type:entity_with_layout', - [], - ]; - $data['with value, without layout'] = [ - FALSE, - 'my_entity_type', - 'my_entity_type:entity_without_layout', - [], - ]; - $data['empty value, populated defaults'] = [ - TRUE, - 'my_entity_type', - '', - [ - 'entity_type_id' => 'my_entity_type', - 'my_entity_type' => 'entity_with_layout', - ], - ]; - $data['empty value, empty defaults'] = [ - FALSE, - NULL, - '', - [], - ]; - return $data; - } - -}