Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
232624b1 | 4 | | CiviCRM version 4.4 | |
6a488035 TO |
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 | class CRM_PCP_BAO_PCP extends CRM_PCP_DAO_PCP { | |
36 | ||
37 | /** | |
38 | * The action links that we need to display for the browse screen | |
39 | * | |
40 | * @var array | |
41 | * @static | |
42 | */ | |
43 | static $_pcpLinks = NULL; | |
9d9922e7 | 44 | |
6a488035 TO |
45 | function __construct() { |
46 | parent::__construct(); | |
47 | } | |
48 | ||
49 | /** | |
50 | * function to add or update either a Personal Campaign Page OR a PCP Block | |
51 | * | |
52 | * @param array $params reference array contains the values submitted by the form | |
9d9922e7 | 53 | * @param bool $pcpBlock if true, create or update PCPBlock, else PCP |
6a488035 TO |
54 | * @access public |
55 | * @static | |
56 | * | |
57 | * @return object | |
58 | */ | |
59 | static function add(&$params, $pcpBlock = TRUE) { | |
60 | if ($pcpBlock) { | |
61 | // action is taken depending upon the mode | |
62 | $dao = new CRM_PCP_DAO_PCPBlock(); | |
63 | $dao->copyValues($params); | |
64 | $dao->save(); | |
65 | return $dao; | |
66 | } | |
67 | ||
68 | $dao = new CRM_PCP_DAO_PCP(); | |
69 | $dao->copyValues($params); | |
70 | ||
71 | // ensure we set status_id since it is a not null field | |
72 | // we should change the schema and allow this to be null | |
73 | if (!$dao->id && !isset($dao->status_id)) { | |
74 | $dao->status_id = 0; | |
75 | } | |
76 | ||
77 | // set currency for CRM-1496 | |
78 | if (!isset($dao->currency)) { | |
9d9922e7 | 79 | $config = & CRM_Core_Config::singleton(); |
80 | $dao->currency = $config->defaultCurrency; | |
6a488035 TO |
81 | } |
82 | ||
83 | $dao->save(); | |
84 | return $dao; | |
85 | } | |
86 | ||
87 | /** | |
88 | * function to get the Display name of a contact for a PCP | |
89 | * | |
9d9922e7 | 90 | * @param int $id id for the PCP |
6a488035 TO |
91 | * |
92 | * @return null|string Dispaly name of the contact if found | |
93 | * @static | |
94 | * @access public | |
95 | */ | |
96 | static function displayName($id) { | |
97 | $id = CRM_Utils_Type::escape($id, 'Integer'); | |
98 | ||
99 | $query = " | |
100 | SELECT civicrm_contact.display_name | |
101 | FROM civicrm_pcp, civicrm_contact | |
102 | WHERE civicrm_pcp.contact_id = civicrm_contact.id | |
103 | AND civicrm_pcp.id = {$id} | |
104 | "; | |
105 | return CRM_Core_DAO::singleValueQuery($query, CRM_Core_DAO::$_nullArray); | |
106 | } | |
107 | ||
108 | /** | |
109 | * Function to return PCP Block info for dashboard | |
110 | * | |
111 | * @return array array of Pcp if found | |
112 | * @access public | |
113 | * @static | |
114 | */ | |
115 | static function getPcpDashboardInfo($contactId) { | |
116 | $links = self::pcpLinks(); | |
117 | ||
118 | $query = " | |
119 | SELECT * FROM civicrm_pcp pcp | |
120 | WHERE pcp.is_active = 1 | |
121 | AND pcp.contact_id = %1 | |
122 | ORDER BY page_type, page_id"; | |
123 | ||
124 | $params = array(1 => array($contactId, 'Integer')); | |
125 | ||
9d9922e7 | 126 | $pcpInfoDao = CRM_Core_DAO::executeQuery($query, $params); |
127 | $pcpInfo = array(); | |
128 | $hide = $mask = array_sum(array_keys($links['all'])); | |
6a488035 TO |
129 | $contactPCPPages = array(); |
130 | ||
9d9922e7 | 131 | $event = CRM_Event_PseudoConstant::event(NULL, FALSE, "( is_template IS NULL OR is_template != 1 )"); |
6a488035 | 132 | $contribute = CRM_Contribute_PseudoConstant::contributionPage(); |
9d9922e7 | 133 | $pcpStatus = CRM_Contribute_PseudoConstant::pcpStatus(); |
134 | $approved = CRM_Utils_Array::key('Approved', $pcpStatus); | |
6a488035 TO |
135 | |
136 | while ($pcpInfoDao->fetch()) { | |
137 | $mask = $hide; | |
138 | if ($links) { | |
139 | $replace = array( | |
140 | 'pcpId' => $pcpInfoDao->id, | |
141 | 'pcpBlock' => $pcpInfoDao->pcp_block_id, | |
142 | 'pageComponent' => $pcpInfoDao->page_type, | |
143 | ); | |
144 | } | |
145 | ||
146 | $pcpLink = $links['all']; | |
147 | $class = ''; | |
148 | ||
149 | if ($pcpInfoDao->status_id != $approved || $pcpInfoDao->is_active != 1) { | |
150 | $class = 'disabled'; | |
151 | if (!$pcpInfoDao->tellfriend) { | |
152 | $mask -= CRM_Core_Action::DETACH; | |
153 | } | |
154 | } | |
155 | ||
156 | if ($pcpInfoDao->is_active == 1) { | |
157 | $mask -= CRM_Core_Action::ENABLE; | |
158 | } | |
159 | else { | |
160 | $mask -= CRM_Core_Action::DISABLE; | |
161 | } | |
87dab4a4 AH |
162 | $action = CRM_Core_Action::formLink($pcpLink, $mask, $replace, ts('more'), |
163 | FALSE, 'pcp.dashboard.active', 'PCP', $pcpInfoDao->id); | |
6a488035 TO |
164 | $component = $pcpInfoDao->page_type; |
165 | $pageTitle = CRM_Utils_Array::value($pcpInfoDao->page_id, $$component); | |
166 | ||
167 | $pcpInfo[] = array( | |
168 | 'pageTitle' => $pageTitle, | |
169 | 'pcpId' => $pcpInfoDao->id, | |
170 | 'pcpTitle' => $pcpInfoDao->title, | |
171 | 'pcpStatus' => $pcpStatus[$pcpInfoDao->status_id], | |
172 | 'action' => $action, | |
173 | 'class' => $class, | |
174 | ); | |
175 | $contactPCPPages[$pcpInfoDao->page_type][] = $pcpInfoDao->page_id; | |
176 | } | |
177 | ||
178 | $excludePageClause = $clause = NULL; | |
179 | if (!empty($contactPCPPages)) { | |
180 | foreach ($contactPCPPages as $component => $entityIds) { | |
181 | $excludePageClause[] = " | |
182 | ( target_entity_type = '{$component}' | |
183 | AND target_entity_id NOT IN ( " . implode(',', $entityIds) . ") )"; | |
184 | } | |
185 | ||
186 | $clause = ' AND ' . implode(' OR ', $excludePageClause); | |
187 | } | |
188 | ||
189 | $query = " | |
190 | SELECT * | |
191 | FROM civicrm_pcp_block block | |
192 | LEFT JOIN civicrm_pcp pcp ON pcp.pcp_block_id = block.id | |
193 | WHERE block.is_active = 1 | |
194 | {$clause} | |
195 | GROUP BY block.id | |
196 | ORDER BY target_entity_type, target_entity_id | |
197 | "; | |
198 | $pcpBlockDao = CRM_Core_DAO::executeQuery($query); | |
9d9922e7 | 199 | $pcpBlock = array(); |
200 | $mask = 0; | |
6a488035 TO |
201 | |
202 | while ($pcpBlockDao->fetch()) { | |
203 | if ($links) { | |
204 | $replace = array( | |
205 | 'pageId' => $pcpBlockDao->target_entity_id, | |
206 | 'pageComponent' => $pcpBlockDao->target_entity_type, | |
207 | ); | |
208 | } | |
9d9922e7 | 209 | $pcpLink = $links['add']; |
87dab4a4 AH |
210 | $action = CRM_Core_Action::formLink($pcpLink, $mask, $replace, ts('more'), |
211 | FALSE, 'pcp.dashboard.other', "{$pcpBlockDao->target_entity_type}_PCP", $pcpBlockDao->target_entity_id); | |
9d9922e7 | 212 | $component = $pcpBlockDao->target_entity_type; |
213 | $pageTitle = CRM_Utils_Array::value($pcpBlockDao->target_entity_id, $$component); | |
6a488035 TO |
214 | $pcpBlock[] = array( |
215 | 'pageId' => $pcpBlockDao->target_entity_id, | |
216 | 'pageTitle' => $pageTitle, | |
217 | 'action' => $action, | |
218 | ); | |
219 | } | |
220 | ||
221 | return array($pcpBlock, $pcpInfo); | |
222 | } | |
223 | ||
224 | /** | |
225 | * function to show the total amount for Personal Campaign Page on thermometer | |
226 | * | |
227 | * @param array $pcpId contains the pcp ID | |
228 | * | |
229 | * @access public | |
230 | * @static | |
231 | * | |
232 | * @return total amount | |
233 | */ | |
234 | static function thermoMeter($pcpId) { | |
235 | $query = " | |
236 | SELECT SUM(cc.total_amount) as total | |
237 | FROM civicrm_pcp pcp | |
238 | LEFT JOIN civicrm_contribution_soft cs ON ( pcp.id = cs.pcp_id ) | |
239 | LEFT JOIN civicrm_contribution cc ON ( cs.contribution_id = cc.id) | |
240 | WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; | |
241 | ||
242 | $params = array(1 => array($pcpId, 'Integer')); | |
243 | return CRM_Core_DAO::singleValueQuery($query, $params); | |
244 | } | |
245 | ||
246 | /** | |
247 | * function to show the amount, nickname on honor roll | |
248 | * | |
249 | * @param array $pcpId contains the pcp ID | |
250 | * | |
251 | * @access public | |
252 | * @static | |
253 | * | |
254 | * @return array $honor | |
255 | */ | |
256 | static function honorRoll($pcpId) { | |
257 | $query = " | |
258 | SELECT cc.id, cs.pcp_roll_nickname, cs.pcp_personal_note, | |
259 | cc.total_amount, cc.currency | |
260 | FROM civicrm_contribution cc | |
261 | LEFT JOIN civicrm_contribution_soft cs ON cc.id = cs.contribution_id | |
262 | WHERE cs.pcp_id = {$pcpId} | |
263 | AND cs.pcp_display_in_roll = 1 | |
264 | AND contribution_status_id = 1 | |
265 | AND is_test = 0"; | |
266 | $dao = CRM_Core_DAO::executeQuery($query, CRM_Core_DAO::$_nullArray); | |
267 | $honor = array(); | |
268 | while ($dao->fetch()) { | |
269 | $honor[$dao->id]['nickname'] = ucwords($dao->pcp_roll_nickname); | |
270 | $honor[$dao->id]['total_amount'] = CRM_Utils_Money::format($dao->total_amount, $dao->currency); | |
271 | $honor[$dao->id]['personal_note'] = $dao->pcp_personal_note; | |
272 | } | |
273 | return $honor; | |
274 | } | |
275 | ||
276 | /** | |
277 | * Get action links | |
278 | * | |
279 | * @return array (reference) of action links | |
280 | * @static | |
281 | */ | |
282 | static function &pcpLinks() { | |
283 | if (!(self::$_pcpLinks)) { | |
284 | $deleteExtra = ts('Are you sure you want to delete this Personal Campaign Page?') . '\n' . ts('This action cannot be undone.'); | |
285 | ||
286 | self::$_pcpLinks['add'] = array( | |
9d9922e7 | 287 | CRM_Core_Action::ADD => array( |
288 | 'name' => ts('Create a Personal Campaign Page'), | |
6a488035 TO |
289 | 'url' => 'civicrm/contribute/campaign', |
290 | 'qs' => 'action=add&reset=1&pageId=%%pageId%%&component=%%pageComponent%%', | |
291 | 'title' => ts('Configure'), | |
292 | ), | |
293 | ); | |
294 | ||
295 | self::$_pcpLinks['all'] = array( | |
9d9922e7 | 296 | CRM_Core_Action::UPDATE => array( |
297 | 'name' => ts('Edit Your Page'), | |
6a488035 TO |
298 | 'url' => 'civicrm/pcp/info', |
299 | 'qs' => 'action=update&reset=1&id=%%pcpId%%&component=%%pageComponent%%', | |
300 | 'title' => ts('Configure'), | |
301 | ), | |
9d9922e7 | 302 | CRM_Core_Action::DETACH => array( |
303 | 'name' => ts('Tell Friends'), | |
6a488035 TO |
304 | 'url' => 'civicrm/friend', |
305 | 'qs' => 'eid=%%pcpId%%&blockId=%%pcpBlock%%&reset=1&pcomponent=pcp&component=%%pageComponent%%', | |
306 | 'title' => ts('Tell Friends'), | |
307 | ), | |
9d9922e7 | 308 | CRM_Core_Action::BROWSE => array( |
309 | 'name' => ts('Update Contact Information'), | |
6a488035 TO |
310 | 'url' => 'civicrm/pcp/info', |
311 | 'qs' => 'action=browse&reset=1&id=%%pcpId%%&component=%%pageComponent%%', | |
312 | 'title' => ts('Update Contact Information'), | |
313 | ), | |
9d9922e7 | 314 | CRM_Core_Action::ENABLE => array( |
315 | 'name' => ts('Enable'), | |
6a488035 TO |
316 | 'url' => 'civicrm/pcp', |
317 | 'qs' => 'action=enable&reset=1&id=%%pcpId%%&component=%%pageComponent%%', | |
318 | 'title' => ts('Enable'), | |
319 | ), | |
9d9922e7 | 320 | CRM_Core_Action::DISABLE => array( |
321 | 'name' => ts('Disable'), | |
6a488035 TO |
322 | 'url' => 'civicrm/pcp', |
323 | 'qs' => 'action=disable&reset=1&id=%%pcpId%%&component=%%pageComponent%%', | |
324 | 'title' => ts('Disable'), | |
325 | ), | |
9d9922e7 | 326 | CRM_Core_Action::DELETE => array( |
327 | 'name' => ts('Delete'), | |
6a488035 TO |
328 | 'url' => 'civicrm/pcp', |
329 | 'qs' => 'action=delete&reset=1&id=%%pcpId%%&component=%%pageComponent%%', | |
330 | 'extra' => 'onclick = "return confirm(\'' . $deleteExtra . '\');"', | |
331 | 'title' => ts('Delete'), | |
332 | ), | |
333 | ); | |
334 | } | |
335 | return self::$_pcpLinks; | |
336 | } | |
337 | ||
338 | /** | |
339 | * Function to Delete the campaign page | |
340 | * | |
341 | * @param int $id campaign page id | |
342 | * | |
343 | * @return null | |
344 | * @access public | |
345 | * @static | |
346 | * | |
347 | */ | |
348 | public static function deleteById($id) { | |
349 | CRM_Utils_Hook::pre('delete', 'Campaign', $id, CRM_Core_DAO::$_nullArray); | |
350 | ||
351 | $transaction = new CRM_Core_Transaction(); | |
352 | ||
353 | // delete from pcp table | |
354 | $pcp = new CRM_PCP_DAO_PCP(); | |
355 | $pcp->id = $id; | |
356 | $pcp->delete(); | |
357 | ||
358 | $transaction->commit(); | |
359 | ||
360 | CRM_Utils_Hook::post('delete', 'Campaign', $id, $pcp); | |
361 | } | |
362 | ||
363 | /** | |
364 | * Function to build the form | |
365 | * | |
366 | * @param object $form form object | |
367 | * | |
368 | * @return None | |
369 | * @access public | |
370 | */ | |
cad004cf | 371 | public static function buildPCPForm($form) { |
6a488035 TO |
372 | $form->addElement('checkbox', 'pcp_active', ts('Enable Personal Campaign Pages?'), NULL, array('onclick' => "return showHideByValue('pcp_active',true,'pcpFields','block','radio',false);")); |
373 | ||
374 | $form->addElement('checkbox', 'is_approval_needed', ts('Approval required')); | |
375 | ||
9d9922e7 | 376 | $profile = array(); |
6a488035 | 377 | $isUserRequired = NULL; |
9d9922e7 | 378 | $config = CRM_Core_Config::singleton(); |
6a488035 TO |
379 | if ($config->userFramework != 'Standalone') { |
380 | $isUserRequired = 2; | |
381 | } | |
9d9922e7 | 382 | CRM_Core_DAO::commonRetrieveAll('CRM_Core_DAO_UFGroup', 'is_cms_user', $isUserRequired, $profiles, array( |
383 | 'title', | |
384 | 'is_active' | |
385 | )); | |
6a488035 TO |
386 | if (!empty($profiles)) { |
387 | foreach ($profiles as $key => $value) { | |
388 | if ($value['is_active']) { | |
389 | $profile[$key] = $value['title']; | |
390 | } | |
391 | } | |
392 | $form->assign('profile', $profile); | |
393 | } | |
394 | ||
9d9922e7 | 395 | $form->add('select', 'supporter_profile_id', ts('Supporter profile'), array('' => ts('- select -')) + $profile, TRUE); |
6a488035 TO |
396 | |
397 | $form->addElement('checkbox', 'is_tellfriend_enabled', ts("Allow 'Tell a friend' functionality"), NULL, array('onclick' => "return showHideByValue('is_tellfriend_enabled',true,'tflimit','table-row','radio',false);")); | |
398 | ||
399 | $form->add('text', | |
400 | 'tellfriend_limit', | |
401 | ts("'Tell a friend' maximum recipients limit"), | |
402 | CRM_Core_DAO::getAttribute('CRM_PCP_DAO_PCPBlock', 'tellfriend_limit') | |
403 | ); | |
404 | $form->addRule('tellfriend_limit', ts('Please enter a valid limit.'), 'integer'); | |
405 | ||
406 | $form->add('text', | |
407 | 'link_text', | |
408 | ts("'Create Personal Campaign Page' link text"), | |
409 | CRM_Core_DAO::getAttribute('CRM_PCP_DAO_PCPBlock', 'link_text') | |
410 | ); | |
411 | ||
412 | $form->add('text', 'notify_email', ts('Notify Email'), CRM_Core_DAO::getAttribute('CRM_PCP_DAO_PCPBlock', 'notify_email')); | |
413 | } | |
414 | ||
415 | ||
416 | /* | |
417 | * Add PCP form elements to a form | |
418 | */ | |
419 | function buildPcp($pcpId, &$page, &$elements = NULL) { | |
420 | ||
421 | $prms = array('id' => $pcpId); | |
422 | CRM_Core_DAO::commonRetrieve('CRM_PCP_DAO_PCP', $prms, $pcpInfo); | |
6a488035 TO |
423 | if ($pcpSupporter = CRM_PCP_BAO_PCP::displayName($pcpId)) { |
424 | if ($pcpInfo['page_type'] == 'event') { | |
eea141c0 DG |
425 | $pcp_supporter_text = ts('This event registration is being made thanks to effort of <strong>%1</strong>, who supports our campaign. ', array(1 => $pcpSupporter)); |
426 | $text = CRM_PCP_BAO_PCP::getPcpBlockStatus($pcpInfo['page_id'], 'event'); | |
427 | if(!empty($text)) { | |
428 | $pcp_supporter_text .= "You can support it as well - once you complete the registration, you will be able to create your own Personal Campaign Page!"; | |
429 | } | |
6a488035 TO |
430 | } |
431 | else { | |
eea141c0 DG |
432 | $pcp_supporter_text = ts('This contribution is being made thanks to effort of <strong>%1</strong>, who supports our campaign. ', array(1 => $pcpSupporter)); |
433 | $text = CRM_PCP_BAO_PCP::getPcpBlockStatus($pcpInfo['page_id'], 'contribute'); | |
434 | if(!empty($text)) { | |
435 | $pcp_supporter_text .= "You can support it as well - once you complete the donation, you will be able to create your own Personal Campaign Page!"; | |
436 | } | |
6a488035 | 437 | } |
eea141c0 DG |
438 | |
439 | $page->assign('pcpSupporterText', $pcp_supporter_text); | |
6a488035 TO |
440 | } |
441 | $page->assign('pcp', TRUE); | |
442 | ||
443 | // build honor roll fields for registration form if supporter has honor roll enabled for their PCP | |
444 | if ($pcpInfo['is_honor_roll']) { | |
445 | $page->assign('is_honor_roll', TRUE); | |
446 | $page->add('checkbox', 'pcp_display_in_roll', ts('Show my support in the public honor roll'), NULL, NULL, | |
447 | array('onclick' => "showHideByValue('pcp_display_in_roll','','nameID|nickID|personalNoteID','block','radio',false); pcpAnonymous( );") | |
448 | ); | |
449 | $extraOption = array('onclick' => "return pcpAnonymous( );"); | |
9d9922e7 | 450 | $elements = array(); |
451 | $elements[] = & $page->createElement('radio', NULL, '', ts('Include my name and message'), 0, $extraOption); | |
452 | $elements[] = & $page->createElement('radio', NULL, '', ts('List my support anonymously'), 1, $extraOption); | |
6a488035 TO |
453 | $page->addGroup($elements, 'pcp_is_anonymous', NULL, ' '); |
454 | $page->_defaults['pcp_is_anonymous'] = 0; | |
455 | ||
456 | $page->add('text', 'pcp_roll_nickname', ts('Name'), array('maxlength' => 30)); | |
457 | $page->add('textarea', "pcp_personal_note", ts('Personal Note'), array('style' => 'height: 3em; width: 40em;')); | |
458 | } | |
459 | else { | |
460 | $page->assign('is_honor_roll', FALSE); | |
461 | } | |
462 | } | |
463 | ||
464 | /* | |
465 | * Process a PCP contribution/ | |
466 | */ | |
9d9922e7 | 467 | public static function handlePcp($pcpId, $component, $entity) { |
6a488035 | 468 | |
9d9922e7 | 469 | self::getPcpEntityTable($component); |
6a488035 TO |
470 | |
471 | if (!$pcpId) { | |
472 | return FALSE; | |
473 | } | |
474 | ||
475 | $approvedId = CRM_Core_OptionGroup::getValue('pcp_status', 'Approved', 'name'); | |
476 | ||
2158332a | 477 | $pcpStatus = CRM_Core_OptionGroup::values("pcp_status"); |
6a488035 TO |
478 | |
479 | $params = array('id' => $pcpId); | |
480 | CRM_Core_DAO::commonRetrieve('CRM_PCP_DAO_PCP', $params, $pcpInfo); | |
481 | ||
482 | $params = array('id' => $pcpInfo['pcp_block_id']); | |
483 | CRM_Core_DAO::commonRetrieve('CRM_PCP_DAO_PCPBlock', $params, $pcpBlock); | |
484 | ||
485 | $params = array('id' => $pcpInfo['page_id']); | |
9d9922e7 | 486 | $now = time(); |
6a488035 TO |
487 | |
488 | if ($component == 'event') { | |
489 | // figure out where to redirect if an exception occurs below based on target entity | |
490 | $urlBase = 'civicrm/event/register'; | |
491 | ||
492 | // ignore startDate for events - PCP's can be active long before event start date | |
493 | $startDate = 0; | |
9d9922e7 | 494 | $endDate = CRM_Utils_Date::unixTime(CRM_Utils_Array::value('end_date', $entity)); |
6a488035 | 495 | } |
6a488035 TO |
496 | elseif ($component == 'contribute') { |
497 | $urlBase = 'civicrm/contribute/transact'; | |
498 | //start and end date of the contribution page | |
499 | $startDate = CRM_Utils_Date::unixTime(CRM_Utils_Array::value('start_date', $entity)); | |
9d9922e7 | 500 | $endDate = CRM_Utils_Date::unixTime(CRM_Utils_Array::value('end_date', $entity)); |
6a488035 TO |
501 | } |
502 | ||
503 | // define redirect url back to contrib page or event if needed | |
9d9922e7 | 504 | $url = CRM_Utils_System::url($urlBase, "reset=1&id={$pcpBlock['entity_id']}", FALSE, NULL, FALSE, TRUE ); |
6a488035 TO |
505 | |
506 | if ($pcpBlock['target_entity_id'] != $entity['id']) { | |
507 | $statusMessage = ts('This page is not related to the Personal Campaign Page you have just visited. However you can still make a contribution here.'); | |
508 | CRM_Core_Error::statusBounce($statusMessage, $url); | |
509 | } | |
510 | elseif ($pcpInfo['status_id'] != $approvedId) { | |
511 | $statusMessage = ts('The Personal Campaign Page you have just visited is currently %1. However you can still support the campaign here.', array(1 => $pcpStatus[$pcpInfo['status_id']])); | |
512 | CRM_Core_Error::statusBounce($statusMessage, $url); | |
513 | } | |
514 | elseif (!CRM_Utils_Array::value('is_active', $pcpBlock)) { | |
515 | $statusMessage = ts('Personal Campaign Pages are currently not enabled for this contribution page. However you can still support the campaign here.'); | |
516 | CRM_Core_Error::statusBounce($statusMessage, $url); | |
517 | } | |
518 | elseif (!CRM_Utils_Array::value('is_active', $pcpInfo)) { | |
519 | $statusMessage = ts('The Personal Campaign Page you have just visited is currently inactive. However you can still support the campaign here.'); | |
520 | CRM_Core_Error::statusBounce($statusMessage, $url); | |
521 | } | |
522 | // Check if we're in range for contribution page start and end dates. for events, check if after event end date | |
523 | elseif (($startDate && $startDate > $now) || ($endDate && $endDate < $now)) { | |
524 | $customStartDate = CRM_Utils_Date::customFormat(CRM_Utils_Array::value('start_date', $entity)); | |
525 | $customEndDate = CRM_Utils_Date::customFormat(CRM_Utils_Array::value('end_date', $entity)); | |
526 | if ($startDate && $endDate) { | |
527 | $statusMessage = ts('The Personal Campaign Page you have just visited is only active from %1 to %2. However you can still support the campaign here.', | |
528 | array(1 => $customStartDate, 2 => $customEndDate) | |
529 | ); | |
530 | CRM_Core_Error::statusBounce($statusMessage, $url); | |
531 | } | |
532 | elseif ($startDate) { | |
533 | $statusMessage = ts('The Personal Campaign Page you have just visited will be active beginning on %1. However you can still support the campaign here.', array(1 => $customStartDate)); | |
534 | CRM_Core_Error::statusBounce($statusMessage, $url); | |
535 | } | |
536 | elseif ($endDate) { | |
537 | if ($component == 'event') { | |
538 | // Target_entity is an event and the event is over, redirect to event info instead of event registration page. | |
539 | $url = CRM_Utils_System::url('civicrm/event/info', | |
540 | "reset=1&id={$pcpBlock['entity_id']}", | |
541 | FALSE, NULL, FALSE, TRUE | |
542 | ); | |
543 | $statusMessage = ts('The event linked to the Personal Campaign Page you have just visited is over (as of %1).', array(1 => $customEndDate)); | |
544 | CRM_Core_Error::statusBounce($statusMessage, $url); | |
9d9922e7 | 545 | } |
546 | else { | |
6a488035 TO |
547 | $statusMessage = ts('The Personal Campaign Page you have just visited is no longer active (as of %1). However you can still support the campaign here.', array(1 => $customEndDate)); |
548 | CRM_Core_Error::statusBounce($statusMessage, $url); | |
549 | } | |
550 | } | |
551 | } | |
552 | ||
553 | return array( | |
554 | 'pcpId' => $pcpId, | |
555 | 'pcpBlock' => $pcpBlock, | |
556 | 'pcpInfo' => $pcpInfo, | |
557 | ); | |
558 | } | |
559 | ||
560 | /** | |
561 | * Function to Approve / Reject the campaign page | |
562 | * | |
563 | * @param int $id campaign page id | |
564 | * | |
565 | * @return null | |
566 | * @access public | |
567 | * @static | |
568 | * | |
569 | */ | |
570 | static function setIsActive($id, $is_active) { | |
571 | switch ($is_active) { | |
572 | case 0: | |
573 | $is_active = 3; | |
574 | break; | |
575 | ||
576 | case 1: | |
577 | $is_active = 2; | |
578 | break; | |
579 | } | |
580 | ||
581 | CRM_Core_DAO::setFieldValue('CRM_PCP_DAO_PCP', $id, 'status_id', $is_active); | |
582 | ||
9d9922e7 | 583 | $pcpTitle = CRM_Core_DAO::getFieldValue('CRM_PCP_DAO_PCP', $id, 'title'); |
584 | $pcpPageType = CRM_Core_DAO::getFieldValue('CRM_PCP_DAO_PCP', $id, 'page_type'); | |
6a488035 | 585 | |
2158332a | 586 | $pcpStatus = CRM_Core_OptionGroup::values("pcp_status"); |
6a488035 TO |
587 | $pcpStatus = $pcpStatus[$is_active]; |
588 | ||
9d9922e7 | 589 | CRM_Core_Session::setStatus(ts("%1 status has been updated to %2.", array( |
590 | 1 => $pcpTitle, | |
591 | 2 => $pcpStatus | |
592 | )), 'Status Updated', 'success'); | |
6a488035 TO |
593 | |
594 | // send status change mail | |
595 | $result = self::sendStatusUpdate($id, $is_active, FALSE, $pcpPageType); | |
596 | ||
597 | if ($result) { | |
598 | CRM_Core_Session::setStatus(ts("A notification email has been sent to the supporter."), ts('Email Sent'), 'success'); | |
599 | } | |
600 | } | |
601 | ||
602 | /** | |
603 | * Function to send notfication email to supporter | |
604 | * 1. when their PCP status is changed by site admin. | |
605 | * 2. when supporter initially creates a Personal Campaign Page ($isInitial set to true). | |
606 | * | |
607 | * @param int $pcpId campaign page id | |
608 | * @param int $newStatus pcp status id | |
609 | * @param int $isInitial is it the first time, campaign page has been created by the user | |
610 | * | |
611 | * @return null | |
612 | * @access public | |
613 | * @static | |
614 | * | |
615 | */ | |
616 | static function sendStatusUpdate($pcpId, $newStatus, $isInitial = FALSE, $component = 'contribute') { | |
2158332a | 617 | $pcpStatus = CRM_Core_OptionGroup::values("pcp_status"); |
6a488035 TO |
618 | $config = CRM_Core_Config::singleton(); |
619 | ||
620 | if (!isset($pcpStatus[$newStatus])) { | |
621 | return FALSE; | |
622 | } | |
623 | ||
624 | require_once 'Mail/mime.php'; | |
625 | ||
626 | //set loginUrl | |
627 | $loginURL = $config->userSystem->getLoginURL(); | |
628 | ||
629 | // used in subject templates | |
630 | $contribPageTitle = self::getPcpPageTitle($pcpId, $component); | |
631 | ||
632 | $tplParams = array( | |
633 | 'loginUrl' => $loginURL, | |
634 | 'contribPageTitle' => $contribPageTitle, | |
635 | 'pcpId' => $pcpId, | |
636 | ); | |
637 | ||
638 | //get the default domain email address. | |
639 | list($domainEmailName, $domainEmailAddress) = CRM_Core_BAO_Domain::getNameAndEmail(); | |
640 | ||
641 | if (!$domainEmailAddress || $domainEmailAddress == 'info@EXAMPLE.ORG') { | |
642 | $fixUrl = CRM_Utils_System::url("civicrm/admin/domain", 'action=update&reset=1'); | |
643 | CRM_Core_Error::fatal(ts('The site administrator needs to enter a valid \'FROM Email Address\' in <a href="%1">Administer CiviCRM » Communications » FROM Email Addresses</a>. The email address used may need to be a valid mail account with your email service provider.', array(1 => $fixUrl))); | |
644 | } | |
645 | ||
646 | $receiptFrom = '"' . $domainEmailName . '" <' . $domainEmailAddress . '>'; | |
647 | ||
648 | // get recipient (supporter) name and email | |
649 | $params = array('id' => $pcpId); | |
650 | CRM_Core_DAO::commonRetrieve('CRM_PCP_DAO_PCP', $params, $pcpInfo); | |
651 | list($name, $address) = CRM_Contact_BAO_Contact_Location::getEmailDetails($pcpInfo['contact_id']); | |
652 | ||
653 | // get pcp block info | |
654 | list($blockId, $eid) = self::getPcpBlockEntityId($pcpId, $component); | |
655 | $params = array('id' => $blockId); | |
656 | CRM_Core_DAO::commonRetrieve('CRM_PCP_DAO_PCPBlock', $params, $pcpBlockInfo); | |
657 | ||
658 | // assign urls required in email template | |
659 | if ($pcpStatus[$newStatus] == 'Approved') { | |
660 | $tplParams['isTellFriendEnabled'] = $pcpBlockInfo['is_tellfriend_enabled']; | |
661 | if ($pcpBlockInfo['is_tellfriend_enabled']) { | |
662 | $pcpTellFriendURL = CRM_Utils_System::url('civicrm/friend', | |
663 | "reset=1&eid=$pcpId&blockId=$blockId&pcomponent=pcp", | |
664 | TRUE, NULL, FALSE, TRUE | |
665 | ); | |
666 | $tplParams['pcpTellFriendURL'] = $pcpTellFriendURL; | |
667 | } | |
668 | } | |
669 | $pcpInfoURL = CRM_Utils_System::url('civicrm/pcp/info', | |
670 | "reset=1&id=$pcpId", | |
671 | TRUE, NULL, FALSE, TRUE | |
672 | ); | |
673 | $tplParams['pcpInfoURL'] = $pcpInfoURL; | |
674 | $tplParams['contribPageTitle'] = $contribPageTitle; | |
675 | if ($emails = CRM_Utils_Array::value('notify_email', $pcpBlockInfo)) { | |
676 | $emailArray = explode(',', $emails); | |
677 | $tplParams['pcpNotifyEmailAddress'] = $emailArray[0]; | |
678 | } | |
679 | // get appropriate message based on status | |
680 | $tplParams['pcpStatus'] = $pcpStatus[$newStatus]; | |
681 | ||
682 | $tplName = $isInitial ? 'pcp_supporter_notify' : 'pcp_status_change'; | |
683 | ||
c6327d7d | 684 | list($sent, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate::sendTemplate( |
6a488035 TO |
685 | array( |
686 | 'groupName' => 'msg_tpl_workflow_contribution', | |
687 | 'valueName' => $tplName, | |
688 | 'contactId' => $pcpInfo['contact_id'], | |
689 | 'tplParams' => $tplParams, | |
690 | 'from' => $receiptFrom, | |
691 | 'toName' => $name, | |
692 | 'toEmail' => $address, | |
693 | ) | |
694 | ); | |
695 | return $sent; | |
696 | } | |
697 | ||
698 | /** | |
699 | * Function to Enable / Disable the campaign page | |
700 | * | |
701 | * @param int $id campaign page id | |
702 | * | |
703 | * @return null | |
704 | * @access public | |
705 | * @static | |
706 | * | |
707 | */ | |
708 | static function setDisable($id, $is_active) { | |
709 | return CRM_Core_DAO::setFieldValue('CRM_PCP_DAO_PCP', $id, 'is_active', $is_active); | |
710 | } | |
711 | ||
712 | /** | |
713 | * Function to get pcp block is active | |
714 | * | |
715 | * @param int $id campaign page id | |
716 | * | |
717 | * @return int | |
718 | * @access public | |
719 | * @static | |
720 | * | |
721 | */ | |
722 | static function getStatus($pcpId, $component) { | |
723 | $query = " | |
724 | SELECT pb.is_active | |
725 | FROM civicrm_pcp pcp | |
726 | LEFT JOIN civicrm_pcp_block pb ON ( pcp.page_id = pb.entity_id ) | |
727 | WHERE pcp.id = %1 | |
728 | AND pb.entity_table = %2"; | |
729 | ||
730 | $entity_table = self::getPcpEntityTable($component); | |
731 | ||
732 | $params = array(1 => array($pcpId, 'Integer'), 2 => array($entity_table, 'String')); | |
733 | return CRM_Core_DAO::singleValueQuery($query, $params); | |
734 | } | |
735 | ||
736 | /** | |
737 | * Function to get pcp block is enabled for component page | |
738 | * | |
739 | * @param int $id contribution page id | |
740 | * | |
741 | * @return String | |
742 | * @access public | |
743 | * @static | |
744 | * | |
745 | */ | |
746 | static function getPcpBlockStatus($pageId, $component) { | |
747 | $query = " | |
748 | SELECT pb.link_text as linkText | |
eea141c0 DG |
749 | FROM civicrm_pcp_block pb |
750 | WHERE pb.is_active = 1 AND | |
751 | pb.entity_id = %1 AND | |
752 | pb.entity_table = %2"; | |
6a488035 TO |
753 | |
754 | $entity_table = self::getPcpEntityTable($component); | |
755 | ||
756 | $params = array(1 => array($pageId, 'Integer'), 2 => array($entity_table, 'String')); | |
757 | return CRM_Core_DAO::singleValueQuery($query, $params); | |
758 | } | |
759 | ||
760 | /** | |
761 | * Function to find out if the PCP block is in use by one or more PCP page | |
762 | * | |
763 | * @param int $id pcp block id | |
764 | * | |
765 | * @return Boolean | |
766 | * @access public | |
767 | * @static | |
768 | * | |
769 | */ | |
770 | static function getPcpBlockInUse($id) { | |
771 | $query = " | |
772 | SELECT count(*) | |
773 | FROM civicrm_pcp pcp | |
774 | WHERE pcp.pcp_block_id = %1"; | |
775 | ||
776 | $params = array(1 => array($id, 'Integer')); | |
777 | $result = CRM_Core_DAO::singleValueQuery($query, $params); | |
778 | return $result > 0; | |
779 | } | |
780 | ||
781 | /** | |
782 | * Function to get email is enabled for supporter's profile | |
783 | * | |
784 | * @param int $id supporter's profile id | |
785 | * | |
786 | * @return boolean | |
787 | * @access public | |
788 | * @static | |
789 | * | |
790 | */ | |
791 | static function checkEmailProfile($profileId) { | |
792 | $query = " | |
793 | SELECT field_name | |
794 | FROM civicrm_uf_field | |
795 | WHERE field_name like 'email%' And is_active = 1 And uf_group_id = %1"; | |
796 | ||
797 | $params = array(1 => array($profileId, 'Integer')); | |
798 | $dao = CRM_Core_DAO::executeQuery($query, $params); | |
799 | if (!$dao->fetch()) { | |
800 | return TRUE; | |
801 | } | |
802 | return FALSE; | |
803 | } | |
804 | ||
805 | /** | |
806 | * Function to obtain the title of page associated with a pcp | |
807 | * | |
808 | * @param int $id campaign page id | |
809 | * | |
810 | * @return int | |
811 | * @access public | |
812 | * @static | |
813 | * | |
814 | */ | |
815 | static function getPcpPageTitle($pcpId, $component) { | |
816 | if ($component == 'contribute') { | |
817 | $query = " | |
818 | SELECT cp.title | |
819 | FROM civicrm_pcp pcp | |
820 | LEFT JOIN civicrm_contribution_page as cp ON ( cp.id = pcp.page_id ) | |
821 | WHERE pcp.id = %1"; | |
822 | } | |
823 | elseif ($component == 'event') { | |
824 | $query = " | |
825 | SELECT ce.title | |
826 | FROM civicrm_pcp pcp | |
827 | LEFT JOIN civicrm_event as ce ON ( ce.id = pcp.page_id ) | |
828 | WHERE pcp.id = %1"; | |
829 | } | |
830 | ||
831 | $params = array(1 => array($pcpId, 'Integer')); | |
832 | return CRM_Core_DAO::singleValueQuery($query, $params); | |
833 | } | |
834 | ||
835 | /** | |
836 | * Function to get pcp block & entity id given pcp id | |
837 | * | |
838 | * @param int $id campaign page id | |
839 | * | |
840 | * @return String | |
841 | * @access public | |
842 | * @static | |
843 | * | |
844 | */ | |
845 | static function getPcpBlockEntityId($pcpId, $component) { | |
846 | $entity_table = self::getPcpEntityTable($component); | |
847 | ||
848 | $query = " | |
849 | SELECT pb.id as pcpBlockId, pb.entity_id | |
850 | FROM civicrm_pcp pcp | |
851 | LEFT JOIN civicrm_pcp_block pb ON ( pb.entity_id = pcp.page_id AND pb.entity_table = %2 ) | |
852 | WHERE pcp.id = %1"; | |
853 | ||
854 | $params = array(1 => array($pcpId, 'Integer'), 2 => array($entity_table, 'String')); | |
855 | $dao = CRM_Core_DAO::executeQuery($query, $params); | |
856 | if ($dao->fetch()) { | |
857 | return array($dao->pcpBlockId, $dao->entity_id); | |
858 | } | |
859 | ||
860 | return array(); | |
861 | } | |
862 | ||
863 | /** | |
864 | * Function to get pcp entity table given a component. | |
865 | * | |
866 | * @param int $id campaign page id | |
867 | * | |
868 | * @return String | |
869 | * @access public | |
870 | * @static | |
871 | * | |
872 | */ | |
873 | static function getPcpEntityTable($component) { | |
874 | $entity_table_map = array( | |
875 | 'event' => 'civicrm_event', | |
876 | 'civicrm_event' => 'civicrm_event', | |
877 | 'contribute' => 'civicrm_contribution_page', | |
878 | 'civicrm_contribution_page' => 'civicrm_contribution_page', | |
879 | ); | |
880 | return isset($entity_table_map[$component]) ? $entity_table_map[$component] : FALSE; | |
881 | } | |
882 | ||
883 | /** | |
884 | * Function to get supporter profile id | |
885 | * | |
886 | * @param int $contributionPageId contribution page id | |
887 | * | |
888 | * @return int | |
889 | * @access public | |
890 | * | |
891 | */ | |
892 | public function getSupporterProfileId($component_id, $component = 'contribute') { | |
893 | $entity_table = self::getPcpEntityTable($component); | |
894 | ||
895 | $query = " | |
896 | SELECT pcp.supporter_profile_id | |
897 | FROM civicrm_pcp_block pcp | |
898 | INNER JOIN civicrm_uf_group ufgroup | |
899 | ON pcp.supporter_profile_id = ufgroup.id | |
900 | WHERE pcp.entity_id = %1 | |
901 | AND pcp.entity_table = %2 | |
902 | AND ufgroup.is_active = 1"; | |
903 | ||
904 | $params = array(1 => array($component_id, 'Integer'), 2 => array($entity_table, 'String')); | |
905 | if (!$supporterProfileId = CRM_Core_DAO::singleValueQuery($query, $params)) { | |
906 | CRM_Core_Error::fatal(ts('Supporter profile is not set for this Personal Campaign Page or the profile is disabled. Please contact the site administrator if you need assistance.')); | |
907 | } | |
908 | else { | |
909 | return $supporterProfileId; | |
910 | } | |
911 | } | |
912 | } | |
913 |