Merge pull request #16501 from eileenmcnaughton/cancel_recur

Update cancelSubscription form to use updated methodology
civicrm · Mar 10, 2020 · 2ae6888 · 2ae6888
2 parents f75168a + 11ec1f9
commit 2ae6888
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 6 deletions.
diff --git a/CRM/Contribute/Form/CancelSubscription.php b/CRM/Contribute/Form/CancelSubscription.php
@@ -8,6 +8,7 @@
  | and copyright information, see https://civicrm.org/licensing       |
  +--------------------------------------------------------------------+
  */
+use Civi\Payment\PropertyBag;
 
 /**
  *
@@ -187,7 +188,7 @@ public function setDefaultValues() {
    * Process the form submission.
    */
   public function postProcess() {
-    $status = $message = NULL;
+    $message = NULL;
     $cancelSubscription = TRUE;
     $params = $this->controller->exportValues($this->_name);
 
@@ -207,17 +208,16 @@ public function postProcess() {
       // civicrm_contribution_recur.processor_id
       $cancelParams = ['subscriptionId' => $this->_subscriptionDetails->subscription_id];
       try {
-        $cancelSubscription = $this->_paymentProcessorObj->cancelSubscription($message, $cancelParams);
+        $propertyBag = new PropertyBag();
+        $propertyBag->setRecurProcessorID($this->_subscriptionDetails->subscription_id);
+        $message = $this->_paymentProcessorObj->doCancelRecurring($propertyBag)['message'];
       }
       catch (\Civi\Payment\Exception\PaymentProcessorException $e) {
         CRM_Core_Error::statusBounce($e->getMessage());
       }
     }
 
-    if (is_a($cancelSubscription, 'CRM_Core_Error')) {
-      CRM_Core_Error::displaySessionError($cancelSubscription);
-    }
-    elseif ($cancelSubscription) {
+    if ($cancelSubscription) {
       try {
         civicrm_api3('ContributionRecur', 'cancel', [
           'id' => $this->_subscriptionDetails->recur_id,

diff --git a/CRM/Core/Payment.php b/CRM/Core/Payment.php
@@ -1328,6 +1328,34 @@ public function doPayment(&$params, $component = 'contribute') {
     return $result;
   }
 
+  /**
+   * Cancel a recurring subscription.
+   *
+   * Payment processor classes should override this rather than implementing cancelSubscription.
+   *
+   * A PaymentProcessorException should be thrown if the update of the contribution_recur
+   * record should not proceed (in many cases this function does nothing
+   * as the payment processor does not need to take any action & this should silently
+   * proceed. Note the form layer will only call this after calling
+   * $processor->supports('cancelRecurring');
+   *
+   * @param \Civi\Payment\PropertyBag $propertyBag
+   *
+   * @return array
+   *
+   * @throws \Civi\Payment\Exception\PaymentProcessorException
+   */
+  public function doCancelRecurring(PropertyBag $propertyBag) {
+    if (method_exists($this, 'cancelSubscription')) {
+      $message = NULL;
+      if ($this->cancelSubscription($message, $propertyBag)) {
+        return ['message' => $message];
+      }
+      throw new PaymentProcessorException($message);
+    }
+    return ['message' => ts('Recurring contribution cancelled')];
+  }
+
   /**
    * Refunds payment
    *

diff --git a/Civi/Payment/PropertyBag.php b/Civi/Payment/PropertyBag.php
@@ -67,6 +67,7 @@ class PropertyBag implements \ArrayAccess {
     'frequency_interval'          => 'recurFrequencyInterval',
     'recurFrequencyUnit'          => TRUE,
     'frequency_unit'              => 'recurFrequencyUnit',
+    'subscriptionId'              => 'recurProcessorID',
     'recurProcessorID'            => TRUE,
     'transactionID'               => TRUE,
     'transaction_id'              => 'transactionID',