3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.3 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
35 class CRM_Contribute_Page_Tab
extends CRM_Core_Page
{
38 * The action links that we need to display for the browse screen
43 static $_links = NULL;
44 static $_honorLinks = NULL;
45 static $_recurLinks = NULL;
46 public $_permission = NULL;
47 public $_contactId = NULL;
51 * This method returns the links that are given for honor search row.
52 * currently the links added for each row are
61 static function &honorLinks() {
62 if (!(self
::$_honorLinks)) {
63 self
::$_honorLinks = array(
64 CRM_Core_Action
::VIEW
=> array(
66 'url' => 'civicrm/contact/view/contribution',
67 'qs' => 'reset=1&id=%%id%%&cid=%%cid%%&honorId=%%honorId%%&action=view&context=%%cxt%%&selectedChild=contribute',
68 'title' => ts('View Contribution'),
70 CRM_Core_Action
::UPDATE
=> array(
72 'url' => 'civicrm/contact/view/contribution',
73 'qs' => 'reset=1&action=update&id=%%id%%&cid=%%cid%%&honorId=%%honorId%%&context=%%cxt%%&subType=%%contributionType%%',
74 'title' => ts('Edit Contribution'),
76 CRM_Core_Action
::DELETE
=> array(
77 'name' => ts('Delete'),
78 'url' => 'civicrm/contact/view/contribution',
79 'qs' => 'reset=1&action=delete&id=%%id%%&cid=%%cid%%&honorId=%%honorId%%&context=%%cxt%%',
80 'title' => ts('Delete Contribution'),
84 return self
::$_honorLinks;
89 * This method returns the links that are given for recur search row.
90 * currently the links added for each row are:
99 static function &recurLinks($recurID = FALSE, $context = 'contribution') {
100 if (!(self
::$_links)) {
101 self
::$_links = array(
102 CRM_Core_Action
::VIEW
=> array(
103 'name' => ts('View'),
104 'title' => ts('View Recurring Payment'),
105 'url' => 'civicrm/contact/view/contributionrecur',
106 'qs' => "reset=1&id=%%crid%%&cid=%%cid%%&context={$context}",
108 CRM_Core_Action
::UPDATE
=> array(
109 'name' => ts('Edit'),
110 'title' => ts('Edit Recurring Payment'),
111 'url' => 'civicrm/contribute/updaterecur',
112 'qs' => "reset=1&action=update&crid=%%crid%%&cid=%%cid%%&context={$context}",
114 CRM_Core_Action
::DISABLE
=> array(
115 'name' => ts('Cancel'),
116 'title' => ts('Cancel'),
117 'extra' => 'onclick = "enableDisable( %%crid%%,\'' . 'CRM_Contribute_BAO_ContributionRecur' . '\',\'' . 'enable-disable' . '\' );"',
118 'ref' => 'disable-action',
124 $paymentProcessorObj = CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($recurID, 'recur', 'obj');
125 if (is_object( $paymentProcessorObj) && $paymentProcessorObj->isSupported('cancelSubscription')) {
126 unset(self
::$_links[CRM_Core_Action
::DISABLE
]['extra'], self
::$_links[CRM_Core_Action
::DISABLE
]['ref']);
127 self
::$_links[CRM_Core_Action
::DISABLE
]['url'] = "civicrm/contribute/unsubscribe";
128 self
::$_links[CRM_Core_Action
::DISABLE
]['qs'] = "reset=1&crid=%%crid%%&cid=%%cid%%&context={$context}";
130 if (is_object( $paymentProcessorObj) && $paymentProcessorObj->isSupported('updateSubscriptionBillingInfo')) {
131 self
::$_links[CRM_Core_Action
::RENEW
] = array('name' => ts('Change Billing Details'),
132 'title' => ts('Change Billing Details'),
133 'url' => 'civicrm/contribute/updatebilling',
134 'qs' => "reset=1&crid=%%crid%%&cid=%%cid%%&context={$context}",
139 return self
::$_links;
144 * This function is called when action is browse
151 // add annual contribution
153 list($annual['count'],
156 ) = CRM_Contribute_BAO_Contribution
::annual($this->_contactId
);
157 $this->assign('annual', $annual);
159 $controller = new CRM_Core_Controller_Simple(
160 'CRM_Contribute_Form_Search',
165 $controller->setEmbedded(TRUE);
166 $controller->reset();
167 $controller->set('cid', $this->_contactId
);
168 $controller->set('crid', $this->_crid
);
169 $controller->set('context', 'contribution');
170 $controller->process();
173 // add recurring block
174 $action = array_sum(array_keys($this->recurLinks()));
175 $params = CRM_Contribute_BAO_ContributionRecur
::getRecurContributions($this->_contactId
);
177 if (!empty($params)) {
178 foreach ($params as $ids => $recur) {
179 $action = array_sum(array_keys($this->recurLinks($ids)));
180 // no action allowed if it's not active
181 $params[$ids]['is_active'] = ($recur['contribution_status_id'] != 3);
183 if ($params[$ids]['is_active']) {
184 $details = CRM_Contribute_BAO_ContributionRecur
::getSubscriptionDetails($params[$ids]['id'], 'recur');
185 $hideUpdate = $details->membership_id
& $details->auto_renew
;
188 $action -= CRM_Core_Action
::UPDATE
;
191 $params[$ids]['action'] = CRM_Core_Action
::formLink(self
::recurLinks($ids), $action,
193 'cid' => $this->_contactId
,
195 'cxt' => 'contribution',
200 // assign vars to templates
201 $this->assign('action', $this->_action
);
202 $this->assign('recurRows', $params);
203 $this->assign('recur', TRUE);
207 // form all action links
208 $action = array_sum(array_keys($this->honorLinks()));
211 $params = CRM_Contribute_BAO_Contribution
::getHonorContacts($this->_contactId
);
212 if (!empty($params)) {
213 foreach ($params as $ids => $honorId) {
214 $params[$ids]['action'] = CRM_Core_Action
::formLink(
218 'cid' => $honorId['honorId'],
220 'cxt' => 'contribution',
221 'contributionType' => $honorId['type_id'],
222 'honorId' => $this->_contactId
,
227 // assign vars to templates
228 $this->assign('action', $this->_action
);
229 $this->assign('honorRows', $params);
230 $this->assign('honor', TRUE);
233 //enable/disable soft credit records for test contribution
235 if (CRM_Utils_Request
::retrieve('isTest', 'Positive', $this)) {
238 $this->assign('isTest', $isTest);
240 $softCreditList = CRM_Contribute_BAO_ContributionSoft
::getSoftContributionList($this->_contactId
, $isTest);
242 if (!empty($softCreditList)) {
243 $softCreditTotals = array();
245 list($softCreditTotals['amount'],
246 $softCreditTotals['avg'],
247 $softCreditTotals['currency']
248 ) = CRM_Contribute_BAO_ContributionSoft
::getSoftContributionTotals($this->_contactId
, $isTest);
250 $this->assign('softCredit', TRUE);
251 $this->assign('softCreditRows', $softCreditList);
252 $this->assign('softCreditTotals', $softCreditTotals);
255 if ($this->_contactId
) {
256 $displayName = CRM_Contact_BAO_Contact
::displayName($this->_contactId
);
257 $this->assign('displayName', $displayName);
262 * This function is called when action is view
268 $controller = new CRM_Core_Controller_Simple(
269 'CRM_Contribute_Form_ContributionView',
270 ts('View Contribution'),
273 $controller->setEmbedded(TRUE);
274 $controller->set('id', $this->_id
);
275 $controller->set('cid', $this->_contactId
);
277 return $controller->run();
281 * This function is called when action is update or new
287 // set https for offline cc transaction
288 $mode = CRM_Utils_Request
::retrieve('mode', 'String', $this);
289 if ($mode == 'test' ||
$mode == 'live') {
290 CRM_Utils_System
::redirectToSSL();
293 $controller = new CRM_Core_Controller_Simple(
294 'CRM_Contribute_Form_Contribution',
295 'Create Contribution',
298 $controller->setEmbedded(TRUE);
299 $controller->set('id', $this->_id
);
300 $controller->set('cid', $this->_contactId
);
302 return $controller->run();
305 function preProcess() {
306 $context = CRM_Utils_Request
::retrieve('context', 'String', $this);
307 $this->_action
= CRM_Utils_Request
::retrieve('action', 'String', $this, FALSE, 'browse');
308 $this->_id
= CRM_Utils_Request
::retrieve('id', 'Positive', $this);
310 if ($context == 'standalone') {
311 $this->_action
= CRM_Core_Action
::ADD
;
314 $this->_contactId
= CRM_Utils_Request
::retrieve('cid', 'Positive', $this, TRUE);
315 $this->assign('contactId', $this->_contactId
);
317 // check logged in url permission
318 CRM_Contact_Page_View
::checkUserPermission($this);
321 CRM_Contact_Page_View
::setTitle($this->_contactId
);
323 $this->assign('action', $this->_action
);
325 if ($this->_permission
== CRM_Core_Permission
::EDIT
&& !CRM_Core_Permission
::check('edit contributions')) {
326 // demote to view since user does not have edit contrib rights
327 $this->_permission
= CRM_Core_Permission
::VIEW
;
328 $this->assign('permission', 'view');
333 * This function is the main function that is called when the page
334 * loads, it decides the which action has to be taken for the page.
342 // check if we can process credit card contribs
343 CRM_Core_Payment
::allowBackofficeCreditCard($this);
347 if ($this->_action
& CRM_Core_Action
::VIEW
) {
350 elseif ($this->_action
& (CRM_Core_Action
::UPDATE | CRM_Core_Action
::ADD | CRM_Core_Action
::DELETE
)) {
357 return parent
::run();
360 function setContext() {
361 $qfKey = CRM_Utils_Request
::retrieve('key', 'String', $this);
362 $context = CRM_Utils_Request
::retrieve('context', 'String',
363 $this, FALSE, 'search'
365 $compContext = CRM_Utils_Request
::retrieve('compContext', 'String', $this);
368 if ($context == 'search' && $compContext) {
369 $context = $compContext;
375 // make sure we dont get tricked with a bad key
377 if (!CRM_Core_Key
::valid($qfKey)) {
381 $session = CRM_Core_Session
::singleton();
385 $url = CRM_Utils_System
::url('civicrm/user', 'reset=1');
389 $url = CRM_Utils_System
::url('civicrm/contribute',
394 case 'pledgeDashboard':
395 $url = CRM_Utils_System
::url('civicrm/pledge',
401 $honorId = CRM_Utils_Request
::retrieve('honorId', 'Positive', $this, FALSE);
407 $cid = $this->_contactId
;
410 $url = CRM_Utils_System
::url('civicrm/contact/view',
411 "reset=1&force=1&cid={$cid}&selectedChild=contribute"
417 $extraParams = "force=1";
419 $extraParams .= "&qfKey=$qfKey";
422 $this->assign('searchKey', $qfKey);
423 if ($context == 'advanced') {
424 $url = CRM_Utils_System
::url('civicrm/contact/search/advanced', $extraParams);
427 $url = CRM_Utils_System
::url('civicrm/contribute/search', $extraParams);
432 $url = CRM_Utils_System
::url('civicrm/dashboard', 'reset=1');
436 $url = CRM_Utils_System
::url('civicrm/contact/view',
437 "reset=1&force=1&cid={$this->_contactId}&selectedChild=activity"
443 $componentId = CRM_Utils_Request
::retrieve('compId', 'Positive', $this);
444 $componentAction = CRM_Utils_Request
::retrieve('compAction', 'Integer', $this);
446 $context = 'membership';
451 $searchKey = "&key=$qfKey";
453 $compContext = "&compContext={$compContext}";
455 if ($componentAction & CRM_Core_Action
::VIEW
) {
461 $url = CRM_Utils_System
::url('civicrm/contact/view/membership',
462 "reset=1&action={$action}&id={$componentId}&cid={$this->_contactId}&context={$context}&selectedChild=member{$searchKey}{$compContext}"
467 $componentId = CRM_Utils_Request
::retrieve('compId', 'Positive', $this);
468 $componentAction = CRM_Utils_Request
::retrieve('compAction', 'Integer', $this);
470 $context = 'participant';
475 $searchKey = "&key=$qfKey";
477 $compContext = "&compContext={$compContext}";
479 if ($componentAction == CRM_Core_Action
::VIEW
) {
485 $url = CRM_Utils_System
::url('civicrm/contact/view/participant',
486 "reset=1&action={$action}&id={$componentId}&cid={$this->_contactId}&context={$context}&selectedChild=event{$searchKey}{$compContext}"
491 $url = CRM_Utils_System
::url('civicrm/contact/view',
492 "reset=1&force=1&cid={$this->_contactId}&selectedChild=pledge"
497 $url = CRM_Utils_System
::url('civicrm/dashboard', 'reset=1');
502 $urlParams = 'force=1';
503 $urlString = 'civicrm/contact/search/custom';
504 if ($this->_action
== CRM_Core_Action
::UPDATE
) {
505 if ($this->_contactId
) {
506 $urlParams .= '&cid=' . $this->_contactId
;
509 $urlParams .= '&context=fulltext&action=view';
510 $urlString = 'civicrm/contact/view/contribution';
513 $urlParams .= "$keyName=$qfKey";
515 $this->assign('searchKey', $qfKey);
516 $url = CRM_Utils_System
::url($urlString, $urlParams);
521 if ($this->_contactId
) {
522 $cid = '&cid=' . $this->_contactId
;
524 $url = CRM_Utils_System
::url('civicrm/contribute/search',
525 'reset=1&force=1' . $cid
530 $session = CRM_Core_Session
::singleton();
531 $session->pushUserContext($url);