' . t('The Field Layout module allows you to arrange fields into regions for content forms and displays.') . '
'; + $output .= '' . t('For more information, see the online documentation for the Field Layout module.', [':field-layout-documentation' => 'https://www.drupal.org/documentation/modules/@todo_once_module_name_is_decided_upon']) . '
'; + return $output; + } +} + +/** + * Implements hook_entity_type_alter(). + */ +function field_layout_entity_type_alter(array &$entity_types) { + /** @var $entity_types \Drupal\Core\Entity\EntityTypeInterface[] */ + if (\Drupal::moduleHandler()->moduleExists('field_ui')) { + $entity_types['entity_view_display']->setFormClass('edit', FieldLayoutEntityViewDisplayEditForm::class); + $entity_types['entity_form_display']->setFormClass('edit', FieldLayoutEntityFormDisplayEditForm::class); + } +} + +/** + * Implements hook_entity_presave(). + */ +function field_layout_entity_presave(EntityInterface $entity) { + // Whenever creating a new entity display, set the layout to default and + // initialize the field layout based on default configuration. + if ($entity instanceof EntityDisplayInterface && !$entity->getThirdPartySettings('field_layout')) { + $field_layout = []; + $field_layout += array_fill_keys(array_keys($entity->get('content')), ['region' => 'content']); + $field_layout += array_fill_keys(array_keys($entity->get('hidden')), ['region' => 'hidden']); + $entity->setThirdPartySetting('field_layout', 'fields', $field_layout); + $entity->setThirdPartySetting('field_layout', 'layout', 'default'); + } +} + +/** + * Implements hook_entity_view_alter(). + */ +function field_layout_entity_view_alter(array &$build, EntityInterface $entity, EntityViewDisplayInterface $display) { + _field_layout_apply_layout($build, $display); +} + +/** + * Implements hook_form_alter(). + */ +function field_layout_form_alter(&$form, FormStateInterface $form_state, $form_id) { + $form_object = $form_state->getFormObject(); + if ($form_object instanceof ContentEntityFormInterface) { + _field_layout_apply_layout($form, $form_object->getFormDisplay($form_state)); + } +} + +/** + * Applies the layout to an entity build. + * + * @param array $build + * A renderable array representing the entity content or form. + * @param \Drupal\Core\Entity\Display\EntityDisplayInterface $display + * The entity display holding the display options configured for the + * entity components. + */ +function _field_layout_apply_layout(array &$build, EntityDisplayInterface $display) { + if (!$layout_definition = \Drupal::service('field_layout.layout_repository')->getLayoutForDisplay($display)) { + return; + } + + // Add the regions to the $build in the correct order. + foreach ($layout_definition['regions'] as $region => $region_info) { + $build['field_layout__' . $region]['#theme_wrappers'][] = 'field_layout_region'; + $build['field_layout__' . $region]['#region'] = $region; + } + + // Move the field from the top-level of $build into a region-specific section. + foreach ($display->getThirdPartySetting('field_layout', 'fields', []) as $name => $field) { + if (isset($build[$name]) && $field['region'] !== 'hidden') { + $build['field_layout__' . $field['region']][$name] = $build[$name]; + } + unset($build[$name]); + } +} + +/** + * Implements hook_theme(). + */ +function field_layout_theme($existing, $type, $theme, $path) { + return [ + 'field_layout_region' => [ + 'render element' => 'elements', + ], + ]; +} + +/** + * Prepares variables for field layout region templates. + * + * Default template: field-layout-region.html.twig. + * + * @param array $variables + * An associative array containing: + * - elements: An associative array containing properties of the region. + */ +function template_preprocess_field_layout_region(&$variables) { + // Create the $content variable that templates expect. + $variables['content'] = $variables['elements']['#children']; + $variables['region'] = $variables['elements']['#region']; +} diff --git a/core/modules/field_layout/field_layout.services.yml b/core/modules/field_layout/field_layout.services.yml new file mode 100644 index 0000000..b4082ff --- /dev/null +++ b/core/modules/field_layout/field_layout.services.yml @@ -0,0 +1,4 @@ +services: + field_layout.layout_repository: + class: Drupal\field_layout\LayoutRepository + arguments: ['@string_translation'] diff --git a/core/modules/field_layout/js/field_layout.js b/core/modules/field_layout/js/field_layout.js new file mode 100644 index 0000000..9b8ab45 --- /dev/null +++ b/core/modules/field_layout/js/field_layout.js @@ -0,0 +1,76 @@ +/** + * @file + * Attaches the behaviors for the Field Layout module. + */ +(function ($, Drupal) { + + "use strict"; + + /** + * Row handlers for the 'Manage display' screen. + */ + Drupal.fieldUIDisplayOverview = Drupal.fieldUIDisplayOverview || {}; + + Drupal.fieldUIDisplayOverview.field_layout = function (row, data) { + this.row = row; + this.name = data.name; + this.region = data.region; + this.tableDrag = data.tableDrag; + + // Attach change listener to the 'region' select. + this.$regionSelect = $(row).find('select.field-layout-region'); + this.$regionSelect.on('change', Drupal.fieldUIOverview.onChange); + + // Load the Field UI row handler. + this.fieldRowHandler = new Drupal.fieldUIDisplayOverview.field(row, data); + + return this; + }; + + Drupal.fieldUIDisplayOverview.field_layout.prototype = { + + /** + * Returns the region corresponding to the current form values of the row. + * + * @return {string} + * Either 'hidden' or 'content'. + */ + getRegion: function () { + return this.$regionSelect.val(); + }, + + /** + * Reacts to a row being changed regions. + * + * This function is called when the row is moved to a different region, as + * a + * result of either : + * - a drag-and-drop action (the row's form elements then probably need to + * be updated accordingly) + * - user input in one of the form elements watched by the + * {@link Drupal.fieldUIOverview.onChange} change listener. + * + * @param {string} region + * The name of the new region for the row. + * + * @return {object} + * A hash object indicating which rows should be Ajax-updated as a result + * of the change, in the format expected by + * {@link Drupal.fieldUIOverview.AJAXRefreshRows}. + */ + regionChange: function (region) { + // Replace dashes with underscores. + region = region.replace(/-/g, '_'); + + // Set the region of the select list. + this.$regionSelect.val(region); + + // Call the field UI row handler implementation. + // @todo Remove the massaging of region once + // Drupal.fieldUIDisplayOverview.field.regionChange is fixed in + // https://www.drupal.org/node/2796885. + return this.fieldRowHandler.regionChange(region === 'hidden' || 'content'); + } + }; + +})(jQuery, Drupal); diff --git a/core/modules/field_layout/src/Form/FieldLayoutEntityDisplayFormTrait.php b/core/modules/field_layout/src/Form/FieldLayoutEntityDisplayFormTrait.php new file mode 100644 index 0000000..b769bee --- /dev/null +++ b/core/modules/field_layout/src/Form/FieldLayoutEntityDisplayFormTrait.php @@ -0,0 +1,176 @@ +fieldLayoutRepository->getLayoutForDisplay($this->getEntity()); + foreach ($layout['regions'] as $name => $region) { + $regions[$name] = [ + 'title' => $region['label'], + 'message' => $this->t('No field is displayed.') + ]; + } + + $regions['hidden'] = [ + 'title' => $this->t('Disabled', [], ['context' => 'Plural']), + 'message' => $this->t('No field is hidden.') + ]; + + return $regions; + } + + /** + * Adds the field layout section to the form. + * + * @param array $form + * An associative array containing the structure of the form. + * @param \Drupal\Core\Form\FormStateInterface $form_state + * The current state of the form. + * + * @return array + */ + protected function addFieldLayout(array $form, FormStateInterface $form_state) { + $form['#entity_builders'][] = [static::class, 'updateFieldLayout']; + + $form['#attached']['library'][] = 'field_layout/drupal.field_layout'; + + $form['fields']['#tabledrag'][] = [ + 'action' => 'match', + 'relationship' => 'parent', + 'group' => 'field-layout-region', + 'subgroup' => 'field-layout-region', + 'source' => 'field-name', + ]; + + $form['field_layouts'] = [ + '#type' => 'details', + '#title' => $this->t('Layout for @bundle in @view_mode', [ + '@bundle' => str_replace('_', ' ', $this->getEntity()->getTargetBundle()), + '@view_mode' => str_replace('_', ' ', $this->getEntity()->getMode()), + ]), + ]; + $layout_options = []; + foreach ($this->fieldLayoutRepository->getLayoutDefinitions() as $name => $layout) { + $layout_options[$name] = $layout['label']; + } + $form['field_layouts']['field_layout'] = [ + '#type' => 'select', + '#title' => $this->t('Select a layout'), + '#options' => $layout_options, + '#default_value' => $this->getEntity()->getThirdPartySetting('field_layout', 'layout', 'default'), + ]; + + return $form; + } + + /** + * Overrides \Drupal\field_ui\Form\EntityDisplayFormBase::getRowRegion(). + */ + public function getRowRegion($row) { + switch ($row['#row_type']) { + case 'field': + case 'extra_field': + return $row['region']['#value'] ?: 'hidden'; + } + } + + /** + * An #entity_builder callback to update the Field Layout settings. + * + * @param string $entity_type_id + * @param \Drupal\Core\Entity\EntityInterface $entity + * @param array $form + * @param \Drupal\Core\Form\FormStateInterface $form_state + */ + public static function updateFieldLayout($entity_type_id, EntityInterface $entity, &$form, FormStateInterface $form_state) { + if ($form_state->isSubmitted() && $entity instanceof ThirdPartySettingsInterface) { + $old_layout = $entity->getThirdPartySetting('field_layout', 'layout'); + $new_layout = $form_state->getValue('field_layout'); + $fields = []; + foreach ($form_state->getValue('fields') as $field_name => $values) { + // If the layout is changing, reset all fields. + // @todo Devise a mechanism for mapping old regions to new ones in + // https://www.drupal.org/node/2796877. + $fields[$field_name]['region'] = $old_layout === $new_layout ? $values['region'] : 'hidden'; + } + $entity->setThirdPartySetting('field_layout', 'fields', $fields); + $entity->setThirdPartySetting('field_layout', 'layout', $new_layout); + } + } + + /** + * Adds a column with the Region select. + * + * @param array $row + * A table row array. + * @param string $field_name + * The field name. + * @param string $label + * The field name. + * + * @return array + * A table row array. + */ + protected function addRegionSelect(array $row, $field_name, $label) { + $row['#js_settings']['rowHandler'] = 'field_layout'; + $field_layout = $this->getEntity()->getThirdPartySetting('field_layout', 'fields', []); + $new_row = [ + 'region' => [ + '#type' => 'select', + '#title' => $this->t('Region for @title', ['@title' => $label]), + '#title_display' => 'invisible', + '#options' => $this->getRegionOptions(), + '#empty_value' => 'hidden', + '#default_value' => isset($field_layout[$field_name]['region']) ? $field_layout[$field_name]['region'] : 'hidden', + '#attributes' => ['class' => ['field-layout-region']], + ], + ]; + + $position = array_search('parent_wrapper', array_keys($row)) + 1; + return array_merge(array_slice($row, 0, $position), $new_row, array_slice($row, $position)); + } + + /** + * Adjusts the table header for field layout. + * + * @param array $header + * The table header. + * + * @return array + * The table header. + */ + protected function adjustTableHeader(array $header) { + array_splice($header, 3, 0, [$this->t('Region')]); + return $header; + } + + /** + * Gets the form entity. + * + * @return \Drupal\Core\Entity\Display\EntityDisplayInterface + * The current form entity. + */ + abstract public function getEntity(); + +} diff --git a/core/modules/field_layout/src/Form/FieldLayoutEntityFormDisplayEditForm.php b/core/modules/field_layout/src/Form/FieldLayoutEntityFormDisplayEditForm.php new file mode 100644 index 0000000..3579155 --- /dev/null +++ b/core/modules/field_layout/src/Form/FieldLayoutEntityFormDisplayEditForm.php @@ -0,0 +1,78 @@ +fieldLayoutRepository = $field_layout_repository; + } + + /** + * {@inheritdoc} + */ + public static function create(ContainerInterface $container) { + return new static( + $container->get('plugin.manager.field.field_type'), + $container->get('plugin.manager.field.widget'), + $container->get('field_layout.layout_repository') + ); + } + + /** + * {@inheritdoc} + */ + public function form(array $form, FormStateInterface $form_state) { + $form = parent::form($form, $form_state); + return $this->addFieldLayout($form, $form_state); + } + + /** + * {@inheritdoc} + */ + protected function buildFieldRow(FieldDefinitionInterface $field_definition, array $form, FormStateInterface $form_state) { + $row = parent::buildFieldRow($field_definition, $form, $form_state); + return $this->addRegionSelect($row, $field_definition->getName(), $field_definition->getLabel()); + } + + /** + * {@inheritdoc} + */ + protected function buildExtraFieldRow($field_id, $extra_field) { + $row = parent::buildExtraFieldRow($field_id, $extra_field); + return $this->addRegionSelect($row, $field_id, $extra_field['label']); + } + + /** + * {@inheritdoc} + */ + protected function getTableHeader() { + $header = parent::getTableHeader(); + return $this->adjustTableHeader($header); + } + +} diff --git a/core/modules/field_layout/src/Form/FieldLayoutEntityViewDisplayEditForm.php b/core/modules/field_layout/src/Form/FieldLayoutEntityViewDisplayEditForm.php new file mode 100644 index 0000000..c36fc1d --- /dev/null +++ b/core/modules/field_layout/src/Form/FieldLayoutEntityViewDisplayEditForm.php @@ -0,0 +1,78 @@ +fieldLayoutRepository = $field_layout_repository; + } + + /** + * {@inheritdoc} + */ + public static function create(ContainerInterface $container) { + return new static( + $container->get('plugin.manager.field.field_type'), + $container->get('plugin.manager.field.formatter'), + $container->get('field_layout.layout_repository') + ); + } + + /** + * {@inheritdoc} + */ + public function form(array $form, FormStateInterface $form_state) { + $form = parent::form($form, $form_state); + return $this->addFieldLayout($form, $form_state); + } + + /** + * {@inheritdoc} + */ + protected function buildFieldRow(FieldDefinitionInterface $field_definition, array $form, FormStateInterface $form_state) { + $row = parent::buildFieldRow($field_definition, $form, $form_state); + return $this->addRegionSelect($row, $field_definition->getName(), $field_definition->getLabel()); + } + + /** + * {@inheritdoc} + */ + protected function buildExtraFieldRow($field_id, $extra_field) { + $row = parent::buildExtraFieldRow($field_id, $extra_field); + return $this->addRegionSelect($row, $field_id, $extra_field['label']); + } + + /** + * {@inheritdoc} + */ + protected function getTableHeader() { + $header = parent::getTableHeader(); + return $this->adjustTableHeader($header); + } + +} diff --git a/core/modules/field_layout/src/LayoutRepository.php b/core/modules/field_layout/src/LayoutRepository.php new file mode 100644 index 0000000..83b3108 --- /dev/null +++ b/core/modules/field_layout/src/LayoutRepository.php @@ -0,0 +1,79 @@ +stringTranslation = $string_translation; + } + + /** + * {@inheritdoc} + */ + public function getLayoutDefinitions() { + // @todo Replace with layout_plugin in https://www.drupal.org/node/2296423. + $layouts = [ + 'default' => [ + 'label' => $this->t('Default'), + 'regions' => [ + 'content' => [ + 'label' => $this->t('Content'), + ], + ], + ], + '1col_stacked' => [ + 'label' => $this->t('One column stacked'), + 'regions' => [ + 'top' => [ + 'label' => $this->t('Top'), + ], + 'bottom' => [ + 'label' => $this->t('Bottom'), + ], + ], + ], + '2col' => [ + 'label' => $this->t('Two column'), + 'regions' => [ + 'left' => [ + 'label' => $this->t('Left'), + ], + 'right' => [ + 'label' => $this->t('Right'), + ], + ], + ], + ]; + return $layouts; + } + + /** + * {@inheritdoc} + */ + public function getLayoutForDisplay(EntityDisplayInterface $display) { + $layout_name = $display->getThirdPartySetting('field_layout', 'layout', 'default'); + $layout_definitions = $this->getLayoutDefinitions(); + if (!$layout_name || !isset($layout_definitions[$layout_name])) { + return []; + } + + return $layout_definitions[$layout_name]; + } + +} diff --git a/core/modules/field_layout/src/LayoutRepositoryInterface.php b/core/modules/field_layout/src/LayoutRepositoryInterface.php new file mode 100644 index 0000000..f8287f3 --- /dev/null +++ b/core/modules/field_layout/src/LayoutRepositoryInterface.php @@ -0,0 +1,31 @@ +. + * - region: The name of the region variable as defined in the theme's + * .info.yml file. + * + * @see template_preprocess_region() + * + * @ingroup themeable + */ +#} +{% +set classes = [ +'field-layout-region', +'field-layout-region--' ~ region|clean_class, +] +%} +{% if content %} +