3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
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_PledgeBlock
extends CRM_Pledge_DAO_PledgeBlock
{
40 public function __construct() {
41 parent
::__construct();
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
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
54 * @return CRM_Pledge_BAO_PledgeBlock object
57 public static function retrieve(&$params, &$defaults) {
58 $pledgeBlock = new CRM_Pledge_DAO_PledgeBlock();
59 $pledgeBlock->copyValues($params);
60 if ($pledgeBlock->find(TRUE)) {
61 CRM_Core_DAO
::storeValues($pledgeBlock, $defaults);
68 * Takes an associative array and creates a pledgeBlock object
70 * @param array $params (reference ) an assoc array of name/value pairs
72 * @return CRM_Pledge_BAO_PledgeBlock object
75 public static function &create(&$params) {
76 $transaction = new CRM_Core_Transaction();
77 $pledgeBlock = self
::add($params);
79 if (is_a($pledgeBlock, 'CRM_Core_Error')) {
80 $pledgeBlock->rollback();
84 $params['id'] = $pledgeBlock->id
;
86 $transaction->commit();
94 * @param array $params reference array contains the values submitted by the form
100 public static function add(&$params) {
102 if (!empty($params['id'])) {
103 CRM_Utils_Hook
::pre('edit', 'PledgeBlock', $params['id'], $params);
106 CRM_Utils_Hook
::pre('create', 'PledgeBlock', NULL, $params);
109 $pledgeBlock = new CRM_Pledge_DAO_PledgeBlock();
111 //fix for pledge_frequency_unit
112 $freqUnits = CRM_Utils_Array
::value('pledge_frequency_unit', $params);
114 if ($freqUnits && is_array($freqUnits)) {
115 unset($params['pledge_frequency_unit']);
116 $newFreqUnits = array();
117 foreach ($freqUnits as $k => $v) {
119 $newFreqUnits[$k] = $v;
123 $freqUnits = $newFreqUnits;
124 if (is_array($freqUnits) && !empty($freqUnits)) {
125 $freqUnits = implode(CRM_Core_DAO
::VALUE_SEPARATOR
, array_keys($freqUnits));
126 $pledgeBlock->pledge_frequency_unit
= $freqUnits;
129 $pledgeBlock->pledge_frequency_unit
= '';
133 $pledgeBlock->copyValues($params);
134 $result = $pledgeBlock->save();
136 if (!empty($params['id'])) {
137 CRM_Utils_Hook
::post('edit', 'PledgeBlock', $pledgeBlock->id
, $pledgeBlock);
140 CRM_Utils_Hook
::post('create', 'Pledge', $pledgeBlock->id
, $pledgeBlock);
147 * Delete the pledgeBlock
149 * @param int $id pledgeBlock id
154 public static function deletePledgeBlock($id) {
155 CRM_Utils_Hook
::pre('delete', 'PledgeBlock', $id, CRM_Core_DAO
::$_nullArray);
157 $transaction = new CRM_Core_Transaction();
161 $dao = new CRM_Pledge_DAO_PledgeBlock();
163 $results = $dao->delete();
165 $transaction->commit();
167 CRM_Utils_Hook
::post('delete', 'PledgeBlock', $dao->id
, $dao);
173 * Return Pledge Block info in Contribution Pages
175 * @param int $pageID contribution page id
180 public static function getPledgeBlock($pageID) {
181 $pledgeBlock = array();
183 $dao = new CRM_Pledge_DAO_PledgeBlock();
184 $dao->entity_table
= 'civicrm_contribution_page';
185 $dao->entity_id
= $pageID;
186 if ($dao->find(TRUE)) {
187 CRM_Core_DAO
::storeValues($dao, $pledgeBlock);
194 * Build Pledge Block in Contribution Pages
196 * @param CRM_Core_Form $form
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(
210 CRM_Core_DAO
::commonRetrieveAll('CRM_Pledge_DAO_PledgePayment', 'pledge_id',
211 $form->_values
['pledge_id'], $allPayments, $returnProperties
214 $allStatus = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
216 $nextPayment = array();
217 $isNextPayment = FALSE;
218 $overduePayments = array();
220 foreach ($allPayments as $payID => $value) {
221 if ($allStatus[$value['status_id']] == 'Overdue') {
222 $overduePayments[$payID] = array(
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'],
231 elseif (!$isNextPayment &&
232 $allStatus[$value['status_id']] == 'Pending'
234 //get the next payment.
235 $nextPayment = array(
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'],
243 $isNextPayment = TRUE;
247 //build check box array for payments.
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),
255 $payments[$key] = CRM_Utils_Array
::value('id', $payment);
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),
264 $payments[$key] = CRM_Utils_Array
::value('id', $nextPayment);
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."));
271 $form->assign('is_pledge_payment', TRUE);
272 $form->addCheckBox('pledge_amount', ts('Make Pledge Payment(s):'), $payments);
277 $pledgeBlock = self
::getPledgeBlock($form->_id
);
279 //build form for pledge creation.
280 $pledgeOptions = array('0' => ts('I want to make a one-time contribution'),
281 '1' => ts('I pledge to contribute this amount every'),
283 $form->addRadio('is_pledge', ts('Pledge Frequency Interval'), $pledgeOptions,
286 $form->addElement('text', 'pledge_installments', ts('Installments'), array('size' => 3));
288 if (!empty($pledgeBlock['is_pledge_interval'])) {
289 $form->assign('is_pledge_interval', CRM_Utils_Array
::value('is_pledge_interval', $pledgeBlock));
290 $form->addElement('text', 'pledge_frequency_interval', NULL, array('size' => 3));
293 $form->add('hidden', 'pledge_frequency_interval', 1);
295 //Frequency unit drop-down label suffixes switch from *ly to *(s)
296 $freqUnitVals = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $pledgeBlock['pledge_frequency_unit']);
297 $freqUnits = array();
298 $frequencyUnits = CRM_Core_OptionGroup
::values('recur_frequency_units');
299 foreach ($freqUnitVals as $key => $val) {
300 if (array_key_exists($val, $frequencyUnits)) {
301 $freqUnits[$val] = !empty($pledgeBlock['is_pledge_interval']) ?
"{$frequencyUnits[$val]}(s)" : $frequencyUnits[$val];
304 $form->addElement('select', 'pledge_frequency_unit', NULL, $freqUnits);