(dev/core/40) Show List of Contributions On Recurring Contribution View

CRM/Contribute/Form/Task.php

@@ -116,10 +116,12 @@ public static function preProcessCommon(&$form, $useTable = FALSE) {
     else {
       $queryParams = $form->get('queryParams');
       $isTest = FALSE;
-      foreach ($queryParams as $fields) {
-        if ($fields[0] == 'contribution_test') {
-          $isTest = TRUE;
-          break;
+      if (is_array($queryParams)) {
+        foreach ($queryParams as $fields) {
+          if ($fields[0] == 'contribution_test') {
+            $isTest = TRUE;
+            break;
+          }
         }
       }
       if (!$isTest) {

CRM/Contribute/Form/UpdateSubscription.php

@@ -87,6 +87,9 @@ public function preProcess() {
       catch (CRM_Core_Exception $e) {
         CRM_Core_Error::statusBounce(ts('There is no valid processor for this subscription so it cannot be edited.'));
       }
+      catch (CiviCRM_API3_Exception $e) {
+        CRM_Core_Error::statusBounce(ts('There is no valid processor for this subscription so it cannot be edited.'));
+      }
       $this->_subscriptionDetails = CRM_Contribute_BAO_ContributionRecur::getSubscriptionDetails($this->contributionRecurID);
     }
 

CRM/Contribute/Page/ContributionRecur.php

@@ -39,6 +39,8 @@ class CRM_Contribute_Page_ContributionRecur extends CRM_Core_Page {
   static $_links = NULL;
   public $_permission = NULL;
   public $_contactId = NULL;
+  public $_id = NULL;
+  public $_action = NULL;
 
   /**
    * View details of a recurring contribution.
@@ -57,7 +59,9 @@ public function view() {
       CRM_Core_Error::statusBounce('Recurring contribution not found (ID: ' . $this->_id);
     }
 
-    $contributionRecur['payment_processor'] = CRM_Financial_BAO_PaymentProcessor::getPaymentProcessorName($contributionRecur['payment_processor_id']);
+    $contributionRecur['payment_processor'] = CRM_Financial_BAO_PaymentProcessor::getPaymentProcessorName(
+      CRM_Utils_Array::value('payment_processor_id', $contributionRecur)
+    );
     $idFields = array('contribution_status_id', 'campaign_id', 'financial_type_id');
     foreach ($idFields as $idField) {
       if (!empty($contributionRecur[$idField])) {

CRM/Contribute/Page/ContributionRecurPayments.php

@@ -0,0 +1,221 @@
+<?php
+
+/**
+ * Shows list of contributions done as payments within a recurring contribution.
+ */
+class CRM_Contribute_Page_ContributionRecurPayments extends CRM_Core_Page {
+
+  /**
+   * Contribution ID
+   *
+   * @var int
+   */
+  private $id = NULL;
+
+  /**
+   * Contact ID
+   *
+   * @var int
+   */
+  private $contactId = NULL;
+
+  /**
+   * Builds list of contributions for a given recurring contribution.
+   *
+   * @return null
+   */
+  public function run() {
+    $this->id = CRM_Utils_Request::retrieve('id', 'Positive', $this, TRUE);
+    $this->contactId = CRM_Utils_Request::retrieve('cid', 'Positive', $this, TRUE);
+
+    $this->loadRelatedContributions();
+
+    return parent::run();
+  }
+
+  /**
+   * Loads contributions associated to the current recurring contribution being
+   * viewed.
+   */
+  private function loadRelatedContributions() {
+    $relatedContributions = array();
+
+    $relatedContributionsResult = civicrm_api3('Contribution', 'get', array(
+      'sequential' => 1,
+      'contribution_recur_id' => $this->id,
+      'contact_id' => $this->contactId,
+      'options' => array('limit' => 0),
+    ));
+
+    foreach ($relatedContributionsResult['values'] as $contribution) {
+      $this->insertAmountExpandingPaymentsControl($contribution);
+      $this->fixDateFormats($contribution);
+      $this->insertStatusLabels($contribution);
+      $this->insertContributionActions($contribution);
+
+      $relatedContributions[] = $contribution;
+    }
+
+    if (count($relatedContributions) > 0) {
+      $this->assign('contributionsCount', count($relatedContributions));
+      $this->assign('relatedContributions', json_encode($relatedContributions));
+    }
+  }
+
+  /**
+   * Inserts a string into the array with the html used to show the expanding
+   * payments control, which loads when user clicks on the amount.
+   *
+   * @param array $contribution
+   *   Reference to the array holding the contribution's data and where the
+   *   control will be inserted into
+   */
+  private function insertAmountExpandingPaymentsControl(&$contribution) {
+    $amount = CRM_Utils_Money::format($contribution['total_amount'], $contribution['currency']);
+
+    $expandPaymentsUrl = CRM_Utils_System::url('civicrm/payment',
+      array(
+        'view' => 'transaction',
+        'component' => 'contribution',
+        'action' => 'browse',
+        'cid' => $this->contactId,
+        'id' => $contribution['contribution_id'],
+        'selector' => 1,
+      ),
+      FALSE, NULL, TRUE
+    );
+
+    $contribution['amount_control'] = '
+      <a class="nowrap bold crm-expand-row" title="view payments" href="' . $expandPaymentsUrl . '">
+        &nbsp; ' . $amount . '
+      </a>
+    ';
+  }
+
+  /**
+   * Fixes date fields present in the given contribution.
+   *
+   * @param array $contribution
+   *   Reference to the array holding the contribution's data
+   */
+  private function fixDateFormats(&$contribution) {
+    $config = CRM_Core_Config::singleton();
+
+    $contribution['formatted_receive_date'] = CRM_Utils_Date::customFormat($contribution['receive_date'], $config->dateformatDatetime);
+    $contribution['formatted_thankyou_date'] = CRM_Utils_Date::customFormat($contribution['thankyou_date'], $config->dateformatDatetime);
+  }
+
+  /**
+   * Inserts a contribution_status_label key into the array, with the value
+   * showing the current status plus observations on the current status.
+   *
+   * @param array $contribution
+   *   Reference to the array holding the contribution's data and where the new
+   *   position will be inserted
+   */
+  private function insertStatusLabels(&$contribution) {
+    $contribution['contribution_status_label'] = $contribution['contribution_status'];
+
+    if ($contribution['is_pay_later'] && CRM_Utils_Array::value('contribution_status', $contribution) == 'Pending') {
+      $contribution['contribution_status_label'] .= ' (' . ts('Pay Later') . ')';
+    }
+    elseif (CRM_Utils_Array::value('contribution_status', $contribution) == 'Pending') {
+      $contribution['contribution_status_label'] .= ' (' . ts('Incomplete Transaction') . ')';
+    }
+  }
+
+  /**
+   * Inserts into the given array a string with the 'action' key, holding the
+   * html to be used to show available actions for the contribution.
+   *
+   * @param $contribution
+   *   Reference to the array holding the contribution's data. It is also the
+   *   array where the new 'action' key will be inserted.
+   */
+  private function insertContributionActions(&$contribution) {
+    $contribution['action'] = CRM_Core_Action::formLink(
+      $this->buildContributionLinks($contribution),
+      $this->getContributionPermissionsMask(),
+      array(
+        'id' => $contribution['contribution_id'],
+        'cid' => $contribution['contact_id'],
+        'cxt' => 'contribution',
+      ),
+      ts('more'),
+      FALSE,
+      'contribution.selector.row',
+      'Contribution',
+      $contribution['contribution_id']
+    );
+  }
+
+  /**
+   * Builds list of links for authorized actions that can be done on given
+   * contribution.
+   *
+   * @param array $contribution
+   *
+   * @return array
+   */
+  private function buildContributionLinks($contribution) {
+    $links = CRM_Contribute_Selector_Search::links($contribution['contribution_id'],
+      CRM_Utils_Request::retrieve('action', 'String'),
+      NULL,
+      NULL
+    );
+
+    $isPayLater = FALSE;
+    if ($contribution['is_pay_later'] && CRM_Utils_Array::value('contribution_status', $contribution) == 'Pending') {
+      $isPayLater = TRUE;
+
+      $links[CRM_Core_Action::ADD] = array(
+        'name' => ts('Pay with Credit Card'),
+        'url' => 'civicrm/contact/view/contribution',
+        'qs' => 'reset=1&action=update&id=%%id%%&cid=%%cid%%&context=%%cxt%%&mode=live',
+        'title' => ts('Pay with Credit Card'),
+      );
+    }
+
+    if (in_array($contribution['contribution_status'], array('Partially paid', 'Pending refund')) || $isPayLater) {
+      $buttonName = ts('Record Payment');
+
+      if ($contribution['contribution_status'] == 'Pending refund') {
+        $buttonName = ts('Record Refund');
+      }
+      elseif (CRM_Core_Config::isEnabledBackOfficeCreditCardPayments()) {
+        $links[CRM_Core_Action::BASIC] = array(
+          'name' => ts('Submit Credit Card payment'),
+          'url' => 'civicrm/payment/add',
+          'qs' => 'reset=1&id=%%id%%&cid=%%cid%%&action=add&component=contribution&mode=live',
+          'title' => ts('Submit Credit Card payment'),
+        );
+      }
+      $links[CRM_Core_Action::ADD] = array(
+        'name' => $buttonName,
+        'url' => 'civicrm/payment',
+        'qs' => 'reset=1&id=%%id%%&cid=%%cid%%&action=add&component=contribution',
+        'title' => $buttonName,
+      );
+    }
+
+    return $links;
+  }
+
+  /**
+   * Builds a mask with allowed contribution related permissions.
+   *
+   * @return int
+   */
+  private function getContributionPermissionsMask() {
+    $permissions = array(CRM_Core_Permission::VIEW);
+    if (CRM_Core_Permission::check('edit contributions')) {
+      $permissions[] = CRM_Core_Permission::EDIT;
+    }
+    if (CRM_Core_Permission::check('delete in CiviContribute')) {
+      $permissions[] = CRM_Core_Permission::DELETE;
+    }
+
+    return CRM_Core_Action::mask($permissions);
+  }
+
+}

CRM/Contribute/xml/Menu/Contribute.xml

@@ -323,4 +323,10 @@
     <page_callback>CRM_Contribute_Page_AJAX::getSoftContributionRows</page_callback>
     <access_arguments>access CiviCRM</access_arguments>
   </item>
+  <item>
+    <path>civicrm/contribute/contributionrecur-payments</path>
+    <title>Recurring Contribution's Payments</title>
+    <page_callback>CRM_Contribute_Page_ContributionRecurPayments</page_callback>
+    <access_arguments>access CiviContribute</access_arguments>
+  </item>
 </menu>

templates/CRM/Contribute/Page/ContributionRecur.tpl

@@ -62,6 +62,31 @@
           <div class="crm-submit-buttons"><a class="button cancel crm-form-submit" href="{crmURL p='civicrm/contact/view' q='action=browse&selectedChild=contribute'}">{ts}Done{/ts}</a></div>
         </div>
     {/if}
+
+  <script type="text/javascript">
+    var recurContribID = {$recur.id};
+    var contactID = {$contactId};
+    {literal}
+    CRM.$(function($) {
+      CRM.loadPage(
+        CRM.url(
+          'civicrm/contribute/contributionrecur-payments',
+          {
+            reset: 1,
+            id: recurContribID,
+            cid: contactID
+          },
+          'back'
+        ),
+        {
+          target : '#recurring-contribution-payments',
+          dialog : false
+        }
+      );
+    });
+    {/literal}
+  </script>
+  <div id="recurring-contribution-payments"></div>
 {/if}
 {if $recurRows}
     {strip}

templates/CRM/Contribute/Page/ContributionRecurPayments.tpl

@@ -0,0 +1,42 @@
+{if $contributionsCount > 0}
+  <div class="crm-accordion-wrapper">
+    <div class="crm-accordion-header">{ts}Related Contributions{/ts}</div>
+    <div class="crm-accordion-body">
+      <table class="crm-contact-contributions">
+        <thead>
+        <tr>
+          <th class='crm-contact-total_amount'>{ts}Amount{/ts}</th>
+          <th class='crm-contact-financial_type_id'>{ts}Type{/ts}</th>
+          <th class='crm-contact-contribution_source'>{ts}Source{/ts}</th>
+          <th class='crm-contact-receive_date'>{ts}Recieved{/ts}</th>
+          <th class='crm-contact-thankyou_date'>{ts}Thank-you Sent{/ts}</th>
+          <th class='crm-contact-contribution_status'>{ts}Status{/ts}</th>
+          <th>&nbsp;</th>
+        </tr>
+        </thead>
+      </table>
+      <script type="text/javascript">
+        var tableData = {$relatedContributions};
+        {literal}
+        cj('table.crm-contact-contributions').DataTable({
+          data : tableData,
+          columns: [
+            { data: 'amount_control' },
+            { data: 'financial_type' },
+            { data: 'contribution_source' },
+            { data: 'formatted_receive_date' },
+            { data: 'formatted_thankyou_date' },
+            { data: 'contribution_status_label' },
+            { data: 'action' }
+          ]
+        });
+        {/literal}
+      </script>
+    </div>
+  </div>
+{else}
+  <div class="messages status no-popup">
+    <div class="icon inform-icon"></div>
+    {ts}No contributions have been recorded for this recurring contribution.{/ts}
+  </div>
+{/if}