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