Allow entity bundle traits to specify display and form mode settings

Author: bradjones1

commerce.module

@@ -80,20 +80,22 @@ function commerce_field_widget_form_alter(&$element, FormStateInterface $form_st
  *   The bundle.
  * @param string $display_context
  *   The display context ('view' or 'form').
+ * @param string $mode
+ *   The display mode, defaults to 'default'
  *
  * @throws \InvalidArgumentException
  *   Thrown when an invalid display context is provided.
  *
  * @return \Drupal\Core\Entity\Display\EntityDisplayInterface
  *   The entity display.
  */
-function commerce_get_entity_display($entity_type, $bundle, $display_context) {
+function commerce_get_entity_display($entity_type, $bundle, $display_context, $mode = 'default') {
   if (!in_array($display_context, ['view', 'form'])) {
     throw new \InvalidArgumentException(sprintf('Invalid display_context %s passed to _commerce_product_get_display().', $display_context));
   }
 
   $storage = \Drupal::entityTypeManager()->getStorage('entity_' . $display_context . '_display');
-  $display = $storage->load($entity_type . '.' . $bundle . '.default');
+  $display = $storage->load($entity_type . '.' . $bundle . '.' . $mode);
   if (!$display) {
     $display = $storage->create([
       'targetEntityType' => $entity_type,

src/ConfigurableFieldManager.php

@@ -70,16 +70,33 @@ public function createField(BundleFieldDefinition $field_definition, $lock = TRU
     ]);
     $field->save();
 
+    $modes = [];
     // Show the field on default entity displays, if specified.
     if ($view_display_options = $field_definition->getDisplayOptions('view')) {
-      $view_display = commerce_get_entity_display($entity_type_id, $bundle, 'view');
-      $view_display->setComponent($field_name, $view_display_options);
-      $view_display->save();
+      $modes['view']['default'] = $view_display_options;
     }
     if ($form_display_options = $field_definition->getDisplayOptions('form')) {
-      $form_display = commerce_get_entity_display($entity_type_id, $bundle, 'form');
-      $form_display->setComponent($field_name, $form_display_options);
-      $form_display->save();
+      $modes['form']['default'] = $view_display_options;
+    }
+    $this->configureFieldDisplayModes($field_definition, $modes);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function configureFieldDisplayModes(BundleFieldDefinition $field_definition, $modes) {
+    $field_name = $field_definition->getName();
+    $entity_type_id = $field_definition->getTargetEntityTypeId();
+    $bundle = $field_definition->getTargetBundle();
+    if (empty($field_name) || empty($entity_type_id) || empty($bundle)) {
+      throw new \InvalidArgumentException('The passed $field_definition is incomplete.');
+    }
+    foreach ($modes as $display => $mode) {
+      foreach ($mode as $name => $view_display_options) {
+        $view_display = commerce_get_entity_display($entity_type_id, $bundle, $display, $name);
+        $view_display->setComponent($field_name, $view_display_options);
+        $view_display->save();
+      }
     }
   }
 

src/ConfigurableFieldManagerInterface.php

@@ -25,6 +25,23 @@ interface ConfigurableFieldManagerInterface {
    */
   public function createField(BundleFieldDefinition $field_definition, $lock = TRUE);
 
+  /**
+   * Configure display modes for the given field definition.
+   *
+   * @param \Drupal\entity\BundleFieldDefinition $field_definition
+   *   The field definition.
+   * @param $modes array
+   *   The display mode configuration, keyed by display type, then mode.
+   *   Display type is one of 'form' or 'view', with their values being arrays
+   *   keyed by display mode ID. The display modes are created if they do not
+   *   already exist.
+   *
+   * @throws \InvalidArgumentException
+   *   Thrown when given an incomplete field definition (missing name,
+   *   target entity type ID, or target bundle).
+   */
+  public function configureFieldDisplayModes(BundleFieldDefinition $field_definition, $modes);
+
   /**
    * Deletes the configurable field created from the given field definition.
    *

src/EntityTraitManager.php

@@ -95,12 +95,17 @@ public function detectConflicts(EntityTraitInterface $trait, array $installed_tr
   public function installTrait(EntityTraitInterface $trait, $entity_type_id, $bundle) {
     // The fields provided by an entity trait are maintained as locked
     // configurable fields, for simplicity.
+    $modes = $trait->buildDisplayModes();
     foreach ($trait->buildFieldDefinitions() as $field_name => $field_definition) {
       $field_definition->setTargetEntityTypeId($entity_type_id);
       $field_definition->setTargetBundle($bundle);
       $field_definition->setName($field_name);
 
       $this->configurableFieldManager->createField($field_definition);
+      if (!empty($modes[$field_name])) {
+        $this->configurableFieldManager
+          ->configureFieldDisplayModes($field_definition, $modes[$field_name]);
+      }
     }
   }
 

src/Plugin/Commerce/EntityTrait/EntityTraitBase.php

@@ -30,4 +30,8 @@ public function buildFieldDefinitions() {
     // Entity traits are not required to provide fields.
   }
 
+  public function buildDisplayModes() {
+    // Entity traits are not required to provide additional display modes.
+  }
+
 }

src/Plugin/Commerce/EntityTrait/EntityTraitInterface.php

@@ -35,12 +35,27 @@ public function getEntityTypeIds();
   /**
    * Builds the field definitions.
    *
-   * THe provided field definitions will be created as configurable
+   * The provided field definitions will be created as configurable
    * fields when the entity trait is installed for an entity type/bundle.
    *
    * @return \Drupal\commerce\BundleFieldDefinition[]
    *   An array of field definitions, keyed by field name.
    */
   public function buildFieldDefinitions();
 
+  /**
+   * Builds display mode settings for non-default modes.
+   *
+   * Display mode settings for default form and displays should be set
+   * using BundleFieldDefinition::setDisplayOptions() and are processed by
+   * ConfigurableFieldManager::createField(). To configure additional display
+   * and form modes, return their configuration here. (Specifying default
+   * settings here will overwrite the config from the field definition.)
+   *
+   * @return array
+   *   The display mode configuration, keyed by field name, values described in
+   *   ConfigurableFieldManagerInterface::configureFieldDisplayModes().
+   */
+  public function buildDisplayModes();
+
 }