Merge pull request #2505 from lcdservices/CRM-14202
[civicrm-core.git] / CRM / Contribute / Page / ContributionPage.php
1 <?php
2 /*
3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
9 | |
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. |
13 | |
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. |
18 | |
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 +--------------------------------------------------------------------+
26 */
27
28 /**
29 *
30 * @package CRM
31 * @copyright CiviCRM LLC (c) 2004-2013
32 * $Id$
33 *
34 */
35
36 /**
37 * Create a page for displaying Contribute Pages
38 * Contribute Pages are pages that are used to display
39 * contributions of different types. Pages consist
40 * of many customizable sections which can be
41 * accessed.
42 *
43 * This page provides a top level browse view
44 * of all the contribution pages in the system.
45 *
46 */
47 class CRM_Contribute_Page_ContributionPage extends CRM_Core_Page {
48
49 /**
50 * The action links that we need to display for the browse screen
51 *
52 * @var array
53 */
54 private static $_actionLinks;
55 private static $_contributionLinks;
56 private static $_configureActionLinks;
57 private static $_onlineContributionLinks;
58
59 private static $_links = NULL;
60
61 protected $_pager = NULL;
62
63 protected $_sortByCharacter;
64
65 /**
66 * Get the action links for this page.
67 *
68 * @return array $_actionLinks
69 *
70 */ function &actionLinks() {
71 // check if variable _actionsLinks is populated
72 if (!isset(self::$_actionLinks)) {
73 // helper variable for nicer formatting
74 $deleteExtra = ts('Are you sure you want to delete this Contribution page?');
75 $copyExtra = ts('Are you sure you want to make a copy of this Contribution page?');
76
77 self::$_actionLinks = array(
78 CRM_Core_Action::COPY => array(
79 'name' => ts('Make a Copy'),
80 'url' => CRM_Utils_System::currentPath(),
81 'qs' => 'action=copy&gid=%%id%%',
82 'title' => ts('Make a Copy of CiviCRM Contribution Page'),
83 'extra' => 'onclick = "return confirm(\'' . $copyExtra . '\');"',
84 ),
85 CRM_Core_Action::DISABLE => array(
86 'name' => ts('Disable'),
87 'title' => ts('Disable'),
88 'ref' => 'crm-enable-disable',
89 ),
90 CRM_Core_Action::ENABLE => array(
91 'name' => ts('Enable'),
92 'ref' => 'crm-enable-disable',
93 'title' => ts('Enable'),
94 ),
95 CRM_Core_Action::DELETE => array(
96 'name' => ts('Delete'),
97 'url' => CRM_Utils_System::currentPath(),
98 'qs' => 'action=delete&reset=1&id=%%id%%',
99 'title' => ts('Delete Custom Field'),
100 'extra' => 'onclick = "return confirm(\'' . $deleteExtra . '\');"',
101 ),
102 );
103 }
104 return self::$_actionLinks;
105 }
106
107 /**
108 * Get the configure action links for this page.
109 *
110 * @return array $_configureActionLinks
111 *
112 */
113 function &configureActionLinks() {
114 // check if variable _actionsLinks is populated
115 if (!isset(self::$_configureActionLinks)) {
116 $urlString = 'civicrm/admin/contribute/';
117 $urlParams = 'reset=1&action=update&id=%%id%%';
118
119 self::$_configureActionLinks = array(
120 CRM_Core_Action::ADD => array(
121 'name' => ts('Title and Settings'),
122 'title' => ts('Title and Settings'),
123 'url' => $urlString . 'settings',
124 'qs' => $urlParams,
125 'uniqueName' => 'settings',
126 ),
127 CRM_Core_Action::UPDATE => array(
128 'name' => ts('Contribution Amounts'),
129 'title' => ts('Contribution Amounts'),
130 'url' => $urlString . 'amount',
131 'qs' => $urlParams,
132 'uniqueName' => 'amount',
133 ),
134 CRM_Core_Action::VIEW => array(
135 'name' => ts('Membership Settings'),
136 'title' => ts('Membership Settings'),
137 'url' => $urlString . 'membership',
138 'qs' => $urlParams,
139 'uniqueName' => 'membership',
140 ),
141 CRM_Core_Action::EXPORT => array(
142 'name' => ts('Thank-you and Receipting'),
143 'title' => ts('Thank-you and Receipting'),
144 'url' => $urlString . 'thankyou',
145 'qs' => $urlParams,
146 'uniqueName' => 'thankyou',
147 ),
148 CRM_Core_Action::BASIC => array(
149 'name' => ts('Tell a Friend'),
150 'title' => ts('Tell a Friend'),
151 'url' => $urlString . 'friend',
152 'qs' => $urlParams,
153 'uniqueName' => 'friend',
154 ),
155 CRM_Core_Action::PROFILE => array(
156 'name' => ts('Include Profiles'),
157 'title' => ts('Include Profiles'),
158 'url' => $urlString . 'custom',
159 'qs' => $urlParams,
160 'uniqueName' => 'custom',
161 ),
162 CRM_Core_Action::MAP => array(
163 'name' => ts('Contribution Widget'),
164 'title' => ts('Contribution Widget'),
165 'url' => $urlString . 'widget',
166 'qs' => $urlParams,
167 'uniqueName' => 'widget',
168 ),
169 CRM_Core_Action::FOLLOWUP => array(
170 'name' => ts('Premiums'),
171 'title' => ts('Premiums'),
172 'url' => $urlString . 'premium',
173 'qs' => $urlParams,
174 'uniqueName' => 'premium',
175 ),
176 CRM_Core_Action::ADVANCED => array(
177 'name' => ts('Personal Campaign Pages'),
178 'title' => ts('Personal Campaign Pages'),
179 'url' => $urlString . 'pcp',
180 'qs' => $urlParams,
181 'uniqueName' => 'pcp',
182 ),
183 );
184 }
185
186 return self::$_configureActionLinks;
187 }
188
189 /**
190 * Get the online contribution links.
191 *
192 * @return array $_onlineContributionLinks.
193 *
194 */
195 function &onlineContributionLinks() {
196 if (!isset(self::$_onlineContributionLinks)) {
197 $urlString = 'civicrm/contribute/transact';
198 $urlParams = 'reset=1&id=%%id%%';
199 self::$_onlineContributionLinks = array(
200 CRM_Core_Action::RENEW => array(
201 'name' => ts('Live Page'),
202 'title' => ts('Live Page'),
203 'url' => $urlString,
204 'qs' => $urlParams,
205 'fe' => TRUE,
206 'uniqueName' => 'live_page',
207 ),
208 CRM_Core_Action::PREVIEW => array(
209 'name' => ts('Test-drive'),
210 'title' => ts('Test-drive'),
211 'url' => $urlString,
212 'qs' => $urlParams . '&action=preview',
213 'uniqueName' => 'test_drive',
214 ),
215 );
216 }
217
218 return self::$_onlineContributionLinks;
219 }
220
221 /**
222 * Get the contributions links.
223 *
224 * @return array $_contributionLinks
225 *
226 */
227 function &contributionLinks() {
228 if (!isset(self::$_contributionLinks)) {
229 //get contribution dates.
230 $dates = CRM_Contribute_BAO_Contribution::getContributionDates();
231 $now = $dates['now'];
232 $yearDate = $dates['yearDate'];
233 $monthDate = $dates['monthDate'];
234 $yearNow = $yearDate + 10000;
235
236 $urlString = 'civicrm/contribute/search';
237 $urlParams = 'reset=1&pid=%%id%%&force=1&test=0';
238
239 self::$_contributionLinks = array(
240 CRM_Core_Action::DETACH => array(
241 'name' => ts('Current Month-To-Date'),
242 'title' => ts('Current Month-To-Date'),
243 'url' => $urlString,
244 'qs' => "{$urlParams}&start={$monthDate}&end={$now}",
245 'uniqueName' => 'current_month_to_date',
246 ),
247 CRM_Core_Action::REVERT => array(
248 'name' => ts('Fiscal Year-To-Date'),
249 'title' => ts('Fiscal Year-To-Date'),
250 'url' => $urlString,
251 'qs' => "{$urlParams}&start={$yearDate}&end={$yearNow}",
252 'uniqueName' => 'fiscal_year_to_date',
253 ),
254 CRM_Core_Action::BROWSE => array(
255 'name' => ts('Cumulative'),
256 'title' => ts('Cumulative'),
257 'url' => $urlString,
258 'qs' => "{$urlParams}&start=&end=$now",
259 'uniqueName' => 'cumulative',
260 ),
261 );
262 }
263
264 return self::$_contributionLinks;
265 }
266
267 /**
268 * Run the page.
269 *
270 * This method is called after the page is created. It checks for the
271 * type of action and executes that action.
272 * Finally it calls the parent's run method.
273 *
274 * @return void
275 * @access public
276 *
277 */
278 function run() {
279 // get the requested action
280 $action = CRM_Utils_Request::retrieve('action', 'String',
281 // default to 'browse'
282 $this, FALSE, 'browse'
283 );
284
285 // assign vars to templates
286 $this->assign('action', $action);
287 $id = CRM_Utils_Request::retrieve('id', 'Positive',
288 $this, FALSE, 0
289 );
290
291 // set breadcrumb to append to 2nd layer pages
292 $breadCrumb = array(array('title' => ts('Manage Contribution Pages'),
293 'url' => CRM_Utils_System::url(CRM_Utils_System::currentPath(),
294 'reset=1'
295 ),
296 ));
297
298 // what action to take ?
299 if ($action & CRM_Core_Action::ADD) {
300 $session = CRM_Core_Session::singleton();
301 $session->pushUserContext(CRM_Utils_System::url(CRM_Utils_System::currentPath(),
302 'action=browse&reset=1'
303 ));
304
305 $controller = new CRM_Contribute_Controller_ContributionPage(NULL, $action);
306 CRM_Utils_System::setTitle(ts('Manage Contribution Page'));
307 CRM_Utils_System::appendBreadCrumb($breadCrumb);
308 return $controller->run();
309 }
310 elseif ($action & CRM_Core_Action::UPDATE) {
311 $config = CRM_Core_Config::singleton();
312
313 // assign vars to templates
314 $this->assign('id', $id);
315 $this->assign('title', CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_ContributionPage', $id, 'title'));
316 $this->assign('is_active', CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_ContributionPage', $id, 'is_active'));
317 if (in_array('CiviMember', $config->enableComponents)) {
318 $this->assign('CiviMember', TRUE);
319 }
320 }
321 elseif ($action & CRM_Core_Action::COPY) {
322 $session = CRM_Core_Session::singleton();
323 CRM_Core_Session::setStatus(ts('A copy of the contribution page has been created'), ts('Successfully Copied'), 'success');
324 $this->copy();
325 }
326 elseif ($action & CRM_Core_Action::DELETE) {
327 CRM_Utils_System::appendBreadCrumb($breadCrumb);
328
329 $session = CRM_Core_Session::singleton();
330 $session->pushUserContext(CRM_Utils_System::url(CRM_Utils_System::currentPath(),
331 'reset=1&action=browse'
332 ));
333
334 $id = CRM_Utils_Request::retrieve('id', 'Positive',
335 $this, FALSE, 0
336 );
337 $query = "
338 SELECT ccp.title
339 FROM civicrm_contribution_page ccp
340 JOIN civicrm_pcp cp ON ccp.id = cp.page_id
341 WHERE cp.page_id = {$id}
342 AND cp.page_type = 'contribute'
343 ";
344
345 if ($pageTitle = CRM_Core_DAO::singleValueQuery($query)) {
346 CRM_Core_Session::setStatus(ts('The \'%1\' cannot be deleted! You must Delete all Personal Campaign Page(s) related with this contribution page prior to deleting the page.', array(1 => $pageTitle)), ts('Deletion Error'), 'error');
347
348 CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/admin/contribute', 'reset=1'));
349 }
350
351 $controller = new CRM_Core_Controller_Simple('CRM_Contribute_Form_ContributionPage_Delete',
352 'Delete Contribution Page',
353 CRM_Core_Action::DELETE
354 );
355 $controller->set('id', $id);
356 $controller->process();
357 return $controller->run();
358 }
359 else {
360 // finally browse the contribution pages
361 $this->browse();
362
363 CRM_Utils_System::setTitle(ts('Manage Contribution Pages'));
364 }
365
366 return parent::run();
367 }
368
369 /**
370 * This function is to make a copy of a contribution page, including
371 * all the fields in the page
372 *
373 * @return void
374 * @access public
375 */
376 function copy() {
377 $gid = CRM_Utils_Request::retrieve('gid', 'Positive',
378 $this, TRUE, 0, 'GET'
379 );
380
381 CRM_Contribute_BAO_ContributionPage::copy($gid);
382
383 CRM_Utils_System::redirect(CRM_Utils_System::url(CRM_Utils_System::currentPath(), 'reset=1'));
384 }
385
386 /**
387 * Browse all contribution pages
388 *
389 * @return void
390 * @access public
391 * @static
392 */
393 function browse($action = NULL) {
394 $this->_sortByCharacter = CRM_Utils_Request::retrieve('sortByCharacter',
395 'String',
396 $this
397 );
398 $createdId = CRM_Utils_Request::retrieve('cid', 'Positive',
399 $this, FALSE, 0
400 );
401
402 if ($this->_sortByCharacter == 1 ||
403 !empty($_POST)
404 ) {
405 $this->_sortByCharacter = '';
406 $this->set('sortByCharacter', '');
407 }
408
409 $this->search();
410
411 $params = array();
412
413 $whereClause = $this->whereClause($params, FALSE);
414 $this->pagerAToZ($whereClause, $params);
415
416 $params = array();
417 $whereClause = $this->whereClause($params, TRUE);
418 $this->pager($whereClause, $params);
419
420 list($offset, $rowCount) = $this->_pager->getOffsetAndRowCount();
421
422 //check for delete CRM-4418
423 $allowToDelete = CRM_Core_Permission::check('delete in CiviContribute');
424
425 $query = "
426 SELECT id
427 FROM civicrm_contribution_page
428 WHERE $whereClause
429 LIMIT $offset, $rowCount";
430 $contribPage = CRM_Core_DAO::executeQuery($query, $params, TRUE, 'CRM_Contribute_DAO_ContributionPage');
431 $contribPageIds = array();
432 while ($contribPage->fetch()) {
433 $contribPageIds[$contribPage->id] = $contribPage->id;
434 }
435 //get all section info.
436 $contriPageSectionInfo = CRM_Contribute_BAO_ContributionPage::getSectionInfo($contribPageIds);
437
438 $query = "
439 SELECT *
440 FROM civicrm_contribution_page
441 WHERE $whereClause
442 ORDER BY title asc
443 LIMIT $offset, $rowCount";
444
445 $dao = CRM_Core_DAO::executeQuery($query, $params, TRUE, 'CRM_Contribute_DAO_ContributionPage');
446
447 //get all campaigns.
448 $allCampaigns = CRM_Campaign_BAO_Campaign::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
449
450 //get configure actions links.
451 $configureActionLinks = self::configureActionLinks();
452
453 while ($dao->fetch()) {
454 $contribution[$dao->id] = array();
455 CRM_Core_DAO::storeValues($dao, $contribution[$dao->id]);
456
457 // form all action links
458 $action = array_sum(array_keys($this->actionLinks()));
459
460 //add configure actions links.
461 $action += array_sum(array_keys($configureActionLinks));
462
463 //add online contribution links.
464 $action += array_sum(array_keys(self::onlineContributionLinks()));
465
466 //add contribution search links.
467 $action += array_sum(array_keys(self::contributionLinks()));
468
469 if ($dao->is_active) {
470 $action -= CRM_Core_Action::ENABLE;
471 }
472 else {
473 $action -= CRM_Core_Action::DISABLE;
474 }
475
476 //CRM-4418
477 if (!$allowToDelete) {
478 $action -= CRM_Core_Action::DELETE;
479 }
480
481 //build the configure links.
482 $sectionsInfo = CRM_Utils_Array::value($dao->id, $contriPageSectionInfo, array());
483 $contribution[$dao->id]['configureActionLinks'] = CRM_Core_Action::formLink(self::formatConfigureLinks($sectionsInfo),
484 $action,
485 array('id' => $dao->id),
486 ts('Configure'),
487 TRUE,
488 'contributionpage.configure.actions',
489 'ContributionPage',
490 $dao->id
491 );
492
493 //build the contributions links.
494 $contribution[$dao->id]['contributionLinks'] = CRM_Core_Action::formLink(self::contributionLinks(),
495 $action,
496 array('id' => $dao->id),
497 ts('Contributions'),
498 TRUE,
499 'contributionpage.contributions.search',
500 'ContributionPage',
501 $dao->id
502 );
503
504 //build the online contribution links.
505 $contribution[$dao->id]['onlineContributionLinks'] = CRM_Core_Action::formLink(self::onlineContributionLinks(),
506 $action,
507 array('id' => $dao->id),
508 ts('Links'),
509 TRUE,
510 'contributionpage.online.links',
511 'ContributionPage',
512 $dao->id
513 );
514
515 //build the normal action links.
516 $contribution[$dao->id]['action'] = CRM_Core_Action::formLink(self::actionLinks(),
517 $action,
518 array('id' => $dao->id),
519 ts('more'),
520 TRUE,
521 'contributionpage.action.links',
522 'ContributionPage',
523 $dao->id
524 );
525
526 //show campaigns on selector.
527 $contribution[$dao->id]['campaign'] = CRM_Utils_Array::value($dao->campaign_id, $allCampaigns);
528 }
529
530 if (isset($contribution)) {
531 $this->assign('rows', $contribution);
532 }
533 }
534
535 function search() {
536 if (isset($this->_action) &
537 (CRM_Core_Action::ADD |
538 CRM_Core_Action::UPDATE |
539 CRM_Core_Action::DELETE
540 )
541 ) {
542 return;
543 }
544
545 $form = new CRM_Core_Controller_Simple('CRM_Contribute_Form_SearchContribution',
546 ts('Search Contribution'),
547 CRM_Core_Action::ADD
548 );
549 $form->setEmbedded(TRUE);
550 $form->setParent($this);
551 $form->process();
552 $form->run();
553 }
554
555 function whereClause(&$params, $sortBy = TRUE) {
556 $values = $clauses = array();
557 $title = $this->get('title');
558 $createdId = $this->get('cid');
559
560 if ($createdId) {
561 $clauses[] = "(created_id = {$createdId})";
562 }
563
564 if ($title) {
565 $clauses[] = "title LIKE %1";
566 if (strpos($title, '%') !== FALSE) {
567 $params[1] = array(trim($title), 'String', FALSE);
568 }
569 else {
570 $params[1] = array(trim($title), 'String', TRUE);
571 }
572 }
573
574 $value = $this->get( 'financial_type_id' );
575 $val = array();
576 if ($value) {
577 if (is_array($value)) {
578 foreach ($value as $k => $v) {
579 if ($v) {
580 $val[$k] = $k;
581 }
582 }
583 $type = implode(',', $val);
584 }
585
586 $clauses[] = "financial_type_id IN ({$type})";
587 }
588
589 if ($sortBy &&
590 $this->_sortByCharacter !== NULL
591 ) {
592 $clauses[] = "title LIKE '" . strtolower(CRM_Core_DAO::escapeWildCardString($this->_sortByCharacter)) . "%'";
593 }
594
595 $campainIds = $this->get('campaign_id');
596 if (!CRM_Utils_System::isNull($campainIds)) {
597 if (!is_array($campainIds)) {
598 $campaignIds = array($campaignIds);
599 }
600 $clauses[] = '( campaign_id IN ( ' . implode(' , ', array_values($campainIds)) . ' ) )';
601 }
602
603 if (empty($clauses)) {
604 // Let template know if user has run a search or not
605 $this->assign('isSearch', 0);
606 return 1;
607 }
608 else {
609 $this->assign('isSearch', 1);
610 }
611
612 return implode(' AND ', $clauses);
613 }
614
615 function pager($whereClause, $whereParams) {
616
617 $params['status'] = ts('Contribution %%StatusMessage%%');
618 $params['csvString'] = NULL;
619 $params['buttonTop'] = 'PagerTopButton';
620 $params['buttonBottom'] = 'PagerBottomButton';
621 $params['rowCount'] = $this->get(CRM_Utils_Pager::PAGE_ROWCOUNT);
622 if (!$params['rowCount']) {
623 $params['rowCount'] = CRM_Utils_Pager::ROWCOUNT;
624 }
625
626 $query = "
627 SELECT count(id)
628 FROM civicrm_contribution_page
629 WHERE $whereClause";
630
631 $params['total'] = CRM_Core_DAO::singleValueQuery($query, $whereParams);
632
633 $this->_pager = new CRM_Utils_Pager($params);
634 $this->assign_by_ref('pager', $this->_pager);
635 }
636
637 function pagerAtoZ($whereClause, $whereParams) {
638
639 $query = "
640 SELECT DISTINCT UPPER(LEFT(title, 1)) as sort_name
641 FROM civicrm_contribution_page
642 WHERE $whereClause
643 ORDER BY LEFT(title, 1)
644 ";
645 $dao = CRM_Core_DAO::executeQuery($query, $whereParams);
646
647 $aToZBar = CRM_Utils_PagerAToZ::getAToZBar($dao, $this->_sortByCharacter, TRUE);
648 $this->assign('aToZ', $aToZBar);
649 }
650
651 function formatConfigureLinks($sectionsInfo) {
652 //build the formatted configure links.
653 $formattedConfLinks = self::configureActionLinks();
654 foreach ($formattedConfLinks as $act => & $link) {
655 $sectionName = CRM_Utils_Array::value('uniqueName', $link);
656 if (!$sectionName) {
657 continue;
658 }
659
660 $classes = array();
661 if (isset($link['class'])) {
662 $classes = $link['class'];
663 }
664
665 if (empty($sectionsInfo[$sectionName])) {
666 $classes = array();
667 if (isset($link['class'])) {
668 $classes = $link['class'];
669 }
670 $link['class'] = array_merge($classes, array('disabled'));
671 }
672 }
673
674 return $formattedConfLinks;
675 }
676 }
677