CRM/Pledge/BAO/Pledge.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   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 class CRM_Pledge_BAO_Pledge extends CRM_Pledge_DAO_Pledge {
  36
  37   /**
  38    * static field for all the pledge information that we can potentially export
  39    *
  40    * @var array
  41    * @static
  42    */
  43   static $_exportableFields = NULL;
  44
  45   /**
  46    * class constructor
  47    */
  48   function __construct() {
  49     parent::__construct();
  50   }
  51
  52   /**
  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
  58    *
  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
  61    *
  62    * @return object CRM_Pledge_BAO_Pledge object
  63    * @access public
  64    * @static
  65    */
  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);
  71       return $pledge;
  72     }
  73     return NULL;
  74   }
  75
  76   /**
  77    * function to add pledge
  78    *
  79    * @param array $params reference array contains the values submitted by the form
  80    *
  81    * @access public
  82    * @static
  83    *
  84    * @return object
  85    */
  86   static function add(&$params) {
  87     if (!empty($params['id'])) {
  88       CRM_Utils_Hook::pre('edit', 'Pledge', $params['id'], $params);
  89     }
  90     else {
  91       CRM_Utils_Hook::pre('create', 'Pledge', NULL, $params);
  92     }
  93
  94     $pledge = new CRM_Pledge_DAO_Pledge();
  95
  96     // if pledge is complete update end date as current date
  97     if ($pledge->status_id == 1) {
  98       $pledge->end_date = date('Ymd');
  99     }
 100
 101     $pledge->copyValues($params);
 102
 103     // set currency for CRM-1496
 104     if (!isset($pledge->currency)) {
 105       $config = CRM_Core_Config::singleton();
 106       $pledge->currency = $config->defaultCurrency;
 107     }
 108
 109     $result = $pledge->save();
 110
 111     if (!empty($params['id'])) {
 112       CRM_Utils_Hook::post('edit', 'Pledge', $pledge->id, $pledge);
 113     }
 114     else {
 115       CRM_Utils_Hook::post('create', 'Pledge', $pledge->id, $pledge);
 116     }
 117
 118     return $result;
 119   }
 120
 121   /**
 122    * Given the list of params in the params array, fetch the object
 123    * and store the values in the values array
 124    *
 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
 128    *
 129    * @return array associated array of field values
 130    * @access public
 131    * @static
 132    */
 133   static function &getValues(&$params, &$values, $returnProperties = NULL) {
 134     if (empty($params)) {
 135       return NULL;
 136     }
 137     CRM_Core_DAO::commonRetrieve('CRM_Pledge_BAO_Pledge', $params, $values, $returnProperties);
 138     return $values;
 139   }
 140
 141   /**
 142    * takes an associative array and creates a pledge object
 143    *
 144    * @param array $params (reference ) an assoc array of name/value pairs
 145    *
 146    * @return object CRM_Pledge_BAO_Pledge object
 147    * @access public
 148    * @static
 149    */
 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]);
 156       }
 157     }
 158
 159     $transaction = new CRM_Core_Transaction();
 160
 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'];
 165     }
 166
 167     //get All Payments status types.
 168     $paymentStatusTypes = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
 169
 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);
 175         }
 176       }
 177       else {
 178         if (!empty($params['id'])) {
 179           $params['status_id'] = CRM_Pledge_BAO_PledgePayment::calculatePledgeStatus($params['id']);
 180         }
 181         else {
 182           $params['status_id'] = array_search('Pending', $paymentStatusTypes);
 183         }
 184       }
 185     }
 186
 187     $pledge = self::add($params);
 188     if (is_a($pledge, 'CRM_Core_Error')) {
 189       $pledge->rollback();
 190       return $pledge;
 191     }
 192
 193     //handle custom data.
 194     if (!empty($params['custom']) &&
 195       is_array($params['custom'])
 196     ) {
 197       CRM_Core_BAO_CustomValueTable::store($params['custom'], 'civicrm_pledge', $pledge->id);
 198     }
 199
 200     // skip payment stuff inedit mode
 201     if (!isset($params['id']) || !empty($params['is_pledge_pending'])) {
 202
 203
 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);
 207       }
 208
 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',
 214       );
 215       foreach ($paymentKeys as $key) {
 216         $paymentParams[$key] = CRM_Utils_Array::value($key, $params, NULL);
 217       }
 218       CRM_Pledge_BAO_PledgePayment::create($paymentParams);
 219     }
 220
 221     $transaction->commit();
 222
 223     $url = CRM_Utils_System::url('civicrm/contact/view/pledge',
 224       "action=view&reset=1&id={$pledge->id}&cid={$pledge->contact_id}&context=home"
 225     );
 226
 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"
 231       );
 232     }
 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"
 236       );
 237     }
 238
 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) . ')';
 241
 242     // add the recently created Pledge
 243     CRM_Utils_Recent::add($title,
 244       $url,
 245       $pledge->id,
 246       'Pledge',
 247       $pledge->contact_id,
 248       NULL,
 249       $recentOther
 250     );
 251
 252     return $pledge;
 253   }
 254
 255   /**
 256    * Function to delete the pledge
 257    *
 258    * @param int $id  pledge id
 259    *
 260    * @access public
 261    * @static
 262    *
 263    */
 264   static function deletePledge($id) {
 265     CRM_Utils_Hook::pre('delete', 'Pledge', $id, CRM_Core_DAO::$_nullArray);
 266
 267     $transaction = new CRM_Core_Transaction();
 268
 269     //check for no Completed Payment records with the pledge
 270     $payment = new CRM_Pledge_DAO_PledgePayment();
 271     $payment->pledge_id = $id;
 272     $payment->find();
 273
 274     while ($payment->fetch()) {
 275       //also delete associated contribution.
 276       if ($payment->contribution_id) {
 277         CRM_Contribute_BAO_Contribution::deleteContribution($payment->contribution_id);
 278       }
 279       $payment->delete();
 280     }
 281
 282     $dao     = new CRM_Pledge_DAO_Pledge();
 283     $dao->id = $id;
 284     $results = $dao->delete();
 285
 286     $transaction->commit();
 287
 288     CRM_Utils_Hook::post('delete', 'Pledge', $dao->id, $dao);
 289
 290     // delete the recently created Pledge
 291     $pledgeRecent = array(
 292       'id' => $id,
 293       'type' => 'Pledge',
 294     );
 295     CRM_Utils_Recent::del($pledgeRecent);
 296
 297     return $results;
 298   }
 299
 300   /**
 301    * function to get the amount details date wise.
 302    */
 303   static function getTotalAmountAndCount($status = NULL, $startDate = NULL, $endDate = NULL) {
 304     $where = array();
 305     $select = $from = $queryDate = NULL;
 306     //get all status
 307     $allStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
 308     $statusId = array_search($status, $allStatus);
 309
 310     switch ($status) {
 311       case 'Completed':
 312         $statusId = array_search('Cancelled', $allStatus);
 313         $where[] = 'status_id != ' . $statusId;
 314         break;
 315
 316       case 'Cancelled':
 317         $where[] = 'status_id = ' . $statusId;
 318         break;
 319
 320       case 'In Progress':
 321         $where[] = 'status_id = ' . $statusId;
 322         break;
 323
 324       case 'Pending':
 325         $where[] = 'status_id = ' . $statusId;
 326         break;
 327
 328       case 'Overdue':
 329         $where[] = 'status_id = ' . $statusId;
 330         break;
 331     }
 332
 333     if ($startDate) {
 334       $where[] = "create_date >= '" . CRM_Utils_Type::escape($startDate, 'Timestamp') . "'";
 335     }
 336     if ($endDate) {
 337       $where[] = "create_date <= '" . CRM_Utils_Type::escape($endDate, 'Timestamp') . "'";
 338     }
 339
 340     $whereCond = implode(' AND ', $where);
 341
 342     $query = "
 343 SELECT sum( amount ) as pledge_amount, count( id ) as pledge_count, currency
 344 FROM   civicrm_pledge
 345 WHERE  $whereCond AND is_test=0
 346 GROUP BY  currency
 347 ";
 348     $start   = substr($startDate, 0, 8);
 349     $end     = substr($endDate, 0, 8);
 350     $pCount  = 0;
 351     $pamount = array();
 352     $dao     = CRM_Core_DAO::executeQuery($query, CRM_Core_DAO::$_nullArray);
 353     while ($dao->fetch()) {
 354       $pCount += $dao->pledge_count;
 355       $pamount[] = CRM_Utils_Money::format($dao->pledge_amount, $dao->currency);
 356     }
 357
 358     $pledge_amount = array('pledge_amount' => implode(', ', $pamount),
 359       'pledge_count' => $pCount,
 360       'purl' => CRM_Utils_System::url('civicrm/pledge/search',
 361         "reset=1&force=1&pstatus={$statusId}&pstart={$start}&pend={$end}&test=0"
 362       ),
 363     );
 364
 365     $where = array();
 366     $statusId = array_search($status, $allStatus);
 367     switch ($status) {
 368       case 'Completed':
 369         $select    = 'sum( total_amount ) as received_pledge , count( cd.id ) as received_count';
 370         $where[]   = 'cp.status_id = ' . $statusId . ' AND cp.contribution_id = cd.id AND cd.is_test=0';
 371         $queryDate = 'receive_date';
 372         $from      = ' civicrm_contribution cd, civicrm_pledge_payment cp';
 373         break;
 374
 375       case 'Cancelled':
 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';
 380         break;
 381
 382       case 'Pending':
 383         $select    = 'sum( scheduled_amount )as received_pledge , count( cp.id ) as received_count';
 384         $where[]   = 'cp.status_id = ' . $statusId . ' AND pledge.is_test=0';
 385         $queryDate = 'scheduled_date';
 386         $from      = ' civicrm_pledge_payment cp INNER JOIN civicrm_pledge pledge on cp.pledge_id = pledge.id';
 387         break;
 388
 389       case 'Overdue':
 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';
 394         break;
 395     }
 396
 397     if ($startDate) {
 398       $where[] = " $queryDate >= '" . CRM_Utils_Type::escape($startDate, 'Timestamp') . "'";
 399     }
 400     if ($endDate) {
 401       $where[] = " $queryDate <= '" . CRM_Utils_Type::escape($endDate, 'Timestamp') . "'";
 402     }
 403
 404     $whereCond = implode(' AND ', $where);
 405
 406     $query = "
 407  SELECT $select, cp.currency
 408  FROM $from
 409  WHERE  $whereCond
 410  GROUP BY  cp.currency
 411 ";
 412     if ($select) {
 413       // CRM_Core_Error::debug($status . ' start:' . $startDate . '- end:' . $endDate, $query);
 414       $dao    = CRM_Core_DAO::executeQuery($query, CRM_Core_DAO::$_nullArray);
 415       $amount = array();
 416       $count  = 0;
 417
 418       while ($dao->fetch()) {
 419         $count += $dao->received_count;
 420         $amount[] = CRM_Utils_Money::format($dao->received_pledge, $dao->currency);
 421       }
 422
 423       if ($count) {
 424         return array_merge($pledge_amount, array('received_amount' => implode(', ', $amount),
 425             'received_count' => $count,
 426             'url' => CRM_Utils_System::url('civicrm/pledge/search',
 427               "reset=1&force=1&status={$statusId}&start={$start}&end={$end}&test=0"
 428             ),
 429           ));
 430       }
 431     }
 432     else {
 433       return $pledge_amount;
 434     }
 435     return NULL;
 436   }
 437
 438   /**
 439    * Function to get list of pledges In Honor of contact Ids
 440    *
 441    * @param int $honorId In Honor of Contact ID
 442    *
 443    * @return return the list of pledge fields
 444    *
 445    * @access public
 446    * @static
 447    */
 448   static function getHonorContacts($honorId) {
 449     $params = array();
 450     $honorDAO = new CRM_Contribute_DAO_ContributionSoft();
 451     $honorDAO->contact_id = $honorId;
 452     $honorDAO->find();
 453
 454     //get all status.
 455     while ($honorDAO->fetch()) {
 456       $pledgePaymentDAO = new CRM_Pledge_DAO_PledgePayment();
 457       $pledgePaymentDAO->contribution_id = $honorDAO->contribution_id;
 458       if ($pledgePaymentDAO->find(TRUE)) {
 459         $pledgeDAO = new CRM_Pledge_DAO_Pledge();
 460         $pledgeDAO->id = $pledgePaymentDAO->pledge_id;
 461         if ($pledgeDAO->find(TRUE)) {
 462           $params[$pledgeDAO->id] = array(
 463             'honor_type' => CRM_Core_OptionGroup::getLabel('soft_credit_type', $honorDAO->soft_credit_type_id, 'value'),
 464             'honorId' => $pledgeDAO->contact_id,
 465             'amount' => $pledgeDAO->amount,
 466             'status' => CRM_Contribute_PseudoConstant::contributionStatus($pledgeDAO->status_id),
 467             'create_date' => $pledgeDAO->create_date,
 468             'acknowledge_date' => $pledgeDAO->acknowledge_date,
 469             'type' => CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialType',
 470               $pledgeDAO->financial_type_id, 'name'
 471             ),
 472             'display_name' => CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
 473               $pledgeDAO->contact_id, 'display_name'
 474             ),
 475           );
 476         }
 477       }
 478     }
 479
 480     return $params;
 481   }
 482
 483   /**
 484    * Function to send Acknowledgment and create activity.
 485    *
 486    * @param object $form form object.
 487    * @param array  $params (reference ) an assoc array of name/value pairs.
 488    * @access public
 489    *
 490    * @return void.
 491    */
 492   function sendAcknowledgment(&$form, $params) {
 493     //handle Acknowledgment.
 494     $allPayments = $payments = array();
 495
 496     //get All Payments status types.
 497     $paymentStatusTypes = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
 498     $returnProperties = array('status_id', 'scheduled_amount', 'scheduled_date', 'contribution_id');
 499     //get all paymnets details.
 500     CRM_Core_DAO::commonRetrieveAll('CRM_Pledge_DAO_PledgePayment', 'pledge_id', $params['id'], $allPayments, $returnProperties);
 501
 502     if (!empty($allPayments)) {
 503       foreach ($allPayments as $payID => $values) {
 504         $contributionValue = $contributionStatus = array();
 505         if (isset($values['contribution_id'])) {
 506           $contributionParams = array('id' => $values['contribution_id']);
 507           $returnProperties = array('contribution_status_id', 'receive_date');
 508           CRM_Core_DAO::commonRetrieve('CRM_Contribute_DAO_Contribution',
 509             $contributionParams, $contributionStatus, $returnProperties
 510           );
 511           $contributionValue = array(
 512             'status' => CRM_Utils_Array::value('contribution_status_id', $contributionStatus),
 513             'receive_date' => CRM_Utils_Array::value('receive_date', $contributionStatus),
 514           );
 515         }
 516         $payments[$payID] = array_merge($contributionValue,
 517           array('amount' => CRM_Utils_Array::value('scheduled_amount', $values),
 518             'due_date' => CRM_Utils_Array::value('scheduled_date', $values),
 519           )
 520         );
 521
 522         //get the first valid payment id.
 523         if (!isset($form->paymentId) && ($paymentStatusTypes[$values['status_id']] == 'Pending' ||
 524             $paymentStatusTypes[$values['status_id']] == 'Overdue'
 525           )) {
 526           $form->paymentId = $values['id'];
 527         }
 528       }
 529     }
 530     //end
 531
 532     //assign pledge fields value to template.
 533     $pledgeFields = array(
 534       'create_date', 'total_pledge_amount', 'frequency_interval', 'frequency_unit',
 535       'installments', 'frequency_day', 'scheduled_amount', 'currency',
 536     );
 537     foreach ($pledgeFields as $field) {
 538       if (!empty($params[$field])) {
 539         $form->assign($field, $params[$field]);
 540       }
 541     }
 542
 543     //assign all payments details.
 544     if ($payments) {
 545       $form->assign('payments', $payments);
 546     }
 547
 548     //handle domain token values
 549     $domain = CRM_Core_BAO_Domain::getDomain();
 550     $tokens = array('domain' => array('name', 'phone', 'address', 'email'),
 551       'contact' => CRM_Core_SelectValues::contactTokens(),
 552     );
 553     $domainValues = array();
 554     foreach ($tokens['domain'] as $token) {
 555       $domainValues[$token] = CRM_Utils_Token::getDomainTokenReplacement($token, $domain);
 556     }
 557     $form->assign('domain', $domainValues);
 558
 559     //handle contact token values.
 560     $ids = array($params['contact_id']);
 561     $fields = array_merge(array_keys(CRM_Contact_BAO_Contact::importableFields()),
 562       array('display_name', 'checksum', 'contact_id')
 563     );
 564     foreach ($fields as $key => $val) {
 565       $returnProperties[$val] = TRUE;
 566     }
 567     $details = CRM_Utils_Token::getTokenDetails($ids,
 568       $returnProperties,
 569       TRUE, TRUE, NULL,
 570       $tokens,
 571       get_class($form)
 572     );
 573     $form->assign('contact', $details[0][$params['contact_id']]);
 574
 575     //handle custom data.
 576     if (!empty($params['hidden_custom'])) {
 577       $groupTree    = CRM_Core_BAO_CustomGroup::getTree('Pledge', CRM_Core_DAO::$_nullObject, $params['id']);
 578       $pledgeParams = array(array('pledge_id', '=', $params['id'], 0, 0));
 579       $customGroup  = array();
 580       // retrieve custom data
 581       foreach ($groupTree as $groupID => $group) {
 582         $customFields = $customValues = array();
 583         if ($groupID == 'info') {
 584           continue;
 585         }
 586         foreach ($group['fields'] as $k => $field) {
 587           $field['title'] = $field['label'];
 588           $customFields["custom_{$k}"] = $field;
 589         }
 590
 591         //to build array of customgroup & customfields in it
 592         CRM_Core_BAO_UFGroup::getValues($params['contact_id'], $customFields, $customValues, FALSE, $pledgeParams);
 593         $customGroup[$group['title']] = $customValues;
 594       }
 595
 596       $form->assign('customGroup', $customGroup);
 597     }
 598
 599     //handle acknowledgment email stuff.
 600     list($pledgerDisplayName,
 601       $pledgerEmail
 602     ) = CRM_Contact_BAO_Contact_Location::getEmailDetails($params['contact_id']);
 603
 604     //check for online pledge.
 605     $session = CRM_Core_Session::singleton();
 606     if (!empty($params['receipt_from_email'])) {
 607       $userName = CRM_Utils_Array::value('receipt_from_name', $params);
 608       $userEmail = CRM_Utils_Array::value('receipt_from_email', $params);
 609     }
 610     elseif (!empty($params['from_email_id'])) {
 611       $receiptFrom = $params['from_email_id'];
 612     }
 613     elseif ($userID = $session->get('userID')) {
 614       //check for loged in user.
 615       list($userName, $userEmail) = CRM_Contact_BAO_Contact_Location::getEmailDetails($userID);
 616     }
 617     else {
 618       //set the domain values.
 619       $userName = CRM_Utils_Array::value('name', $domainValues);
 620       $userEmail = CRM_Utils_Array::value('email', $domainValues);
 621     }
 622
 623     if (!isset($receiptFrom)) {
 624       $receiptFrom = "$userName <$userEmail>";
 625     }
 626
 627     list($sent, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate::sendTemplate(
 628       array(
 629         'groupName' => 'msg_tpl_workflow_pledge',
 630         'valueName' => 'pledge_acknowledge',
 631         'contactId' => $params['contact_id'],
 632         'from' => $receiptFrom,
 633         'toName' => $pledgerDisplayName,
 634         'toEmail' => $pledgerEmail,
 635       )
 636     );
 637
 638     //check if activity record exist for this pledge
 639     //Acknowledgment, if exist do not add activity.
 640     $activityType = 'Pledge Acknowledgment';
 641     $activity = new CRM_Activity_DAO_Activity();
 642     $activity->source_record_id = $params['id'];
 643     $activity->activity_type_id = CRM_Core_OptionGroup::getValue('activity_type',
 644       $activityType,
 645       'name'
 646     );
 647     $config = CRM_Core_Config::singleton();
 648
 649     $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)';
 650
 651     if (!$activity->find()) {
 652       $activityParams = array(
 653         'subject' => $subject,
 654         'source_contact_id' => $params['contact_id'],
 655         'source_record_id' => $params['id'],
 656         'activity_type_id' => CRM_Core_OptionGroup::getValue('activity_type',
 657           $activityType,
 658           'name'
 659         ),
 660         'activity_date_time' => CRM_Utils_Date::isoToMysql($params['acknowledge_date']),
 661         'is_test' => $params['is_test'],
 662         'status_id' => 2,
 663         'details' => $details,
 664         'campaign_id' => CRM_Utils_Array::value('campaign_id', $params),
 665       );
 666
 667       //lets insert assignee record.
 668       if (!empty($params['contact_id'])) {
 669         $activityParams['assignee_contact_id'] = $params['contact_id'];
 670       }
 671
 672       if (is_a(CRM_Activity_BAO_Activity::create($activityParams), 'CRM_Core_Error')) {
 673         CRM_Core_Error::fatal("Failed creating Activity for acknowledgment");
 674       }
 675     }
 676   }
 677
 678   /**
 679    * combine all the exportable fields from the lower levels object
 680    *
 681    * @return array array of exportable Fields
 682    * @access public
 683    * @static
 684    */
 685   static function &exportableFields() {
 686     if (!self::$_exportableFields) {
 687       if (!self::$_exportableFields) {
 688         self::$_exportableFields = array();
 689       }
 690
 691       $fields = CRM_Pledge_DAO_Pledge::export();
 692
 693       $fields = array_merge($fields, CRM_Pledge_DAO_PledgePayment::export());
 694
 695       //set title to calculated fields
 696       $calculatedFields = array('pledge_total_paid' => array('title' => ts('Total Paid')),
 697         'pledge_balance_amount' => array('title' => ts('Balance Amount')),
 698         'pledge_next_pay_date' => array('title' => ts('Next Payment Date')),
 699         'pledge_next_pay_amount' => array('title' => ts('Next Payment Amount')),
 700         'pledge_payment_paid_amount' => array('title' => ts('Paid Amount')),
 701         'pledge_payment_paid_date' => array('title' => ts('Paid Date')),
 702         'pledge_payment_status' => array('title' => ts('Pledge Payment Status'),
 703           'name' => 'pledge_payment_status',
 704           'data_type' => CRM_Utils_Type::T_STRING,
 705         ),
 706       );
 707
 708
 709       $pledgeFields = array(
 710         'pledge_status' => array('title' => 'Pledge Status',
 711           'name' => 'pledge_status',
 712           'data_type' => CRM_Utils_Type::T_STRING,
 713         ),
 714         'pledge_frequency_unit' => array(
 715           'title' => 'Pledge Frequency Unit',
 716           'name' => 'pledge_frequency_unit',
 717           'data_type' => CRM_Utils_Type::T_ENUM,
 718         ),
 719         'pledge_frequency_interval' => array(
 720           'title' => 'Pledge Frequency Interval',
 721           'name' => 'pledge_frequency_interval',
 722           'data_type' => CRM_Utils_Type::T_INT,
 723         ),
 724         'pledge_contribution_page_id' => array(
 725           'title' => 'Pledge Contribution Page Id',
 726           'name' => 'pledge_contribution_page_id',
 727           'data_type' => CRM_Utils_Type::T_INT,
 728         ),
 729       );
 730
 731       $fields = array_merge($fields, $pledgeFields, $calculatedFields);
 732
 733       // add custom data
 734       $fields = array_merge($fields, CRM_Core_BAO_CustomField::getFieldsForImport('Pledge'));
 735       self::$_exportableFields = $fields;
 736     }
 737
 738     return self::$_exportableFields;
 739   }
 740
 741   /**
 742    * Function to get pending or in progress pledges
 743    *
 744    * @param int $contactID contact id
 745    *
 746    * @return array associated array of pledge id(s)
 747    * @static
 748    */
 749   static function getContactPledges($contactID) {
 750     $pledgeDetails = array();
 751     $pledgeStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
 752
 753     $status = array();
 754
 755     //get pending and in progress status
 756     foreach (array(
 757       'Pending', 'In Progress', 'Overdue') as $name) {
 758       if ($statusId = array_search($name, $pledgeStatuses)) {
 759         $status[] = $statusId;
 760       }
 761     }
 762     if (empty($status)) {
 763       return $pledgeDetails;
 764     }
 765
 766     $statusClause = " IN (" . implode(',', $status) . ")";
 767
 768     $query = "
 769  SELECT civicrm_pledge.id id
 770  FROM civicrm_pledge
 771  WHERE civicrm_pledge.status_id  {$statusClause}
 772   AND civicrm_pledge.contact_id = %1
 773 ";
 774
 775     $params[1] = array($contactID, 'Integer');
 776     $pledge = CRM_Core_DAO::executeQuery($query, $params);
 777
 778     while ($pledge->fetch()) {
 779       $pledgeDetails[] = $pledge->id;
 780     }
 781
 782     return $pledgeDetails;
 783   }
 784
 785   /**
 786    * Function to get pledge record count for a Contact
 787    *
 788    * @param int $contactId Contact ID
 789    *
 790    * @return int count of pledge records
 791    * @access public
 792    * @static
 793    */
 794   static function getContactPledgeCount($contactID) {
 795     $query = "SELECT count(*) FROM civicrm_pledge WHERE civicrm_pledge.contact_id = {$contactID} AND civicrm_pledge.is_test = 0";
 796     return CRM_Core_DAO::singleValueQuery($query);
 797   }
 798
 799   public static function updatePledgeStatus($params) {
 800
 801     $returnMessages = array();
 802
 803     $sendReminders = CRM_Utils_Array::value('send_reminders', $params, FALSE);
 804
 805     $allStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
 806
 807     //unset statues that we never use for pledges
 808     foreach (array(
 809       'Completed', 'Cancelled', 'Failed') as $statusKey) {
 810       if ($key = CRM_Utils_Array::key($statusKey, $allStatus)) {
 811         unset($allStatus[$key]);
 812       }
 813     }
 814
 815     $statusIds = implode(',', array_keys($allStatus));
 816     $updateCnt = 0;
 817
 818     $query = "
 819 SELECT  pledge.contact_id              as contact_id,
 820         pledge.id                      as pledge_id,
 821         pledge.amount                  as amount,
 822         payment.scheduled_date         as scheduled_date,
 823         pledge.create_date             as create_date,
 824         payment.id                     as payment_id,
 825         pledge.currency                as currency,
 826         pledge.contribution_page_id    as contribution_page_id,
 827         payment.reminder_count         as reminder_count,
 828         pledge.max_reminders           as max_reminders,
 829         payment.reminder_date          as reminder_date,
 830         pledge.initial_reminder_day    as initial_reminder_day,
 831         pledge.additional_reminder_day as additional_reminder_day,
 832         pledge.status_id               as pledge_status,
 833         payment.status_id              as payment_status,
 834         pledge.is_test                 as is_test,
 835         pledge.campaign_id             as campaign_id,
 836         SUM(payment.scheduled_amount)  as amount_due,
 837         ( SELECT sum(civicrm_pledge_payment.actual_amount)
 838         FROM civicrm_pledge_payment
 839         WHERE civicrm_pledge_payment.status_id = 1
 840         AND  civicrm_pledge_payment.pledge_id = pledge.id
 841         ) as amount_paid
 842         FROM      civicrm_pledge pledge, civicrm_pledge_payment payment
 843         WHERE     pledge.id = payment.pledge_id
 844         AND     payment.status_id IN ( {$statusIds} ) AND pledge.status_id IN ( {$statusIds} )
 845         GROUP By  payment.id
 846         ";
 847
 848     $dao = CRM_Core_DAO::executeQuery($query);
 849
 850     $now = date('Ymd');
 851     $pledgeDetails = $contactIds = $pledgePayments = $pledgeStatus = array();
 852     while ($dao->fetch()) {
 853       $checksumValue = CRM_Contact_BAO_Contact_Utils::generateChecksum($dao->contact_id);
 854
 855       $pledgeDetails[$dao->payment_id] = array(
 856         'scheduled_date' => $dao->scheduled_date,
 857         'amount_due' => $dao->amount_due,
 858         'amount' => $dao->amount,
 859         'amount_paid' => $dao->amount_paid,
 860         'create_date' => $dao->create_date,
 861         'contact_id' => $dao->contact_id,
 862         'pledge_id' => $dao->pledge_id,
 863         'checksumValue' => $checksumValue,
 864         'contribution_page_id' => $dao->contribution_page_id,
 865         'reminder_count' => $dao->reminder_count,
 866         'max_reminders' => $dao->max_reminders,
 867         'reminder_date' => $dao->reminder_date,
 868         'initial_reminder_day' => $dao->initial_reminder_day,
 869         'additional_reminder_day' => $dao->additional_reminder_day,
 870         'pledge_status' => $dao->pledge_status,
 871         'payment_status' => $dao->payment_status,
 872         'is_test' => $dao->is_test,
 873         'currency' => $dao->currency,
 874         'campaign_id' => $dao->campaign_id,
 875       );
 876
 877       $contactIds[$dao->contact_id] = $dao->contact_id;
 878       $pledgeStatus[$dao->pledge_id] = $dao->pledge_status;
 879
 880       if (CRM_Utils_Date::overdue(CRM_Utils_Date::customFormat($dao->scheduled_date, '%Y%m%d'),
 881           $now
 882         ) && $dao->payment_status != array_search('Overdue', $allStatus)) {
 883         $pledgePayments[$dao->pledge_id][$dao->payment_id] = $dao->payment_id;
 884       }
 885     }
 886
 887     // process the updating script...
 888
 889     foreach ($pledgePayments as $pledgeId => $paymentIds) {
 890       // 1. update the pledge /pledge payment status. returns new status when an update happens
 891       $returnMessages[] = "Checking if status update is needed for Pledge Id: {$pledgeId} (current status is {$allStatus[$pledgeStatus[$pledgeId]]})";
 892
 893       $newStatus = CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($pledgeId, $paymentIds,
 894         array_search('Overdue', $allStatus), NULL, 0, FALSE, TRUE
 895       );
 896       if ($newStatus != $pledgeStatus[$pledgeId]) {
 897         $returnMessages[] = "- status updated to: {$allStatus[$newStatus]}";
 898         $updateCnt += 1;
 899       }
 900     }
 901
 902     if ($sendReminders) {
 903       // retrieve domain tokens
 904       $domain = CRM_Core_BAO_Domain::getDomain();
 905       $tokens = array('domain' => array('name', 'phone', 'address', 'email'),
 906         'contact' => CRM_Core_SelectValues::contactTokens(),
 907       );
 908
 909       $domainValues = array();
 910       foreach ($tokens['domain'] as $token) {
 911         $domainValues[$token] = CRM_Utils_Token::getDomainTokenReplacement($token, $domain);
 912       }
 913
 914       //get the domain email address, since we don't carry w/ object.
 915       $domainValue = CRM_Core_BAO_Domain::getNameAndEmail();
 916       $domainValues['email'] = $domainValue[1];
 917
 918       // retrieve contact tokens
 919
 920       // this function does NOT return Deceased contacts since we don't want to send them email
 921       list($contactDetails) = CRM_Utils_Token::getTokenDetails($contactIds,
 922         NULL,
 923         FALSE, FALSE, NULL,
 924         $tokens, 'CRM_UpdatePledgeRecord'
 925       );
 926
 927       // assign domain values to template
 928       $template = CRM_Core_Smarty::singleton();
 929       $template->assign('domain', $domainValues);
 930
 931       //set receipt from
 932       $receiptFrom = '"' . $domainValues['name'] . '" <' . $domainValues['email'] . '>';
 933
 934       foreach ($pledgeDetails as $paymentId => $details) {
 935         if (array_key_exists($details['contact_id'], $contactDetails)) {
 936           $contactId = $details['contact_id'];
 937           $pledgerName = $contactDetails[$contactId]['display_name'];
 938         }
 939         else {
 940           continue;
 941         }
 942
 943         if (empty($details['reminder_date'])) {
 944           $nextReminderDate = new DateTime($details['scheduled_date']);
 945           $nextReminderDate->modify("-" . $details['initial_reminder_day'] . "day");
 946           $nextReminderDate = $nextReminderDate->format("Ymd");
 947         }
 948         else {
 949           $nextReminderDate = new DateTime($details['reminder_date']);
 950           $nextReminderDate->modify("+" . $details['additional_reminder_day'] . "day");
 951           $nextReminderDate = $nextReminderDate->format("Ymd");
 952         }
 953         if (($details['reminder_count'] < $details['max_reminders'])
 954           && ($nextReminderDate <= $now)
 955         ) {
 956
 957           $toEmail = $doNotEmail = $onHold = NULL;
 958
 959           if (!empty($contactDetails[$contactId]['email'])) {
 960             $toEmail = $contactDetails[$contactId]['email'];
 961           }
 962
 963           if (!empty($contactDetails[$contactId]['do_not_email'])) {
 964             $doNotEmail = $contactDetails[$contactId]['do_not_email'];
 965           }
 966
 967           if (!empty($contactDetails[$contactId]['on_hold'])) {
 968             $onHold = $contactDetails[$contactId]['on_hold'];
 969           }
 970
 971           // 2. send acknowledgement mail
 972           if ($toEmail && !($doNotEmail || $onHold)) {
 973             //assign value to template
 974             $template->assign('amount_paid', $details['amount_paid'] ? $details['amount_paid'] : 0);
 975             $template->assign('contact', $contactDetails[$contactId]);
 976             $template->assign('next_payment', $details['scheduled_date']);
 977             $template->assign('amount_due', $details['amount_due']);
 978             $template->assign('checksumValue', $details['checksumValue']);
 979             $template->assign('contribution_page_id', $details['contribution_page_id']);
 980             $template->assign('pledge_id', $details['pledge_id']);
 981             $template->assign('scheduled_payment_date', $details['scheduled_date']);
 982             $template->assign('amount', $details['amount']);
 983             $template->assign('create_date', $details['create_date']);
 984             $template->assign('currency', $details['currency']);
 985             list($mailSent, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate::sendTemplate(
 986               array(
 987                 'groupName' => 'msg_tpl_workflow_pledge',
 988                 'valueName' => 'pledge_reminder',
 989                 'contactId' => $contactId,
 990                 'from' => $receiptFrom,
 991                 'toName' => $pledgerName,
 992                 'toEmail' => $toEmail,
 993               )
 994             );
 995
 996             // 3. update pledge payment details
 997             if ($mailSent) {
 998               CRM_Pledge_BAO_PledgePayment::updateReminderDetails($paymentId);
 999               $activityType = 'Pledge Reminder';
1000               $activityParams = array(
1001                 'subject' => $subject,
1002                 'source_contact_id' => $contactId,
1003                 'source_record_id' => $paymentId,
1004                 'assignee_contact_id' => $contactId,
1005                 'activity_type_id' => CRM_Core_OptionGroup::getValue('activity_type',
1006                   $activityType,
1007                   'name'
1008                 ),
1009                 'activity_date_time' => CRM_Utils_Date::isoToMysql($now),
1010                 'due_date_time' => CRM_Utils_Date::isoToMysql($details['scheduled_date']),
1011                 'is_test' => $details['is_test'],
1012                 'status_id' => 2,
1013                 'campaign_id' => $details['campaign_id'],
1014               );
1015               if (is_a(civicrm_api('activity', 'create', $activityParams), 'CRM_Core_Error')) {
1016                 $returnMessages[] = "Failed creating Activity for acknowledgment";
1017                 return array('is_error' => 1, 'message' => $returnMessages);
1018               }
1019               $returnMessages[] = "Payment reminder sent to: {$pledgerName} - {$toEmail}";
1020             }
1021           }
1022         }
1023       }
1024       // end foreach on $pledgeDetails
1025     }
1026     // end if ( $sendReminders )
1027     $returnMessages[] = "{$updateCnt} records updated.";
1028
1029     return array('is_error' => 0, 'messages' => implode("\n\r", $returnMessages));
1030   }
1031
1032   /**
1033    * Mark a pledge (and any outstanding payments) as cancelled.
1034    *
1035    * @param int $pledgeID
1036    */
1037   public static function cancel($pledgeID) {
1038     $statuses = array_flip(CRM_Contribute_PseudoConstant::contributionStatus());
1039     $paymentIDs = self::findCancelablePayments($pledgeID);
1040     CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($pledgeID, $paymentIDs, NULL,
1041       $statuses['Cancelled'], 0, FALSE, TRUE
1042     );
1043   }
1044
1045   /**
1046    * Find payments which can be safely canceled.
1047    *
1048    * @param int $pledgeID
1049    * @return array of int (civicrm_pledge_payment.id)
1050    */
1051   public static function findCancelablePayments($pledgeID) {
1052     $statuses = array_flip(CRM_Contribute_PseudoConstant::contributionStatus());
1053
1054     $paymentDAO = new CRM_Pledge_DAO_PledgePayment();
1055     $paymentDAO->pledge_id = $pledgeID;
1056     $paymentDAO->whereAdd(sprintf("status_id IN (%d,%d)",
1057       $statuses['Overdue'],
1058       $statuses['Pending']
1059     ));
1060     $paymentDAO->find();
1061
1062     $paymentIDs = array();
1063     while ($paymentDAO->fetch()) {
1064       $paymentIDs[] = $paymentDAO->id;
1065     }
1066     return $paymentIDs;
1067   }
1068 }
1069