Merge pull request #4939 from colemanw/CRM-15789
[civicrm-core.git] / CRM / Pledge / Form / Pledge.php
1 <?php
2 /*
3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
32 * $Id$
33 *
34 */
35
36 /**
37 * This class generates form components for processing a pledge
38 *
39 */
40 class CRM_Pledge_Form_Pledge extends CRM_Core_Form {
41 public $_action;
42
43 /**
44 * The id of the pledge that we are proceessing
45 *
46 * @var int
47 */
48 public $_id;
49
50 /**
51 * The id of the contact associated with this pledge
52 *
53 * @var int
54 */
55 public $_contactID;
56
57 /**
58 * The Pledge values if an existing pledge
59 */
60 public $_values;
61
62 /**
63 * The Pledge frequency Units
64 */
65 public $_freqUnits;
66
67 /**
68 * Is current pledge pending.
69 */
70 public $_isPending = FALSE;
71
72 /**
73 * Set variables up before form is built
74 *
75 * @return void
76 */
77 public function preProcess() {
78 $this->_contactID = CRM_Utils_Request::retrieve('cid', 'Positive', $this);
79 $this->_action = CRM_Utils_Request::retrieve('action', 'String',
80 $this, FALSE, 'add'
81 );
82 $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this);
83 $this->_context = CRM_Utils_Request::retrieve('context', 'String', $this);
84
85 // check for action permissions.
86 if (!CRM_Core_Permission::checkActionPermission('CiviPledge', $this->_action)) {
87 CRM_Core_Error::fatal(ts('You do not have permission to access this page.'));
88 }
89
90 $this->assign('action', $this->_action);
91 $this->assign('context', $this->_context);
92 if ($this->_action & CRM_Core_Action::DELETE) {
93 return;
94 }
95
96 $this->userDisplayName = $this->userEmail = NULL;
97 if ($this->_contactID) {
98 list($this->userDisplayName,
99 $this->userEmail
100 ) = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contactID);
101 $this->assign('displayName', $this->userDisplayName);
102 }
103
104 $this->setPageTitle(ts('Pledge'));
105
106 //build custom data
107 CRM_Custom_Form_CustomData::preProcess($this, NULL, NULL, 1, 'Pledge', $this->_id);
108 $this->_values = array();
109 // current pledge id
110 if ($this->_id) {
111 //get the contribution id
112 $this->_contributionID = CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_PledgePayment',
113 $this->_id, 'contribution_id', 'pledge_id'
114 );
115 $params = array('id' => $this->_id);
116 CRM_Pledge_BAO_Pledge::getValues($params, $this->_values);
117
118 $this->_isPending = (CRM_Pledge_BAO_Pledge::pledgeHasFinancialTransactions($this->_id, CRM_Utils_Array::value('status_id', $this->_values))) ? FALSE : T;
119 }
120
121 //get the pledge frequency units.
122 $this->_freqUnits = CRM_Core_OptionGroup::values('recur_frequency_units');
123
124 $this->_fromEmails = CRM_Core_BAO_Email::getFromEmail();
125 }
126
127
128 /**
129 * Set default values for the form.
130 * the default values are retrieved from the database
131 *
132 *
133 * @return void
134 */
135 public function setDefaultValues() {
136 $defaults = $this->_values;
137
138 $fields = array();
139 if ($this->_action & CRM_Core_Action::DELETE) {
140 return $defaults;
141 }
142
143 if (!empty($defaults['is_test'])) {
144 $this->assign('is_test', TRUE);
145 }
146
147 if ($this->_id) {
148 $startDate = CRM_Utils_Array::value('start_date', $this->_values);
149 $createDate = CRM_Utils_Array::value('create_date', $this->_values);
150 list($defaults['start_date']) = CRM_Utils_Date::setDateDefaults($startDate);
151 list($defaults['create_date']) = CRM_Utils_Date::setDateDefaults($createDate);
152
153 if ($ackDate = CRM_Utils_Array::value('acknowledge_date', $this->_values)) {
154 list($defaults['acknowledge_date']) = CRM_Utils_Date::setDateDefaults($ackDate);
155 }
156
157 //check is this pledge pending
158 // fix the display of the monetary value, CRM-4038
159 if ($this->_isPending) {
160 $defaults['eachPaymentAmount'] = $this->_values['amount'] / $this->_values['installments'];
161 $defaults['eachPaymentAmount'] = CRM_Utils_Money::format($defaults['eachPaymentAmount'], NULL, '%a');
162 }
163 else {
164 $this->assign('start_date', $startDate);
165 $this->assign('create_date', $createDate);
166 }
167 // fix the display of the monetary value, CRM-4038
168 if (isset($this->_values['amount'])) {
169 $defaults['amount'] = CRM_Utils_Money::format($this->_values['amount'], NULL, '%a');
170 }
171 $this->assign('amount', $this->_values['amount']);
172 $this->assign('installments', $defaults['installments']);
173 }
174 else {
175 //default values.
176 list($now) = CRM_Utils_Date::setDateDefaults();
177 $defaults['create_date'] = $now;
178 $defaults['start_date'] = $now;
179 $defaults['installments'] = 12;
180 $defaults['frequency_interval'] = 1;
181 $defaults['frequency_day'] = 1;
182 $defaults['initial_reminder_day'] = 5;
183 $defaults['max_reminders'] = 1;
184 $defaults['additional_reminder_day'] = 5;
185 $defaults['frequency_unit'] = array_search('month', $this->_freqUnits);
186 $defaults['financial_type_id'] = array_search('Donation', CRM_Contribute_PseudoConstant::financialType());
187 }
188
189 $pledgeStatus = CRM_Contribute_PseudoConstant::contributionStatus();
190 $pledgeStatusNames = CRM_Core_OptionGroup::values('contribution_status',
191 FALSE, FALSE, FALSE, NULL, 'name', TRUE
192 );
193 // get default status label (pending)
194 $defaultPledgeStatus = CRM_Utils_Array::value(array_search('Pending', $pledgeStatusNames),
195 $pledgeStatus
196 );
197
198 //assign status.
199 $this->assign('status', CRM_Utils_Array::value(CRM_Utils_Array::value('status_id', $this->_values),
200 $pledgeStatus,
201 $defaultPledgeStatus
202 ));
203
204 if (isset($this->userEmail)) {
205 $this->assign('email', $this->userEmail);
206 }
207
208 // custom data set defaults
209 $defaults += CRM_Custom_Form_CustomData::setDefaultValues($this);
210
211 return $defaults;
212 }
213
214 /**
215 * Build the form object
216 *
217 * @return void
218 */
219 public function buildQuickForm() {
220 if ($this->_action & CRM_Core_Action::DELETE) {
221 $this->addButtons(array(
222 array(
223 'type' => 'next',
224 'name' => ts('Delete'),
225 'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
226 'isDefault' => TRUE,
227 ),
228 array(
229 'type' => 'cancel',
230 'name' => ts('Cancel'),
231 ),
232 )
233 );
234 return;
235 }
236
237 if ($this->_context == 'standalone') {
238 $this->addEntityRef('contact_id', ts('Contact'), array(
239 'create' => TRUE,
240 'api' => array('extra' => array('email'))
241 ), TRUE);
242 }
243
244 $showAdditionalInfo = FALSE;
245 $this->_formType = CRM_Utils_Array::value('formType', $_GET);
246
247 $defaults = array();
248
249 $paneNames = array(
250 'Payment Reminders' => 'PaymentReminders',
251 );
252 foreach ($paneNames as $name => $type) {
253 $urlParams = "snippet=4&formType={$type}";
254 $allPanes[$name] = array(
255 'url' => CRM_Utils_System::url('civicrm/contact/view/pledge', $urlParams),
256 'open' => 'false',
257 'id' => $type,
258 );
259 //see if we need to include this paneName in the current form
260 if ($this->_formType == $type || !empty($_POST["hidden_{$type}"]) ||
261 CRM_Utils_Array::value("hidden_{$type}", $defaults)
262 ) {
263 $showAdditionalInfo = TRUE;
264 $allPanes[$name]['open'] = 'true';
265 }
266 $fnName = "build{$type}";
267 CRM_Contribute_Form_AdditionalInfo::$fnName($this);
268 }
269
270 $this->assign('allPanes', $allPanes);
271 $this->assign('showAdditionalInfo', $showAdditionalInfo);
272
273 if ($this->_formType) {
274 $this->assign('formType', $this->_formType);
275 return;
276 }
277
278 $this->applyFilter('__ALL__', 'trim');
279
280 //pledge fields.
281 $attributes = CRM_Core_DAO::getAttribute('CRM_Pledge_DAO_Pledge');
282
283 $this->assign('isPending', $this->_isPending);
284
285 $js = array(
286 'onblur' => "calculatedPaymentAmount( );",
287 'onkeyup' => "calculatedPaymentAmount( );",
288 );
289
290 $currencyFreeze = FALSE;
291 if ($this->_id &&
292 !$this->_isPending
293 ) {
294 $currencyFreeze = TRUE;
295 }
296
297 $element = $this->addMoney('amount', ts('Total Pledge Amount'), TRUE,
298 array_merge($attributes['pledge_amount'], $js), TRUE,
299 'currency', NULL, $currencyFreeze
300 );
301
302 if ($this->_id &&
303 !$this->_isPending
304 ) {
305 $element->freeze();
306 }
307
308 $element = &$this->add('text', 'installments', ts('To be paid in'),
309 array_merge($attributes['installments'], $js), TRUE
310 );
311 $this->addRule('installments', ts('Please enter a valid number of installments.'), 'positiveInteger');
312 if ($this->_id &&
313 !$this->_isPending
314 ) {
315 $element->freeze();
316 }
317
318 $element = &$this->add('text', 'frequency_interval', ts('every'),
319 $attributes['pledge_frequency_interval'], TRUE
320 );
321 $this->addRule('frequency_interval', ts('Please enter a number for frequency (e.g. every "3" months).'), 'positiveInteger');
322 if ($this->_id &&
323 !$this->_isPending
324 ) {
325 $element->freeze();
326 }
327
328 // Fix frequency unit display for use with frequency_interval
329 $freqUnitsDisplay = array();
330 foreach ($this->_freqUnits as $val => $label) {
331 $freqUnitsDisplay[$val] = ts('%1(s)', array(1 => $label));
332 }
333 $element = &$this->add('select', 'frequency_unit',
334 ts('Frequency'),
335 array(
336 '' => ts('- select -')
337 ) + $freqUnitsDisplay,
338 TRUE
339 );
340
341 if ($this->_id &&
342 !$this->_isPending
343 ) {
344 $element->freeze();
345 }
346
347 $element = &$this->add('text', 'frequency_day', ts('Payments are due on the'), $attributes['frequency_day'], TRUE);
348 $this->addRule('frequency_day', ts('Please enter a valid payment due day.'), 'positiveInteger');
349 if ($this->_id &&
350 !$this->_isPending
351 ) {
352 $element->freeze();
353 }
354
355 $this->add('text', 'eachPaymentAmount', ts('each'), array(
356 'size' => 10,
357 'style' => "background-color:#EBECE4",
358 'READONLY'
359 ));
360
361 //add various dates
362 if (!$this->_id || $this->_isPending) {
363 $this->addDate('create_date', ts('Pledge Made'), TRUE);
364 $this->addDate('start_date', ts('Payments Start'), TRUE);
365 }
366
367 if ($this->_id &&
368 !$this->_isPending
369 ) {
370 $eachPaymentAmount = $this->_values['original_installment_amount'];
371 $this->assign('currency', $this->_values['currency']);
372 $this->assign('eachPaymentAmount', $eachPaymentAmount);
373 $this->assign('hideCalender', TRUE);
374 }
375
376 if (CRM_Utils_Array::value('status_id', $this->_values) !=
377 array_search('Cancelled', CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name'))
378 ) {
379
380 $this->addElement('checkbox', 'is_acknowledge', ts('Send Acknowledgment?'), NULL,
381 array('onclick' => "showHideByValue( 'is_acknowledge', '', 'acknowledgeDate', 'table-row', 'radio', true); showHideByValue( 'is_acknowledge', '', 'fromEmail', 'table-row', 'radio', false );")
382 );
383
384 $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails);
385 }
386
387 $this->addDate('acknowledge_date', ts('Acknowledgment Date'));
388
389 $this->add('select', 'financial_type_id',
390 ts('Financial Type'),
391 array('' => ts('- select -')) + CRM_Contribute_PseudoConstant::financialType(),
392 TRUE
393 );
394
395 //CRM-7362 --add campaigns.
396 CRM_Campaign_BAO_Campaign::addCampaign($this, CRM_Utils_Array::value('campaign_id', $this->_values));
397
398 $pageIds = array();
399 CRM_Core_DAO::commonRetrieveAll('CRM_Pledge_DAO_PledgeBlock', 'entity_table',
400 'civicrm_contribution_page', $pageIds, array('entity_id')
401 );
402 $pages = CRM_Contribute_PseudoConstant::contributionPage();
403 $pledgePages = array();
404 foreach ($pageIds as $key => $value) {
405 $pledgePages[$value['entity_id']] = $pages[$value['entity_id']];
406 }
407 $ele = $this->add('select', 'contribution_page_id', ts('Self-service Payments Page'),
408 array(
409 '' => ts('- select -')
410 ) + $pledgePages
411 );
412
413 $mailingInfo = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME,
414 'mailing_backend'
415 );
416 $this->assign('outBound_option', $mailingInfo['outBound_option']);
417
418 //build custom data
419 CRM_Custom_Form_CustomData::buildQuickForm($this);
420
421 // make this form an upload since we dont know if the custom data injected dynamically
422 // is of type file etc $uploadNames = $this->get( 'uploadNames' );
423 $this->addButtons(array(
424 array(
425 'type' => 'upload',
426 'name' => ts('Save'),
427 'js' => array('onclick' => "return verify( );"),
428 'isDefault' => TRUE,
429 ),
430 array(
431 'type' => 'upload',
432 'name' => ts('Save and New'),
433 'js' => array('onclick' => "return verify( );"),
434 'subName' => 'new',
435 ),
436 array(
437 'type' => 'cancel',
438 'name' => ts('Cancel'),
439 ),
440 )
441 );
442
443 $this->addFormRule(array('CRM_Pledge_Form_Pledge', 'formRule'), $this);
444
445 if ($this->_action & CRM_Core_Action::VIEW) {
446 $this->freeze();
447 }
448 }
449
450 /**
451 * Global form rule
452 *
453 * @param array $fields
454 * The input form values.
455 * @param array $files
456 * The uploaded files if any.
457 * @param $self
458 *
459 *
460 * @return bool|array
461 * true if no errors, else array of errors
462 */
463 public static function formRule($fields, $files, $self) {
464 $errors = array();
465
466 if ($fields['amount'] <= 0) {
467 $errors['amount'] = ts('Total Pledge Amount should be greater than zero.');
468 }
469 if ($fields['installments'] <= 0) {
470 $errors['installments'] = ts('Installments should be greater than zero.');
471 }
472
473 if ($fields['frequency_unit'] != 'week') {
474 if ($fields['frequency_day'] > 31 || $fields['frequency_day'] == 0) {
475 $errors['frequency_day'] = ts('Please enter a valid frequency day ie. 1 through 31.');
476 }
477 }
478 elseif ($fields['frequency_unit'] == 'week') {
479 if ($fields['frequency_day'] > 7 || $fields['frequency_day'] == 0) {
480 $errors['frequency_day'] = ts('Please enter a valid frequency day ie. 1 through 7.');
481 }
482 }
483 return $errors;
484 }
485
486 /**
487 * Process the form submission
488 *
489 *
490 * @return void
491 */
492 public function postProcess() {
493 if ($this->_action & CRM_Core_Action::DELETE) {
494 CRM_Pledge_BAO_Pledge::deletePledge($this->_id);
495 return;
496 }
497
498 //get the submitted form values.
499 $formValues = $this->controller->exportValues($this->_name);
500
501 // set the contact, when contact is selected
502 if (!empty($formValues['contact_id'])) {
503 $this->_contactID = $formValues['contact_id'];
504 }
505
506 $session = CRM_Core_Session::singleton();
507
508 //get All Payments status types.
509 $paymentStatusTypes = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
510
511 $fields = array(
512 'frequency_unit',
513 'frequency_interval',
514 'frequency_day',
515 'installments',
516 'financial_type_id',
517 'initial_reminder_day',
518 'max_reminders',
519 'additional_reminder_day',
520 'contribution_page_id',
521 'campaign_id',
522 );
523 foreach ($fields as $f) {
524 $params[$f] = CRM_Utils_Array::value($f, $formValues);
525 }
526
527 //defaults status is "Pending".
528 //if update get status.
529 if ($this->_id) {
530 $params['pledge_status_id'] = $params['status_id'] = $this->_values['status_id'];
531 }
532 else {
533 $params['pledge_status_id'] = $params['status_id'] = array_search('Pending', $paymentStatusTypes);
534 }
535 //format amount
536 $params['amount'] = CRM_Utils_Rule::cleanMoney(CRM_Utils_Array::value('amount', $formValues));
537 $params['currency'] = CRM_Utils_Array::value('currency', $formValues);
538 $params['original_installment_amount'] = ($params['amount'] / $params['installments']);
539
540 $dates = array('create_date', 'start_date', 'acknowledge_date', 'cancel_date');
541 foreach ($dates as $d) {
542 if ($this->_id && (!$this->_isPending) && !empty($this->_values[$d])) {
543 if ($d == 'start_date') {
544 $params['scheduled_date'] = CRM_Utils_Date::processDate($this->_values[$d]);
545 }
546 $params[$d] = CRM_Utils_Date::processDate($this->_values[$d]);
547 }
548 elseif (!empty($formValues[$d]) && !CRM_Utils_System::isNull($formValues[$d])) {
549 if ($d == 'start_date') {
550 $params['scheduled_date'] = CRM_Utils_Date::processDate($formValues[$d]);
551 }
552 $params[$d] = CRM_Utils_Date::processDate($formValues[$d]);
553 }
554 else {
555 $params[$d] = 'null';
556 }
557 }
558
559 if (!empty($formValues['is_acknowledge'])) {
560 $params['acknowledge_date'] = date('Y-m-d');
561 }
562
563 // assign id only in update mode
564 if ($this->_action & CRM_Core_Action::UPDATE) {
565 $params['id'] = $this->_id;
566 }
567
568 $params['contact_id'] = $this->_contactID;
569
570 //format custom data
571 if (!empty($formValues['hidden_custom'])) {
572 $params['hidden_custom'] = 1;
573
574 $customFields = CRM_Core_BAO_CustomField::getFields('Pledge');
575 $params['custom'] = CRM_Core_BAO_CustomField::postProcess($formValues,
576 $customFields,
577 $this->_id,
578 'Pledge'
579 );
580 }
581
582 //handle pending pledge.
583 $params['is_pledge_pending'] = $this->_isPending;
584
585 //create pledge record.
586 $pledge = CRM_Pledge_BAO_Pledge::create($params);
587
588 $statusMsg = NULL;
589
590 if ($pledge->id) {
591 //set the status msg.
592 if ($this->_action & CRM_Core_Action::ADD) {
593 $statusMsg = ts('Pledge has been recorded and the payment schedule has been created.<br />');
594 }
595 elseif ($this->_action & CRM_Core_Action::UPDATE) {
596 $statusMsg = ts('Pledge has been updated.<br />');
597 }
598 }
599
600 //handle Acknowledgment.
601 if (!empty($formValues['is_acknowledge']) && $pledge->id) {
602
603 //calculate scheduled amount.
604 $params['scheduled_amount'] = round($params['amount'] / $params['installments']);
605 $params['total_pledge_amount'] = $params['amount'];
606 //get some required pledge values in params.
607 $params['id'] = $pledge->id;
608 $params['acknowledge_date'] = $pledge->acknowledge_date;
609 $params['is_test'] = $pledge->is_test;
610 $params['currency'] = $pledge->currency;
611 // retrieve 'from email id' for acknowledgement
612 $params['from_email_id'] = $formValues['from_email_address'];
613
614 $this->paymentId = NULL;
615 //send Acknowledgment mail.
616 CRM_Pledge_BAO_Pledge::sendAcknowledgment($this, $params);
617
618 if (!isset($this->userEmail)) {
619 list($this->userDisplayName,
620 $this->userEmail
621 ) = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contactID);
622 }
623
624 $statusMsg .= ' ' . ts("An acknowledgment email has been sent to %1.<br />", array(1 => $this->userEmail));
625
626 //build the payment urls.
627 if ($this->paymentId) {
628 $urlParams = "reset=1&action=add&cid={$this->_contactID}&ppid={$this->paymentId}&context=pledge";
629 $contribURL = CRM_Utils_System::url('civicrm/contact/view/contribution', $urlParams);
630 $urlParams .= "&mode=live";
631 $creditURL = CRM_Utils_System::url('civicrm/contact/view/contribution', $urlParams);
632
633 //check if we can process credit card payment.
634 $processors = CRM_Core_PseudoConstant::paymentProcessor(FALSE, FALSE,
635 "billing_mode IN ( 1, 3 )"
636 );
637 if (count($processors) > 0) {
638 $statusMsg .= ' ' . ts("If a payment is due now, you can record <a href='%1'>a check, EFT, or cash payment for this pledge</a> OR <a href='%2'>submit a credit card payment</a>.", array(
639 1 => $contribURL,
640 2 => $creditURL
641 ));
642 }
643 else {
644 $statusMsg .= ' ' . ts("If a payment is due now, you can record <a href='%1'>a check, EFT, or cash payment for this pledge</a>.", array(1 => $contribURL));
645 }
646 }
647 }
648 CRM_Core_Session::setStatus($statusMsg, ts('Payment Due'), 'info');
649
650 $buttonName = $this->controller->getButtonName();
651 if ($this->_context == 'standalone') {
652 if ($buttonName == $this->getButtonName('upload', 'new')) {
653 $session->replaceUserContext(CRM_Utils_System::url('civicrm/pledge/add',
654 'reset=1&action=add&context=standalone'
655 ));
656 }
657 else {
658 $session->replaceUserContext(CRM_Utils_System::url('civicrm/contact/view',
659 "reset=1&cid={$this->_contactID}&selectedChild=pledge"
660 ));
661 }
662 }
663 elseif ($buttonName == $this->getButtonName('upload', 'new')) {
664 $session->replaceUserContext(CRM_Utils_System::url('civicrm/contact/view/pledge',
665 "reset=1&action=add&context=pledge&cid={$this->_contactID}"
666 ));
667 }
668 }
669 }