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
17 class CRM_Contribute_Page_Tab
extends CRM_Core_Page
{
20 * The permission we have on this contact
24 public $_permission = NULL;
27 * The contact ID for the contributions we are acting on
30 public $_contactId = NULL;
33 * The recurring contribution ID (if any)
39 * This method returns the links that are given for recur search row.
40 * currently the links added for each row are:
45 * @param bool $recurID
46 * @param string $context
50 public static function recurLinks($recurID = FALSE, $context = 'contribution') {
52 CRM_Core_Action
::VIEW
=> [
54 'title' => ts('View Recurring Payment'),
55 'url' => 'civicrm/contact/view/contributionrecur',
56 'qs' => "reset=1&id=%%crid%%&cid=%%cid%%&context={$context}",
58 CRM_Core_Action
::UPDATE
=> [
60 'title' => ts('Edit Recurring Payment'),
61 'url' => 'civicrm/contribute/updaterecur',
62 'qs' => "reset=1&action=update&crid=%%crid%%&cid=%%cid%%&context={$context}",
64 CRM_Core_Action
::DISABLE
=> [
65 'name' => ts('Cancel'),
66 'title' => ts('Cancel'),
67 'ref' => 'crm-enable-disable',
72 $paymentProcessorObj = CRM_Contribute_BAO_ContributionRecur
::getPaymentProcessorObject($recurID);
73 if ($paymentProcessorObj) {
74 if ($paymentProcessorObj->supports('cancelRecurring')) {
75 unset($links[CRM_Core_Action
::DISABLE
]['extra'], $links[CRM_Core_Action
::DISABLE
]['ref']);
76 $links[CRM_Core_Action
::DISABLE
]['url'] = "civicrm/contribute/unsubscribe";
77 $links[CRM_Core_Action
::DISABLE
]['qs'] = "reset=1&crid=%%crid%%&cid=%%cid%%&context={$context}";
80 if ($paymentProcessorObj->supports('UpdateSubscriptionBillingInfo')) {
81 $links[CRM_Core_Action
::RENEW
] = [
82 'name' => ts('Change Billing Details'),
83 'title' => ts('Change Billing Details'),
84 'url' => 'civicrm/contribute/updatebilling',
85 'qs' => "reset=1&crid=%%crid%%&cid=%%cid%%&context={$context}",
89 if (!$paymentProcessorObj->supports('ChangeSubscriptionAmount') && !$paymentProcessorObj->supports('EditRecurringContribution')) {
90 unset($links[CRM_Core_Action
::UPDATE
]);
94 unset($links[CRM_Core_Action
::DISABLE
]);
95 unset($links[CRM_Core_Action
::UPDATE
]);
103 * called when action is browse.
106 public function browse() {
107 // add annual contribution
109 list($annual['count'],
112 ) = CRM_Contribute_BAO_Contribution
::annual($this->_contactId
);
113 $this->assign('annual', $annual);
115 $controller = new CRM_Core_Controller_Simple(
116 'CRM_Contribute_Form_Search',
121 $controller->setEmbedded(TRUE);
122 $controller->reset();
123 $controller->set('cid', $this->_contactId
);
124 $controller->set('crid', $this->_crid
);
125 $controller->set('context', 'contribution');
126 $controller->set('limit', 50);
127 $controller->process();
130 // add recurring block
131 $this->addRecurringContributionsBlock();
133 // enable/disable soft credit records for test contribution
135 if (CRM_Utils_Request
::retrieve('isTest', 'Positive', $this)) {
138 $this->assign('isTest', $isTest);
140 $softCreditList = CRM_Contribute_BAO_ContributionSoft
::getSoftContributionList($this->_contactId
, NULL, $isTest);
142 if (!empty($softCreditList)) {
143 $softCreditTotals = [];
145 list($softCreditTotals['count'],
146 $softCreditTotals['cancel']['count'],
147 $softCreditTotals['amount'],
148 $softCreditTotals['avg'],
149 // to get cancel amount
150 $softCreditTotals['cancel']['amount']
151 ) = CRM_Contribute_BAO_ContributionSoft
::getSoftContributionTotals($this->_contactId
, $isTest);
153 $this->assign('softCredit', TRUE);
154 $this->assign('softCreditRows', $softCreditList);
155 $this->assign('softCreditTotals', $softCreditTotals);
158 if ($this->_contactId
) {
159 $displayName = CRM_Contact_BAO_Contact
::displayName($this->_contactId
);
160 $this->assign('displayName', $displayName);
161 $tabCount = CRM_Contact_BAO_Contact
::getCountComponent('contribution', $this->_contactId
);
162 $this->assign('tabCount', $tabCount);
163 $this->ajaxResponse
['tabCount'] = $tabCount;
168 * Get all the recurring contribution information and assign to the template
170 private function addRecurringContributionsBlock() {
171 list($activeContributions, $activeContributionsCount) = $this->getActiveRecurringContributions();
172 list($inactiveRecurringContributions, $inactiveContributionsCount) = $this->getInactiveRecurringContributions();
174 if (!empty($activeContributions) ||
!empty($inactiveRecurringContributions)) {
175 // assign vars to templates
176 $this->assign('action', $this->_action
);
177 $this->assign('activeRecurRows', $activeContributions);
178 $this->assign('contributionRecurCount', $activeContributionsCount +
$inactiveContributionsCount);
179 $this->assign('inactiveRecurRows', $inactiveRecurringContributions);
180 $this->assign('recur', TRUE);
185 * Loads active recurring contributions for the current contact and formats
186 * them to be used on the form.
190 private function getActiveRecurringContributions() {
192 $contributionRecurResult = civicrm_api3('ContributionRecur', 'get', [
193 'contact_id' => $this->_contactId
,
194 'contribution_status_id' => ['NOT IN' => CRM_Contribute_BAO_ContributionRecur
::getInactiveStatuses()],
195 'options' => ['limit' => 0, 'sort' => 'is_test, start_date DESC'],
197 $recurContributions = $contributionRecurResult['values'] ??
NULL;
199 catch (Exception
$e) {
200 $recurContributions = [];
203 return $this->buildRecurringContributionsArray($recurContributions);
207 * Loads inactive recurring contributions for the current contact and formats
208 * them to be used on the form.
212 private function getInactiveRecurringContributions() {
214 $contributionRecurResult = civicrm_api3('ContributionRecur', 'get', [
215 'contact_id' => $this->_contactId
,
216 'contribution_status_id' => ['IN' => CRM_Contribute_BAO_ContributionRecur
::getInactiveStatuses()],
217 'options' => ['limit' => 0, 'sort' => 'is_test, start_date DESC'],
219 $recurContributions = $contributionRecurResult['values'] ??
NULL;
221 catch (Exception
$e) {
222 $recurContributions = NULL;
225 return $this->buildRecurringContributionsArray($recurContributions);
229 * @param $recurContributions
233 private function buildRecurringContributionsArray($recurContributions) {
234 $liveRecurringContributionCount = 0;
235 foreach ($recurContributions as $recurId => $recurDetail) {
236 // Is recurring contribution active?
237 $recurContributions[$recurId]['is_active'] = !in_array(CRM_Contribute_PseudoConstant
::contributionStatus($recurDetail['contribution_status_id'], 'name'), CRM_Contribute_BAO_ContributionRecur
::getInactiveStatuses());
238 if ($recurContributions[$recurId]['is_active']) {
239 $actionMask = array_sum(array_keys(self
::recurLinks($recurId)));
242 $actionMask = CRM_Core_Action
::mask([CRM_Core_Permission
::VIEW
]);
245 if (empty($recurDetail['is_test'])) {
246 $liveRecurringContributionCount++
;
249 // Get the name of the payment processor
250 if (!empty($recurDetail['payment_processor_id'])) {
251 $recurContributions[$recurId]['payment_processor'] = CRM_Financial_BAO_PaymentProcessor
::getPaymentProcessorName($recurDetail['payment_processor_id']);
253 // Get the label for the contribution status
254 if (!empty($recurDetail['contribution_status_id'])) {
255 $recurContributions[$recurId]['contribution_status'] = CRM_Core_PseudoConstant
::getLabel('CRM_Contribute_BAO_ContributionRecur', 'contribution_status_id', $recurDetail['contribution_status_id']);
258 $recurContributions[$recurId]['action'] = CRM_Core_Action
::formLink(self
::recurLinks($recurId), $actionMask,
260 'cid' => $this->_contactId
,
262 'cxt' => 'contribution',
266 'contribution.selector.recurring',
272 return [$recurContributions, $liveRecurringContributionCount];
276 * called when action is view.
280 public function view() {
281 $controller = new CRM_Core_Controller_Simple(
282 'CRM_Contribute_Form_ContributionView',
283 ts('View Contribution'),
286 $controller->setEmbedded(TRUE);
287 $controller->set('id', $this->_id
);
288 $controller->set('cid', $this->_contactId
);
290 return $controller->run();
294 * called when action is update or new.
297 * @throws \CRM_Core_Exception
300 public function edit() {
301 // set https for offline cc transaction
302 $mode = CRM_Utils_Request
::retrieve('mode', 'Alphanumeric', $this);
303 if ($mode == 'test' ||
$mode == 'live') {
304 CRM_Utils_System
::redirectToSSL();
307 $controller = new CRM_Core_Controller_Simple(
308 'CRM_Contribute_Form_Contribution',
309 'Create Contribution',
312 $controller->setEmbedded(TRUE);
313 $controller->set('id', $this->_id
);
314 $controller->set('cid', $this->_contactId
);
316 return $controller->run();
320 * @throws \CRM_Core_Exception
321 * @throws \CiviCRM_API3_Exception
323 public function preProcess() {
324 $context = CRM_Utils_Request
::retrieve('context', 'Alphanumeric', $this);
325 $this->_action
= CRM_Utils_Request
::retrieve('action', 'String', $this, FALSE, 'browse');
326 $this->_id
= CRM_Utils_Request
::retrieve('id', 'Positive', $this);
328 if ($context == 'standalone') {
329 $this->_action
= CRM_Core_Action
::ADD
;
332 $this->_contactId
= CRM_Utils_Request
::retrieve('cid', 'Positive', $this, empty($this->_id
));
333 if (empty($this->_contactId
)) {
334 $this->_contactId
= civicrm_api3('contribution', 'getvalue', [
336 'return' => 'contact_id',
339 $this->assign('contactId', $this->_contactId
);
341 // check logged in url permission
342 CRM_Contact_Page_View
::checkUserPermission($this);
344 $this->assign('action', $this->_action
);
346 if ($this->_permission
== CRM_Core_Permission
::EDIT
&& !CRM_Core_Permission
::check('edit contributions')) {
347 // demote to view since user does not have edit contrib rights
348 $this->_permission
= CRM_Core_Permission
::VIEW
;
349 $this->assign('permission', 'view');
354 * the main function that is called when the page
355 * loads, it decides the which action has to be taken for the page.
357 * @throws \CRM_Core_Exception
358 * @throws \CiviCRM_API3_Exception
360 public function run() {
363 // check if we can process credit card contribs
364 $this->assign('newCredit', CRM_Core_Config
::isEnabledBackOfficeCreditCardPayments());
368 if ($this->_action
& CRM_Core_Action
::VIEW
) {
371 elseif ($this->_action
& (CRM_Core_Action
::UPDATE | CRM_Core_Action
::ADD | CRM_Core_Action
::DELETE
)) {
382 * @throws \CRM_Core_Exception
384 public function setContext() {
385 $qfKey = CRM_Utils_Request
::retrieve('key', 'String', $this);
386 $context = CRM_Utils_Request
::retrieve('context', 'Alphanumeric',
387 $this, FALSE, 'search'
389 $compContext = CRM_Utils_Request
::retrieve('compContext', 'String', $this);
391 $searchContext = CRM_Utils_Request
::retrieve('searchContext', 'String', $this);
394 if ($context == 'search' && $compContext) {
395 $context = $compContext;
401 // make sure we dont get tricked with a bad key
403 if (!CRM_Core_Key
::valid($qfKey)) {
409 $url = CRM_Utils_System
::url('civicrm/user', 'reset=1');
413 $url = CRM_Utils_System
::url('civicrm/contribute',
418 case 'pledgeDashboard':
419 $url = CRM_Utils_System
::url('civicrm/pledge',
425 $url = CRM_Utils_System
::url('civicrm/contact/view',
426 "reset=1&force=1&cid={$this->_contactId}&selectedChild=contribute"
432 $extraParams = "force=1";
434 $extraParams .= "&qfKey=$qfKey";
437 $this->assign('searchKey', $qfKey);
438 if ($context == 'advanced') {
439 $url = CRM_Utils_System
::url('civicrm/contact/search/advanced', $extraParams);
441 elseif ($searchContext) {
442 $url = CRM_Utils_System
::url("civicrm/$searchContext/search", $extraParams);
445 $url = CRM_Utils_System
::url('civicrm/contribute/search', $extraParams);
450 $url = CRM_Utils_System
::url('civicrm/dashboard', 'reset=1');
454 $url = CRM_Utils_System
::url('civicrm/contact/view',
455 "reset=1&force=1&cid={$this->_contactId}&selectedChild=activity"
461 $componentId = CRM_Utils_Request
::retrieve('compId', 'Positive', $this);
462 $componentAction = CRM_Utils_Request
::retrieve('compAction', 'Integer', $this);
464 $context = 'membership';
469 $searchKey = "&key=$qfKey";
471 $compContext = "&compContext={$compContext}";
473 if ($componentAction & CRM_Core_Action
::VIEW
) {
479 $url = CRM_Utils_System
::url('civicrm/contact/view/membership',
480 "reset=1&action={$action}&id={$componentId}&cid={$this->_contactId}&context={$context}&selectedChild=member{$searchKey}{$compContext}"
485 $componentId = CRM_Utils_Request
::retrieve('compId', 'Positive', $this);
486 $componentAction = CRM_Utils_Request
::retrieve('compAction', 'Integer', $this);
488 $context = 'participant';
493 $searchKey = "&key=$qfKey";
495 $compContext = "&compContext={$compContext}";
497 if ($componentAction == CRM_Core_Action
::VIEW
) {
503 $url = CRM_Utils_System
::url('civicrm/contact/view/participant',
504 "reset=1&action={$action}&id={$componentId}&cid={$this->_contactId}&context={$context}&selectedChild=event{$searchKey}{$compContext}"
509 $url = CRM_Utils_System
::url('civicrm/contact/view',
510 "reset=1&force=1&cid={$this->_contactId}&selectedChild=pledge"
515 $url = CRM_Utils_System
::url('civicrm/dashboard', 'reset=1');
520 $urlParams = 'force=1';
521 $urlString = 'civicrm/contact/search/custom';
522 if ($this->_action
== CRM_Core_Action
::UPDATE
) {
523 if ($this->_contactId
) {
524 $urlParams .= '&cid=' . $this->_contactId
;
527 $urlParams .= '&context=fulltext&action=view';
528 $urlString = 'civicrm/contact/view/contribution';
531 $urlParams .= "$keyName=$qfKey";
533 $this->assign('searchKey', $qfKey);
534 $url = CRM_Utils_System
::url($urlString, $urlParams);
539 if ($this->_contactId
) {
540 $cid = '&cid=' . $this->_contactId
;
542 $url = CRM_Utils_System
::url('civicrm/contribute/search',
543 'reset=1&force=1' . $cid
548 $session = CRM_Core_Session
::singleton();
549 $session->pushUserContext($url);