3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
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 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 * Main page for viewing Recurring Contributions.
21 class CRM_Contribute_Page_ContributionRecur
extends CRM_Core_Page
{
23 use CRM_Core_Page_EntityPageTrait
;
28 public function getDefaultEntity() {
29 return 'ContributionRecur';
32 protected function getDefaultAction() {
37 * View details of a recurring contribution.
39 public function view() {
40 if (empty($this->getEntityId())) {
41 CRM_Core_Error
::statusBounce(ts('Recurring contribution not found'));
45 $contributionRecur = civicrm_api3('ContributionRecur', 'getsingle', [
46 'id' => $this->getEntityId(),
49 catch (Exception
$e) {
50 CRM_Core_Error
::statusBounce(ts('Recurring contribution not found (ID: %1)', [1 => $this->getEntityId()]));
53 $contributionRecur['payment_processor'] = CRM_Financial_BAO_PaymentProcessor
::getPaymentProcessorName(
54 CRM_Utils_Array
::value('payment_processor_id', $contributionRecur)
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]);
63 // Add linked membership
64 $membership = civicrm_api3('Membership', 'get', [
65 'contribution_recur_id' => $contributionRecur['id'],
67 if (!empty($membership['count'])) {
68 $membershipDetails = reset($membership['values']);
69 $contributionRecur['membership_id'] = $membershipDetails['id'];
70 $contributionRecur['membership_name'] = $membershipDetails['membership_name'];
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']);
77 if (isset($contributionRecur['trxn_id']) && ($contributionRecur['processor_id'] === $contributionRecur['trxn_id'])) {
78 unset($contributionRecur['trxn_id']);
80 $this->assign('recur', $contributionRecur);
82 $templateContribution = CRM_Contribute_BAO_ContributionRecur
::getTemplateContribution($this->getEntityId());
85 $displayLineItems = FALSE;
86 if (!empty($templateContribution['id'])) {
87 $lineItems = [CRM_Price_BAO_LineItem
::getLineItemsByContributionID(($templateContribution['id']))];
88 $displayLineItems = TRUE;
90 $this->assign('lineItem', $lineItems);
91 $this->assign('displayLineItems', $displayLineItems);
93 $displayName = CRM_Contact_BAO_Contact
::displayName($contributionRecur['contact_id']);
94 $this->assign('displayName', $displayName);
96 // Check if this is default domain contact CRM-10482
97 if (CRM_Contact_BAO_Contact
::checkDomainContact($contributionRecur['contact_id'])) {
98 $displayName .= ' (' . ts('default organization') . ')';
101 // omitting contactImage from title for now since the summary overlay css doesn't work outside of our crm-container
102 CRM_Utils_System
::setTitle(ts('View Recurring Contribution from') . ' ' . $displayName);
105 public function preProcess() {
106 $this->preProcessQuickEntityPage();
110 * the main function that is called when the page loads,
111 * it decides the which action has to be taken for the page.
115 public function run() {
117 $this->assign('hasAccessCiviContributePermission', CRM_Core_Permission
::check('access CiviContribute'));
118 if ($this->isViewContext()) {
122 return parent
::run();