move updateRelatedComponent to BAO
authorjitendrapurohit <jitendra.purohit@webaccessglobal.com>
Tue, 26 Jul 2016 11:58:47 +0000 (17:28 +0530)
committerjitendrapurohit <jitendra.purohit@webaccessglobal.com>
Tue, 26 Jul 2016 11:58:47 +0000 (17:28 +0530)
CRM/Contribute/BAO/Contribution.php
CRM/Contribute/Form/AbstractEditPayment.php
CRM/Contribute/Form/Contribution.php
CRM/Contribute/Form/Task/Batch.php

index f1a56fbefeb4ae02befee4f74046bf3af908b036..9d161c90b279f19eb9030d3dbcc729384bff99ac 100644 (file)
@@ -5086,4 +5086,103 @@ LIMIT 1;";
     return $contributeSettings;
   }
 
+  /**
+   * This function process contribution related objects.
+   *
+   * @param int $contributionId
+   * @param int $statusId
+   * @param int|null $previousStatusId
+   *
+   * @param string $receiveDate
+   *
+   * @return null|string
+   */
+  public static function transitionComponentWithReturnMessage($contributionId, $statusId, $previousStatusId = NULL, $receiveDate = NULL) {
+    $statusMsg = NULL;
+    if (!$contributionId || !$statusId) {
+      return $statusMsg;
+    }
+
+    $params = array(
+      'contribution_id' => $contributionId,
+      'contribution_status_id' => $statusId,
+      'previous_contribution_status_id' => $previousStatusId,
+      'receive_date' => $receiveDate,
+    );
+
+    $updateResult = CRM_Contribute_BAO_Contribution::transitionComponents($params);
+
+    if (!is_array($updateResult) ||
+      !($updatedComponents = CRM_Utils_Array::value('updatedComponents', $updateResult)) ||
+      !is_array($updatedComponents) ||
+      empty($updatedComponents)
+    ) {
+      return $statusMsg;
+    }
+
+    // get the user display name.
+    $sql = "
+   SELECT  display_name as displayName
+     FROM  civicrm_contact
+LEFT JOIN  civicrm_contribution on (civicrm_contribution.contact_id = civicrm_contact.id )
+    WHERE  civicrm_contribution.id = {$contributionId}";
+    $userDisplayName = CRM_Core_DAO::singleValueQuery($sql);
+
+    // get the status message for user.
+    foreach ($updatedComponents as $componentName => $updatedStatusId) {
+
+      if ($componentName == 'CiviMember') {
+        $updatedStatusName = CRM_Utils_Array::value($updatedStatusId,
+          CRM_Member_PseudoConstant::membershipStatus()
+        );
+        if ($updatedStatusName == 'Cancelled') {
+          $statusMsg .= "<br />" . ts("Membership for %1 has been Cancelled.", array(1 => $userDisplayName));
+        }
+        elseif ($updatedStatusName == 'Expired') {
+          $statusMsg .= "<br />" . ts("Membership for %1 has been Expired.", array(1 => $userDisplayName));
+        }
+        else {
+          $endDate = CRM_Utils_Array::value('membership_end_date', $updateResult);
+          if ($endDate) {
+            $statusMsg .= "<br />" . ts("Membership for %1 has been updated. The membership End Date is %2.",
+                array(
+                  1 => $userDisplayName,
+                  2 => $endDate,
+                )
+              );
+          }
+        }
+      }
+
+      if ($componentName == 'CiviEvent') {
+        $updatedStatusName = CRM_Utils_Array::value($updatedStatusId,
+          CRM_Event_PseudoConstant::participantStatus()
+        );
+        if ($updatedStatusName == 'Cancelled') {
+          $statusMsg .= "<br />" . ts("Event Registration for %1 has been Cancelled.", array(1 => $userDisplayName));
+        }
+        elseif ($updatedStatusName == 'Registered') {
+          $statusMsg .= "<br />" . ts("Event Registration for %1 has been updated.", array(1 => $userDisplayName));
+        }
+      }
+
+      if ($componentName == 'CiviPledge') {
+        $updatedStatusName = CRM_Utils_Array::value($updatedStatusId,
+          CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name')
+        );
+        if ($updatedStatusName == 'Cancelled') {
+          $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been Cancelled.", array(1 => $userDisplayName));
+        }
+        elseif ($updatedStatusName == 'Failed') {
+          $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been Failed.", array(1 => $userDisplayName));
+        }
+        elseif ($updatedStatusName == 'Completed') {
+          $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been updated.", array(1 => $userDisplayName));
+        }
+      }
+    }
+
+    return $statusMsg;
+  }
+
 }
index 622c027a0e7753cebe08b1d0ae14b0db849a9036..c5f8855dc0ac232fb44df913f5df4d8b7b59684d 100644 (file)
@@ -300,105 +300,6 @@ WHERE  contribution_id = {$id}
     $dao->free();
   }
 
-  /**
-   * This function process contribution related objects.
-   *
-   * @param int $contributionId
-   * @param int $statusId
-   * @param int|null $previousStatusId
-   *
-   * @param string $receiveDate
-   *
-   * @return null|string
-   */
-  public static function updateRelatedComponent($contributionId, $statusId, $previousStatusId = NULL, $receiveDate = NULL) {
-    $statusMsg = NULL;
-    if (!$contributionId || !$statusId) {
-      return $statusMsg;
-    }
-
-    $params = array(
-      'contribution_id' => $contributionId,
-      'contribution_status_id' => $statusId,
-      'previous_contribution_status_id' => $previousStatusId,
-      'receive_date' => $receiveDate,
-    );
-
-    $updateResult = CRM_Contribute_BAO_Contribution::transitionComponents($params);
-
-    if (!is_array($updateResult) ||
-      !($updatedComponents = CRM_Utils_Array::value('updatedComponents', $updateResult)) ||
-      !is_array($updatedComponents) ||
-      empty($updatedComponents)
-    ) {
-      return $statusMsg;
-    }
-
-    // get the user display name.
-    $sql = "
-   SELECT  display_name as displayName
-     FROM  civicrm_contact
-LEFT JOIN  civicrm_contribution on (civicrm_contribution.contact_id = civicrm_contact.id )
-    WHERE  civicrm_contribution.id = {$contributionId}";
-    $userDisplayName = CRM_Core_DAO::singleValueQuery($sql);
-
-    // get the status message for user.
-    foreach ($updatedComponents as $componentName => $updatedStatusId) {
-
-      if ($componentName == 'CiviMember') {
-        $updatedStatusName = CRM_Utils_Array::value($updatedStatusId,
-          CRM_Member_PseudoConstant::membershipStatus()
-        );
-        if ($updatedStatusName == 'Cancelled') {
-          $statusMsg .= "<br />" . ts("Membership for %1 has been Cancelled.", array(1 => $userDisplayName));
-        }
-        elseif ($updatedStatusName == 'Expired') {
-          $statusMsg .= "<br />" . ts("Membership for %1 has been Expired.", array(1 => $userDisplayName));
-        }
-        else {
-          $endDate = CRM_Utils_Array::value('membership_end_date', $updateResult);
-          if ($endDate) {
-            $statusMsg .= "<br />" . ts("Membership for %1 has been updated. The membership End Date is %2.",
-                array(
-                  1 => $userDisplayName,
-                  2 => $endDate,
-                )
-              );
-          }
-        }
-      }
-
-      if ($componentName == 'CiviEvent') {
-        $updatedStatusName = CRM_Utils_Array::value($updatedStatusId,
-          CRM_Event_PseudoConstant::participantStatus()
-        );
-        if ($updatedStatusName == 'Cancelled') {
-          $statusMsg .= "<br />" . ts("Event Registration for %1 has been Cancelled.", array(1 => $userDisplayName));
-        }
-        elseif ($updatedStatusName == 'Registered') {
-          $statusMsg .= "<br />" . ts("Event Registration for %1 has been updated.", array(1 => $userDisplayName));
-        }
-      }
-
-      if ($componentName == 'CiviPledge') {
-        $updatedStatusName = CRM_Utils_Array::value($updatedStatusId,
-          CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name')
-        );
-        if ($updatedStatusName == 'Cancelled') {
-          $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been Cancelled.", array(1 => $userDisplayName));
-        }
-        elseif ($updatedStatusName == 'Failed') {
-          $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been Failed.", array(1 => $userDisplayName));
-        }
-        elseif ($updatedStatusName == 'Completed') {
-          $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been updated.", array(1 => $userDisplayName));
-        }
-      }
-    }
-
-    return $statusMsg;
-  }
-
   /**
    * @return array
    *   Array of valid processors. The array resembles the DB table but also has 'object' as a key
index ab2789805c37ff00e3ed2c5594cdbaabbe3e31d4..4b3ad1d7b446d78923ba6339f43f4ca903de6a30 100644 (file)
@@ -1714,7 +1714,7 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP
 
       // process associated membership / participant, CRM-4395
       if ($contribution->id && $action & CRM_Core_Action::UPDATE) {
-        $this->statusMessage[] = self::updateRelatedComponent($contribution->id,
+        $this->statusMessage[] = CRM_Contribute_BAO_Contribution::transitionComponentWithReturnMessage($contribution->id,
           $contribution->contribution_status_id,
           CRM_Utils_Array::value('contribution_status_id',
             $this->_values
index a97547a942acbf15dfe641e95f40c32dd7e3c6de..2f3a4c4b5caeba5cdbda648de6d9884f1167d877 100644 (file)
@@ -235,7 +235,7 @@ class CRM_Contribute_Form_Task_Batch extends CRM_Contribute_Form_Task {
         $contribution = CRM_Contribute_BAO_Contribution::add($value, $ids);
 
         if (!empty($value['contribution_status_id'])) {
-          CRM_Contribute_Form_AbstractEditPayment::updateRelatedComponent($contribution->id,
+          CRM_Contribute_BAO_Contribution::transitionComponentWithReturnMessage($contribution->id,
             $value['contribution_status_id'],
             CRM_Utils_Array::value("field[{$key}][contribution_status_id]",
               $this->_defaultValues