3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
35 class CRM_Pledge_BAO_Pledge
extends CRM_Pledge_DAO_Pledge
{
38 * Static field for all the pledge information that we can potentially export
43 static $_exportableFields = NULL;
48 function __construct() {
49 parent
::__construct();
53 * Takes a bunch of params that are needed to match certain criteria and
54 * retrieves the relevant objects. Typically the valid params are only
55 * pledge id. We'll tweak this function to be more full featured over a period
56 * of time. This is the inverse function of create. It also stores all the retrieved
57 * values in the default array
59 * @param array $params (reference ) an assoc array of name/value pairs
60 * @param array $defaults (reference ) an assoc array to hold the flattened values
62 * @return CRM_Pledge_BAO_Pledge object
66 static function retrieve(&$params, &$defaults) {
67 $pledge = new CRM_Pledge_DAO_Pledge();
68 $pledge->copyValues($params);
69 if ($pledge->find(TRUE)) {
70 CRM_Core_DAO
::storeValues($pledge, $defaults);
79 * @param array $params reference array contains the values submitted by the form
86 static function add(&$params) {
87 if (!empty($params['id'])) {
88 CRM_Utils_Hook
::pre('edit', 'Pledge', $params['id'], $params);
91 CRM_Utils_Hook
::pre('create', 'Pledge', NULL, $params);
94 $pledge = new CRM_Pledge_DAO_Pledge();
96 // if pledge is complete update end date as current date
97 if ($pledge->status_id
== 1) {
98 $pledge->end_date
= date('Ymd');
101 $pledge->copyValues($params);
103 // set currency for CRM-1496
104 if (!isset($pledge->currency
)) {
105 $config = CRM_Core_Config
::singleton();
106 $pledge->currency
= $config->defaultCurrency
;
109 $result = $pledge->save();
111 if (!empty($params['id'])) {
112 CRM_Utils_Hook
::post('edit', 'Pledge', $pledge->id
, $pledge);
115 CRM_Utils_Hook
::post('create', 'Pledge', $pledge->id
, $pledge);
122 * Given the list of params in the params array, fetch the object
123 * and store the values in the values array
125 * @param array $params input parameters to find object
126 * @param array $values output values of the object
127 * @param array $returnProperties if you want to return specific fields
129 * @return array associated array of field values
133 static function &getValues(&$params, &$values, $returnProperties = NULL) {
134 if (empty($params)) {
137 CRM_Core_DAO
::commonRetrieve('CRM_Pledge_BAO_Pledge', $params, $values, $returnProperties);
142 * Takes an associative array and creates a pledge object
144 * @param array $params (reference ) an assoc array of name/value pairs
146 * @return CRM_Pledge_BAO_Pledge object
150 static function &create(&$params) {
151 //FIXME: a cludgy hack to fix the dates to MySQL format
152 $dateFields = array('start_date', 'create_date', 'acknowledge_date', 'modified_date', 'cancel_date', 'end_date');
153 foreach ($dateFields as $df) {
154 if (isset($params[$df])) {
155 $params[$df] = CRM_Utils_Date
::isoToMysql($params[$df]);
159 $transaction = new CRM_Core_Transaction();
161 $paymentParams = array();
162 $paymentParams['status_id'] = CRM_Utils_Array
::value('status_id', $params);
163 if (!empty($params['installment_amount'])) {
164 $params['amount'] = $params['installment_amount'] * $params['installments'];
167 //get All Payments status types.
168 $paymentStatusTypes = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
170 //update the pledge status only if it does NOT come from form
171 if (!isset($params['pledge_status_id'])) {
172 if (isset($params['contribution_id'])) {
173 if ($params['installments'] > 1) {
174 $params['status_id'] = array_search('In Progress', $paymentStatusTypes);
178 if (!empty($params['id'])) {
179 $params['status_id'] = CRM_Pledge_BAO_PledgePayment
::calculatePledgeStatus($params['id']);
182 $params['status_id'] = array_search('Pending', $paymentStatusTypes);
187 $pledge = self
::add($params);
188 if (is_a($pledge, 'CRM_Core_Error')) {
193 //handle custom data.
194 if (!empty($params['custom']) &&
195 is_array($params['custom'])
197 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_pledge', $pledge->id
);
200 // skip payment stuff inedit mode
201 if (!isset($params['id']) ||
!empty($params['is_pledge_pending'])) {
204 //if pledge is pending delete all payments and recreate.
205 if (!empty($params['is_pledge_pending'])) {
206 CRM_Pledge_BAO_PledgePayment
::deletePayments($pledge->id
);
209 //building payment params
210 $paymentParams['pledge_id'] = $pledge->id
;
211 $paymentKeys = array(
212 'amount', 'installments', 'scheduled_date', 'frequency_unit', 'currency',
213 'frequency_day', 'frequency_interval', 'contribution_id', 'installment_amount', 'actual_amount',
215 foreach ($paymentKeys as $key) {
216 $paymentParams[$key] = CRM_Utils_Array
::value($key, $params, NULL);
218 CRM_Pledge_BAO_PledgePayment
::create($paymentParams);
221 $transaction->commit();
223 $url = CRM_Utils_System
::url('civicrm/contact/view/pledge',
224 "action=view&reset=1&id={$pledge->id}&cid={$pledge->contact_id}&context=home"
227 $recentOther = array();
228 if (CRM_Core_Permission
::checkActionPermission('CiviPledge', CRM_Core_Action
::UPDATE
)) {
229 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/contact/view/pledge',
230 "action=update&reset=1&id={$pledge->id}&cid={$pledge->contact_id}&context=home"
233 if (CRM_Core_Permission
::checkActionPermission('CiviPledge', CRM_Core_Action
::DELETE
)) {
234 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/contact/view/pledge',
235 "action=delete&reset=1&id={$pledge->id}&cid={$pledge->contact_id}&context=home"
239 $contributionTypes = CRM_Contribute_PseudoConstant
::financialType();
240 $title = CRM_Contact_BAO_Contact
::displayName($pledge->contact_id
) . ' - (' . ts('Pledged') . ' ' . CRM_Utils_Money
::format($pledge->amount
, $pledge->currency
) . ' - ' . CRM_Utils_Array
::value($pledge->financial_type_id
, $contributionTypes) . ')';
242 // add the recently created Pledge
243 CRM_Utils_Recent
::add($title,
258 * @param int $id pledge id
265 static function deletePledge($id) {
266 CRM_Utils_Hook
::pre('delete', 'Pledge', $id, CRM_Core_DAO
::$_nullArray);
268 $transaction = new CRM_Core_Transaction();
270 //check for no Completed Payment records with the pledge
271 $payment = new CRM_Pledge_DAO_PledgePayment();
272 $payment->pledge_id
= $id;
275 while ($payment->fetch()) {
276 //also delete associated contribution.
277 if ($payment->contribution_id
) {
278 CRM_Contribute_BAO_Contribution
::deleteContribution($payment->contribution_id
);
283 $dao = new CRM_Pledge_DAO_Pledge();
285 $results = $dao->delete();
287 $transaction->commit();
289 CRM_Utils_Hook
::post('delete', 'Pledge', $dao->id
, $dao);
291 // delete the recently created Pledge
292 $pledgeRecent = array(
296 CRM_Utils_Recent
::del($pledgeRecent);
302 * Get the amount details date wise.
304 * @param string $status
305 * @param string $startDate
306 * @param string $endDate
310 static function getTotalAmountAndCount($status = NULL, $startDate = NULL, $endDate = NULL) {
312 $select = $from = $queryDate = NULL;
314 $allStatus = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
315 $statusId = array_search($status, $allStatus);
319 $statusId = array_search('Cancelled', $allStatus);
320 $where[] = 'status_id != ' . $statusId;
324 $where[] = 'status_id = ' . $statusId;
328 $where[] = 'status_id = ' . $statusId;
332 $where[] = 'status_id = ' . $statusId;
336 $where[] = 'status_id = ' . $statusId;
341 $where[] = "create_date >= '" . CRM_Utils_Type
::escape($startDate, 'Timestamp') . "'";
344 $where[] = "create_date <= '" . CRM_Utils_Type
::escape($endDate, 'Timestamp') . "'";
347 $whereCond = implode(' AND ', $where);
350 SELECT sum( amount ) as pledge_amount, count( id ) as pledge_count, currency
352 WHERE $whereCond AND is_test=0
355 $start = substr($startDate, 0, 8);
356 $end = substr($endDate, 0, 8);
359 $dao = CRM_Core_DAO
::executeQuery($query, CRM_Core_DAO
::$_nullArray);
360 while ($dao->fetch()) {
361 $pCount +
= $dao->pledge_count
;
362 $pamount[] = CRM_Utils_Money
::format($dao->pledge_amount
, $dao->currency
);
365 $pledge_amount = array('pledge_amount' => implode(', ', $pamount),
366 'pledge_count' => $pCount,
367 'purl' => CRM_Utils_System
::url('civicrm/pledge/search',
368 "reset=1&force=1&pstatus={$statusId}&pstart={$start}&pend={$end}&test=0"
373 $statusId = array_search($status, $allStatus);
376 $select = 'sum( total_amount ) as received_pledge , count( cd.id ) as received_count';
377 $where[] = 'cp.status_id = ' . $statusId . ' AND cp.contribution_id = cd.id AND cd.is_test=0';
378 $queryDate = 'receive_date';
379 $from = ' civicrm_contribution cd, civicrm_pledge_payment cp';
383 $select = 'sum( total_amount ) as received_pledge , count( cd.id ) as received_count';
384 $where[] = 'cp.status_id = ' . $statusId . ' AND cp.contribution_id = cd.id AND cd.is_test=0';
385 $queryDate = 'receive_date';
386 $from = ' civicrm_contribution cd, civicrm_pledge_payment cp';
390 $select = 'sum( scheduled_amount )as received_pledge , count( cp.id ) as received_count';
391 $where[] = 'cp.status_id = ' . $statusId . ' AND pledge.is_test=0';
392 $queryDate = 'scheduled_date';
393 $from = ' civicrm_pledge_payment cp INNER JOIN civicrm_pledge pledge on cp.pledge_id = pledge.id';
397 $select = 'sum( scheduled_amount ) as received_pledge , count( cp.id ) as received_count';
398 $where[] = 'cp.status_id = ' . $statusId . ' AND pledge.is_test=0';
399 $queryDate = 'scheduled_date';
400 $from = ' civicrm_pledge_payment cp INNER JOIN civicrm_pledge pledge on cp.pledge_id = pledge.id';
405 $where[] = " $queryDate >= '" . CRM_Utils_Type
::escape($startDate, 'Timestamp') . "'";
408 $where[] = " $queryDate <= '" . CRM_Utils_Type
::escape($endDate, 'Timestamp') . "'";
411 $whereCond = implode(' AND ', $where);
414 SELECT $select, cp.currency
420 $dao = CRM_Core_DAO
::executeQuery($query, CRM_Core_DAO
::$_nullArray);
424 while ($dao->fetch()) {
425 $count +
= $dao->received_count
;
426 $amount[] = CRM_Utils_Money
::format($dao->received_pledge
, $dao->currency
);
430 return array_merge($pledge_amount, array('received_amount' => implode(', ', $amount),
431 'received_count' => $count,
432 'url' => CRM_Utils_System
::url('civicrm/pledge/search',
433 "reset=1&force=1&status={$statusId}&start={$start}&end={$end}&test=0"
439 return $pledge_amount;
445 * Get list of pledges In Honor of contact Ids
447 * @param int $honorId In Honor of Contact ID
449 * @return array return the list of pledge fields
454 static function getHonorContacts($honorId) {
456 $honorDAO = new CRM_Contribute_DAO_ContributionSoft();
457 $honorDAO->contact_id
= $honorId;
461 while ($honorDAO->fetch()) {
462 $pledgePaymentDAO = new CRM_Pledge_DAO_PledgePayment();
463 $pledgePaymentDAO->contribution_id
= $honorDAO->contribution_id
;
464 if ($pledgePaymentDAO->find(TRUE)) {
465 $pledgeDAO = new CRM_Pledge_DAO_Pledge();
466 $pledgeDAO->id
= $pledgePaymentDAO->pledge_id
;
467 if ($pledgeDAO->find(TRUE)) {
468 $params[$pledgeDAO->id
] = array(
469 'honor_type' => CRM_Core_OptionGroup
::getLabel('soft_credit_type', $honorDAO->soft_credit_type_id
, 'value'),
470 'honorId' => $pledgeDAO->contact_id
,
471 'amount' => $pledgeDAO->amount
,
472 'status' => CRM_Contribute_PseudoConstant
::contributionStatus($pledgeDAO->status_id
),
473 'create_date' => $pledgeDAO->create_date
,
474 'acknowledge_date' => $pledgeDAO->acknowledge_date
,
475 'type' => CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialType',
476 $pledgeDAO->financial_type_id
, 'name'
478 'display_name' => CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
479 $pledgeDAO->contact_id
, 'display_name'
490 * Send Acknowledgment and create activity.
492 * @param CRM_Core_Form $form form object.
493 * @param array $params an assoc array of name/value pairs.
498 static function sendAcknowledgment(&$form, $params) {
499 //handle Acknowledgment.
500 $allPayments = $payments = array();
502 //get All Payments status types.
503 $paymentStatusTypes = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
504 $returnProperties = array('status_id', 'scheduled_amount', 'scheduled_date', 'contribution_id');
505 //get all paymnets details.
506 CRM_Core_DAO
::commonRetrieveAll('CRM_Pledge_DAO_PledgePayment', 'pledge_id', $params['id'], $allPayments, $returnProperties);
508 if (!empty($allPayments)) {
509 foreach ($allPayments as $payID => $values) {
510 $contributionValue = $contributionStatus = array();
511 if (isset($values['contribution_id'])) {
512 $contributionParams = array('id' => $values['contribution_id']);
513 $returnProperties = array('contribution_status_id', 'receive_date');
514 CRM_Core_DAO
::commonRetrieve('CRM_Contribute_DAO_Contribution',
515 $contributionParams, $contributionStatus, $returnProperties
517 $contributionValue = array(
518 'status' => CRM_Utils_Array
::value('contribution_status_id', $contributionStatus),
519 'receive_date' => CRM_Utils_Array
::value('receive_date', $contributionStatus),
522 $payments[$payID] = array_merge($contributionValue,
523 array('amount' => CRM_Utils_Array
::value('scheduled_amount', $values),
524 'due_date' => CRM_Utils_Array
::value('scheduled_date', $values),
528 //get the first valid payment id.
529 if (!isset($form->paymentId
) && ($paymentStatusTypes[$values['status_id']] == 'Pending' ||
530 $paymentStatusTypes[$values['status_id']] == 'Overdue'
532 $form->paymentId
= $values['id'];
537 //assign pledge fields value to template.
538 $pledgeFields = array(
539 'create_date', 'total_pledge_amount', 'frequency_interval', 'frequency_unit',
540 'installments', 'frequency_day', 'scheduled_amount', 'currency',
542 foreach ($pledgeFields as $field) {
543 if (!empty($params[$field])) {
544 $form->assign($field, $params[$field]);
548 //assign all payments details.
550 $form->assign('payments', $payments);
553 //handle domain token values
554 $domain = CRM_Core_BAO_Domain
::getDomain();
555 $tokens = array('domain' => array('name', 'phone', 'address', 'email'),
556 'contact' => CRM_Core_SelectValues
::contactTokens(),
558 $domainValues = array();
559 foreach ($tokens['domain'] as $token) {
560 $domainValues[$token] = CRM_Utils_Token
::getDomainTokenReplacement($token, $domain);
562 $form->assign('domain', $domainValues);
564 //handle contact token values.
565 $ids = array($params['contact_id']);
566 $fields = array_merge(array_keys(CRM_Contact_BAO_Contact
::importableFields()),
567 array('display_name', 'checksum', 'contact_id')
569 foreach ($fields as $key => $val) {
570 $returnProperties[$val] = TRUE;
572 $details = CRM_Utils_Token
::getTokenDetails($ids,
578 $form->assign('contact', $details[0][$params['contact_id']]);
580 //handle custom data.
581 if (!empty($params['hidden_custom'])) {
582 $groupTree = CRM_Core_BAO_CustomGroup
::getTree('Pledge', CRM_Core_DAO
::$_nullObject, $params['id']);
583 $pledgeParams = array(array('pledge_id', '=', $params['id'], 0, 0));
584 $customGroup = array();
585 // retrieve custom data
586 foreach ($groupTree as $groupID => $group) {
587 $customFields = $customValues = array();
588 if ($groupID == 'info') {
591 foreach ($group['fields'] as $k => $field) {
592 $field['title'] = $field['label'];
593 $customFields["custom_{$k}"] = $field;
596 //to build array of customgroup & customfields in it
597 CRM_Core_BAO_UFGroup
::getValues($params['contact_id'], $customFields, $customValues, FALSE, $pledgeParams);
598 $customGroup[$group['title']] = $customValues;
601 $form->assign('customGroup', $customGroup);
604 //handle acknowledgment email stuff.
605 list($pledgerDisplayName,
607 ) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($params['contact_id']);
609 //check for online pledge.
610 $session = CRM_Core_Session
::singleton();
611 if (!empty($params['receipt_from_email'])) {
612 $userName = CRM_Utils_Array
::value('receipt_from_name', $params);
613 $userEmail = CRM_Utils_Array
::value('receipt_from_email', $params);
615 elseif (!empty($params['from_email_id'])) {
616 $receiptFrom = $params['from_email_id'];
618 elseif ($userID = $session->get('userID')) {
619 //check for logged in user.
620 list($userName, $userEmail) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($userID);
623 //set the domain values.
624 $userName = CRM_Utils_Array
::value('name', $domainValues);
625 $userEmail = CRM_Utils_Array
::value('email', $domainValues);
628 if (!isset($receiptFrom)) {
629 $receiptFrom = "$userName <$userEmail>";
632 list($sent, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate
::sendTemplate(
634 'groupName' => 'msg_tpl_workflow_pledge',
635 'valueName' => 'pledge_acknowledge',
636 'contactId' => $params['contact_id'],
637 'from' => $receiptFrom,
638 'toName' => $pledgerDisplayName,
639 'toEmail' => $pledgerEmail,
643 //check if activity record exist for this pledge
644 //Acknowledgment, if exist do not add activity.
645 $activityType = 'Pledge Acknowledgment';
646 $activity = new CRM_Activity_DAO_Activity();
647 $activity->source_record_id
= $params['id'];
648 $activity->activity_type_id
= CRM_Core_OptionGroup
::getValue('activity_type',
652 $config = CRM_Core_Config
::singleton();
655 $details = 'Total Amount ' . CRM_Utils_Money
::format($params['total_pledge_amount'], CRM_Utils_Array
::value('currency', $params)) . ' To be paid in ' . $params['installments'] . ' installments of ' . CRM_Utils_Money
::format($params['scheduled_amount'], CRM_Utils_Array
::value('currency', $params)) . ' every ' . $params['frequency_interval'] . ' ' . $params['frequency_unit'] . '(s)';
657 if (!$activity->find()) {
658 $activityParams = array(
659 'subject' => $subject,
660 'source_contact_id' => $params['contact_id'],
661 'source_record_id' => $params['id'],
662 'activity_type_id' => CRM_Core_OptionGroup
::getValue('activity_type',
666 'activity_date_time' => CRM_Utils_Date
::isoToMysql($params['acknowledge_date']),
667 'is_test' => $params['is_test'],
669 'details' => $details,
670 'campaign_id' => CRM_Utils_Array
::value('campaign_id', $params),
673 //lets insert assignee record.
674 if (!empty($params['contact_id'])) {
675 $activityParams['assignee_contact_id'] = $params['contact_id'];
678 if (is_a(CRM_Activity_BAO_Activity
::create($activityParams), 'CRM_Core_Error')) {
679 CRM_Core_Error
::fatal("Failed creating Activity for acknowledgment");
685 * Combine all the exportable fields from the lower levels object
687 * @return array array of exportable Fields
691 static function &exportableFields() {
692 if (!self
::$_exportableFields) {
693 if (!self
::$_exportableFields) {
694 self
::$_exportableFields = array();
697 $fields = CRM_Pledge_DAO_Pledge
::export();
699 $fields = array_merge($fields, CRM_Pledge_DAO_PledgePayment
::export());
701 //set title to calculated fields
702 $calculatedFields = array('pledge_total_paid' => array('title' => ts('Total Paid')),
703 'pledge_balance_amount' => array('title' => ts('Balance Amount')),
704 'pledge_next_pay_date' => array('title' => ts('Next Payment Date')),
705 'pledge_next_pay_amount' => array('title' => ts('Next Payment Amount')),
706 'pledge_payment_paid_amount' => array('title' => ts('Paid Amount')),
707 'pledge_payment_paid_date' => array('title' => ts('Paid Date')),
708 'pledge_payment_status' => array('title' => ts('Pledge Payment Status'),
709 'name' => 'pledge_payment_status',
710 'data_type' => CRM_Utils_Type
::T_STRING
,
715 $pledgeFields = array(
716 'pledge_status' => array('title' => 'Pledge Status',
717 'name' => 'pledge_status',
718 'data_type' => CRM_Utils_Type
::T_STRING
,
720 'pledge_frequency_unit' => array(
721 'title' => 'Pledge Frequency Unit',
722 'name' => 'pledge_frequency_unit',
723 'data_type' => CRM_Utils_Type
::T_ENUM
,
725 'pledge_frequency_interval' => array(
726 'title' => 'Pledge Frequency Interval',
727 'name' => 'pledge_frequency_interval',
728 'data_type' => CRM_Utils_Type
::T_INT
,
730 'pledge_contribution_page_id' => array(
731 'title' => 'Pledge Contribution Page Id',
732 'name' => 'pledge_contribution_page_id',
733 'data_type' => CRM_Utils_Type
::T_INT
,
737 $fields = array_merge($fields, $pledgeFields, $calculatedFields);
740 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Pledge'));
741 self
::$_exportableFields = $fields;
744 return self
::$_exportableFields;
748 * Get pending or in progress pledges
750 * @param int $contactID contact id
752 * @return array associated array of pledge id(s)
755 static function getContactPledges($contactID) {
756 $pledgeDetails = array();
757 $pledgeStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
761 //get pending and in progress status
763 'Pending', 'In Progress', 'Overdue') as $name) {
764 if ($statusId = array_search($name, $pledgeStatuses)) {
765 $status[] = $statusId;
768 if (empty($status)) {
769 return $pledgeDetails;
772 $statusClause = " IN (" . implode(',', $status) . ")";
775 SELECT civicrm_pledge.id id
777 WHERE civicrm_pledge.status_id {$statusClause}
778 AND civicrm_pledge.contact_id = %1
781 $params[1] = array($contactID, 'Integer');
782 $pledge = CRM_Core_DAO
::executeQuery($query, $params);
784 while ($pledge->fetch()) {
785 $pledgeDetails[] = $pledge->id
;
788 return $pledgeDetails;
792 * Get pledge record count for a Contact
794 * @param int $contactID
796 * @return int count of pledge records
800 static function getContactPledgeCount($contactID) {
801 $query = "SELECT count(*) FROM civicrm_pledge WHERE civicrm_pledge.contact_id = {$contactID} AND civicrm_pledge.is_test = 0";
802 return CRM_Core_DAO
::singleValueQuery($query);
806 * @param array $params
810 public static function updatePledgeStatus($params) {
812 $returnMessages = array();
814 $sendReminders = CRM_Utils_Array
::value('send_reminders', $params, FALSE);
816 $allStatus = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
818 //unset statues that we never use for pledges
820 'Completed', 'Cancelled', 'Failed') as $statusKey) {
821 if ($key = CRM_Utils_Array
::key($statusKey, $allStatus)) {
822 unset($allStatus[$key]);
826 $statusIds = implode(',', array_keys($allStatus));
830 SELECT pledge.contact_id as contact_id,
831 pledge.id as pledge_id,
832 pledge.amount as amount,
833 payment.scheduled_date as scheduled_date,
834 pledge.create_date as create_date,
835 payment.id as payment_id,
836 pledge.currency as currency,
837 pledge.contribution_page_id as contribution_page_id,
838 payment.reminder_count as reminder_count,
839 pledge.max_reminders as max_reminders,
840 payment.reminder_date as reminder_date,
841 pledge.initial_reminder_day as initial_reminder_day,
842 pledge.additional_reminder_day as additional_reminder_day,
843 pledge.status_id as pledge_status,
844 payment.status_id as payment_status,
845 pledge.is_test as is_test,
846 pledge.campaign_id as campaign_id,
847 SUM(payment.scheduled_amount) as amount_due,
848 ( SELECT sum(civicrm_pledge_payment.actual_amount)
849 FROM civicrm_pledge_payment
850 WHERE civicrm_pledge_payment.status_id = 1
851 AND civicrm_pledge_payment.pledge_id = pledge.id
853 FROM civicrm_pledge pledge, civicrm_pledge_payment payment
854 WHERE pledge.id = payment.pledge_id
855 AND payment.status_id IN ( {$statusIds} ) AND pledge.status_id IN ( {$statusIds} )
859 $dao = CRM_Core_DAO
::executeQuery($query);
862 $pledgeDetails = $contactIds = $pledgePayments = $pledgeStatus = array();
863 while ($dao->fetch()) {
864 $checksumValue = CRM_Contact_BAO_Contact_Utils
::generateChecksum($dao->contact_id
);
866 $pledgeDetails[$dao->payment_id
] = array(
867 'scheduled_date' => $dao->scheduled_date
,
868 'amount_due' => $dao->amount_due
,
869 'amount' => $dao->amount
,
870 'amount_paid' => $dao->amount_paid
,
871 'create_date' => $dao->create_date
,
872 'contact_id' => $dao->contact_id
,
873 'pledge_id' => $dao->pledge_id
,
874 'checksumValue' => $checksumValue,
875 'contribution_page_id' => $dao->contribution_page_id
,
876 'reminder_count' => $dao->reminder_count
,
877 'max_reminders' => $dao->max_reminders
,
878 'reminder_date' => $dao->reminder_date
,
879 'initial_reminder_day' => $dao->initial_reminder_day
,
880 'additional_reminder_day' => $dao->additional_reminder_day
,
881 'pledge_status' => $dao->pledge_status
,
882 'payment_status' => $dao->payment_status
,
883 'is_test' => $dao->is_test
,
884 'currency' => $dao->currency
,
885 'campaign_id' => $dao->campaign_id
,
888 $contactIds[$dao->contact_id
] = $dao->contact_id
;
889 $pledgeStatus[$dao->pledge_id
] = $dao->pledge_status
;
891 if (CRM_Utils_Date
::overdue(CRM_Utils_Date
::customFormat($dao->scheduled_date
, '%Y%m%d'),
893 ) && $dao->payment_status
!= array_search('Overdue', $allStatus)) {
894 $pledgePayments[$dao->pledge_id
][$dao->payment_id
] = $dao->payment_id
;
898 // process the updating script...
900 foreach ($pledgePayments as $pledgeId => $paymentIds) {
901 // 1. update the pledge /pledge payment status. returns new status when an update happens
902 $returnMessages[] = "Checking if status update is needed for Pledge Id: {$pledgeId} (current status is {$allStatus[$pledgeStatus[$pledgeId]]})";
904 $newStatus = CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($pledgeId, $paymentIds,
905 array_search('Overdue', $allStatus), NULL, 0, FALSE, TRUE
907 if ($newStatus != $pledgeStatus[$pledgeId]) {
908 $returnMessages[] = "- status updated to: {$allStatus[$newStatus]}";
913 if ($sendReminders) {
914 // retrieve domain tokens
915 $domain = CRM_Core_BAO_Domain
::getDomain();
916 $tokens = array('domain' => array('name', 'phone', 'address', 'email'),
917 'contact' => CRM_Core_SelectValues
::contactTokens(),
920 $domainValues = array();
921 foreach ($tokens['domain'] as $token) {
922 $domainValues[$token] = CRM_Utils_Token
::getDomainTokenReplacement($token, $domain);
925 //get the domain email address, since we don't carry w/ object.
926 $domainValue = CRM_Core_BAO_Domain
::getNameAndEmail();
927 $domainValues['email'] = $domainValue[1];
929 // retrieve contact tokens
931 // this function does NOT return Deceased contacts since we don't want to send them email
932 list($contactDetails) = CRM_Utils_Token
::getTokenDetails($contactIds,
935 $tokens, 'CRM_UpdatePledgeRecord'
938 // assign domain values to template
939 $template = CRM_Core_Smarty
::singleton();
940 $template->assign('domain', $domainValues);
943 $receiptFrom = '"' . $domainValues['name'] . '" <' . $domainValues['email'] . '>';
945 foreach ($pledgeDetails as $paymentId => $details) {
946 if (array_key_exists($details['contact_id'], $contactDetails)) {
947 $contactId = $details['contact_id'];
948 $pledgerName = $contactDetails[$contactId]['display_name'];
954 if (empty($details['reminder_date'])) {
955 $nextReminderDate = new DateTime($details['scheduled_date']);
956 $nextReminderDate->modify("-" . $details['initial_reminder_day'] . "day");
957 $nextReminderDate = $nextReminderDate->format("Ymd");
960 $nextReminderDate = new DateTime($details['reminder_date']);
961 $nextReminderDate->modify("+" . $details['additional_reminder_day'] . "day");
962 $nextReminderDate = $nextReminderDate->format("Ymd");
964 if (($details['reminder_count'] < $details['max_reminders'])
965 && ($nextReminderDate <= $now)
968 $toEmail = $doNotEmail = $onHold = NULL;
970 if (!empty($contactDetails[$contactId]['email'])) {
971 $toEmail = $contactDetails[$contactId]['email'];
974 if (!empty($contactDetails[$contactId]['do_not_email'])) {
975 $doNotEmail = $contactDetails[$contactId]['do_not_email'];
978 if (!empty($contactDetails[$contactId]['on_hold'])) {
979 $onHold = $contactDetails[$contactId]['on_hold'];
982 // 2. send acknowledgement mail
983 if ($toEmail && !($doNotEmail ||
$onHold)) {
984 //assign value to template
985 $template->assign('amount_paid', $details['amount_paid'] ?
$details['amount_paid'] : 0);
986 $template->assign('contact', $contactDetails[$contactId]);
987 $template->assign('next_payment', $details['scheduled_date']);
988 $template->assign('amount_due', $details['amount_due']);
989 $template->assign('checksumValue', $details['checksumValue']);
990 $template->assign('contribution_page_id', $details['contribution_page_id']);
991 $template->assign('pledge_id', $details['pledge_id']);
992 $template->assign('scheduled_payment_date', $details['scheduled_date']);
993 $template->assign('amount', $details['amount']);
994 $template->assign('create_date', $details['create_date']);
995 $template->assign('currency', $details['currency']);
996 list($mailSent, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate
::sendTemplate(
998 'groupName' => 'msg_tpl_workflow_pledge',
999 'valueName' => 'pledge_reminder',
1000 'contactId' => $contactId,
1001 'from' => $receiptFrom,
1002 'toName' => $pledgerName,
1003 'toEmail' => $toEmail,
1007 // 3. update pledge payment details
1009 CRM_Pledge_BAO_PledgePayment
::updateReminderDetails($paymentId);
1010 $activityType = 'Pledge Reminder';
1011 $activityParams = array(
1012 'subject' => $subject,
1013 'source_contact_id' => $contactId,
1014 'source_record_id' => $paymentId,
1015 'assignee_contact_id' => $contactId,
1016 'activity_type_id' => CRM_Core_OptionGroup
::getValue('activity_type',
1020 'activity_date_time' => CRM_Utils_Date
::isoToMysql($now),
1021 'due_date_time' => CRM_Utils_Date
::isoToMysql($details['scheduled_date']),
1022 'is_test' => $details['is_test'],
1024 'campaign_id' => $details['campaign_id'],
1026 if (is_a(civicrm_api('activity', 'create', $activityParams), 'CRM_Core_Error')) {
1027 $returnMessages[] = "Failed creating Activity for acknowledgment";
1028 return array('is_error' => 1, 'message' => $returnMessages);
1030 $returnMessages[] = "Payment reminder sent to: {$pledgerName} - {$toEmail}";
1035 // end foreach on $pledgeDetails
1037 // end if ( $sendReminders )
1038 $returnMessages[] = "{$updateCnt} records updated.";
1040 return array('is_error' => 0, 'messages' => implode("\n\r", $returnMessages));
1044 * Mark a pledge (and any outstanding payments) as cancelled.
1046 * @param int $pledgeID
1048 public static function cancel($pledgeID) {
1049 $statuses = array_flip(CRM_Contribute_PseudoConstant
::contributionStatus());
1050 $paymentIDs = self
::findCancelablePayments($pledgeID);
1051 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($pledgeID, $paymentIDs, NULL,
1052 $statuses['Cancelled'], 0, FALSE, TRUE
1057 * Find payments which can be safely canceled.
1059 * @param int $pledgeID
1060 * @return array of int (civicrm_pledge_payment.id)
1062 public static function findCancelablePayments($pledgeID) {
1063 $statuses = array_flip(CRM_Contribute_PseudoConstant
::contributionStatus());
1065 $paymentDAO = new CRM_Pledge_DAO_PledgePayment();
1066 $paymentDAO->pledge_id
= $pledgeID;
1067 $paymentDAO->whereAdd(sprintf("status_id IN (%d,%d)",
1068 $statuses['Overdue'],
1069 $statuses['Pending']
1071 $paymentDAO->find();
1073 $paymentIDs = array();
1074 while ($paymentDAO->fetch()) {
1075 $paymentIDs[] = $paymentDAO->id
;
1081 * Is this pledge free from financial transactions (this is important to know as we allow editing
1082 * when no transactions have taken place - the editing process currently involves deleting all pledge payments & contributions
1083 * & recreating so we want to block that if appropriate
1085 * @param integer $pledgeID
1086 * @param integer $pledgeStatusID
1087 * @return bool do financial transactions exist for this pledge?
1089 static function pledgeHasFinancialTransactions($pledgeID, $pledgeStatusID) {
1090 if (empty($pledgeStatusID)) {
1091 //why would this happen? If we can see where it does then we can see if we should look it up
1092 //but assuming from form code it CAN be empty
1095 if (self
::isTransactedStatus($pledgeStatusID)) {
1099 return civicrm_api3('pledge_payment', 'getcount', array('pledge_id' => $pledgeID, 'status_id' => array('IN' => self
::getTransactionalStatus())));
1103 * Does this pledge / pledge payment status mean that a financial transaction has taken place?
1104 * @param int $statusID pledge status id
1106 * @return bool is it a transactional status?
1108 protected static function isTransactedStatus($statusID) {
1109 if (!in_array($statusID, self
::getNonTransactionalStatus())) {
1116 * Get array of non transactional statuses
1117 * @return array non transactional status ids
1119 protected static function getNonTransactionalStatus() {
1120 $paymentStatus = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
1121 return array_flip(array_intersect($paymentStatus, array('Overdue', 'Pending')));
1125 * Get array of non transactional statuses
1126 * @return array non transactional status ids
1128 protected static function getTransactionalStatus() {
1129 $paymentStatus = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
1130 return array_diff(array_flip($paymentStatus), self
::getNonTransactionalStatus());