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