CRM/Contribute/Page/ContributionRecur.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17
  18 /**
  19  * Main page for viewing Recurring Contributions.
  20  */
  21 class CRM_Contribute_Page_ContributionRecur extends CRM_Core_Page {
  22
  23   use CRM_Core_Page_EntityPageTrait;
  24
  25   /**
  26    * @return string
  27    */
  28   public function getDefaultEntity() {
  29     return 'ContributionRecur';
  30   }
  31
  32   protected function getDefaultAction() {
  33     return 'view';
  34   }
  35
  36   /**
  37    * View details of a recurring contribution.
  38    */
  39   public function view() {
  40     if (empty($this->getEntityId())) {
  41       CRM_Core_Error::statusBounce(ts('Recurring contribution not found'));
  42     }
  43
  44     try {
  45       $contributionRecur = civicrm_api3('ContributionRecur', 'getsingle', [
  46         'id' => $this->getEntityId(),
  47       ]);
  48     }
  49     catch (Exception $e) {
  50       CRM_Core_Error::statusBounce(ts('Recurring contribution not found (ID: %1)', [1 => $this->getEntityId()]));
  51     }
  52
  53     $contributionRecur['payment_processor'] = CRM_Financial_BAO_PaymentProcessor::getPaymentProcessorName(
  54       CRM_Utils_Array::value('payment_processor_id', $contributionRecur)
  55     );
  56     $idFields = ['contribution_status_id', 'campaign_id', 'financial_type_id'];
  57     foreach ($idFields as $idField) {
  58       if (!empty($contributionRecur[$idField])) {
  59         $contributionRecur[substr($idField, 0, -3)] = CRM_Core_PseudoConstant::getLabel('CRM_Contribute_BAO_ContributionRecur', $idField, $contributionRecur[$idField]);
  60       }
  61     }
  62
  63     // Add linked membership
  64     $membership = civicrm_api3('Membership', 'get', [
  65       'contribution_recur_id' => $contributionRecur['id'],
  66     ]);
  67     if (!empty($membership['count'])) {
  68       $membershipDetails = reset($membership['values']);
  69       $contributionRecur['membership_id'] = $membershipDetails['id'];
  70       $contributionRecur['membership_name'] = $membershipDetails['membership_name'];
  71     }
  72
  73     $groupTree = CRM_Core_BAO_CustomGroup::getTree('ContributionRecur', NULL, $contributionRecur['id'], NULL, [],
  74       NULL, TRUE, NULL, FALSE, CRM_Core_Permission::VIEW);
  75     CRM_Core_BAO_CustomGroup::buildCustomDataView($this, $groupTree, FALSE, NULL, NULL, NULL, $contributionRecur['id']);
  76
  77     $this->assign('recur', $contributionRecur);
  78
  79     $templateContribution = CRM_Contribute_BAO_ContributionRecur::getTemplateContribution($this->getEntityId());
  80
  81     $lineItems = [];
  82     $displayLineItems = FALSE;
  83     if (!empty($templateContribution['id'])) {
  84       $lineItems = [CRM_Price_BAO_LineItem::getLineItemsByContributionID(($templateContribution['id']))];
  85       $displayLineItems = TRUE;
  86     }
  87     $this->assign('lineItem', $lineItems);
  88     $this->assign('displayLineItems', $displayLineItems);
  89
  90     $displayName = CRM_Contact_BAO_Contact::displayName($contributionRecur['contact_id']);
  91     $this->assign('displayName', $displayName);
  92
  93     // Check if this is default domain contact CRM-10482
  94     if (CRM_Contact_BAO_Contact::checkDomainContact($contributionRecur['contact_id'])) {
  95       $displayName .= ' (' . ts('default organization') . ')';
  96     }
  97
  98     // omitting contactImage from title for now since the summary overlay css doesn't work outside of our crm-container
  99     CRM_Utils_System::setTitle(ts('View Recurring Contribution from') . ' ' . $displayName);
 100   }
 101
 102   public function preProcess() {
 103     $this->preProcessQuickEntityPage();
 104   }
 105
 106   /**
 107    * the main function that is called when the page loads,
 108    * it decides the which action has to be taken for the page.
 109    *
 110    * @return null
 111    */
 112   public function run() {
 113     $this->preProcess();
 114     $this->assign('hasAccessCiviContributePermission', CRM_Core_Permission::check('access CiviContribute'));
 115     if ($this->isViewContext()) {
 116       $this->view();
 117     }
 118
 119     return parent::run();
 120   }
 121
 122 }