' . t('Layout Builder provides layout building utility, surprisingly.') . '
'; + $output .= '' . t('For more information, see the online documentation for the Layout Builder module.', [':layout-builder-documentation' => 'https://www.drupal.org/docs/8/core/modules/layout_builder']) . '
'; + return $output; + } +} + +/** + * Implements hook_contextual_links_view_alter(). + * + * Change Configure Blocks into off_canvas links. + */ +function layout_builder_contextual_links_view_alter(&$element, $items) { + // @todo Move this to system_contextual_links_view_alter(). + // If any items use the off_canvas render, add the corresponding library. + foreach ($items as $item) { + if (isset($item['localized_options']['attributes']['data-dialog-renderer']) && $item['localized_options']['attributes']['data-dialog-renderer'] === 'off_canvas') { + $element['#attached']['library'][] = 'settings_tray/drupal.off_canvas'; + // After finding one, stop. + break; + } + } +} + +/** + * Implements hook_form_FORM_ID_alter() for \Drupal\field_ui\Form\EntityViewDisplayEditForm. + */ +function layout_builder_form_entity_view_display_edit_form_alter(&$form, FormStateInterface $form_state) { + /** @var \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display */ + $display = $form_state->getFormObject()->getEntity(); + $entity_type = \Drupal::entityTypeManager()->getDefinition($display->getTargetEntityTypeId()); + + // Remove layout_builder__layout both visually and from the #fields handling. + // This prevents any interaction with this field. It is manipulated directly + // in layout_builder_entity_view_display_alter(). + unset($form['fields']['layout_builder__layout']); + unset($form['#fields'][array_search('layout_builder__layout', $form['#fields'])]); + + $form['layout'] = [ + '#type' => 'details', + '#open' => TRUE, + '#title' => t('Layout options'), + '#tree' => TRUE, + ]; + $form['layout']['allow_custom'] = [ + '#type' => 'checkbox', + '#title' => t('Allow each @entity to have its layout customized.', [ + '@entity' => $entity_type->getSingularLabel(), + ]), + '#default_value' => $display->getThirdPartySetting('layout_builder', 'allow_custom', FALSE), + ]; + + array_unshift($form['actions']['submit']['#submit'], 'layout_builder_form_entity_view_display_edit_submit'); +} + +/** + * Form submission handler for layout options on the entity view display form. + * + * @see layout_builder_form_entity_view_display_edit_form_alter() + */ +function layout_builder_form_entity_view_display_edit_submit(&$form, FormStateInterface $form_state) { + /** @var \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display */ + $display = $form_state->getFormObject()->getEntity(); + + $original_value = $display->getThirdPartySetting('layout_builder', 'allow_custom', FALSE); + $allow_custom = $form_state->getValue(['layout', 'allow_custom'], FALSE); + + // Only continue if the value has changed. + if ($original_value !== $allow_custom) { + $display->setThirdPartySetting('layout_builder', 'allow_custom', $allow_custom); + $entity_type_id = $display->getTargetEntityTypeId(); + $bundle = $display->getTargetBundle(); + + if ($allow_custom) { + layout_builder_add_layout_section_field($entity_type_id, $bundle); + } + elseif ($field = FieldConfig::loadByName($entity_type_id, $bundle, 'layout_builder__layout')) { + $field->delete(); + } + } +} + +/** + * Adds a layout section field to a given bundle. + * + * @param string $entity_type_id + * The entity type ID. + * @param string $bundle + * The bundle. + * @param string $field_name + * (optional) The name for the layout section field. Defaults to + * 'layout_builder__layout'. + * + * @return \Drupal\field\FieldConfigInterface + * A layout section field. + */ +function layout_builder_add_layout_section_field($entity_type_id, $bundle, $field_name = 'layout_builder__layout') { + $field = FieldConfig::loadByName($entity_type_id, $bundle, $field_name); + if (!$field) { + $field_storage = FieldStorageConfig::loadByName($entity_type_id, $field_name); + if (!$field_storage) { + $field_storage = FieldStorageConfig::create([ + 'entity_type' => $entity_type_id, + 'field_name' => $field_name, + 'type' => 'layout_section', + ]); + $field_storage->save(); + } + + $field = FieldConfig::create([ + 'field_storage' => $field_storage, + 'bundle' => $bundle, + 'label' => t('Layout'), + ]); + $field->save(); + } + return $field; +} + +/** + * Implements hook_entity_view_display_alter(). + */ +function layout_builder_entity_view_display_alter(EntityViewDisplayInterface $display, array $context) { + // @todo Expand to work for all view modes. + if (!in_array($context['view_mode'], ['full', 'default'])) { + return; + } + + if ($display->getThirdPartySetting('layout_builder', 'allow_custom', FALSE)) { + /** @var \Drupal\Core\Field\FieldDefinitionInterface[] $field_definitions */ + $field_definitions = \Drupal::service('entity_field.manager')->getFieldDefinitions($display->getTargetEntityTypeId(), $display->getTargetBundle()); + // Remove all display-configurable fields. + foreach (array_keys($display->getComponents()) as $name) { + if (isset($field_definitions[$name]) && $field_definitions[$name]->isDisplayConfigurable('view')) { + $display->removeComponent($name); + } + } + + // Force the layout to render with no label. + $display->setComponent('layout_builder__layout', ['label' => 'hidden']); + } +} diff --git a/core/modules/layout_builder/layout_builder.permissions.yml b/core/modules/layout_builder/layout_builder.permissions.yml new file mode 100644 index 0000000..0d66577 --- /dev/null +++ b/core/modules/layout_builder/layout_builder.permissions.yml @@ -0,0 +1,3 @@ +configure any layout: + title: 'Configure any layout' + restrict access: true diff --git a/core/modules/layout_builder/layout_builder.routing.yml b/core/modules/layout_builder/layout_builder.routing.yml new file mode 100644 index 0000000..0b4c08b --- /dev/null +++ b/core/modules/layout_builder/layout_builder.routing.yml @@ -0,0 +1,75 @@ +layout_builder.choose_section: + path: '/layout_builder/choose/section/{entity_type_id}/{entity_id}/{delta}' + defaults: + _controller: '\Drupal\layout_builder\Controller\LayoutController::chooseSection' + requirements: + _permission: 'configure any layout' + options: + _admin_route: TRUE + +layout_builder.add_section: + path: '/layout_builder/add/section/{entity_type_id}/{entity_id}/{delta}/{plugin_id}' + defaults: + _controller: '\Drupal\layout_builder\Controller\LayoutController::addSection' + requirements: + _permission: 'configure any layout' + options: + _admin_route: TRUE + +layout_builder.remove_section: + path: '/layout_builder/remove/section/{entity_type_id}/{entity_id}/{delta}' + defaults: + _form: '\Drupal\layout_builder\Form\RemoveSectionForm' + requirements: + _permission: 'configure any layout' + options: + _admin_route: TRUE + +layout_builder.choose_block: + path: '/layout_builder/choose/block/{entity_type_id}/{entity_id}/{delta}/{region}' + defaults: + _controller: '\Drupal\layout_builder\Controller\LayoutController::chooseBlock' + requirements: + _permission: 'configure any layout' + options: + _admin_route: TRUE + +layout_builder.add_block: + path: '/layout_builder/add/block/{entity_type_id}/{entity_id}/{delta}/{region}/{plugin_id}' + defaults: + _form: '\Drupal\layout_builder\Form\ConfigureBlockForm' + requirements: + _permission: 'configure any layout' + options: + _admin_route: TRUE + +layout_builder.configure_block: + path: '/layout_builder/configure/block/{entity_type_id}/{entity_id}/{delta}/{region}/{uuid}' + defaults: + _form: '\Drupal\layout_builder\Form\ConfigureBlockForm' + requirements: + _permission: 'configure any layout' + options: + _admin_route: TRUE + +layout_builder.remove_block: + path: '/layout_builder/remove/block/{entity_type_id}/{entity_id}/{delta}/{region}/{uuid}' + defaults: + _form: '\Drupal\layout_builder\Form\RemoveBlockForm' + requirements: + _permission: 'configure any layout' + options: + _admin_route: TRUE + +layout_builder.move_block: + path: '/layout_builder/move/block/{entity_type_id}/{entity_id}' + defaults: + _controller: '\Drupal\layout_builder\Controller\LayoutController::moveBlock' + methods: [POST] + requirements: + _permission: 'configure any layout' + options: + _admin_route: 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 new file mode 100644 index 0000000..dcb254d --- /dev/null +++ b/core/modules/layout_builder/layout_builder.services.yml @@ -0,0 +1,22 @@ +services: + layout_builder.builder: + class: Drupal\layout_builder\LayoutSectionBuilder + arguments: ['@current_user', '@plugin.manager.core.layout', '@plugin.manager.block', '@context.handler', '@context.repository'] + layout_builder.tempstore_repository: + class: Drupal\layout_builder\LayoutTempstoreRepository + arguments: ['@user.shared_tempstore', '@entity_type.manager'] + access_check.entity.layout: + class: Drupal\layout_builder\Access\LayoutSectionAccessCheck + arguments: ['@entity_type.manager'] + tags: + - { name: access_check, applies_to: _has_layout_selection } + layout_builder.routes: + class: Drupal\layout_builder\Routing\LayoutBuilderRoutes + arguments: ['@entity_type.manager'] + tags: + - { name: event_subscriber } + layout_builder.route_enhancer: + class: Drupal\layout_builder\Routing\LayoutBuilderRouteEnhancer + arguments: ['@entity_type.manager'] + tags: + - { name: route_enhancer } diff --git a/core/modules/layout_builder/src/Access/LayoutSectionAccessCheck.php b/core/modules/layout_builder/src/Access/LayoutSectionAccessCheck.php new file mode 100644 index 0000000..e08dd12 --- /dev/null +++ b/core/modules/layout_builder/src/Access/LayoutSectionAccessCheck.php @@ -0,0 +1,63 @@ +entityTypeManager = $entity_type_manager; + } + + /** + * Checks routing access to layout for the entity. + * + * @param \Drupal\Core\Routing\RouteMatchInterface $route_match + * The current route match. + * @param \Drupal\Core\Session\AccountInterface $account + * The currently logged in account. + * + * @return \Drupal\Core\Access\AccessResultInterface + * The access result. + */ + public function access(RouteMatchInterface $route_match, AccountInterface $account) { + $entity = $route_match->getParameter('layout_section_entity'); + // If we don't have an entity, forbid access. + if (empty($entity)) { + return AccessResult::forbidden()->addCacheContexts(['route']); + } + + // If the entity isn't fieldable, forbid access. + if (!$entity instanceof FieldableEntityInterface || !$entity->hasField('layout_builder__layout')) { + $access = AccessResult::forbidden(); + } + else { + $access = AccessResult::allowedIf($account->hasPermission('configure any layout')); + } + + return $access->addCacheableDependency($entity); + } + +} diff --git a/core/modules/layout_builder/src/Controller/LayoutBuilderController.php b/core/modules/layout_builder/src/Controller/LayoutBuilderController.php new file mode 100644 index 0000000..76a98a0 --- /dev/null +++ b/core/modules/layout_builder/src/Controller/LayoutBuilderController.php @@ -0,0 +1,299 @@ +builder = $builder; + $this->layoutManager = $layout_manager; + $this->blockManager = $block_manager; + $this->layoutTempstoreRepository = $layout_tempstore_repository; + } + + /** + * {@inheritdoc} + */ + public static function create(ContainerInterface $container) { + return new static( + $container->get('layout_builder.builder'), + $container->get('plugin.manager.core.layout'), + $container->get('plugin.manager.block'), + $container->get('layout_builder.tempstore_repository') + ); + } + + /** + * Provides a title callback. + * + * @param \Drupal\Core\Entity\FieldableEntityInterface $layout_section_entity + * The entity. + * + * @return string + * The title for the layout page. + */ + public function title(FieldableEntityInterface $layout_section_entity) { + return $this->t('Edit layout for %label', ['%label' => $layout_section_entity->label()]); + } + + /** + * Renders the Layout UI. + * + * @param \Drupal\Core\Entity\FieldableEntityInterface $layout_section_entity + * The entity. + * + * @return array + * A render array. + */ + public function layout(FieldableEntityInterface $layout_section_entity) { + $layout_section_entity = $this->layoutTempstoreRepository->get($layout_section_entity); + $entity_id = $layout_section_entity->id(); + if ($layout_section_entity instanceof RevisionableInterface) { + $entity_id = $layout_section_entity->getRevisionId(); + } + + $entity_type_id = $layout_section_entity->getEntityTypeId(); + + $output = []; + $count = 0; + $output[] = $this->buildAddSectionLink($entity_type_id, $entity_id, $count); + $count++; + /** @var \Drupal\layout_builder\LayoutSectionItemInterface $item */ + foreach ($layout_section_entity->layout_builder__layout as $item) { + $output[] = $this->buildAdministrativeSection($item->layout, $item->section ?: [], $entity_type_id, $entity_id, $count - 1); + $output[] = $this->buildAddSectionLink($entity_type_id, $entity_id, $count); + $count++; + } + $output['#attached']['library'][] = 'layout_builder/drupal.layout_builder'; + $output['#type'] = 'container'; + $output['#attributes']['id'] = 'layout-builder'; + // Mark this UI as uncacheable. + $output['#cache']['max-age'] = 0; + return $output; + } + + /** + * Builds a link to add a new section at a given delta. + * + * @param string $entity_type_id + * The entity type. + * @param string $entity_id + * The entity ID. + * @param int $delta + * The delta of the section to splice. + * + * @return array + * A render array for a link. + */ + protected function buildAddSectionLink($entity_type_id, $entity_id, $delta) { + $link = Link::createFromRoute($this->t('Add Section'), + 'layout_builder.choose_section', + [ + 'entity_type_id' => $entity_type_id, + 'entity_id' => $entity_id, + 'delta' => $delta, + ], + [ + 'attributes' => [ + 'class' => ['use-ajax'], + 'data-dialog-type' => 'dialog', + 'data-dialog-renderer' => 'off_canvas', + ], + ] + ); + return [ + 'link' => $link->toRenderable(), + '#type' => 'container', + '#attributes' => [ + 'class' => ['add-section'], + ], + ]; + } + + /** + * Builds the render array for the layout section while editing. + * + * @param string $layout_id + * The ID of the layout. + * @param array $section + * An array of configuration, keyed first by region and then by block UUID. + * @param string $entity_type_id + * The entity type. + * @param string $entity_id + * The entity ID. + * @param int $delta + * The delta of the section to splice. + * + * @return array + * The render array for a given section. + */ + protected function buildAdministrativeSection($layout_id, array $section, $entity_type_id, $entity_id, $delta) { + $build = $this->builder->buildSection($layout_id, $section); + $layout = $this->layoutManager->getDefinition($layout_id); + foreach ($layout->getRegions() as $region => $info) { + $link = Link::createFromRoute($this->t('Add Block'), + 'layout_builder.choose_block', + [ + 'entity_type_id' => $entity_type_id, + 'entity_id' => $entity_id, + 'delta' => $delta, + 'region' => $region, + ], + [ + 'attributes' => [ + 'class' => ['use-ajax'], + 'data-dialog-type' => 'dialog', + 'data-dialog-renderer' => 'off_canvas', + ], + ] + ); + $build[$region]['layout_builder_add_block']['link'] = $link->toRenderable(); + $build[$region]['layout_builder_add_block']['#type'] = 'container'; + $build[$region]['layout_builder_add_block']['#attributes'] = ['class' => ['add-block']]; + $build[$region]['#attributes']['data-region'] = $region; + } + foreach ($section as $region => $blocks) { + foreach ($blocks as $uuid => $configuration) { + if (isset($build[$region][$uuid])) { + $build[$region][$uuid]['#attributes']['class'][] = 'draggable'; + $build[$region][$uuid]['#attributes']['data-layout-block-uuid'] = $uuid; + $build[$region][$uuid]['#contextual_links'] = [ + 'layout_builder_block' => [ + 'route_parameters' => [ + 'entity_type_id' => $entity_type_id, + 'entity_id' => $entity_id, + 'delta' => $delta, + 'region' => $region, + 'uuid' => $uuid, + ], + ], + ]; + } + } + } + + $build['#attributes']['data-layout-update-url'] = Url::fromRoute('layout_builder.move_block', [ + 'entity_type_id' => $entity_type_id, + 'entity_id' => $entity_id, + ])->toString(); + $build['#attributes']['data-layout-delta'] = $delta; + + return [ + '#type' => 'container', + '#attributes' => [ + 'class' => ['layout-section'], + ], + 'remove' => [ + '#type' => 'link', + '#title' => $this->t('Remove section'), + '#url' => Url::fromRoute('layout_builder.remove_section', [ + 'entity_type_id' => $entity_type_id, + 'entity_id' => $entity_id, + 'delta' => $delta, + ]), + '#attributes' => [ + 'class' => ['use-ajax', 'remove-section'], + 'data-dialog-type' => 'dialog', + 'data-dialog-renderer' => 'off_canvas', + ], + ], + 'layout-section' => $build, + ]; + } + + /** + * Saves the layout. + * + * @param \Drupal\Core\Entity\FieldableEntityInterface $layout_section_entity + * The entity. + * + * @return \Symfony\Component\HttpFoundation\RedirectResponse + * A redirect response. + */ + public function saveLayout(FieldableEntityInterface $layout_section_entity) { + $layout_section_entity = $this->layoutTempstoreRepository->get($layout_section_entity); + + // @todo figure out if we should save a new revision. + $layout_section_entity->save(); + + $this->layoutTempstoreRepository->delete($layout_section_entity); + + // @todo Make trusted redirect instead. + return new RedirectResponse($layout_section_entity->toUrl()->setAbsolute()->toString(), Response::HTTP_SEE_OTHER); + } + + /** + * Cancels the layout. + * + * @param \Drupal\Core\Entity\FieldableEntityInterface $layout_section_entity + * The entity. + * + * @return \Symfony\Component\HttpFoundation\RedirectResponse + * A redirect response. + */ + public function cancelLayout(FieldableEntityInterface $layout_section_entity) { + $this->layoutTempstoreRepository->delete($layout_section_entity); + // @todo Make trusted redirect instead. + return new RedirectResponse($layout_section_entity->toUrl()->setAbsolute()->toString(), Response::HTTP_SEE_OTHER); + } + +} diff --git a/core/modules/layout_builder/src/Controller/LayoutController.php b/core/modules/layout_builder/src/Controller/LayoutController.php new file mode 100644 index 0000000..02a1b77 --- /dev/null +++ b/core/modules/layout_builder/src/Controller/LayoutController.php @@ -0,0 +1,300 @@ +layoutManager = $layout_manager; + $this->blockManager = $block_manager; + $this->layoutTempstoreRepository = $layout_tempstore_repository; + } + + /** + * {@inheritdoc} + */ + public static function create(ContainerInterface $container) { + return new static( + $container->get('plugin.manager.core.layout'), + $container->get('plugin.manager.block'), + $container->get('layout_builder.tempstore_repository') + ); + } + + /** + * Choose a layout plugin to add as a section. + * + * @param string $entity_type_id + * The entity type ID. + * @param string $entity_id + * The entity ID. + * @param int $delta + * The delta of the section to splice. + * + * @return array + * The render array. + */ + public function chooseSection($entity_type_id, $entity_id, $delta) { + $output = []; + $items = []; + foreach ($this->layoutManager->getDefinitions() as $plugin_id => $definition) { + $icon = $definition->getIconPath(); + if ($icon) { + $icon = [ + '#theme' => 'image', + '#uri' => $icon, + '#alt' => $definition->getLabel(), + ]; + } + + $items[] = [ + 'label' => [ + '#type' => 'link', + '#title' => [ + $icon ?: [], + [ + '#type' => 'container', + '#children' => $definition->getLabel(), + ], + ], + '#url' => $this->generateSectionUrl($entity_type_id, $entity_id, $delta, $plugin_id), + '#attributes' => [ + 'class' => ['use-ajax'], + 'data-dialog-type' => 'dialog', + 'data-dialog-renderer' => 'off_canvas', + ], + ], + ]; + } + $output['layouts'] = [ + '#type' => 'details', + '#title' => $this->t('Basic Layouts'), + '#open' => TRUE, + '#attributes' => [ + 'class' => [ + 'layout-selection', + ], + ], + 'list' => [ + '#theme' => 'item_list', + '#items' => $items, + '#attributes' => [ + 'class' => [ + 'layout-list', + ], + ], + ], + ]; + + return $output; + } + + /** + * Add the layout to the entity field in a tempstore. + * + * @param string $entity_type_id + * The entity type ID. + * @param string $entity_id + * The entity ID. + * @param int $delta + * The delta of the section to splice. + * @param string $plugin_id + * The plugin ID of the layout to add. + * + * @return \Drupal\Core\Ajax\AjaxResponse + * The render array. + */ + public function addSection($entity_type_id, $entity_id, $delta, $plugin_id) { + $entity = $this->layoutTempstoreRepository->getFromId($entity_type_id, $entity_id); + $values = $entity->layout_builder__layout->getValue(); + if (isset($values[$delta])) { + $start = array_slice($values, 0, $delta); + $end = array_slice($values, $delta); + $value = [ + 'layout' => $plugin_id, + 'section' => [], + ]; + $values = array_merge($start, [$value], $end); + } + else { + $values[] = [ + 'layout' => $plugin_id, + 'section' => [], + ]; + } + $entity->layout_builder__layout->setValue($values); + $this->layoutTempstoreRepository->set($entity); + return $this->rebuildAndClose(new AjaxResponse(), $entity); + } + + /** + * Provides the UI for choosing a new block. + * + * @param string $entity_type_id + * The entity type ID. + * @param string $entity_id + * The entity ID. + * @param int $delta + * The delta of the section to splice. + * @param string $region + * The region the block is going in. + * + * @return array + * A render array. + */ + public function chooseBlock($entity_type_id, $entity_id, $delta, $region) { + $build['#type'] = 'container'; + $build['#attributes']['class'][] = 'block-categories'; + + foreach ($this->blockManager->getGroupedDefinitions() as $category => $blocks) { + $build[$category]['#type'] = 'details'; + $build[$category]['#open'] = TRUE; + $build[$category]['#title'] = $category; + $build[$category]['links'] = [ + '#type' => 'table', + ]; + foreach ($blocks as $block_id => $block) { + $build[$category]['links'][]['data'] = [ + '#type' => 'link', + '#title' => $block['admin_label'], + '#url' => Url::fromRoute('layout_builder.add_block', + [ + 'entity_type_id' => $entity_type_id, + 'entity_id' => $entity_id, + 'delta' => $delta, + 'region' => $region, + 'plugin_id' => $block_id, + ] + ), + '#attributes' => [ + 'class' => ['use-ajax'], + 'data-dialog-type' => 'dialog', + 'data-dialog-renderer' => 'off_canvas', + ], + ]; + } + } + return $build; + } + + /** + * Moves a block to another region. + * + * @param \Symfony\Component\HttpFoundation\Request $request + * The request. + * @param string $entity_type_id + * The entity type ID. + * @param string $entity_id + * The entity ID. + * + * @return \Drupal\Core\Ajax\AjaxResponse + * An AJAX response. + */ + public function moveBlock(Request $request, $entity_type_id, $entity_id) { + $entity = $this->layoutTempstoreRepository->getFromId($entity_type_id, $entity_id); + $data = $request->request->all(); + + /** @var \Drupal\layout_builder\LayoutSectionItemInterface $field */ + $field = $entity->layout_builder__layout->get($data['delta_from']); + $values = $field->section ?: []; + + $region_from = $data['region_from']; + $region_to = $data['region_to']; + $block_uuid = $data['block_uuid']; + $configuration = $values[$region_from][$block_uuid]; + unset($values[$region_from][$block_uuid]); + $field->section = array_filter($values); + + /** @var \Drupal\layout_builder\LayoutSectionItemInterface $field */ + $field = $entity->layout_builder__layout->get($data['delta_to']); + $values = $field->section ?: []; + if (isset($data['preceding_block_uuid'])) { + $slice_id = array_search($data['preceding_block_uuid'], array_keys($values[$region_to])); + $before = array_slice($values[$region_to], 0, $slice_id + 1); + $after = array_slice($values[$region_to], $slice_id + 1); + $values[$region_to] = array_merge($before, [$block_uuid => $configuration], $after); + } + else { + if (empty($values[$region_to])) { + $values[$region_to] = []; + } + $values[$region_to] = array_merge([$block_uuid => $configuration], $values[$region_to]); + } + $field->section = array_filter($values); + + $this->layoutTempstoreRepository->set($entity); + return $this->rebuildLayout(new AjaxResponse(), $entity); + } + + /** + * A helper function for building Url object to add a section. + * + * @param string $entity_type_id + * The entity type. + * @param string $entity_id + * The entity ID. + * @param int $delta + * The delta of the section to splice. + * @param string $plugin_id + * The plugin ID of the layout to add. + * + * @return \Drupal\Core\Url + * The Url object of the add_section route. + */ + protected function generateSectionUrl($entity_type_id, $entity_id, $delta, $plugin_id) { + return new Url('layout_builder.add_section', [ + 'entity_type_id' => $entity_type_id, + 'entity_id' => $entity_id, + 'delta' => $delta, + 'plugin_id' => $plugin_id, + ]); + } + +} diff --git a/core/modules/layout_builder/src/Controller/LayoutRebuildTrait.php b/core/modules/layout_builder/src/Controller/LayoutRebuildTrait.php new file mode 100644 index 0000000..77e2e67 --- /dev/null +++ b/core/modules/layout_builder/src/Controller/LayoutRebuildTrait.php @@ -0,0 +1,155 @@ +hasAnyErrors()) { + $form['status_messages'] = [ + '#type' => 'status_messages', + '#weight' => -1000, + ]; + $response = new AjaxResponse(); + $response->addCommand(new ReplaceCommand('[data-drupal-selector="' . $form['#attributes']['data-drupal-selector'] . '"]', $form)); + } + else { + $entity = $this->getLayoutTempstoreRepository()->getFromId($this->entityTypeId, $this->entityId); + $response = $this->rebuildAndClose(new AjaxResponse(), $entity); + } + return $response; + } + + /** + * Gets the layout tempstore repository. + * + * @return \Drupal\layout_builder\LayoutTempstoreRepositoryInterface + * The layout tempstore repository. + */ + protected function getLayoutTempstoreRepository() { + if (!$this->layoutTempstoreRepository) { + $this->layoutTempstoreRepository = \Drupal::service('layout_builder.tempstore_repository'); + } + return $this->layoutTempstoreRepository; + } + + /** + * Rebuilds the layout. + * + * @param \Drupal\Core\Ajax\AjaxResponse $response + * The AJAX response. + * @param \Drupal\Core\Entity\EntityInterface $entity + * The entity. + * + * @return \Drupal\Core\Ajax\AjaxResponse + * An AJAX response to either rebuild the layout and close the dialog, or + * reload the page. + */ + protected function rebuildAndClose(AjaxResponse $response, EntityInterface $entity) { + $response = $this->rebuildLayout($response, $entity); + $url = Url::fromRoute("entity.{$entity->getEntityTypeId()}.layout", [$entity->getEntityTypeId() => $entity->id()]); + return $this->closeLayout($response, $url); + } + + /** + * Rebuilds the layout. + * + * @param \Drupal\Core\Ajax\AjaxResponse $response + * The AJAX response. + * @param \Drupal\Core\Entity\EntityInterface $entity + * The entity. + * + * @return \Drupal\Core\Ajax\AjaxResponse + * An AJAX response to either rebuild the layout and close the dialog, or + * reload the page. + */ + protected function rebuildLayout(AjaxResponse $response, EntityInterface $entity) { + $layout_controller = $this->getClassResolver()->getInstanceFromDefinition(LayoutBuilderController::class); + $layout = $layout_controller->layout($entity); + $response->addCommand(new ReplaceCommand('#layout-builder', $layout)); + return $response; + } + + /** + * Returns to the layout builder. + * + * @param \Drupal\Core\Ajax\AjaxResponse $response + * The AJAX response. + * @param \Drupal\Core\Url $url + * The URL to redirect to if not using a dialog. + * + * @return \Drupal\Core\Ajax\AjaxResponse + * An AJAX response to either rebuild the layout and close the dialog, or + * reload the page. + */ + protected function closeLayout(AjaxResponse $response, Url $url) { + if ($this->isDialog()) { + $response->addCommand(new CloseDialogCommand('#drupal-off-canvas')); + } + else { + $response->addCommand(new RedirectCommand($url->setAbsolute()->toString())); + } + return $response; + } + + /** + * Determines if the current request is within a dialog. + * + * @return bool + * TRUE if the current request is within a dialog, FALSE otherwise. + */ + protected function isDialog() { + return $this->getRequest()->get(MainContentViewSubscriber::WRAPPER_FORMAT) === 'drupal_dialog.off_canvas'; + } + + /** + * Gets the request object. + * + * @return \Symfony\Component\HttpFoundation\Request + * The request object. + */ + protected function getRequest() { + if (!$this->requestStack) { + $this->requestStack = \Drupal::requestStack(); + } + return $this->requestStack->getCurrentRequest(); + } + + /** + * Gets the class resolver. + * + * @return \Drupal\Core\DependencyInjection\ClassResolver + * The class resolver. + */ + protected function getClassResolver() { + if (!$this->classResolver) { + $this->classResolver = \Drupal::classResolver(); + } + return $this->classResolver; + } + +} diff --git a/core/modules/layout_builder/src/Form/ConfigureBlockForm.php b/core/modules/layout_builder/src/Form/ConfigureBlockForm.php new file mode 100644 index 0000000..bb60337 --- /dev/null +++ b/core/modules/layout_builder/src/Form/ConfigureBlockForm.php @@ -0,0 +1,278 @@ +layoutTempstoreRepository = $layout_tempstore_repository; + $this->contextRepository = $context_repository; + $this->entityTypeManager = $entity_type_manager; + $this->blockManager = $block_manager; + $this->uuid = $uuid; + $this->classResolver = $class_resolver; + $this->pluginFormFactory = $plugin_form_manager; + } + + /** + * {@inheritdoc} + */ + public static function create(ContainerInterface $container) { + return new static( + $container->get('layout_builder.tempstore_repository'), + $container->get('context.repository'), + $container->get('entity_type.manager'), + $container->get('plugin.manager.block'), + $container->get('uuid'), + $container->get('class_resolver'), + $container->get('plugin_form.factory') + ); + } + + /** + * {@inheritdoc} + */ + public function getFormId() { + return 'layout_builder_configure_block'; + } + + /** + * Prepares the block plugin based on the block ID. + * + * @param string $block_id + * Either a block ID, or the plugin ID used to create a new block. + * @param array $configuration + * The block configuration. + * + * @return \Drupal\Core\Block\BlockPluginInterface + * The block plugin. + */ + protected function prepareBlock($block_id, array $configuration) { + if (!isset($configuration['uuid'])) { + $configuration['uuid'] = $this->uuid->generate(); + } + + return $this->blockManager->createInstance($block_id, $configuration); + } + + /** + * {@inheritdoc} + */ + public function buildForm(array $form, FormStateInterface $form_state, $entity_type_id = NULL, $entity_id = NULL, $delta = NULL, $region = NULL, $plugin_id = NULL, $uuid = NULL) { + $this->entityTypeId = $entity_type_id; + $this->entityId = $entity_id; + $this->delta = $delta; + $this->region = $region; + + $configuration = []; + if ($uuid) { + $entity = $this->layoutTempstoreRepository->getFromId($this->entityTypeId, $this->entityId); + + /** @var \Drupal\layout_builder\LayoutSectionItemInterface $field */ + $field = $entity->layout_builder__layout->get($this->delta); + $plugin_id = $field->section[$region][$uuid]['id']; + $configuration = $field->section[$region][$uuid]; + } + $this->block = $this->prepareBlock($plugin_id, $configuration); + + $form_state->setTemporaryValue('gathered_contexts', $this->contextRepository->getAvailableContexts()); + + // Some Block Plugins rely on the block_theme value to load theme settings. + // @see \Drupal\system\Plugin\Block\SystemBrandingBlock::blockForm(). + $form_state->set('block_theme', $this->config('system.theme')->get('default')); + + $form['#tree'] = TRUE; + $form['settings'] = []; + $subform_state = SubformState::createForSubform($form['settings'], $form, $form_state); + $form['settings'] = $this->getPluginForm($this->block)->buildConfigurationForm($form['settings'], $subform_state); + + $form['actions']['submit'] = [ + '#type' => 'submit', + '#value' => $uuid ? $this->t('Update') : $this->t('Add Block'), + '#button_type' => 'primary', + '#ajax' => [ + 'callback' => '::ajaxSubmit', + ], + ]; + + $form['#attached']['library'][] = 'core/drupal.dialog.ajax'; + $form['#attributes']['id'] = 'dialog-form'; + + return $form; + } + + /** + * {@inheritdoc} + */ + public function validateForm(array &$form, FormStateInterface $form_state) { + $sub_form_state = SubformState::createForSubform($form['settings'], $form, $form_state); + $this->getPluginForm($this->block)->validateConfigurationForm($form['settings'], $sub_form_state); + } + + /** + * {@inheritdoc} + */ + public function submitForm(array &$form, FormStateInterface $form_state) { + // Call the plugin submit handler. + $sub_form_state = SubformState::createForSubform($form['settings'], $form, $form_state); + $this->getPluginForm($this->block)->submitConfigurationForm($form, $sub_form_state); + + // If this block is context-aware, set the context mapping. + if ($this->block instanceof ContextAwarePluginInterface) { + $this->block->setContextMapping($sub_form_state->getValue('context_mapping', [])); + } + + $configuration = $this->block->getConfiguration(); + + /** @var \Drupal\layout_builder\LayoutSectionItemInterface $field */ + $entity = $this->layoutTempstoreRepository->getFromId($this->entityTypeId, $this->entityId); + $values = $entity->layout_builder__layout->getValue(); + $values[$this->delta]['section'][$this->region][$configuration['uuid']] = $configuration; + $entity->layout_builder__layout->setValue($values); + + $this->layoutTempstoreRepository->set($entity); + $form_state->setRedirect("entity.{$this->entityTypeId}.layout", [$this->entityTypeId => $this->entityId]); + } + + /** + * Retrieves the plugin form for a given block and operation. + * + * @param \Drupal\Core\Block\BlockPluginInterface $block + * The block plugin. + * + * @return \Drupal\Core\Plugin\PluginFormInterface + * The plugin form for the block. + */ + protected function getPluginForm(BlockPluginInterface $block) { + if ($block instanceof PluginWithFormsInterface) { + return $this->pluginFormFactory->createInstance($block, 'configure'); + } + return $block; + } + +} diff --git a/core/modules/layout_builder/src/Form/LayoutRebuildConfirmFormBase.php b/core/modules/layout_builder/src/Form/LayoutRebuildConfirmFormBase.php new file mode 100644 index 0000000..3c56206 --- /dev/null +++ b/core/modules/layout_builder/src/Form/LayoutRebuildConfirmFormBase.php @@ -0,0 +1,132 @@ +layoutTempstoreRepository = $layout_tempstore_repository; + } + + /** + * {@inheritdoc} + */ + public static function create(ContainerInterface $container) { + return new static( + $container->get('layout_builder.tempstore_repository') + ); + } + + /** + * {@inheritdoc} + */ + public function getCancelUrl() { + $parameters = [ + $this->entityTypeId => $this->entityId, + ]; + return new Url("entity.{$this->entityTypeId}.layout", $parameters); + } + + /** + * {@inheritdoc} + */ + public function buildForm(array $form, FormStateInterface $form_state, $entity_type_id = NULL, $entity_id = NULL, $delta = NULL) { + $form = parent::buildForm($form, $form_state); + + $this->entityTypeId = $entity_type_id; + $this->entityId = $entity_id; + $this->delta = $delta; + + $form['#attached']['library'][] = 'core/drupal.dialog.ajax'; + $form['actions']['submit']['#ajax']['callback'] = '::ajaxSubmit'; + + // @todo Improve the cancel link of ConfirmFormBase to handle AJAX links. + $form['actions']['cancel'] = [ + '#type' => 'button', + '#value' => $this->getCancelText(), + '#ajax' => [ + 'callback' => '::ajaxCancel', + ], + ]; + return $form; + } + + /** + * {@inheritdoc} + */ + public function submitForm(array &$form, FormStateInterface $form_state) { + $entity = $this->layoutTempstoreRepository->getFromId($this->entityTypeId, $this->entityId); + + $this->handleEntity($entity, $form_state); + + $this->layoutTempstoreRepository->set($entity); + + $form_state->setRedirect("entity.{$entity->getEntityTypeId()}.layout", [$entity->getEntityTypeId() => $entity->id()]); + } + + /** + * Performs any actions on the layout entity before saving. + * + * @param \Drupal\Core\Entity\EntityInterface $entity + * The entity. + * @param \Drupal\Core\Form\FormStateInterface $form_state + * The current state of the form. + */ + abstract protected function handleEntity(EntityInterface $entity, FormStateInterface $form_state); + + /** + * Ajax callback to close the modal. + */ + public function ajaxCancel(array &$form, FormStateInterface $form_state) { + return $this->closeLayout(new AjaxResponse(), $this->getCancelUrl()); + } + +} diff --git a/core/modules/layout_builder/src/Form/RemoveBlockForm.php b/core/modules/layout_builder/src/Form/RemoveBlockForm.php new file mode 100644 index 0000000..99018ed --- /dev/null +++ b/core/modules/layout_builder/src/Form/RemoveBlockForm.php @@ -0,0 +1,68 @@ +t('Are you sure you want to remove this block?'); + } + + /** + * {@inheritdoc} + */ + public function getConfirmText() { + return $this->t('Remove'); + } + + /** + * {@inheritdoc} + */ + public function getFormId() { + return 'layout_builder_remove_block'; + } + + /** + * {@inheritdoc} + */ + public function buildForm(array $form, FormStateInterface $form_state, $entity_type_id = NULL, $entity_id = NULL, $delta = NULL, $region = NULL, $uuid = NULL) { + $this->region = $region; + $this->uuid = $uuid; + return parent::buildForm($form, $form_state, $entity_type_id, $entity_id, $delta); + } + + /** + * {@inheritdoc} + */ + protected function handleEntity(EntityInterface $entity, FormStateInterface $form_state) { + /** @var \Drupal\layout_builder\LayoutSectionItemInterface $field */ + $field = $entity->layout_builder__layout->get($this->delta); + $values = $field->section; + unset($values[$this->region][$this->uuid]); + $field->section = $values; + } + +} diff --git a/core/modules/layout_builder/src/Form/RemoveSectionForm.php b/core/modules/layout_builder/src/Form/RemoveSectionForm.php new file mode 100644 index 0000000..7b2f564 --- /dev/null +++ b/core/modules/layout_builder/src/Form/RemoveSectionForm.php @@ -0,0 +1,41 @@ +t('Are you sure you want to remove this section?'); + } + + /** + * {@inheritdoc} + */ + public function getConfirmText() { + return $this->t('Remove'); + } + + /** + * {@inheritdoc} + */ + protected function handleEntity(EntityInterface $entity, FormStateInterface $form_state) { + $entity->layout_builder__layout->removeItem($this->delta); + } + +} diff --git a/core/modules/layout_builder/src/LayoutSectionBuilder.php b/core/modules/layout_builder/src/LayoutSectionBuilder.php new file mode 100644 index 0000000..ea05d48 --- /dev/null +++ b/core/modules/layout_builder/src/LayoutSectionBuilder.php @@ -0,0 +1,152 @@ +account = $account; + $this->layoutPluginManager = $layoutPluginManager; + $this->blockManager = $blockManager; + $this->contextHandler = $context_handler; + $this->contextRepository = $context_repository; + } + + /** + * Builds the render array for the layout section. + * + * @param string $layout_id + * The ID of the layout. + * @param array $section + * An array of configuration, keyed first by region and then by block UUID. + * + * @return array + * The render array for a given section. + */ + public function buildSection($layout_id, array $section) { + $cacheability = CacheableMetadata::createFromRenderArray([]); + + $regions = []; + $weight = 0; + foreach ($section as $region => $blocks) { + // @todo determine if config should at least always be an empty array. + foreach ($blocks as $uuid => $configuration) { + $block = $this->getBlock($uuid, $configuration); + + $access = $block->access($this->account, TRUE); + $cacheability->addCacheableDependency($access); + + if ($access->isAllowed()) { + $regions[$region][$uuid] = [ + '#theme' => 'block', + '#weight' => $weight++, + '#configuration' => $block->getConfiguration(), + '#plugin_id' => $block->getPluginId(), + '#base_plugin_id' => $block->getBaseId(), + '#derivative_plugin_id' => $block->getDerivativeId(), + 'content' => $block->build(), + ]; + $cacheability->addCacheableDependency($block); + } + } + } + + $layout = $this->layoutPluginManager->createInstance($layout_id); + $section = $layout->build($regions); + $cacheability->applyTo($section); + return $section; + } + + /** + * Gets a block instance. + * + * @param string $uuid + * The UUID of this block instance. + * @param array $configuration + * An array of configuration relevant to the block instance. Must contain + * the plugin ID with the key 'id'. + * + * @return \Drupal\Core\Block\BlockPluginInterface + * The block instance. + * + * @throws \Drupal\Component\Plugin\Exception\PluginException + * Thrown when the configuration parameter does not contain 'id'. + */ + protected function getBlock($uuid, array $configuration) { + if (!isset($configuration['id'])) { + throw new PluginException(sprintf('No plugin ID specified for block with "%s" UUID', $uuid)); + } + + $block = $this->blockManager->createInstance($configuration['id'], $configuration); + if ($block instanceof ContextAwarePluginInterface) { + $contexts = $this->contextRepository->getRuntimeContexts(array_values($block->getContextMapping())); + $this->contextHandler->applyContextMapping($block, $contexts); + } + return $block; + } + +} diff --git a/core/modules/layout_builder/src/LayoutSectionItemInterface.php b/core/modules/layout_builder/src/LayoutSectionItemInterface.php new file mode 100644 index 0000000..1a39cde --- /dev/null +++ b/core/modules/layout_builder/src/LayoutSectionItemInterface.php @@ -0,0 +1,15 @@ +tempStoreFactory = $temp_store_factory; + $this->entityTypeManager = $entity_type_manager; + } + + /** + * {@inheritdoc} + */ + public function get(EntityInterface $entity) { + list($collection, $id) = $this->generateTempstoreId($entity); + $tempstore = $this->tempStoreFactory->get($collection)->get($id); + if (!empty($tempstore['entity'])) { + return $tempstore['entity']; + } + return $entity; + } + + /** + * {@inheritdoc} + */ + public function getFromId($entity_type_id, $entity_id) { + $entity = $this->entityTypeManager->getStorage($entity_type_id)->loadRevision($entity_id); + return $this->get($entity); + } + + /** + * {@inheritdoc} + */ + public function set(EntityInterface $entity) { + list($collection, $id) = $this->generateTempstoreId($entity); + $this->tempStoreFactory->get($collection)->set($id, ['entity' => $entity]); + } + + /** + * {@inheritdoc} + */ + public function delete(EntityInterface $entity) { + if ($this->get($entity)) { + list($collection, $id) = $this->generateTempstoreId($entity); + $this->tempStoreFactory->get($collection)->delete($id); + } + } + + /** + * Generates a collection and ID for putting an entity in tempstore. + * + * @param \Drupal\Core\Entity\EntityInterface $entity + * The entity being stored. + * + * @return array + * An array containing the collection name and the tempstore ID. + */ + protected function generateTempstoreId(EntityInterface $entity) { + // @todo Can we make the collection simply the entity type ID? + $collection = $entity->getEntityTypeId() . '.layout_builder__layout'; + $id = "{$entity->id()}.{$entity->language()->getId()}"; + if ($entity instanceof RevisionableInterface) { + $id .= '.' . $entity->getRevisionId(); + } + return [$collection, $id]; + } + +} diff --git a/core/modules/layout_builder/src/LayoutTempstoreRepositoryInterface.php b/core/modules/layout_builder/src/LayoutTempstoreRepositoryInterface.php new file mode 100644 index 0000000..8043c84 --- /dev/null +++ b/core/modules/layout_builder/src/LayoutTempstoreRepositoryInterface.php @@ -0,0 +1,54 @@ +entityTypeManager = $entity_type_manager; + } + + /** + * {@inheritdoc} + */ + public static function create(ContainerInterface $container, $base_plugin_id) { + return new static( + $container->get('entity_type.manager') + ); + } + + /** + * {@inheritdoc} + */ + public function getDerivativeDefinitions($base_plugin_definition) { + foreach (array_keys($this->getEntityTypes()) as $entity_type_id) { + $this->derivatives["entity.$entity_type_id.layout"] = $base_plugin_definition + [ + 'route_name' => "entity.$entity_type_id.layout", + 'weight' => 15, + 'title' => $this->t('Layout'), + 'base_route' => "entity.$entity_type_id.canonical", + 'entity_type_id' => $entity_type_id, + 'class' => LayoutBuilderLocalTask::class, + ]; + $this->derivatives["entity.$entity_type_id.save_layout"] = $base_plugin_definition + [ + 'route_name' => "entity.$entity_type_id.save_layout", + 'title' => $this->t('Save Layout'), + 'parent_id' => "layout_builder_ui:entity.$entity_type_id.layout", + 'entity_type_id' => $entity_type_id, + 'class' => LayoutBuilderLocalTask::class, + ]; + $this->derivatives["entity.$entity_type_id.cancel_layout"] = $base_plugin_definition + [ + 'route_name' => "entity.$entity_type_id.cancel_layout", + 'title' => $this->t('Cancel Layout'), + 'parent_id' => "layout_builder_ui:entity.$entity_type_id.layout", + 'entity_type_id' => $entity_type_id, + 'class' => LayoutBuilderLocalTask::class, + 'weight' => 5, + ]; + } + + return $this->derivatives; + } + + /** + * 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->entityClassImplements(FieldableEntityInterface::class) && $entity_type->hasLinkTemplate('canonical') && $entity_type->hasViewBuilderClass(); + }); + } + +} diff --git a/core/modules/layout_builder/src/Plugin/Field/FieldFormatter/LayoutSectionFormatter.php b/core/modules/layout_builder/src/Plugin/Field/FieldFormatter/LayoutSectionFormatter.php new file mode 100644 index 0000000..4638f0e --- /dev/null +++ b/core/modules/layout_builder/src/Plugin/Field/FieldFormatter/LayoutSectionFormatter.php @@ -0,0 +1,87 @@ +builder = $builder; + parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings); + } + + /** + * {@inheritdoc} + */ + public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) { + return new static( + $container->get('layout_builder.builder'), + $plugin_id, + $plugin_definition, + $configuration['field_definition'], + $configuration['settings'], + $configuration['label'], + $configuration['view_mode'], + $configuration['third_party_settings'] + ); + } + + /** + * {@inheritdoc} + */ + public function viewElements(FieldItemListInterface $items, $langcode) { + $elements = []; + + /** @var \Drupal\layout_builder\LayoutSectionItemInterface[] $items */ + foreach ($items as $delta => $item) { + $elements[$delta] = $this->builder->buildSection($item->layout, $item->section); + } + + return $elements; + } + +} diff --git a/core/modules/layout_builder/src/Plugin/Field/FieldType/LayoutSectionItem.php b/core/modules/layout_builder/src/Plugin/Field/FieldType/LayoutSectionItem.php new file mode 100644 index 0000000..2ca2248 --- /dev/null +++ b/core/modules/layout_builder/src/Plugin/Field/FieldType/LayoutSectionItem.php @@ -0,0 +1,88 @@ +setLabel(new TranslatableMarkup('Layout')) + ->setSetting('case_sensitive', FALSE) + ->setRequired(TRUE); + $properties[static::mainPropertyName()] = MapDataDefinition::create('map') + ->setLabel(new TranslatableMarkup('Layout Section')) + ->setRequired(FALSE); + + return $properties; + } + + /** + * {@inheritdoc} + */ + public static function mainPropertyName() { + return 'section'; + } + + /** + * {@inheritdoc} + */ + public static function schema(FieldStorageDefinitionInterface $field_definition) { + $schema = [ + 'columns' => [ + 'layout' => [ + 'type' => 'varchar', + 'length' => '255', + 'binary' => FALSE, + ], + static::mainPropertyName() => [ + 'type' => 'blob', + 'size' => 'normal', + 'serialize' => TRUE, + ], + ], + ]; + + return $schema; + } + + /** + * {@inheritdoc} + */ + public static function generateSampleValue(FieldDefinitionInterface $field_definition) { + $values['layout'] = 'layout_onecol'; + $values[static::mainPropertyName()] = []; + return $values; + } + + /** + * {@inheritdoc} + */ + public function isEmpty() { + return empty($this->layout); + } + +} diff --git a/core/modules/layout_builder/src/Plugin/Menu/LayoutBuilderLocalTask.php b/core/modules/layout_builder/src/Plugin/Menu/LayoutBuilderLocalTask.php new file mode 100644 index 0000000..4f80e38 --- /dev/null +++ b/core/modules/layout_builder/src/Plugin/Menu/LayoutBuilderLocalTask.php @@ -0,0 +1,23 @@ +getParameter('layout_section_entity'); + return $parameters; + } + +} diff --git a/core/modules/layout_builder/src/Routing/LayoutBuilderRouteEnhancer.php b/core/modules/layout_builder/src/Routing/LayoutBuilderRouteEnhancer.php new file mode 100644 index 0000000..d19024f --- /dev/null +++ b/core/modules/layout_builder/src/Routing/LayoutBuilderRouteEnhancer.php @@ -0,0 +1,30 @@ +hasOption('_layout_builder'); + } + + /** + * {@inheritdoc} + */ + public function enhance(array $defaults, Request $request) { + // Copy the entity by reference so that any changes are reflected. + $defaults['layout_section_entity'] = &$defaults[$defaults['entity_type_id']]; + return $defaults; + } + +} diff --git a/core/modules/layout_builder/src/Routing/LayoutBuilderRoutes.php b/core/modules/layout_builder/src/Routing/LayoutBuilderRoutes.php new file mode 100644 index 0000000..0566132 --- /dev/null +++ b/core/modules/layout_builder/src/Routing/LayoutBuilderRoutes.php @@ -0,0 +1,141 @@ +entityTypeManager = $entity_type_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) { + $template = $entity_type->getLinkTemplate('canonical'); + $route = (new Route("$template/layout")) + ->setDefaults([ + '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::layout', + '_title_callback' => '\Drupal\layout_builder\Controller\LayoutBuilderController::title', + 'layout_section_entity' => NULL, + 'entity_type_id' => $entity_type_id, + ]) + ->addRequirements([ + $entity_type_id => '\d+', + '_has_layout_selection' => 'true', + ]) + ->addOptions([ + '_layout_builder' => TRUE, + 'parameters' => [ + $entity_type_id => [ + 'type' => "entity:$entity_type_id", + ], + ], + ]); + $routes["entity.$entity_type_id.layout"] = $route; + + $route = (new Route("$template/layout/save")) + ->setDefaults([ + '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::saveLayout', + 'layout_section_entity' => NULL, + 'entity_type_id' => $entity_type_id, + ]) + ->addRequirements([ + $entity_type_id => '\d+', + '_has_layout_selection' => 'true', + ]) + ->addOptions([ + '_layout_builder' => TRUE, + 'parameters' => [ + $entity_type_id => [ + 'type' => "entity:$entity_type_id", + ], + ], + ]); + $routes["entity.$entity_type_id.save_layout"] = $route; + + $route = (new Route("$template/layout/cancel")) + ->setDefaults([ + '_controller' => '\Drupal\layout_builder\Controller\LayoutBuilderController::cancelLayout', + 'layout_section_entity' => NULL, + 'entity_type_id' => $entity_type_id, + ]) + ->addRequirements([ + $entity_type_id => '\d+', + '_has_layout_selection' => 'true', + ]) + ->addOptions([ + '_layout_builder' => TRUE, + 'parameters' => [ + $entity_type_id => [ + 'type' => "entity:$entity_type_id", + ], + ], + ]); + $routes["entity.$entity_type_id.cancel_layout"] = $route; + } + return $routes; + } + + /** + * {@inheritdoc} + */ + protected function alterRoutes(RouteCollection $collection) { + $templates = ['canonical', 'edit_form', 'delete_form']; + foreach ($this->getEntityTypes() as $entity_type) { + foreach ($templates as $template) { + // Mark this as a Layout Builder route so that links like local tasks + // will be enhanced. + if ($route = $collection->get('entity.' . $entity_type->id() . '.' . $template)) { + $route->setOption('_layout_builder', TRUE); + $route->addDefaults([ + 'layout_section_entity' => NULL, + 'entity_type_id' => $entity_type->id(), + ]); + } + } + } + } + + /** + * 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->entityClassImplements(FieldableEntityInterface::class) && $entity_type->hasLinkTemplate('canonical') && $entity_type->hasViewBuilderClass(); + }); + } + +} diff --git a/core/modules/layout_builder/tests/src/Functional/LayoutSectionTest.php b/core/modules/layout_builder/tests/src/Functional/LayoutSectionTest.php new file mode 100644 index 0000000..0d63b17 --- /dev/null +++ b/core/modules/layout_builder/tests/src/Functional/LayoutSectionTest.php @@ -0,0 +1,333 @@ +createContentType([ + 'type' => 'bundle_with_section_field', + ]); + $this->createContentType([ + 'type' => 'bundle_without_section_field', + ]); + + layout_builder_add_layout_section_field('node', 'bundle_with_section_field'); + $display = EntityViewDisplay::load('node.bundle_with_section_field.default'); + $display->setThirdPartySetting('layout_builder', 'allow_custom', TRUE); + $display->save(); + + $this->drupalLogin($this->drupalCreateUser([ + 'configure any layout', + ], 'foobar')); + } + + /** + * Provides test data for ::testLayoutSectionFormatter(). + */ + public function providerTestLayoutSectionFormatter() { + $data = []; + $data['block_with_context'] = [ + [ + [ + 'layout' => 'layout_onecol', + 'section' => [ + 'content' => [ + 'baz' => [ + 'id' => 'test_context_aware', + 'context_mapping' => [ + 'user' => '@user.current_user_context:current_user', + ], + ], + ], + ], + ], + ], + [ + '.layout--onecol', + '#test_context_aware--username', + ], + [ + 'foobar', + 'User context found', + ], + 'user', + 'user:2', + 'UNCACHEABLE', + ]; + $data['single_section_single_block'] = [ + [ + [ + 'layout' => 'layout_onecol', + 'section' => [ + 'content' => [ + 'baz' => [ + 'id' => 'system_powered_by_block', + ], + ], + ], + ], + ], + '.layout--onecol', + 'Powered by', + '', + '', + 'MISS', + ]; + $data['multiple_sections'] = [ + [ + [ + 'layout' => 'layout_onecol', + 'section' => [ + 'content' => [ + 'baz' => [ + 'id' => 'system_powered_by_block', + ], + ], + ], + ], + [ + 'layout' => 'layout_twocol', + 'section' => [ + 'first' => [ + 'foo' => [ + 'id' => 'test_block_instantiation', + 'display_message' => 'foo text', + ], + ], + 'second' => [ + 'bar' => [ + 'id' => 'test_block_instantiation', + 'display_message' => 'bar text', + ], + ], + ], + ], + ], + [ + '.layout--onecol', + '.layout--twocol', + ], + [ + 'Powered by', + 'foo text', + 'bar text', + ], + 'user.permissions', + '', + 'MISS', + ]; + return $data; + } + + /** + * Tests layout_section formatter output. + * + * @dataProvider providerTestLayoutSectionFormatter + */ + public function testLayoutSectionFormatter($layout_data, $expected_selector, $expected_content, $expected_cache_contexts, $expected_cache_tags, $expected_dynamic_cache) { + $this->createSectionNode($layout_data); + + $this->drupalGet('node/1'); + $this->assertLayoutSection($expected_selector, $expected_content, $expected_cache_contexts, $expected_cache_tags, $expected_dynamic_cache); + + $this->drupalGet('node/1/layout'); + $this->assertLayoutSection($expected_selector, $expected_content, $expected_cache_contexts, $expected_cache_tags, 'UNCACHEABLE'); + } + + /** + * Tests the access checking of the section formatter. + */ + public function testLayoutSectionFormatterAccess() { + $this->createSectionNode([ + [ + 'layout' => 'layout_onecol', + 'section' => [ + 'content' => [ + 'baz' => [ + 'id' => 'test_access', + ], + ], + ], + ], + ]); + + // Restrict access to the block. + $this->container->get('state')->set('test_block_access', FALSE); + + $this->drupalGet('node/1'); + $this->assertLayoutSection('.layout--onecol', NULL, '', '', 'UNCACHEABLE'); + // Ensure the block was not rendered. + $this->assertSession()->pageTextNotContains('Hello test world'); + + // Grant access to the block, and ensure it was rendered. + $this->container->get('state')->set('test_block_access', TRUE); + $this->drupalGet('node/1'); + $this->assertLayoutSection('.layout--onecol', 'Hello test world', '', '', 'UNCACHEABLE'); + } + + /** + * Tests the multilingual support of the section formatter. + */ + public function testMultilingualLayoutSectionFormatter() { + $this->container->get('module_installer')->install(['content_translation']); + $this->rebuildContainer(); + + ConfigurableLanguage::createFromLangcode('es')->save(); + $this->container->get('content_translation.manager')->setEnabled('node', 'bundle_with_section_field', TRUE); + + $entity = $this->createSectionNode([ + [ + 'layout' => 'layout_onecol', + 'section' => [ + 'content' => [ + 'baz' => [ + 'id' => 'system_powered_by_block', + ], + ], + ], + ], + ]); + $entity->addTranslation('es', [ + 'title' => 'Translated node title', + $this->fieldName => [ + [ + 'layout' => 'layout_twocol', + 'section' => [ + 'first' => [ + 'foo' => [ + 'id' => 'test_block_instantiation', + 'display_message' => 'foo text', + ], + ], + 'second' => [ + 'bar' => [ + 'id' => 'test_block_instantiation', + 'display_message' => 'bar text', + ], + ], + ], + ], + ], + ]); + $entity->save(); + + $this->drupalGet('node/1'); + $this->assertLayoutSection('.layout--onecol', 'Powered by'); + $this->drupalGet('es/node/1'); + $this->assertLayoutSection('.layout--twocol', ['foo text', 'bar text']); + } + + /** + * Ensures that the entity title is displayed. + */ + public function testLayoutPageTitle() { + $this->drupalPlaceBlock('page_title_block'); + $this->createSectionNode([]); + + $this->drupalGet('node/1/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()); + } + + /** + * Tests that no Layout link shows without a section field. + */ + public function testLayoutUrlNoSectionField() { + $this->createNode([ + 'type' => 'bundle_without_section_field', + 'title' => 'The node title', + 'body' => [ + [ + 'value' => 'The node body', + ], + ], + ]); + $this->drupalGet('node/1/layout'); + $this->assertSession()->statusCodeEquals(403); + } + + /** + * Asserts the output of a layout section. + * + * @param string|array $expected_selector + * A selector or list of CSS selectors to find. + * @param string|array $expected_content + * A string or list of strings to find. + * @param string $expected_cache_contexts + * A string of cache contexts to be found in the header. + * @param string $expected_cache_tags + * A string of cache tags to be found in the header. + * @param string $expected_dynamic_cache + * The expected dynamic cache header. Either 'HIT', 'MISS' or 'UNCACHEABLE'. + */ + protected function assertLayoutSection($expected_selector, $expected_content, $expected_cache_contexts = '', $expected_cache_tags = '', $expected_dynamic_cache = 'MISS') { + $assert_session = $this->assertSession(); + // Find the given selector. + foreach ((array) $expected_selector as $selector) { + $element = $this->cssSelect($selector); + $this->assertNotEmpty($element); + } + + // Find the given content. + foreach ((array) $expected_content as $content) { + $assert_session->pageTextContains($content); + } + if ($expected_cache_contexts) { + $assert_session->responseHeaderContains('X-Drupal-Cache-Contexts', $expected_cache_contexts); + } + if ($expected_cache_tags) { + $assert_session->responseHeaderContains('X-Drupal-Cache-Tags', $expected_cache_tags); + } + $assert_session->responseHeaderEquals('X-Drupal-Dynamic-Cache', $expected_dynamic_cache); + } + + /** + * Creates a node with a section field. + * + * @param array $section_values + * An array of values for a section field. + * + * @return \Drupal\node\NodeInterface + * The node object. + */ + protected function createSectionNode(array $section_values) { + return $this->createNode([ + 'type' => 'bundle_with_section_field', + 'title' => 'The node title', + 'body' => [ + [ + 'value' => 'The node body', + ], + ], + $this->fieldName => $section_values, + ]); + } + +} diff --git a/core/modules/layout_builder/tests/src/FunctionalJavascript/LayoutBuilderTest.php b/core/modules/layout_builder/tests/src/FunctionalJavascript/LayoutBuilderTest.php new file mode 100644 index 0000000..7da0494 --- /dev/null +++ b/core/modules/layout_builder/tests/src/FunctionalJavascript/LayoutBuilderTest.php @@ -0,0 +1,255 @@ +drupalPlaceBlock('local_tasks_block'); + + $bundle = BlockContentType::create([ + 'id' => 'basic', + 'label' => 'Basic', + ]); + $bundle->save(); + block_content_add_body_field($bundle->id()); + BlockContent::create([ + 'info' => 'My custom block', + 'type' => 'basic', + 'body' => [ + [ + 'value' => 'This is the block content', + 'format' => filter_default_format(), + ], + ], + ])->save(); + + $this->createContentType(['type' => 'bundle_with_section_field']); + $this->createNode([ + 'type' => 'bundle_with_section_field', + 'title' => 'The node title', + 'body' => [ + [ + 'value' => 'The node body', + ], + ], + ]); + + $this->drupalLogin($this->drupalCreateUser([ + 'access contextual links', + 'configure any layout', + 'administer node display', + ], 'foobar')); + } + + /** + * Tests the Layout Builder UI. + * + * @todo: + * Add tests for revision support. + */ + public function test() { + $assert_session = $this->assertSession(); + $page = $this->getSession()->getPage(); + + // Enable layout support. + $this->drupalGet('admin/structure/types/manage/bundle_with_section_field/display'); + $page->checkField('layout[allow_custom]'); + $page->pressButton('Save'); + + // Ensure the block is not displayed initially. + $this->drupalGet('node/1'); + $assert_session->pageTextNotContains('Powered by Drupal'); + + // Enter the layout editing mode. + $this->clickLink('Layout'); + $assert_session->linkExists('Add Section'); + $assert_session->linkNotExists('Add Block'); + + // Add a new section. + $this->clickLink('Add Section'); + $assert_session->assertWaitOnAjaxRequest(); + $assert_session->elementExists('css', '#drupal-off-canvas'); + + $this->clickLink('One column'); + $assert_session->assertWaitOnAjaxRequest(); + $assert_session->elementNotExists('css', '#drupal-off-canvas'); + + $assert_session->linkExists('Add Section'); + $assert_session->linkExists('Add Block'); + + // Add a new block. + $this->clickLink('Add Block'); + $assert_session->assertWaitOnAjaxRequest(); + + $assert_session->elementExists('css', '#drupal-off-canvas'); + + $this->clickLink('Powered by Drupal'); + $assert_session->assertWaitOnAjaxRequest(); + $assert_session->elementExists('css', '#drupal-off-canvas'); + + $page->fillField('settings[label]', 'This is the label'); + $page->checkField('settings[label_display]'); + + // Save the new block, and ensure it is displayed on the page. + $page->pressButton('Add Block'); + $assert_session->assertWaitOnAjaxRequest(); + $assert_session->elementNotExists('css', '#drupal-off-canvas'); + + $assert_session->addressEquals('node/1/layout'); + $assert_session->pageTextContains('Powered by Drupal'); + $assert_session->pageTextContains('This is the label'); + + // Until the layout is saved, the new block is not visible on the node page. + $this->drupalGet('node/1'); + $assert_session->pageTextNotContains('Powered by Drupal'); + + // When returning to the layout edit mode, the new block is visible. + $this->drupalGet('node/1/layout'); + $assert_session->pageTextContains('Powered by Drupal'); + + // Save the layout, and the new block is visible. + $this->clickLink('Save Layout'); + $assert_session->addressEquals('node/1'); + $assert_session->pageTextContains('Powered by Drupal'); + $assert_session->pageTextContains('This is the label'); + $assert_session->elementExists('css', '.layout'); + + // Drag one block from one region to another. + $this->drupalGet('node/1/layout'); + $this->clickLink('Add Section'); + $assert_session->assertWaitOnAjaxRequest(); + + $this->clickLink('Two column'); + $assert_session->assertWaitOnAjaxRequest(); + + $assert_session->elementNotExists('css', '.layout__region--second .block-system-powered-by-block'); + $assert_session->elementTextNotContains('css', '.layout__region--second', 'Powered by Drupal'); + // Drag the block from one layout to another. + $page->find('css', '.layout__region--content .block-system-powered-by-block')->dragTo($page->find('css', '.layout__region--second')); + $assert_session->assertWaitOnAjaxRequest(); + // Ensure the drag succeeded. + $assert_session->elementExists('css', '.layout__region--second .block-system-powered-by-block'); + $assert_session->elementTextContains('css', '.layout__region--second', 'Powered by Drupal'); + // Ensure the drag persisted after reload. + $this->drupalGet('node/1/layout'); + $assert_session->elementExists('css', '.layout__region--second .block-system-powered-by-block'); + $assert_session->elementTextContains('css', '.layout__region--second', 'Powered by Drupal'); + // Ensure the drag persisted after save. + $this->clickLink('Save Layout'); + $assert_session->elementExists('css', '.layout__region--second .block-system-powered-by-block'); + $assert_session->elementTextContains('css', '.layout__region--second', 'Powered by Drupal'); + + // Configure a block. + $this->drupalGet('node/1/layout'); + $assert_session->assertWaitOnAjaxRequest(); + $this->toggleContextualTriggerVisibility('.block-system-powered-by-block'); + $assert_session->assertWaitOnAjaxRequest(); + $page->find('css', '.block-system-powered-by-block .contextual .trigger')->click(); + $assert_session->assertWaitOnAjaxRequest(); + + $this->clickLink('Configure'); + $assert_session->assertWaitOnAjaxRequest(); + $assert_session->elementExists('css', '#drupal-off-canvas'); + + $page->fillField('settings[label]', 'This is the new label'); + $page->pressButton('Update'); + $assert_session->assertWaitOnAjaxRequest(); + $assert_session->elementNotExists('css', '#drupal-off-canvas'); + + $assert_session->addressEquals('node/1/layout'); + $assert_session->pageTextContains('Powered by Drupal'); + $assert_session->pageTextContains('This is the new label'); + $assert_session->pageTextNotContains('This is the label'); + + // Remove a block. + $this->drupalGet('node/1/layout'); + + $this->toggleContextualTriggerVisibility('.block-system-powered-by-block'); + $page->find('css', '.block-system-powered-by-block .contextual .trigger')->click(); + $this->clickLink('Remove block'); + $assert_session->assertWaitOnAjaxRequest(); + $assert_session->elementExists('css', '#drupal-off-canvas'); + + $page->pressButton('Remove'); + $assert_session->assertWaitOnAjaxRequest(); + $assert_session->elementNotExists('css', '#drupal-off-canvas'); + + $assert_session->pageTextNotContains('Powered by Drupal'); + $assert_session->linkExists('Add Block'); + $assert_session->addressEquals('node/1/layout'); + + $this->clickLink('Save Layout'); + $assert_session->elementExists('css', '.layout'); + + // Test deriver-based blocks. + $this->drupalGet('node/1/layout'); + $this->clickLink('Add Block'); + $assert_session->assertWaitOnAjaxRequest(); + + $this->clickLink('My custom block'); + $assert_session->assertWaitOnAjaxRequest(); + + $page->pressButton('Add Block'); + $assert_session->assertWaitOnAjaxRequest(); + $assert_session->pageTextContains('This is the block content'); + + // Remove both sections. + $this->clickLink('Remove section'); + $assert_session->assertWaitOnAjaxRequest(); + + $page->pressButton('Remove'); + $assert_session->assertWaitOnAjaxRequest(); + + $this->clickLink('Remove section'); + $assert_session->assertWaitOnAjaxRequest(); + + $page->pressButton('Remove'); + $assert_session->assertWaitOnAjaxRequest(); + + $assert_session->pageTextNotContains('This is the block content'); + $assert_session->linkNotExists('Add Block'); + $this->clickLink('Save Layout'); + $assert_session->elementNotExists('css', '.layout'); + } + + /** + * Toggles the visibility of a contextual trigger. + * + * @todo Remove this function when related trait added in + * https://www.drupal.org/node/2821724. + * + * @param string $selector + * The selector for the element that contains the contextual link. + */ + protected function toggleContextualTriggerVisibility($selector) { + // Hovering over the element itself with should be enough, but does not + // work. Manually remove the visually-hidden class. + $this->getSession()->executeScript("jQuery('{$selector} .contextual .trigger').toggleClass('visually-hidden');"); + } + +} diff --git a/core/modules/layout_builder/tests/src/Unit/LayoutSectionBuilderTest.php b/core/modules/layout_builder/tests/src/Unit/LayoutSectionBuilderTest.php new file mode 100644 index 0000000..3908e6d --- /dev/null +++ b/core/modules/layout_builder/tests/src/Unit/LayoutSectionBuilderTest.php @@ -0,0 +1,260 @@ +account = $this->prophesize(AccountInterface::class); + $this->layoutPluginManager = $this->prophesize(LayoutPluginManagerInterface::class); + $this->blockManager = $this->prophesize(BlockManagerInterface::class); + $this->contextHandler = $this->prophesize(ContextHandlerInterface::class); + $this->contextRepository = $this->prophesize(ContextRepositoryInterface::class); + $this->layoutSectionBuilder = new LayoutSectionBuilder($this->account->reveal(), $this->layoutPluginManager->reveal(), $this->blockManager->reveal(), $this->contextHandler->reveal(), $this->contextRepository->reveal()); + + $this->layout = $this->prophesize(LayoutInterface::class); + $this->layoutPluginManager->createInstance('layout_onecol')->willReturn($this->layout->reveal()); + } + + /** + * @covers ::buildSection + */ + public function testBuildSection() { + $block_content = ['#markup' => 'The block content.']; + $render_array = [ + '#theme' => 'block', + '#weight' => 0, + '#configuration' => [], + '#plugin_id' => 'block_plugin_id', + '#base_plugin_id' => 'block_plugin_id', + '#derivative_plugin_id' => NULL, + 'content' => $block_content, + ]; + $this->layout->build(['content' => ['some_uuid' => $render_array]])->willReturnArgument(0); + + $block = $this->prophesize(BlockPluginInterface::class); + $this->blockManager->createInstance('block_plugin_id', ['id' => 'block_plugin_id'])->willReturn($block->reveal()); + + $access_result = AccessResult::allowed(); + $block->access($this->account->reveal(), TRUE)->willReturn($access_result); + $block->build()->willReturn($block_content); + $block->getCacheContexts()->willReturn([]); + $block->getCacheTags()->willReturn([]); + $block->getCacheMaxAge()->willReturn(Cache::PERMANENT); + $block->getPluginId()->willReturn('block_plugin_id'); + $block->getBaseId()->willReturn('block_plugin_id'); + $block->getDerivativeId()->willReturn(NULL); + $block->getConfiguration()->willReturn([]); + + $section = [ + 'content' => [ + 'some_uuid' => [ + 'id' => 'block_plugin_id', + ], + ], + ]; + $expected = [ + '#cache' => [ + 'contexts' => [], + 'tags' => [], + 'max-age' => -1, + ], + 'content' => [ + 'some_uuid' => $render_array, + ], + ]; + $result = $this->layoutSectionBuilder->buildSection('layout_onecol', $section); + $this->assertEquals($expected, $result); + } + + /** + * @covers ::buildSection + */ + public function testBuildSectionAccessDenied() { + $this->layout->build([])->willReturn([]); + + $block = $this->prophesize(BlockPluginInterface::class); + $this->blockManager->createInstance('block_plugin_id', ['id' => 'block_plugin_id'])->willReturn($block->reveal()); + + $access_result = AccessResult::forbidden(); + $block->access($this->account->reveal(), TRUE)->willReturn($access_result); + $block->build()->shouldNotBeCalled(); + + $section = [ + 'content' => [ + 'some_uuid' => [ + 'id' => 'block_plugin_id', + ], + ], + ]; + $expected = [ + '#cache' => [ + 'contexts' => [], + 'tags' => [], + 'max-age' => -1, + ], + ]; + $result = $this->layoutSectionBuilder->buildSection('layout_onecol', $section); + $this->assertEquals($expected, $result); + } + + /** + * @covers ::buildSection + */ + public function testBuildSectionEmpty() { + $this->layout->build([])->willReturn([]); + + $section = []; + $expected = [ + '#cache' => [ + 'contexts' => [], + 'tags' => [], + 'max-age' => -1, + ], + ]; + $result = $this->layoutSectionBuilder->buildSection('layout_onecol', $section); + $this->assertEquals($expected, $result); + } + + /** + * @covers ::buildSection + * @covers ::getBlock + */ + public function testContextAwareBlock() { + $render_array = [ + '#theme' => 'block', + '#weight' => 0, + '#configuration' => [], + '#plugin_id' => 'block_plugin_id', + '#base_plugin_id' => 'block_plugin_id', + '#derivative_plugin_id' => NULL, + 'content' => [], + ]; + $this->layout->build(['content' => ['some_uuid' => $render_array]])->willReturnArgument(0); + + $block = $this->prophesize(BlockPluginInterface::class)->willImplement(ContextAwarePluginInterface::class); + $this->blockManager->createInstance('block_plugin_id', ['id' => 'block_plugin_id'])->willReturn($block->reveal()); + + $access_result = AccessResult::allowed(); + $block->access($this->account->reveal(), TRUE)->willReturn($access_result); + $block->build()->willReturn([]); + $block->getCacheContexts()->willReturn([]); + $block->getCacheTags()->willReturn([]); + $block->getCacheMaxAge()->willReturn(Cache::PERMANENT); + $block->getContextMapping()->willReturn([]); + $block->getPluginId()->willReturn('block_plugin_id'); + $block->getBaseId()->willReturn('block_plugin_id'); + $block->getDerivativeId()->willReturn(NULL); + $block->getConfiguration()->willReturn([]); + + $this->contextRepository->getRuntimeContexts([])->willReturn([]); + $this->contextHandler->applyContextMapping($block->reveal(), [])->shouldBeCalled(); + + $section = [ + 'content' => [ + 'some_uuid' => [ + 'id' => 'block_plugin_id', + ], + ], + ]; + $expected = [ + '#cache' => [ + 'contexts' => [], + 'tags' => [], + 'max-age' => -1, + ], + 'content' => [ + 'some_uuid' => $render_array, + ], + ]; + $result = $this->layoutSectionBuilder->buildSection('layout_onecol', $section); + $this->assertEquals($expected, $result); + } + + /** + * @covers ::buildSection + * @covers ::getBlock + */ + public function testBuildSectionMissingPluginId() { + $section = [ + 'content' => [ + 'some_uuid' => [], + ], + ]; + $this->setExpectedException(PluginException::class, 'No plugin ID specified for block with "some_uuid" UUID'); + $this->layoutSectionBuilder->buildSection('layout_onecol', $section); + } + +} diff --git a/core/modules/layout_builder/tests/src/Unit/LayoutTempstoreRepositoryTest.php b/core/modules/layout_builder/tests/src/Unit/LayoutTempstoreRepositoryTest.php new file mode 100644 index 0000000..919b02c --- /dev/null +++ b/core/modules/layout_builder/tests/src/Unit/LayoutTempstoreRepositoryTest.php @@ -0,0 +1,110 @@ +prophesize(SharedTempStore::class); + $tempstore->get('the_entity_id.en')->shouldBeCalled(); + + $tempstore_factory = $this->prophesize(SharedTempStoreFactory::class); + $tempstore_factory->get('the_entity_type_id.layout_builder__layout')->willReturn($tempstore->reveal()); + + $entity = $this->prophesize(EntityInterface::class); + $entity->getEntityTypeId()->willReturn('the_entity_type_id'); + $entity->id()->willReturn('the_entity_id'); + $entity->language()->willReturn(new Language(['id' => 'en'])); + + $entity_storage = $this->prophesize(EntityStorageInterface::class); + $entity_storage->loadRevision('the_entity_id')->willReturn($entity->reveal()); + + $entity_type_manager = $this->prophesize(EntityTypeManagerInterface::class); + $entity_type_manager->getStorage('the_entity_type_id')->willReturn($entity_storage->reveal()); + + $repository = new LayoutTempstoreRepository($tempstore_factory->reveal(), $entity_type_manager->reveal()); + + $result = $repository->getFromId('the_entity_type_id', 'the_entity_id'); + $this->assertSame($entity->reveal(), $result); + } + + /** + * @covers ::getFromId + * @covers ::get + * @covers ::generateTempstoreId + */ + public function testGetFromIdLoadedTempstore() { + $tempstore_entity = $this->prophesize(EntityInterface::class); + $tempstore = $this->prophesize(SharedTempStore::class); + $tempstore->get('the_entity_id.en')->willReturn(['entity' => $tempstore_entity->reveal()]); + $tempstore_factory = $this->prophesize(SharedTempStoreFactory::class); + $tempstore_factory->get('the_entity_type_id.layout_builder__layout')->willReturn($tempstore->reveal()); + + $entity = $this->prophesize(EntityInterface::class); + $entity->getEntityTypeId()->willReturn('the_entity_type_id'); + $entity->id()->willReturn('the_entity_id'); + $entity->language()->willReturn(new Language(['id' => 'en'])); + + $entity_storage = $this->prophesize(EntityStorageInterface::class); + $entity_storage->loadRevision('the_entity_id')->willReturn($entity->reveal()); + + $entity_type_manager = $this->prophesize(EntityTypeManagerInterface::class); + $entity_type_manager->getStorage('the_entity_type_id')->willReturn($entity_storage->reveal()); + + $repository = new LayoutTempstoreRepository($tempstore_factory->reveal(), $entity_type_manager->reveal()); + + $result = $repository->getFromId('the_entity_type_id', 'the_entity_id'); + $this->assertSame($tempstore_entity->reveal(), $result); + $this->assertNotSame($entity->reveal(), $result); + } + + /** + * @covers ::getFromId + * @covers ::get + * @covers ::generateTempstoreId + */ + public function testGetFromIdRevisionable() { + $tempstore = $this->prophesize(SharedTempStore::class); + $tempstore->get('the_entity_id.en.the_revision_id')->shouldBeCalled(); + + $tempstore_factory = $this->prophesize(SharedTempStoreFactory::class); + $tempstore_factory->get('the_entity_type_id.layout_builder__layout')->willReturn($tempstore->reveal()); + + $entity = $this->prophesize(EntityInterface::class)->willImplement(RevisionableInterface::class); + $entity->getEntityTypeId()->willReturn('the_entity_type_id'); + $entity->id()->willReturn('the_entity_id'); + $entity->language()->willReturn(new Language(['id' => 'en'])); + $entity->getRevisionId()->willReturn('the_revision_id'); + + $entity_storage = $this->prophesize(EntityStorageInterface::class); + $entity_storage->loadRevision('the_entity_id')->willReturn($entity->reveal()); + + $entity_type_manager = $this->prophesize(EntityTypeManagerInterface::class); + $entity_type_manager->getStorage('the_entity_type_id')->willReturn($entity_storage->reveal()); + + $repository = new LayoutTempstoreRepository($tempstore_factory->reveal(), $entity_type_manager->reveal()); + + $result = $repository->getFromId('the_entity_type_id', 'the_entity_id'); + $this->assertSame($entity->reveal(), $result); + } + +}