CRM/Pledge/BAO/PledgeBlock.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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-2019
  32  */
  33 class CRM_Pledge_BAO_PledgeBlock extends CRM_Pledge_DAO_PledgeBlock {
  34
  35   /**
  36    * Class constructor.
  37    */
  38   public function __construct() {
  39     parent::__construct();
  40   }
  41
  42   /**
  43    * Retrieve DB object based on input parameters.
  44    *
  45    * It also stores all the retrieved values in the default array.
  46    *
  47    * @param array $params
  48    *   (reference ) an assoc array of name/value pairs.
  49    * @param array $defaults
  50    *   (reference ) an assoc array to hold the flattened values.
  51    *
  52    * @return CRM_Pledge_BAO_PledgeBlock
  53    */
  54   public static function retrieve(&$params, &$defaults) {
  55     $pledgeBlock = new CRM_Pledge_DAO_PledgeBlock();
  56     $pledgeBlock->copyValues($params);
  57     if ($pledgeBlock->find(TRUE)) {
  58       CRM_Core_DAO::storeValues($pledgeBlock, $defaults);
  59       return $pledgeBlock;
  60     }
  61     return NULL;
  62   }
  63
  64   /**
  65    * Takes an associative array and creates a pledgeBlock object.
  66    *
  67    * @param array $params
  68    *   (reference ) an assoc array of name/value pairs.
  69    *
  70    * @return CRM_Pledge_BAO_PledgeBlock
  71    */
  72   public static function &create(&$params) {
  73     $transaction = new CRM_Core_Transaction();
  74     $pledgeBlock = self::add($params);
  75
  76     if (is_a($pledgeBlock, 'CRM_Core_Error')) {
  77       $pledgeBlock->rollback();
  78       return $pledgeBlock;
  79     }
  80
  81     $params['id'] = $pledgeBlock->id;
  82
  83     $transaction->commit();
  84
  85     return $pledgeBlock;
  86   }
  87
  88   /**
  89    * Add pledgeBlock.
  90    *
  91    * @param array $params
  92    *   Reference array contains the values submitted by the form.
  93    *
  94    *
  95    * @return object
  96    */
  97   public static function add(&$params) {
  98
  99     if (!empty($params['id'])) {
 100       CRM_Utils_Hook::pre('edit', 'PledgeBlock', $params['id'], $params);
 101     }
 102     else {
 103       CRM_Utils_Hook::pre('create', 'PledgeBlock', NULL, $params);
 104     }
 105
 106     $pledgeBlock = new CRM_Pledge_DAO_PledgeBlock();
 107
 108     // fix for pledge_frequency_unit
 109     $freqUnits = CRM_Utils_Array::value('pledge_frequency_unit', $params);
 110
 111     if ($freqUnits && is_array($freqUnits)) {
 112       unset($params['pledge_frequency_unit']);
 113       $newFreqUnits = array();
 114       foreach ($freqUnits as $k => $v) {
 115         if ($v) {
 116           $newFreqUnits[$k] = $v;
 117         }
 118       }
 119
 120       $freqUnits = $newFreqUnits;
 121       if (is_array($freqUnits) && !empty($freqUnits)) {
 122         $freqUnits = implode(CRM_Core_DAO::VALUE_SEPARATOR, array_keys($freqUnits));
 123         $pledgeBlock->pledge_frequency_unit = $freqUnits;
 124       }
 125       else {
 126         $pledgeBlock->pledge_frequency_unit = '';
 127       }
 128     }
 129
 130     $pledgeBlock->copyValues($params);
 131     $result = $pledgeBlock->save();
 132
 133     if (!empty($params['id'])) {
 134       CRM_Utils_Hook::post('edit', 'PledgeBlock', $pledgeBlock->id, $pledgeBlock);
 135     }
 136     else {
 137       CRM_Utils_Hook::post('create', 'Pledge', $pledgeBlock->id, $pledgeBlock);
 138     }
 139
 140     return $result;
 141   }
 142
 143   /**
 144    * Delete the pledgeBlock.
 145    *
 146    * @param int $id
 147    *   PledgeBlock id.
 148    *
 149    * @return mixed|null
 150    */
 151   public static function deletePledgeBlock($id) {
 152     CRM_Utils_Hook::pre('delete', 'PledgeBlock', $id, CRM_Core_DAO::$_nullArray);
 153
 154     $transaction = new CRM_Core_Transaction();
 155
 156     $results = NULL;
 157
 158     $dao = new CRM_Pledge_DAO_PledgeBlock();
 159     $dao->id = $id;
 160     $results = $dao->delete();
 161
 162     $transaction->commit();
 163
 164     CRM_Utils_Hook::post('delete', 'PledgeBlock', $dao->id, $dao);
 165
 166     return $results;
 167   }
 168
 169   /**
 170    * Return Pledge  Block info in Contribution Pages.
 171    *
 172    * @param int $pageID
 173    *   Contribution page id.
 174    *
 175    * @return array
 176    */
 177   public static function getPledgeBlock($pageID) {
 178     $pledgeBlock = array();
 179
 180     $dao = new CRM_Pledge_DAO_PledgeBlock();
 181     $dao->entity_table = 'civicrm_contribution_page';
 182     $dao->entity_id = $pageID;
 183     if ($dao->find(TRUE)) {
 184       CRM_Core_DAO::storeValues($dao, $pledgeBlock);
 185     }
 186
 187     return $pledgeBlock;
 188   }
 189
 190   /**
 191    * Build Pledge Block in Contribution Pages.
 192    *
 193    * @param CRM_Core_Form $form
 194    */
 195   public static function buildPledgeBlock($form) {
 196     //build pledge payment fields.
 197     if (!empty($form->_values['pledge_id'])) {
 198       //get all payments required details.
 199       $allPayments = array();
 200       $returnProperties = array(
 201         'status_id',
 202         'scheduled_date',
 203         'scheduled_amount',
 204         'currency',
 205       );
 206       CRM_Core_DAO::commonRetrieveAll('CRM_Pledge_DAO_PledgePayment', 'pledge_id',
 207         $form->_values['pledge_id'], $allPayments, $returnProperties
 208       );
 209       // get all status
 210       $allStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
 211
 212       $nextPayment = array();
 213       $isNextPayment = FALSE;
 214       $overduePayments = array();
 215       foreach ($allPayments as $payID => $value) {
 216         if ($allStatus[$value['status_id']] == 'Overdue') {
 217           $overduePayments[$payID] = array(
 218             'id' => $payID,
 219             'scheduled_amount' => CRM_Utils_Rule::cleanMoney($value['scheduled_amount']),
 220             'scheduled_amount_currency' => $value['currency'],
 221             'scheduled_date' => CRM_Utils_Date::customFormat($value['scheduled_date'],
 222               '%B %d'
 223             ),
 224           );
 225         }
 226         elseif (!$isNextPayment &&
 227           $allStatus[$value['status_id']] == 'Pending'
 228         ) {
 229           // get the next payment.
 230           $nextPayment = array(
 231             'id' => $payID,
 232             'scheduled_amount' => CRM_Utils_Rule::cleanMoney($value['scheduled_amount']),
 233             'scheduled_amount_currency' => $value['currency'],
 234             'scheduled_date' => CRM_Utils_Date::customFormat($value['scheduled_date'],
 235               '%B %d'
 236             ),
 237           );
 238           $isNextPayment = TRUE;
 239         }
 240       }
 241
 242       // build check box array for payments.
 243       $payments = array();
 244       if (!empty($overduePayments)) {
 245         foreach ($overduePayments as $id => $payment) {
 246           $label = ts("%1 - due on %2 (overdue)", array(
 247             1 => CRM_Utils_Money::format(CRM_Utils_Array::value('scheduled_amount', $payment), CRM_Utils_Array::value('scheduled_amount_currency', $payment)),
 248             2 => CRM_Utils_Array::value('scheduled_date', $payment),
 249           ));
 250           $paymentID = CRM_Utils_Array::value('id', $payment);
 251           $payments[] = $form->createElement('checkbox', $paymentID, NULL, $label, array('amount' => CRM_Utils_Array::value('scheduled_amount', $payment)));
 252         }
 253       }
 254
 255       if (!empty($nextPayment)) {
 256         $label = ts("%1 - due on %2", array(
 257           1 => CRM_Utils_Money::format(CRM_Utils_Array::value('scheduled_amount', $nextPayment), CRM_Utils_Array::value('scheduled_amount_currency', $nextPayment)),
 258           2 => CRM_Utils_Array::value('scheduled_date', $nextPayment),
 259         ));
 260         $paymentID = CRM_Utils_Array::value('id', $nextPayment);
 261         $payments[] = $form->createElement('checkbox', $paymentID, NULL, $label, array('amount' => CRM_Utils_Array::value('scheduled_amount', $nextPayment)));
 262       }
 263       // give error if empty or build form for payment.
 264       if (empty($payments)) {
 265         CRM_Core_Error::fatal(ts("Oops. It looks like there is no valid payment status for online payment."));
 266       }
 267       else {
 268         $form->assign('is_pledge_payment', TRUE);
 269         $form->addGroup($payments, 'pledge_amount', ts('Make Pledge Payment(s):'), '<br />');
 270       }
 271     }
 272     else {
 273
 274       $pledgeBlock = self::getPledgeBlock($form->_id);
 275
 276       // build form for pledge creation.
 277       $pledgeOptions = array(
 278         '0' => ts('I want to make a one-time contribution'),
 279         '1' => ts('I pledge to contribute this amount every'),
 280       );
 281       $form->addRadio('is_pledge', ts('Pledge Frequency Interval'), $pledgeOptions,
 282         NULL, array('<br/>')
 283       );
 284       $form->addElement('text', 'pledge_installments', ts('Installments'), ['size' => 3, 'aria-label' => ts('Installments')]);
 285
 286       if (!empty($pledgeBlock['is_pledge_interval'])) {
 287         $form->assign('is_pledge_interval', CRM_Utils_Array::value('is_pledge_interval', $pledgeBlock));
 288         $form->addElement('text', 'pledge_frequency_interval', NULL, ['size' => 3, 'aria-label' => ts('Frequency Intervals')]);
 289       }
 290       else {
 291         $form->add('hidden', 'pledge_frequency_interval', 1);
 292       }
 293       // Frequency unit drop-down label suffixes switch from *ly to *(s)
 294       $freqUnitVals = explode(CRM_Core_DAO::VALUE_SEPARATOR, $pledgeBlock['pledge_frequency_unit']);
 295       $freqUnits = array();
 296       $frequencyUnits = CRM_Core_OptionGroup::values('recur_frequency_units');
 297       foreach ($freqUnitVals as $key => $val) {
 298         if (array_key_exists($val, $frequencyUnits)) {
 299           $freqUnits[$val] = !empty($pledgeBlock['is_pledge_interval']) ? "{$frequencyUnits[$val]}(s)" : $frequencyUnits[$val];
 300         }
 301       }
 302       $form->addElement('select', 'pledge_frequency_unit', NULL, $freqUnits, ['aria-label' => ts('Frequency Units')]);
 303       // CRM-18854
 304       if (!empty($pledgeBlock['is_pledge_start_date_visible'])) {
 305         if (!empty($pledgeBlock['pledge_start_date'])) {
 306           $defaults = array();
 307           $date = (array) json_decode($pledgeBlock['pledge_start_date']);
 308           foreach ($date as $field => $value) {
 309             switch ($field) {
 310               case 'contribution_date':
 311                 $form->add('datepicker', 'start_date', ts('First installment payment'), [], FALSE, ['time' => FALSE]);
 312                 $paymentDate = $value = date('Y-m-d');
 313                 $defaults['start_date'] = $value;
 314                 $form->assign('is_date', TRUE);
 315                 break;
 316
 317               case 'calendar_date':
 318                 $form->add('datepicker', 'start_date', ts('First installment payment'), [], FALSE, ['time' => FALSE]);
 319                 $defaults['start_date'] = $value;
 320                 $form->assign('is_date', TRUE);
 321                 $paymentDate = $value;
 322                 break;
 323
 324               case 'calendar_month':
 325                 $month = CRM_Utils_Date::getCalendarDayOfMonth();
 326                 $form->add('select', 'start_date', ts('Day of month installments paid'), $month);
 327                 $paymentDate = CRM_Pledge_BAO_Pledge::getPaymentDate($value);
 328                 $defaults['start_date'] = $paymentDate;
 329                 break;
 330
 331               default:
 332                 break;
 333
 334             }
 335             $form->setDefaults($defaults);
 336             $form->assign('start_date_display', $paymentDate);
 337             $form->assign('start_date_editable', FALSE);
 338             if (!empty($pledgeBlock['is_pledge_start_date_editable'])) {
 339               $form->assign('start_date_editable', TRUE);
 340               if ($field == 'calendar_month') {
 341                 $form->assign('is_date', FALSE);
 342                 $form->setDefaults(array('start_date' => $value));
 343               }
 344             }
 345           }
 346         }
 347       }
 348     }
 349   }
 350
 351 }