Convert beginDoPayment and getRecurringContributionId to use payment propertyBag

CRM/Core/Payment/MJWTrait.php

@@ -144,39 +144,29 @@ trait CRM_Core_Payment_MJWTrait {
   }
 
   /**
-   * Get the recurring contribution ID from parameters passed in to cancelSubscription
-   * Historical the data passed to cancelSubscription is pretty poor and doesn't include much!
-   * @todo Remove once CiviCRM minver = 5.25 (https://github.com/civicrm/civicrm-core/pull/16741)
+   * Get the recurring contribution ID from parameters
    *
-   * @param array $params
+   * @param \Civi\Payment\PropertyBag $propertyBag
    *
    * @return int|null
    */
-  protected function getRecurringContributionId($params) {
-    // contribution_recur_id = Not yet passed, but could be added via core PR
-    // contributionRecurID = backend live contribution
-    $contributionRecurId = $params['contribution_recur_id'] ?? $params['contributionRecurID'] ?? NULL;
-    if (!empty($contributionRecurId)) {
-      return $contributionRecurId;
+  protected function getRecurringContributionId(\Civi\Payment\PropertyBag $propertyBag) {
+    if ($propertyBag->has('contributionRecurID')) {
+      return $propertyBag->getContributionRecurID();
     }
 
-    // Not yet passed, but could be added via core PR
-    $contributionId = $params['contribution_id'] ?? NULL;
-    try {
-      return (int) civicrm_api3('Contribution', 'getvalue', ['id' => $contributionId, 'return' => 'contribution_recur_id']);
+    if ($propertyBag->has('contributionID')) {
+      return (int) civicrm_api3('Contribution', 'getvalue', ['id' => $propertyBag->getContributionID(), 'return' => 'contribution_recur_id']);
     }
-    catch (Exception $e) {
-      $subscriptionId = $params['subscriptionId'] ?? NULL;
-      if (!empty($subscriptionId)) {
-        try {
-          return (int) civicrm_api3('ContributionRecur', 'getvalue', ['processor_id' => $subscriptionId, 'return' => 'id']);
-        }
-        catch (Exception $e) {
-          return NULL;
-        }
-      }
-      return NULL;
+
+    if ($propertyBag->has('processorID')) {
+      $propertyBag->getRecurProcessorID();
+      return (int) civicrm_api3('ContributionRecur', 'getvalue', [
+        'processor_id' => $propertyBag->getRecurProcessorID(),
+        'return' => 'id'
+      ]);
     }
+    return NULL;
   }
 
   /**
@@ -435,20 +425,26 @@ trait CRM_Core_Payment_MJWTrait {
   }
 
   /**
-   * @param \Civi\Payment\PropertyBag $params
+   * @param \Civi\Payment\PropertyBag $propertyBag
    *
    * @return \Civi\Payment\PropertyBag
    */
-  protected function beginDoPayment($params) {
+  protected function beginDoPayment($propertyBag) {
     // This currently doesn't have a default (5.27). Should be fixed in a future version of CiviCRM.
-    if (!$params->has('isRecur')) {
-      $params->setIsRecur(FALSE);
+    if (!$propertyBag->has('isRecur')) {
+      $propertyBag->setIsRecur(FALSE);
+    }
+
+    // Make sure we have a description for the contribution
+    if (!$propertyBag->has('description')) {
+      $propertyBag->setDescription(E::ts('Contribution: %1', [1 => $this->getPaymentProcessorLabel()]));
     }
-    $params->setCustomProperty('error_url', $this->getErrorUrl($params));
+
+    $propertyBag->setCustomProperty('error_url', $this->getErrorUrl($propertyBag));
 
     // Make sure we have a contactID set on propertyBag
-    $this->getContactId($params);
-    return $params;
+    $this->getContactId($propertyBag);
+    return $propertyBag;
   }
 
   /**