3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2018
33 class CRM_Contribute_Page_Tab
extends CRM_Core_Page
{
36 * The action links that we need to display for the browse screen.
40 static $_links = NULL;
41 static $_recurLinks = NULL;
42 public $_permission = NULL;
43 public $_contactId = NULL;
47 * This method returns the links that are given for recur search row.
48 * currently the links added for each row are:
53 * @param bool $recurID
54 * @param string $context
58 public static function &recurLinks($recurID = FALSE, $context = 'contribution') {
59 if (!(self
::$_links)) {
60 self
::$_links = array(
61 CRM_Core_Action
::VIEW
=> array(
63 'title' => ts('View Recurring Payment'),
64 'url' => 'civicrm/contact/view/contributionrecur',
65 'qs' => "reset=1&id=%%crid%%&cid=%%cid%%&context={$context}",
67 CRM_Core_Action
::UPDATE
=> array(
69 'title' => ts('Edit Recurring Payment'),
70 'url' => 'civicrm/contribute/updaterecur',
71 'qs' => "reset=1&action=update&crid=%%crid%%&cid=%%cid%%&context={$context}",
73 CRM_Core_Action
::DISABLE
=> array(
74 'name' => ts('Cancel'),
75 'title' => ts('Cancel'),
76 'ref' => 'crm-enable-disable',
82 $links = self
::$_links;
83 $paymentProcessorObj = CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($recurID, 'recur', 'obj');
84 if (!is_object($paymentProcessorObj)) {
85 unset($links[CRM_Core_Action
::DISABLE
]);
86 unset($links[CRM_Core_Action
::UPDATE
]);
89 if ($paymentProcessorObj->supports('cancelRecurring')) {
90 unset($links[CRM_Core_Action
::DISABLE
]['extra'], $links[CRM_Core_Action
::DISABLE
]['ref']);
91 $links[CRM_Core_Action
::DISABLE
]['url'] = "civicrm/contribute/unsubscribe";
92 $links[CRM_Core_Action
::DISABLE
]['qs'] = "reset=1&crid=%%crid%%&cid=%%cid%%&context={$context}";
95 if ($paymentProcessorObj->supports('UpdateSubscriptionBillingInfo')) {
96 $links[CRM_Core_Action
::RENEW
] = array(
97 'name' => ts('Change Billing Details'),
98 'title' => ts('Change Billing Details'),
99 'url' => 'civicrm/contribute/updatebilling',
100 'qs' => "reset=1&crid=%%crid%%&cid=%%cid%%&context={$context}",
104 if (!$paymentProcessorObj->supports('ChangeSubscriptionAmount') && !$paymentProcessorObj->supports('EditRecurringContribution')) {
105 unset($links[CRM_Core_Action
::UPDATE
]);
110 return self
::$_links;
114 * called when action is browse.
117 public function browse() {
118 // add annual contribution
120 list($annual['count'],
123 ) = CRM_Contribute_BAO_Contribution
::annual($this->_contactId
);
124 $this->assign('annual', $annual);
126 $controller = new CRM_Core_Controller_Simple(
127 'CRM_Contribute_Form_Search',
132 $controller->setEmbedded(TRUE);
133 $controller->reset();
134 $controller->set('cid', $this->_contactId
);
135 $controller->set('crid', $this->_crid
);
136 $controller->set('context', 'contribution');
137 $controller->set('limit', 50);
138 $controller->process();
141 // add recurring block
142 $this->addRecurringContributionsBlock();
144 // enable/disable soft credit records for test contribution
146 if (CRM_Utils_Request
::retrieve('isTest', 'Positive', $this)) {
149 $this->assign('isTest', $isTest);
151 $softCreditList = CRM_Contribute_BAO_ContributionSoft
::getSoftContributionList($this->_contactId
, NULL, $isTest);
153 if (!empty($softCreditList)) {
154 $softCreditTotals = array();
156 list($softCreditTotals['amount'],
157 $softCreditTotals['avg'],
158 $softCreditTotals['currency'],
159 $softCreditTotals['cancelAmount'] // to get cancel amount
160 ) = CRM_Contribute_BAO_ContributionSoft
::getSoftContributionTotals($this->_contactId
, $isTest);
162 $this->assign('softCredit', TRUE);
163 $this->assign('softCreditRows', $softCreditList);
164 $this->assign('softCreditTotals', $softCreditTotals);
167 if ($this->_contactId
) {
168 $displayName = CRM_Contact_BAO_Contact
::displayName($this->_contactId
);
169 $this->assign('displayName', $displayName);
170 $tabCount = CRM_Contact_BAO_Contact
::getCountComponent('contribution', $this->_contactId
);
171 $this->assign('tabCount', $tabCount);
172 $this->ajaxResponse
['tabCount'] = $tabCount;
177 * Get all the recurring contribution information and assign to the template
179 private function addRecurringContributionsBlock() {
180 list($activeContributions, $activeContributionsCount) = $this->getActiveRecurringContributions();
181 list($inactiveRecurringContributions, $inactiveContributionsCount) = $this->getInactiveRecurringContributions();
183 if (!empty($activeContributions) ||
!empty($inactiveRecurringContributions)) {
184 // assign vars to templates
185 $this->assign('action', $this->_action
);
186 $this->assign('activeRecurRows', $activeContributions);
187 $this->assign('contributionRecurCount', $activeContributionsCount +
$inactiveContributionsCount);
188 $this->assign('inactiveRecurRows', $inactiveRecurringContributions);
189 $this->assign('recur', TRUE);
194 * Loads active recurring contributions for the current contact and formats
195 * them to be used on the form.
199 private function getActiveRecurringContributions() {
201 $contributionRecurResult = civicrm_api3('ContributionRecur', 'get', array(
202 'contact_id' => $this->_contactId
,
203 'contribution_status_id' => array('NOT IN' => CRM_Contribute_BAO_ContributionRecur
::getInactiveStatuses()),
204 'options' => ['limit' => 0, 'sort' => 'is_test, start_date DESC'],
206 $recurContributions = CRM_Utils_Array
::value('values', $contributionRecurResult);
208 catch (Exception
$e) {
209 $recurContributions = array();
212 return $this->buildRecurringContributionsArray($recurContributions);
216 * Loads inactive recurring contributions for the current contact and formats
217 * them to be used on the form.
221 private function getInactiveRecurringContributions() {
223 $contributionRecurResult = civicrm_api3('ContributionRecur', 'get', array(
224 'contact_id' => $this->_contactId
,
225 'contribution_status_id' => array('IN' => CRM_Contribute_BAO_ContributionRecur
::getInactiveStatuses()),
226 'options' => ['limit' => 0, 'sort' => 'is_test, start_date DESC'],
228 $recurContributions = CRM_Utils_Array
::value('values', $contributionRecurResult);
230 catch (Exception
$e) {
231 $recurContributions = NULL;
234 return $this->buildRecurringContributionsArray($recurContributions);
238 * @param $recurContributions
242 private function buildRecurringContributionsArray($recurContributions) {
243 $liveRecurringContributionCount = 0;
244 foreach ($recurContributions as $recurId => $recurDetail) {
245 $action = array_sum(array_keys($this->recurLinks($recurId)));
246 // no action allowed if it's not active
247 $recurContributions[$recurId]['is_active'] = (!CRM_Contribute_BAO_Contribution
::isContributionStatusNegative($recurDetail['contribution_status_id']));
249 if (empty($recurDetail['is_test'])) {
250 $liveRecurringContributionCount++
;
253 // Get the name of the payment processor
254 if (!empty($recurDetail['payment_processor_id'])) {
255 $recurContributions[$recurId]['payment_processor'] = CRM_Financial_BAO_PaymentProcessor
::getPaymentProcessorName($recurDetail['payment_processor_id']);
257 // Get the label for the contribution status
258 if (!empty($recurDetail['contribution_status_id'])) {
259 $recurContributions[$recurId]['contribution_status'] = CRM_Core_PseudoConstant
::getLabel('CRM_Contribute_BAO_ContributionRecur', 'contribution_status_id', $recurDetail['contribution_status_id']);
262 if ($recurContributions[$recurId]['is_active']) {
263 $recurContributions[$recurId]['action'] = CRM_Core_Action
::formLink(self
::recurLinks($recurId), $action,
265 'cid' => $this->_contactId
,
267 'cxt' => 'contribution',
271 'contribution.selector.recurring',
278 return [$recurContributions, $liveRecurringContributionCount];
282 * called when action is view.
286 public function view() {
287 $controller = new CRM_Core_Controller_Simple(
288 'CRM_Contribute_Form_ContributionView',
289 ts('View Contribution'),
292 $controller->setEmbedded(TRUE);
293 $controller->set('id', $this->_id
);
294 $controller->set('cid', $this->_contactId
);
296 return $controller->run();
300 * called when action is update or new.
303 * @throws \CRM_Core_Exception
306 public function edit() {
307 // set https for offline cc transaction
308 $mode = CRM_Utils_Request
::retrieve('mode', 'Alphanumeric', $this);
309 if ($mode == 'test' ||
$mode == 'live') {
310 CRM_Utils_System
::redirectToSSL();
313 $controller = new CRM_Core_Controller_Simple(
314 'CRM_Contribute_Form_Contribution',
315 'Create Contribution',
318 $controller->setEmbedded(TRUE);
319 $controller->set('id', $this->_id
);
320 $controller->set('cid', $this->_contactId
);
322 return $controller->run();
325 public function preProcess() {
326 $context = CRM_Utils_Request
::retrieve('context', 'Alphanumeric', $this);
327 $this->_action
= CRM_Utils_Request
::retrieve('action', 'String', $this, FALSE, 'browse');
328 $this->_id
= CRM_Utils_Request
::retrieve('id', 'Positive', $this);
330 if ($context == 'standalone') {
331 $this->_action
= CRM_Core_Action
::ADD
;
334 $this->_contactId
= CRM_Utils_Request
::retrieve('cid', 'Positive', $this, empty($this->_id
));
335 if (empty($this->_contactId
)) {
336 $this->_contactId
= civicrm_api3('contribution', 'getvalue', array(
338 'return' => 'contact_id',
341 $this->assign('contactId', $this->_contactId
);
343 // check logged in url permission
344 CRM_Contact_Page_View
::checkUserPermission($this);
346 $this->assign('action', $this->_action
);
348 if ($this->_permission
== CRM_Core_Permission
::EDIT
&& !CRM_Core_Permission
::check('edit contributions')) {
349 // demote to view since user does not have edit contrib rights
350 $this->_permission
= CRM_Core_Permission
::VIEW
;
351 $this->assign('permission', 'view');
356 * the main function that is called when the page
357 * loads, it decides the which action has to be taken for the page.
361 public function run() {
364 // check if we can process credit card contribs
365 $this->assign('newCredit', CRM_Core_Config
::isEnabledBackOfficeCreditCardPayments());
369 if ($this->_action
& CRM_Core_Action
::VIEW
) {
372 elseif ($this->_action
& (CRM_Core_Action
::UPDATE | CRM_Core_Action
::ADD | CRM_Core_Action
::DELETE
)) {
379 return parent
::run();
382 public function setContext() {
383 $qfKey = CRM_Utils_Request
::retrieve('key', 'String', $this);
384 $context = CRM_Utils_Request
::retrieve('context', 'Alphanumeric',
385 $this, FALSE, 'search'
387 $compContext = CRM_Utils_Request
::retrieve('compContext', 'String', $this);
389 $searchContext = CRM_Utils_Request
::retrieve('searchContext', 'String', $this);
392 if ($context == 'search' && $compContext) {
393 $context = $compContext;
399 // make sure we dont get tricked with a bad key
401 if (!CRM_Core_Key
::valid($qfKey)) {
407 $url = CRM_Utils_System
::url('civicrm/user', 'reset=1');
411 $url = CRM_Utils_System
::url('civicrm/contribute',
416 case 'pledgeDashboard':
417 $url = CRM_Utils_System
::url('civicrm/pledge',
423 $url = CRM_Utils_System
::url('civicrm/contact/view',
424 "reset=1&force=1&cid={$this->_contactId}&selectedChild=contribute"
430 $extraParams = "force=1";
432 $extraParams .= "&qfKey=$qfKey";
435 $this->assign('searchKey', $qfKey);
436 if ($context == 'advanced') {
437 $url = CRM_Utils_System
::url('civicrm/contact/search/advanced', $extraParams);
439 elseif ($searchContext) {
440 $url = CRM_Utils_System
::url("civicrm/$searchContext/search", $extraParams);
443 $url = CRM_Utils_System
::url('civicrm/contribute/search', $extraParams);
448 $url = CRM_Utils_System
::url('civicrm/dashboard', 'reset=1');
452 $url = CRM_Utils_System
::url('civicrm/contact/view',
453 "reset=1&force=1&cid={$this->_contactId}&selectedChild=activity"
459 $componentId = CRM_Utils_Request
::retrieve('compId', 'Positive', $this);
460 $componentAction = CRM_Utils_Request
::retrieve('compAction', 'Integer', $this);
462 $context = 'membership';
467 $searchKey = "&key=$qfKey";
469 $compContext = "&compContext={$compContext}";
471 if ($componentAction & CRM_Core_Action
::VIEW
) {
477 $url = CRM_Utils_System
::url('civicrm/contact/view/membership',
478 "reset=1&action={$action}&id={$componentId}&cid={$this->_contactId}&context={$context}&selectedChild=member{$searchKey}{$compContext}"
483 $componentId = CRM_Utils_Request
::retrieve('compId', 'Positive', $this);
484 $componentAction = CRM_Utils_Request
::retrieve('compAction', 'Integer', $this);
486 $context = 'participant';
491 $searchKey = "&key=$qfKey";
493 $compContext = "&compContext={$compContext}";
495 if ($componentAction == CRM_Core_Action
::VIEW
) {
501 $url = CRM_Utils_System
::url('civicrm/contact/view/participant',
502 "reset=1&action={$action}&id={$componentId}&cid={$this->_contactId}&context={$context}&selectedChild=event{$searchKey}{$compContext}"
507 $url = CRM_Utils_System
::url('civicrm/contact/view',
508 "reset=1&force=1&cid={$this->_contactId}&selectedChild=pledge"
513 $url = CRM_Utils_System
::url('civicrm/dashboard', 'reset=1');
518 $urlParams = 'force=1';
519 $urlString = 'civicrm/contact/search/custom';
520 if ($this->_action
== CRM_Core_Action
::UPDATE
) {
521 if ($this->_contactId
) {
522 $urlParams .= '&cid=' . $this->_contactId
;
525 $urlParams .= '&context=fulltext&action=view';
526 $urlString = 'civicrm/contact/view/contribution';
529 $urlParams .= "$keyName=$qfKey";
531 $this->assign('searchKey', $qfKey);
532 $url = CRM_Utils_System
::url($urlString, $urlParams);
537 if ($this->_contactId
) {
538 $cid = '&cid=' . $this->_contactId
;
540 $url = CRM_Utils_System
::url('civicrm/contribute/search',
541 'reset=1&force=1' . $cid
546 $session = CRM_Core_Session
::singleton();
547 $session->pushUserContext($url);