3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
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 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',
187 return self
::$_configureActionLinks;
191 * Get the online contribution links.
195 public 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'),
206 'uniqueName' => 'live_page',
208 CRM_Core_Action
::PREVIEW
=> array(
209 'name' => ts('Test-drive'),
210 'title' => ts('Test-drive'),
212 'qs' => $urlParams . '&action=preview',
213 'uniqueName' => 'test_drive',
218 return self
::$_onlineContributionLinks;
222 * Get the contributions links.
226 public function &contributionLinks() {
227 if (!isset(self
::$_contributionLinks)) {
228 //get contribution dates.
229 $dates = CRM_Contribute_BAO_Contribution
::getContributionDates();
230 $now = $dates['now'];
231 $yearDate = $dates['yearDate'];
232 $monthDate = $dates['monthDate'];
233 $yearNow = $yearDate +
10000;
235 $urlString = 'civicrm/contribute/search';
236 $urlParams = 'reset=1&pid=%%id%%&force=1&test=0';
238 self
::$_contributionLinks = array(
239 CRM_Core_Action
::DETACH
=> array(
240 'name' => ts('Current Month-To-Date'),
241 'title' => ts('Current Month-To-Date'),
243 'qs' => "{$urlParams}&start={$monthDate}&end={$now}",
244 'uniqueName' => 'current_month_to_date',
246 CRM_Core_Action
::REVERT
=> array(
247 'name' => ts('Fiscal Year-To-Date'),
248 'title' => ts('Fiscal Year-To-Date'),
250 'qs' => "{$urlParams}&start={$yearDate}&end={$yearNow}",
251 'uniqueName' => 'fiscal_year_to_date',
253 CRM_Core_Action
::BROWSE
=> array(
254 'name' => ts('Cumulative'),
255 'title' => ts('Cumulative'),
257 'qs' => "{$urlParams}&start=&end=$now",
258 'uniqueName' => 'cumulative',
263 return self
::$_contributionLinks;
269 * This method is called after the page is created. It checks for the
270 * type of action and executes that action.
271 * Finally it calls the parent's run method.
275 public function run() {
276 // get the requested action
277 $action = CRM_Utils_Request
::retrieve('action', 'String',
278 // default to 'browse'
279 $this, FALSE, 'browse'
282 // assign vars to templates
283 $this->assign('action', $action);
284 $id = CRM_Utils_Request
::retrieve('id', 'Positive',
288 // set breadcrumb to append to 2nd layer pages
291 'title' => ts('Manage Contribution Pages'),
292 'url' => CRM_Utils_System
::url(CRM_Utils_System
::currentPath(),
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'
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();
310 elseif ($action & CRM_Core_Action
::UPDATE
) {
311 $config = CRM_Core_Config
::singleton();
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);
321 elseif ($action & CRM_Core_Action
::COPY
) {
322 // @todo Unused local variable can be safely removed.
323 // But are there any side effects of CRM_Core_Session::singleton() that we
325 $session = CRM_Core_Session
::singleton();
326 CRM_Core_Session
::setStatus(ts('A copy of the contribution page has been created'), ts('Successfully Copied'), 'success');
329 elseif ($action & CRM_Core_Action
::DELETE
) {
330 CRM_Utils_System
::appendBreadCrumb($breadCrumb);
332 $session = CRM_Core_Session
::singleton();
333 $session->pushUserContext(CRM_Utils_System
::url(CRM_Utils_System
::currentPath(),
334 'reset=1&action=browse'
337 $id = CRM_Utils_Request
::retrieve('id', 'Positive',
342 FROM civicrm_contribution_page ccp
343 JOIN civicrm_pcp cp ON ccp.id = cp.page_id
344 WHERE cp.page_id = {$id}
345 AND cp.page_type = 'contribute'
348 if ($pageTitle = CRM_Core_DAO
::singleValueQuery($query)) {
349 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');
351 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/admin/contribute', 'reset=1'));
354 $controller = new CRM_Core_Controller_Simple('CRM_Contribute_Form_ContributionPage_Delete',
355 'Delete Contribution Page',
356 CRM_Core_Action
::DELETE
358 $controller->set('id', $id);
359 $controller->process();
360 return $controller->run();
363 // finally browse the contribution pages
366 CRM_Utils_System
::setTitle(ts('Manage Contribution Pages'));
369 return parent
::run();
373 * Make a copy of a contribution page, including all the fields in the page.
375 public function copy() {
376 $gid = CRM_Utils_Request
::retrieve('gid', 'Positive',
377 $this, TRUE, 0, 'GET'
380 CRM_Contribute_BAO_ContributionPage
::copy($gid);
382 CRM_Utils_System
::redirect(CRM_Utils_System
::url(CRM_Utils_System
::currentPath(), 'reset=1'));
386 * Browse all contribution pages.
388 * @param mixed $action
391 public function browse($action = NULL) {
392 $this->_sortByCharacter
= CRM_Utils_Request
::retrieve('sortByCharacter',
396 // @todo Unused local variable can be safely removed.
397 // But are there any side effects of CRM_Utils_Request::retrieve() that we
399 $createdId = CRM_Utils_Request
::retrieve('cid', 'Positive',
403 if ($this->_sortByCharacter
== 'all' ||
406 $this->_sortByCharacter
= '';
407 $this->set('sortByCharacter', '');
414 $whereClause = $this->whereClause($params, FALSE);
415 $this->pagerAToZ($whereClause, $params);
418 $whereClause = $this->whereClause($params, TRUE);
419 $this->pager($whereClause, $params);
421 list($offset, $rowCount) = $this->_pager
->getOffsetAndRowCount();
423 //check for delete CRM-4418
424 $allowToDelete = CRM_Core_Permission
::check('delete in CiviContribute');
428 FROM civicrm_contribution_page
430 ORDER BY is_active desc, title asc
431 LIMIT $offset, $rowCount";
432 $contribPage = CRM_Core_DAO
::executeQuery($query, $params, TRUE, 'CRM_Contribute_DAO_ContributionPage');
433 $contribPageIds = array();
434 while ($contribPage->fetch()) {
435 $contribPageIds[$contribPage->id
] = $contribPage->id
;
437 //get all section info.
438 $contriPageSectionInfo = CRM_Contribute_BAO_ContributionPage
::getSectionInfo($contribPageIds);
442 FROM civicrm_contribution_page
444 ORDER BY is_active desc, title asc
445 LIMIT $offset, $rowCount";
447 $dao = CRM_Core_DAO
::executeQuery($query, $params, TRUE, 'CRM_Contribute_DAO_ContributionPage');
450 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
452 //get configure actions links.
453 $configureActionLinks = self
::configureActionLinks();
455 while ($dao->fetch()) {
456 $contribution[$dao->id
] = array();
457 CRM_Core_DAO
::storeValues($dao, $contribution[$dao->id
]);
459 // form all action links
460 $action = array_sum(array_keys($this->actionLinks()));
462 //add configure actions links.
463 $action +
= array_sum(array_keys($configureActionLinks));
465 //add online contribution links.
466 $action +
= array_sum(array_keys(self
::onlineContributionLinks()));
468 //add contribution search links.
469 $action +
= array_sum(array_keys(self
::contributionLinks()));
471 if ($dao->is_active
) {
472 $action -= (int) CRM_Core_Action
::ENABLE
;
475 $action -= (int) CRM_Core_Action
::DISABLE
;
479 if (!$allowToDelete) {
480 $action -= (int) CRM_Core_Action
::DELETE
;
483 //build the configure links.
484 $sectionsInfo = CRM_Utils_Array
::value($dao->id
, $contriPageSectionInfo, array());
485 $contribution[$dao->id
]['configureActionLinks'] = CRM_Core_Action
::formLink(self
::formatConfigureLinks($sectionsInfo),
487 array('id' => $dao->id
),
490 'contributionpage.configure.actions',
495 //build the contributions links.
496 $contribution[$dao->id
]['contributionLinks'] = CRM_Core_Action
::formLink(self
::contributionLinks(),
498 array('id' => $dao->id
),
501 'contributionpage.contributions.search',
506 //build the online contribution links.
507 $contribution[$dao->id
]['onlineContributionLinks'] = CRM_Core_Action
::formLink(self
::onlineContributionLinks(),
509 array('id' => $dao->id
),
512 'contributionpage.online.links',
517 //build the normal action links.
518 $contribution[$dao->id
]['action'] = CRM_Core_Action
::formLink(self
::actionLinks(),
520 array('id' => $dao->id
),
523 'contributionpage.action.links',
528 //show campaigns on selector.
529 $contribution[$dao->id
]['campaign'] = CRM_Utils_Array
::value($dao->campaign_id
, $allCampaigns);
532 if (isset($contribution)) {
533 $this->assign('rows', $contribution);
537 public function search() {
538 if (isset($this->_action
) & (CRM_Core_Action
::ADD |
539 CRM_Core_Action
::UPDATE |
540 CRM_Core_Action
::DELETE
546 $form = new CRM_Core_Controller_Simple('CRM_Contribute_Form_SearchContribution',
547 ts('Search Contribution'),
550 $form->setEmbedded(TRUE);
551 $form->setParent($this);
557 * @param array $params
558 * @param bool $sortBy
562 public function whereClause(&$params, $sortBy = TRUE) {
563 // @todo Unused local variable can be safely removed.
564 $values = $clauses = array();
565 $title = $this->get('title');
566 $createdId = $this->get('cid');
569 $clauses[] = "(created_id = {$createdId})";
573 $clauses[] = "title LIKE %1";
574 if (strpos($title, '%') !== FALSE) {
575 $params[1] = array(trim($title), 'String', FALSE);
578 $params[1] = array(trim($title), 'String', TRUE);
582 $value = $this->get('financial_type_id');
585 if (is_array($value)) {
586 foreach ($value as $k => $v) {
591 $type = implode(',', $val);
593 // @todo Variable 'type' might not have been defined.
594 $clauses[] = "financial_type_id IN ({$type})";
597 if ($sortBy && $this->_sortByCharacter
!== NULL) {
598 $clauses[] = "title LIKE '" . strtolower(CRM_Core_DAO
::escapeWildCardString($this->_sortByCharacter
)) . "%'";
601 $campaignIds = $this->getCampaignIds();
602 if (count($campaignIds) >= 1) {
603 $clauses[] = '( campaign_id IN ( ' . implode(' , ', $campaignIds) . ' ) )';
606 if (empty($clauses)) {
607 // Let template know if user has run a search or not
608 $this->assign('isSearch', 0);
612 $this->assign('isSearch', 1);
615 return implode(' AND ', $clauses);
619 * Gets the campaign ids from the session.
623 public function getCampaignIds() {
624 // The unfiltered value from the session cannot be trusted, it needs to be
625 // processed to get a clean array of positive integers.
627 foreach ((array) $this->get('campaign_id') as $id) {
628 if ((string) (int) $id === (string) $id && $id > 0) {
636 * @param $whereClause
637 * @param array $whereParams
639 public function pager($whereClause, $whereParams) {
641 $params['status'] = ts('Contribution %%StatusMessage%%');
642 $params['csvString'] = NULL;
643 $params['buttonTop'] = 'PagerTopButton';
644 $params['buttonBottom'] = 'PagerBottomButton';
645 $params['rowCount'] = $this->get(CRM_Utils_Pager
::PAGE_ROWCOUNT
);
646 if (!$params['rowCount']) {
647 $params['rowCount'] = CRM_Utils_Pager
::ROWCOUNT
;
652 FROM civicrm_contribution_page
655 $params['total'] = CRM_Core_DAO
::singleValueQuery($query, $whereParams);
657 $this->_pager
= new CRM_Utils_Pager($params);
658 $this->assign_by_ref('pager', $this->_pager
);
662 * @param $whereClause
663 * @param array $whereParams
665 public function pagerAtoZ($whereClause, $whereParams) {
668 SELECT DISTINCT UPPER(LEFT(title, 1)) as sort_name
669 FROM civicrm_contribution_page
671 ORDER BY LEFT(title, 1)
673 $dao = CRM_Core_DAO
::executeQuery($query, $whereParams);
675 $aToZBar = CRM_Utils_PagerAToZ
::getAToZBar($dao, $this->_sortByCharacter
, TRUE);
676 $this->assign('aToZ', $aToZBar);
680 * @param array $sectionsInfo
684 public function formatConfigureLinks($sectionsInfo) {
685 // build the formatted configure links.
686 $formattedConfLinks = self
::configureActionLinks();
687 foreach ($formattedConfLinks as $act => & $link) {
688 $sectionName = CRM_Utils_Array
::value('uniqueName', $link);
693 if (empty($sectionsInfo[$sectionName])) {
695 if (isset($link['class'])) {
696 $classes = $link['class'];
698 $link['class'] = array_merge($classes, array('disabled'));
702 return $formattedConfLinks;