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