3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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-2019
35 * Create a page for displaying Contribute Pages
36 * Contribute Pages are pages that are used to display
37 * contributions of different types. Pages consist
38 * of many customizable sections which can be
41 * This page provides a top level browse view
42 * of all the contribution pages in the system.
45 class CRM_Contribute_Page_ContributionPage
extends CRM_Core_Page
{
48 * The action links that we need to display for the browse screen.
52 private static $_actionLinks;
53 private static $_contributionLinks;
54 private static $_configureActionLinks;
55 private static $_onlineContributionLinks;
58 * @var CRM_Utils_Pager
60 protected $_pager = NULL;
65 protected $_sortByCharacter;
68 * Get the action links for this page.
72 public static function &actionLinks() {
73 // check if variable _actionsLinks is populated
74 if (!isset(self
::$_actionLinks)) {
75 // helper variable for nicer formatting
76 $deleteExtra = ts('Are you sure you want to delete this Contribution page?');
77 $copyExtra = ts('Are you sure you want to make a copy of this Contribution page?');
79 self
::$_actionLinks = array(
80 CRM_Core_Action
::COPY
=> array(
81 'name' => ts('Make a Copy'),
82 'url' => CRM_Utils_System
::currentPath(),
83 'qs' => 'action=copy&gid=%%id%%',
84 'title' => ts('Make a Copy of CiviCRM Contribution Page'),
85 'extra' => 'onclick = "return confirm(\'' . $copyExtra . '\');"',
87 CRM_Core_Action
::DISABLE
=> array(
88 'name' => ts('Disable'),
89 'title' => ts('Disable'),
90 'ref' => 'crm-enable-disable',
92 CRM_Core_Action
::ENABLE
=> array(
93 'name' => ts('Enable'),
94 'ref' => 'crm-enable-disable',
95 'title' => ts('Enable'),
97 CRM_Core_Action
::DELETE
=> array(
98 'name' => ts('Delete'),
99 'url' => CRM_Utils_System
::currentPath(),
100 'qs' => 'action=delete&reset=1&id=%%id%%',
101 'title' => ts('Delete Custom Field'),
102 'extra' => 'onclick = "return confirm(\'' . $deleteExtra . '\');"',
106 return self
::$_actionLinks;
110 * Get the configure action links for this page.
114 public function &configureActionLinks() {
115 // check if variable _actionsLinks is populated
116 if (!isset(self
::$_configureActionLinks)) {
117 $urlString = 'civicrm/admin/contribute/';
118 $urlParams = 'reset=1&action=update&id=%%id%%';
120 self
::$_configureActionLinks = array(
121 CRM_Core_Action
::ADD
=> array(
122 'name' => ts('Title and Settings'),
123 'title' => ts('Title and Settings'),
124 'url' => $urlString . 'settings',
126 'uniqueName' => 'settings',
128 CRM_Core_Action
::UPDATE
=> array(
129 'name' => ts('Contribution Amounts'),
130 'title' => ts('Contribution Amounts'),
131 'url' => $urlString . 'amount',
133 'uniqueName' => 'amount',
135 CRM_Core_Action
::VIEW
=> array(
136 'name' => ts('Membership Settings'),
137 'title' => ts('Membership Settings'),
138 'url' => $urlString . 'membership',
140 'uniqueName' => 'membership',
142 CRM_Core_Action
::EXPORT
=> array(
143 'name' => ts('Thank-you and Receipting'),
144 'title' => ts('Thank-you and Receipting'),
145 'url' => $urlString . 'thankyou',
147 'uniqueName' => 'thankyou',
149 CRM_Core_Action
::BASIC
=> array(
150 'name' => ts('Tell a Friend'),
151 'title' => ts('Tell a Friend'),
152 'url' => $urlString . 'friend',
154 'uniqueName' => 'friend',
156 CRM_Core_Action
::PROFILE
=> array(
157 'name' => ts('Include Profiles'),
158 'title' => ts('Include Profiles'),
159 'url' => $urlString . 'custom',
161 'uniqueName' => 'custom',
163 CRM_Core_Action
::MAP
=> array(
164 'name' => ts('Contribution Widget'),
165 'title' => ts('Contribution Widget'),
166 'url' => $urlString . 'widget',
168 'uniqueName' => 'widget',
170 CRM_Core_Action
::FOLLOWUP
=> array(
171 'name' => ts('Premiums'),
172 'title' => ts('Premiums'),
173 'url' => $urlString . 'premium',
175 'uniqueName' => 'premium',
177 CRM_Core_Action
::ADVANCED
=> array(
178 'name' => ts('Personal Campaign Pages'),
179 'title' => ts('Personal Campaign Pages'),
180 'url' => $urlString . 'pcp',
182 'uniqueName' => 'pcp',
186 'urlString' => $urlString,
187 'urlParams' => $urlParams,
189 CRM_Utils_Hook
::tabset('civicrm/admin/contribute', self
::$_configureActionLinks, $context);
192 return self
::$_configureActionLinks;
196 * Get the online contribution links.
200 public function &onlineContributionLinks() {
201 if (!isset(self
::$_onlineContributionLinks)) {
202 $urlString = 'civicrm/contribute/transact';
203 $urlParams = 'reset=1&id=%%id%%';
204 self
::$_onlineContributionLinks = array(
205 CRM_Core_Action
::RENEW
=> array(
206 'name' => ts('Live Page'),
207 'title' => ts('Live Page'),
211 'uniqueName' => 'live_page',
213 CRM_Core_Action
::PREVIEW
=> array(
214 'name' => ts('Test-drive'),
215 'title' => ts('Test-drive'),
217 'qs' => $urlParams . '&action=preview',
218 'fe' => TRUE, // Addresses https://lab.civicrm.org/dev/core/issues/658
219 'uniqueName' => 'test_drive',
224 return self
::$_onlineContributionLinks;
228 * Get the contributions links.
232 public function &contributionLinks() {
233 if (!isset(self
::$_contributionLinks)) {
234 //get contribution dates.
235 $dates = CRM_Contribute_BAO_Contribution
::getContributionDates();
236 $now = $dates['now'];
237 $yearDate = $dates['yearDate'];
238 $monthDate = $dates['monthDate'];
239 $yearNow = $yearDate +
10000;
241 $urlString = 'civicrm/contribute/search';
242 $urlParams = 'reset=1&pid=%%id%%&force=1&test=0';
244 self
::$_contributionLinks = array(
245 CRM_Core_Action
::DETACH
=> array(
246 'name' => ts('Current Month-To-Date'),
247 'title' => ts('Current Month-To-Date'),
249 'qs' => "{$urlParams}&start={$monthDate}&end={$now}",
250 'uniqueName' => 'current_month_to_date',
252 CRM_Core_Action
::REVERT
=> array(
253 'name' => ts('Fiscal Year-To-Date'),
254 'title' => ts('Fiscal Year-To-Date'),
256 'qs' => "{$urlParams}&start={$yearDate}&end={$yearNow}",
257 'uniqueName' => 'fiscal_year_to_date',
259 CRM_Core_Action
::BROWSE
=> array(
260 'name' => ts('Cumulative'),
261 'title' => ts('Cumulative'),
263 'qs' => "{$urlParams}&start=&end=$now",
264 'uniqueName' => 'cumulative',
269 return self
::$_contributionLinks;
275 * This method is called after the page is created. It checks for the
276 * type of action and executes that action.
277 * Finally it calls the parent's run method.
281 public function run() {
282 // get the requested action
283 $action = CRM_Utils_Request
::retrieve('action', 'String',
284 // default to 'browse'
285 $this, FALSE, 'browse'
288 // assign vars to templates
289 $this->assign('action', $action);
290 $id = CRM_Utils_Request
::retrieve('id', 'Positive',
294 // set breadcrumb to append to 2nd layer pages
297 'title' => ts('Manage Contribution Pages'),
298 'url' => CRM_Utils_System
::url(CRM_Utils_System
::currentPath(),
304 // what action to take ?
305 if ($action & CRM_Core_Action
::ADD
) {
306 $session = CRM_Core_Session
::singleton();
307 $session->pushUserContext(CRM_Utils_System
::url(CRM_Utils_System
::currentPath(),
308 'action=browse&reset=1'
311 $controller = new CRM_Contribute_Controller_ContributionPage(NULL, $action);
312 CRM_Utils_System
::setTitle(ts('Manage Contribution Page'));
313 CRM_Utils_System
::appendBreadCrumb($breadCrumb);
314 return $controller->run();
316 elseif ($action & CRM_Core_Action
::UPDATE
) {
317 $config = CRM_Core_Config
::singleton();
319 // assign vars to templates
320 $this->assign('id', $id);
321 $this->assign('title', CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_ContributionPage', $id, 'title'));
322 $this->assign('is_active', CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_ContributionPage', $id, 'is_active'));
323 if (in_array('CiviMember', $config->enableComponents
)) {
324 $this->assign('CiviMember', TRUE);
327 elseif ($action & CRM_Core_Action
::COPY
) {
328 // @todo Unused local variable can be safely removed.
329 // But are there any side effects of CRM_Core_Session::singleton() that we
331 $session = CRM_Core_Session
::singleton();
332 CRM_Core_Session
::setStatus(ts('A copy of the contribution page has been created'), ts('Successfully Copied'), 'success');
335 elseif ($action & CRM_Core_Action
::DELETE
) {
336 CRM_Utils_System
::appendBreadCrumb($breadCrumb);
338 $session = CRM_Core_Session
::singleton();
339 $session->pushUserContext(CRM_Utils_System
::url(CRM_Utils_System
::currentPath(),
340 'reset=1&action=browse'
343 $id = CRM_Utils_Request
::retrieve('id', 'Positive',
348 FROM civicrm_contribution_page ccp
349 JOIN civicrm_pcp cp ON ccp.id = cp.page_id
350 WHERE cp.page_id = {$id}
351 AND cp.page_type = 'contribute'
354 if ($pageTitle = CRM_Core_DAO
::singleValueQuery($query)) {
355 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');
357 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/admin/contribute', 'reset=1'));
360 $controller = new CRM_Core_Controller_Simple('CRM_Contribute_Form_ContributionPage_Delete',
361 'Delete Contribution Page',
362 CRM_Core_Action
::DELETE
364 $controller->set('id', $id);
365 $controller->process();
366 return $controller->run();
369 // finally browse the contribution pages
372 CRM_Utils_System
::setTitle(ts('Manage Contribution Pages'));
375 return parent
::run();
379 * Make a copy of a contribution page, including all the fields in the page.
381 public function copy() {
382 $gid = CRM_Utils_Request
::retrieve('gid', 'Positive',
383 $this, TRUE, 0, 'GET'
386 CRM_Contribute_BAO_ContributionPage
::copy($gid);
388 CRM_Utils_System
::redirect(CRM_Utils_System
::url(CRM_Utils_System
::currentPath(), 'reset=1'));
392 * Browse all contribution pages.
394 * @param mixed $action
397 public function browse($action = NULL) {
398 Civi
::resources()->addStyleFile('civicrm', 'css/searchForm.css', 1, 'html-header');
400 $this->_sortByCharacter
= CRM_Utils_Request
::retrieve('sortByCharacter',
404 // @todo Unused local variable can be safely removed.
405 // But are there any side effects of CRM_Utils_Request::retrieve() that we
407 $createdId = CRM_Utils_Request
::retrieve('cid', 'Positive',
411 if ($this->_sortByCharacter
== 'all' ||
414 $this->_sortByCharacter
= '';
415 $this->set('sortByCharacter', '');
422 $whereClause = $this->whereClause($params, FALSE);
423 $config = CRM_Core_Config
::singleton();
424 if ($config->includeAlphabeticalPager
) {
425 $this->pagerAToZ($whereClause, $params);
428 $whereClause = $this->whereClause($params, TRUE);
429 $this->pager($whereClause, $params);
431 list($offset, $rowCount) = $this->_pager
->getOffsetAndRowCount();
433 //check for delete CRM-4418
434 $allowToDelete = CRM_Core_Permission
::check('delete in CiviContribute');
438 FROM civicrm_contribution_page
440 ORDER BY is_active desc, title asc
441 LIMIT $offset, $rowCount";
442 $contribPage = CRM_Core_DAO
::executeQuery($query, $params, TRUE, 'CRM_Contribute_DAO_ContributionPage');
443 $contribPageIds = array();
444 while ($contribPage->fetch()) {
445 $contribPageIds[$contribPage->id
] = $contribPage->id
;
447 //get all section info.
448 $contriPageSectionInfo = CRM_Contribute_BAO_ContributionPage
::getSectionInfo($contribPageIds);
452 FROM civicrm_contribution_page
454 ORDER BY is_active desc, title asc
455 LIMIT $offset, $rowCount";
457 $dao = CRM_Core_DAO
::executeQuery($query, $params, TRUE, 'CRM_Contribute_DAO_ContributionPage');
460 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
462 //get configure actions links.
463 $configureActionLinks = self
::configureActionLinks();
465 while ($dao->fetch()) {
466 $contribution[$dao->id
] = array();
467 CRM_Core_DAO
::storeValues($dao, $contribution[$dao->id
]);
469 // form all action links
470 $action = array_sum(array_keys(self
::actionLinks()));
472 //add configure actions links.
473 $action +
= array_sum(array_keys($configureActionLinks));
475 //add online contribution links.
476 $action +
= array_sum(array_keys(self
::onlineContributionLinks()));
478 //add contribution search links.
479 $action +
= array_sum(array_keys(self
::contributionLinks()));
481 if ($dao->is_active
) {
482 $action -= (int) CRM_Core_Action
::ENABLE
;
485 $action -= (int) CRM_Core_Action
::DISABLE
;
489 if (!$allowToDelete) {
490 $action -= (int) CRM_Core_Action
::DELETE
;
493 //build the configure links.
494 $sectionsInfo = CRM_Utils_Array
::value($dao->id
, $contriPageSectionInfo, array());
495 $contribution[$dao->id
]['configureActionLinks'] = CRM_Core_Action
::formLink(self
::formatConfigureLinks($sectionsInfo),
497 array('id' => $dao->id
),
500 'contributionpage.configure.actions',
505 //build the contributions links.
506 $contribution[$dao->id
]['contributionLinks'] = CRM_Core_Action
::formLink(self
::contributionLinks(),
508 array('id' => $dao->id
),
511 'contributionpage.contributions.search',
516 //build the online contribution links.
517 $contribution[$dao->id
]['onlineContributionLinks'] = CRM_Core_Action
::formLink(self
::onlineContributionLinks(),
519 array('id' => $dao->id
),
522 'contributionpage.online.links',
527 //build the normal action links.
528 $contribution[$dao->id
]['action'] = CRM_Core_Action
::formLink(self
::actionLinks(),
530 array('id' => $dao->id
),
533 'contributionpage.action.links',
538 //show campaigns on selector.
539 $contribution[$dao->id
]['campaign'] = CRM_Utils_Array
::value($dao->campaign_id
, $allCampaigns);
542 if (isset($contribution)) {
543 $this->assign('rows', $contribution);
547 public function search() {
548 if (isset($this->_action
) & (CRM_Core_Action
::ADD |
549 CRM_Core_Action
::UPDATE |
550 CRM_Core_Action
::DELETE
556 $form = new CRM_Core_Controller_Simple('CRM_Contribute_Form_SearchContribution',
557 ts('Search Contribution'),
560 $form->setEmbedded(TRUE);
561 $form->setParent($this);
567 * @param array $params
568 * @param bool $sortBy
572 public function whereClause(&$params, $sortBy = TRUE) {
573 // @todo Unused local variable can be safely removed.
574 $values = $clauses = array();
575 $title = $this->get('title');
576 $createdId = $this->get('cid');
579 $clauses[] = "(created_id = {$createdId})";
583 $clauses[] = "title LIKE %1";
584 if (strpos($title, '%') !== FALSE) {
585 $params[1] = array(trim($title), 'String', FALSE);
588 $params[1] = array(trim($title), 'String', TRUE);
592 $value = $this->get('financial_type_id');
595 if (is_array($value)) {
596 foreach ($value as $k => $v) {
601 $type = implode(',', $val);
603 // @todo Variable 'type' might not have been defined.
604 $clauses[] = "financial_type_id IN ({$type})";
607 if ($sortBy && $this->_sortByCharacter
!== NULL) {
608 $clauses[] = "title LIKE '" . strtolower(CRM_Core_DAO
::escapeWildCardString($this->_sortByCharacter
)) . "%'";
611 $campaignIds = $this->getCampaignIds();
612 if (count($campaignIds) >= 1) {
613 $clauses[] = '( campaign_id IN ( ' . implode(' , ', $campaignIds) . ' ) )';
616 if (empty($clauses)) {
617 // Let template know if user has run a search or not
618 $this->assign('isSearch', 0);
622 $this->assign('isSearch', 1);
625 return implode(' AND ', $clauses);
629 * Gets the campaign ids from the session.
633 public function getCampaignIds() {
634 // The unfiltered value from the session cannot be trusted, it needs to be
635 // processed to get a clean array of positive integers.
637 foreach ((array) $this->get('campaign_id') as $id) {
638 if ((string) (int) $id === (string) $id && $id > 0) {
646 * @param $whereClause
647 * @param array $whereParams
649 public function pager($whereClause, $whereParams) {
651 $params['status'] = ts('Contribution %%StatusMessage%%');
652 $params['csvString'] = NULL;
653 $params['buttonTop'] = 'PagerTopButton';
654 $params['buttonBottom'] = 'PagerBottomButton';
655 $params['rowCount'] = $this->get(CRM_Utils_Pager
::PAGE_ROWCOUNT
);
656 if (!$params['rowCount']) {
657 $params['rowCount'] = CRM_Utils_Pager
::ROWCOUNT
;
662 FROM civicrm_contribution_page
665 $params['total'] = CRM_Core_DAO
::singleValueQuery($query, $whereParams);
667 $this->_pager
= new CRM_Utils_Pager($params);
668 $this->assign_by_ref('pager', $this->_pager
);
672 * @param $whereClause
673 * @param array $whereParams
675 public function pagerAtoZ($whereClause, $whereParams) {
678 SELECT DISTINCT UPPER(LEFT(title, 1)) as sort_name
679 FROM civicrm_contribution_page
681 ORDER BY UPPER(LEFT(title, 1))
683 $dao = CRM_Core_DAO
::executeQuery($query, $whereParams);
685 $aToZBar = CRM_Utils_PagerAToZ
::getAToZBar($dao, $this->_sortByCharacter
, TRUE);
686 $this->assign('aToZ', $aToZBar);
690 * @param array $sectionsInfo
694 public function formatConfigureLinks($sectionsInfo) {
695 // build the formatted configure links.
696 $formattedConfLinks = self
::configureActionLinks();
697 foreach ($formattedConfLinks as $act => & $link) {
698 $sectionName = CRM_Utils_Array
::value('uniqueName', $link);
703 if (empty($sectionsInfo[$sectionName])) {
705 if (isset($link['class'])) {
706 $classes = $link['class'];
708 $link['class'] = array_merge($classes, array('disabled'));
712 return $formattedConfLinks;