Issue #2845097: Introduce a CommerceElementBase

Author: bojanz

modules/payment/src/Element/PaymentGatewayForm.php

@@ -2,11 +2,10 @@
 
 namespace Drupal\commerce_payment\Element;
 
+use Drupal\commerce\Element\CommerceElementBase;
 use Drupal\commerce_payment\Entity\EntityWithPaymentGatewayInterface;
 use Drupal\commerce_payment\Exception\PaymentGatewayException;
 use Drupal\Core\Form\FormStateInterface;
-use Drupal\Core\Render\Element;
-use Drupal\Core\Render\Element\RenderElement;
 
 /**
  * Provides a form element for embedding the payment gateway forms.
@@ -25,7 +24,7 @@
  *
  * @RenderElement("commerce_payment_gateway_form")
  */
-class PaymentGatewayForm extends RenderElement {
+class PaymentGatewayForm extends CommerceElementBase {
 
   /**
    * {@inheritdoc}
@@ -37,12 +36,14 @@ public function getInfo() {
       // The entity operated on. Instance of EntityWithPaymentGatewayInterface.
       '#default_value' => NULL,
       '#process' => [
+        [$class, 'attachElementSubmit'],
         [$class, 'processForm'],
       ],
       '#element_validate' => [
+        [$class, 'validateElementSubmit'],
         [$class, 'validateForm'],
       ],
-      '#element_submit' => [
+      '#commerce_element_submit' => [
         [$class, 'submitForm'],
       ],
       '#theme_wrappers' => ['container'],
@@ -82,10 +83,6 @@ public static function processForm(array $element, FormStateInterface $form_stat
     if (isset($element['#page_title'])) {
       $complete_form['#title'] = $element['#page_title'];
     }
-    // The #validate callbacks of the complete form run last.
-    // That allows executeElementSubmitHandlers() to be completely certain that
-    // the form has passed validation before proceeding.
-    $complete_form['#validate'][] = [get_class(), 'executeElementSubmitHandlers'];
 
     return $element;
   }
@@ -97,18 +94,8 @@ public static function processForm(array $element, FormStateInterface $form_stat
    *   The form element.
    * @param \Drupal\Core\Form\FormStateInterface $form_state
    *   The current state of the form.
-   *
-   * @throws \Exception
-   *   Thrown if button-level #validate handlers are detected on the parent
-   *   form, as a protection against buggy behavior.
    */
   public static function validateForm(array &$element, FormStateInterface $form_state) {
-    // Button-level #validate handlers replace the form-level ones, which means
-    // that executeElementSubmitHandlers() won't be triggered.
-    if ($handlers = $form_state->getValidateHandlers()) {
-      throw new \Exception('The commerce_payment_gateway_form element is not compatible with submit buttons that set #validate handlers');
-    }
-
     $plugin_form = self::createPluginForm($element);
     $plugin_form->validateConfigurationForm($element, $form_state);
   }
@@ -144,7 +131,7 @@ public static function submitForm(array &$element, FormStateInterface $form_stat
    *   The plugin form.
    */
   public static function createPluginForm(array $element) {
-    /** @var \Drupal\commerce\PluginForm\PluginFormFactoryInterface $plugin_form_factory */
+    /** @var \Drupal\Core\Plugin\PluginFormFactoryInterface $plugin_form_factory */
     $plugin_form_factory = \Drupal::service('plugin_form.factory');
     /** @var \Drupal\commerce_payment\Entity\EntityWithPaymentGatewayInterface $entity */
     $entity = $element['#default_value'];
@@ -156,38 +143,4 @@ public static function createPluginForm(array $element) {
     return $plugin_form;
   }
 
-  /**
-   * Submits elements by calling their #element_submit callbacks.
-   *
-   * Form API has no #element_submit, requiring us to simulate it by running
-   * our #element_submit handlers either in the last step of validation, or the
-   * first step of submission. In this case it's the last step of validation,
-   * allowing exceptions thrown by the plugin to be converted into form errors.
-   *
-   * @param array $element
-   *   The form element.
-   * @param \Drupal\Core\Form\FormStateInterface $form_state
-   *   The form state.
-   */
-  public static function executeElementSubmitHandlers(array &$element, FormStateInterface $form_state) {
-    if (!$form_state->isSubmitted() || $form_state->hasAnyErrors()) {
-      // The form wasn't submitted (#ajax in progress) or failed validation.
-      return;
-    }
-
-    // Recurse through all children.
-    foreach (Element::children($element) as $key) {
-      if (!empty($element[$key])) {
-        static::executeElementSubmitHandlers($element[$key], $form_state);
-      }
-    }
-
-    // If there are callbacks on this level, run them.
-    if (!empty($element['#element_submit'])) {
-      foreach ($element['#element_submit'] as $callback) {
-        call_user_func_array($callback, [&$element, &$form_state]);
-      }
-    }
-  }
-
 }

modules/promotion/src/Plugin/Commerce/PromotionOffer/PercentageOffBase.php

@@ -54,7 +54,7 @@ public function buildConfigurationForm(array $form, FormStateInterface $form_sta
    */
   public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
     $values = $form_state->getValue($form['#parents']);
-    if (empty($values['target_plugin_configuration']['amount'])) {
+    if (empty($values['amount'])) {
       $form_state->setError($form, $this->t('Percentage amount cannot be empty.'));
     }
   }

src/Element/CommerceElementBase.php

@@ -0,0 +1,101 @@
+<?php
+
+namespace Drupal\commerce\Element;
+
+use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\Render\Element;
+use Drupal\Core\Render\Element\FormElement;
+
+/**
+ * Provides a base class for Commerce form elements.
+ *
+ * Allows form elements to use #commerce_element_submit, a substitute
+ * for the #element_submit that's missing from Drupal core.
+ *
+ * Each inheriting form element should add the attachElementSubmit and
+ * validateElementSubmit callbacks to their getInfo() methods.
+ */
+abstract class CommerceElementBase extends FormElement {
+
+  /**
+   * Attaches the #commerce_element_submit functionality.
+   *
+   * @param array $element
+   *   The form element being processed.
+   * @param \Drupal\Core\Form\FormStateInterface $form_state
+   *   The current state of the form.
+   * @param array $complete_form
+   *   The complete form structure.
+   *
+   * @return array
+   *   The processed form element.
+   */
+  public static function attachElementSubmit(array $element, FormStateInterface $form_state, array &$complete_form) {
+    if (isset($complete_form['#commerce_element_submit_attached'])) {
+      return $element;
+    }
+    // The #validate callbacks of the complete form run last.
+    // That allows executeElementSubmitHandlers() to be completely certain that
+    // the form has passed validation before proceeding.
+    $complete_form['#validate'][] = [get_class(), 'executeElementSubmitHandlers'];
+    $complete_form['#commerce_element_submit_attached'] = TRUE;
+
+    return $element;
+  }
+
+  /**
+   * Confirms that #commerce_element_submit handlers can be run.
+   *
+   * @param array $element
+   *   The form element.
+   * @param \Drupal\Core\Form\FormStateInterface $form_state
+   *   The current state of the form.
+   *
+   * @throws \Exception
+   *   Thrown if button-level #validate handlers are detected on the parent
+   *   form, as a protection against buggy behavior.
+   */
+  public static function validateElementSubmit(array &$element, FormStateInterface $form_state) {
+    // Button-level #validate handlers replace the form-level ones, which means
+    // that executeElementSubmitHandlers() won't be triggered.
+    if ($handlers = $form_state->getValidateHandlers()) {
+      throw new \Exception('The current form must not have button-level #validate handlers');
+    }
+  }
+
+  /**
+   * Submits elements by calling their #commerce_element_submit callbacks.
+   *
+   * Form API has no #element_submit, requiring us to simulate it by running
+   * the #commerce_element_submit handlers either in the last step of
+   * validation, or the first step of submission. In this case it's the last
+   * step of validation, allowing thrown exceptions to be converted into form
+   * errors.
+   *
+   * @param array $element
+   *   The form element.
+   * @param \Drupal\Core\Form\FormStateInterface $form_state
+   *   The form state.
+   */
+  public static function executeElementSubmitHandlers(array &$element, FormStateInterface $form_state) {
+    if (!$form_state->isSubmitted() || $form_state->hasAnyErrors()) {
+      // The form wasn't submitted (#ajax in progress) or failed validation.
+      return;
+    }
+
+    // Recurse through all children.
+    foreach (Element::children($element) as $key) {
+      if (!empty($element[$key])) {
+        static::executeElementSubmitHandlers($element[$key], $form_state);
+      }
+    }
+
+    // If there are callbacks on this level, run them.
+    if (!empty($element['#commerce_element_submit'])) {
+      foreach ($element['#commerce_element_submit'] as $callback) {
+        call_user_func_array($callback, [&$element, &$form_state]);
+      }
+    }
+  }
+
+}