352 lines
12 KiB
PHP
352 lines
12 KiB
PHP
|
<?php
|
||
|
|
/*
|
||
|
|
+--------------------------------------------------------------------+
|
||
|
|
| CiviCRM version 4.7 |
|
||
|
|
+--------------------------------------------------------------------+
|
||
|
|
| Copyright CiviCRM LLC (c) 2004-2017 |
|
||
|
|
+--------------------------------------------------------------------+
|
||
|
|
| This file is a part of CiviCRM. |
|
||
|
|
| |
|
||
|
|
| CiviCRM is free software; you can copy, modify, and distribute it |
|
||
|
|
| under the terms of the GNU Affero General Public License |
|
||
|
|
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
|
||
|
|
| |
|
||
|
|
| CiviCRM is distributed in the hope that it will be useful, but |
|
||
|
|
| WITHOUT ANY WARRANTY; without even the implied warranty of |
|
||
|
|
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
|
||
|
|
| See the GNU Affero General Public License for more details. |
|
||
|
|
| |
|
||
|
|
| You should have received a copy of the GNU Affero General Public |
|
||
|
|
| License and the CiviCRM Licensing Exception along |
|
||
|
|
| with this program; if not, contact CiviCRM LLC |
|
||
|
|
| at info[AT]civicrm[DOT]org. If you have questions about the |
|
||
|
|
| GNU Affero General Public License or the licensing of CiviCRM, |
|
||
|
|
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
|
||
|
|
+--------------------------------------------------------------------+
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
*
|
||
|
|
* @package CRM
|
||
|
|
* @copyright CiviCRM LLC (c) 2004-2017
|
||
|
|
*/
|
||
|
|
class CRM_Pledge_BAO_PledgeBlock extends CRM_Pledge_DAO_PledgeBlock {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Class constructor.
|
||
|
|
*/
|
||
|
|
public function __construct() {
|
||
|
|
parent::__construct();
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Retrieve DB object based on input parameters.
|
||
|
|
*
|
||
|
|
* It also stores all the retrieved values in the default array.
|
||
|
|
*
|
||
|
|
* @param array $params
|
||
|
|
* (reference ) an assoc array of name/value pairs.
|
||
|
|
* @param array $defaults
|
||
|
|
* (reference ) an assoc array to hold the flattened values.
|
||
|
|
*
|
||
|
|
* @return CRM_Pledge_BAO_PledgeBlock
|
||
|
|
*/
|
||
|
|
public static function retrieve(&$params, &$defaults) {
|
||
|
|
$pledgeBlock = new CRM_Pledge_DAO_PledgeBlock();
|
||
|
|
$pledgeBlock->copyValues($params);
|
||
|
|
if ($pledgeBlock->find(TRUE)) {
|
||
|
|
CRM_Core_DAO::storeValues($pledgeBlock, $defaults);
|
||
|
|
return $pledgeBlock;
|
||
|
|
}
|
||
|
|
return NULL;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Takes an associative array and creates a pledgeBlock object.
|
||
|
|
*
|
||
|
|
* @param array $params
|
||
|
|
* (reference ) an assoc array of name/value pairs.
|
||
|
|
*
|
||
|
|
* @return CRM_Pledge_BAO_PledgeBlock
|
||
|
|
*/
|
||
|
|
public static function &create(&$params) {
|
||
|
|
$transaction = new CRM_Core_Transaction();
|
||
|
|
$pledgeBlock = self::add($params);
|
||
|
|
|
||
|
|
if (is_a($pledgeBlock, 'CRM_Core_Error')) {
|
||
|
|
$pledgeBlock->rollback();
|
||
|
|
return $pledgeBlock;
|
||
|
|
}
|
||
|
|
|
||
|
|
$params['id'] = $pledgeBlock->id;
|
||
|
|
|
||
|
|
$transaction->commit();
|
||
|
|
|
||
|
|
return $pledgeBlock;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Add pledgeBlock.
|
||
|
|
*
|
||
|
|
* @param array $params
|
||
|
|
* Reference array contains the values submitted by the form.
|
||
|
|
*
|
||
|
|
*
|
||
|
|
* @return object
|
||
|
|
*/
|
||
|
|
public static function add(&$params) {
|
||
|
|
|
||
|
|
if (!empty($params['id'])) {
|
||
|
|
CRM_Utils_Hook::pre('edit', 'PledgeBlock', $params['id'], $params);
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
CRM_Utils_Hook::pre('create', 'PledgeBlock', NULL, $params);
|
||
|
|
}
|
||
|
|
|
||
|
|
$pledgeBlock = new CRM_Pledge_DAO_PledgeBlock();
|
||
|
|
|
||
|
|
// fix for pledge_frequency_unit
|
||
|
|
$freqUnits = CRM_Utils_Array::value('pledge_frequency_unit', $params);
|
||
|
|
|
||
|
|
if ($freqUnits && is_array($freqUnits)) {
|
||
|
|
unset($params['pledge_frequency_unit']);
|
||
|
|
$newFreqUnits = array();
|
||
|
|
foreach ($freqUnits as $k => $v) {
|
||
|
|
if ($v) {
|
||
|
|
$newFreqUnits[$k] = $v;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
$freqUnits = $newFreqUnits;
|
||
|
|
if (is_array($freqUnits) && !empty($freqUnits)) {
|
||
|
|
$freqUnits = implode(CRM_Core_DAO::VALUE_SEPARATOR, array_keys($freqUnits));
|
||
|
|
$pledgeBlock->pledge_frequency_unit = $freqUnits;
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$pledgeBlock->pledge_frequency_unit = '';
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
$pledgeBlock->copyValues($params);
|
||
|
|
$result = $pledgeBlock->save();
|
||
|
|
|
||
|
|
if (!empty($params['id'])) {
|
||
|
|
CRM_Utils_Hook::post('edit', 'PledgeBlock', $pledgeBlock->id, $pledgeBlock);
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
CRM_Utils_Hook::post('create', 'Pledge', $pledgeBlock->id, $pledgeBlock);
|
||
|
|
}
|
||
|
|
|
||
|
|
return $result;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Delete the pledgeBlock.
|
||
|
|
*
|
||
|
|
* @param int $id
|
||
|
|
* PledgeBlock id.
|
||
|
|
*
|
||
|
|
* @return mixed|null
|
||
|
|
*/
|
||
|
|
public static function deletePledgeBlock($id) {
|
||
|
|
CRM_Utils_Hook::pre('delete', 'PledgeBlock', $id, CRM_Core_DAO::$_nullArray);
|
||
|
|
|
||
|
|
$transaction = new CRM_Core_Transaction();
|
||
|
|
|
||
|
|
$results = NULL;
|
||
|
|
|
||
|
|
$dao = new CRM_Pledge_DAO_PledgeBlock();
|
||
|
|
$dao->id = $id;
|
||
|
|
$results = $dao->delete();
|
||
|
|
|
||
|
|
$transaction->commit();
|
||
|
|
|
||
|
|
CRM_Utils_Hook::post('delete', 'PledgeBlock', $dao->id, $dao);
|
||
|
|
|
||
|
|
return $results;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Return Pledge Block info in Contribution Pages.
|
||
|
|
*
|
||
|
|
* @param int $pageID
|
||
|
|
* Contribution page id.
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
public static function getPledgeBlock($pageID) {
|
||
|
|
$pledgeBlock = array();
|
||
|
|
|
||
|
|
$dao = new CRM_Pledge_DAO_PledgeBlock();
|
||
|
|
$dao->entity_table = 'civicrm_contribution_page';
|
||
|
|
$dao->entity_id = $pageID;
|
||
|
|
if ($dao->find(TRUE)) {
|
||
|
|
CRM_Core_DAO::storeValues($dao, $pledgeBlock);
|
||
|
|
}
|
||
|
|
|
||
|
|
return $pledgeBlock;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Build Pledge Block in Contribution Pages.
|
||
|
|
*
|
||
|
|
* @param CRM_Core_Form $form
|
||
|
|
*/
|
||
|
|
public static function buildPledgeBlock($form) {
|
||
|
|
//build pledge payment fields.
|
||
|
|
if (!empty($form->_values['pledge_id'])) {
|
||
|
|
//get all payments required details.
|
||
|
|
$allPayments = array();
|
||
|
|
$returnProperties = array(
|
||
|
|
'status_id',
|
||
|
|
'scheduled_date',
|
||
|
|
'scheduled_amount',
|
||
|
|
'currency',
|
||
|
|
'pledge_start_date',
|
||
|
|
);
|
||
|
|
CRM_Core_DAO::commonRetrieveAll('CRM_Pledge_DAO_PledgePayment', 'pledge_id',
|
||
|
|
$form->_values['pledge_id'], $allPayments, $returnProperties
|
||
|
|
);
|
||
|
|
// get all status
|
||
|
|
$allStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
|
||
|
|
|
||
|
|
$nextPayment = array();
|
||
|
|
$isNextPayment = FALSE;
|
||
|
|
$overduePayments = array();
|
||
|
|
foreach ($allPayments as $payID => $value) {
|
||
|
|
if ($allStatus[$value['status_id']] == 'Overdue') {
|
||
|
|
$overduePayments[$payID] = array(
|
||
|
|
'id' => $payID,
|
||
|
|
'scheduled_amount' => CRM_Utils_Rule::cleanMoney($value['scheduled_amount']),
|
||
|
|
'scheduled_amount_currency' => $value['currency'],
|
||
|
|
'scheduled_date' => CRM_Utils_Date::customFormat($value['scheduled_date'],
|
||
|
|
'%B %d'
|
||
|
|
),
|
||
|
|
);
|
||
|
|
}
|
||
|
|
elseif (!$isNextPayment &&
|
||
|
|
$allStatus[$value['status_id']] == 'Pending'
|
||
|
|
) {
|
||
|
|
// get the next payment.
|
||
|
|
$nextPayment = array(
|
||
|
|
'id' => $payID,
|
||
|
|
'scheduled_amount' => CRM_Utils_Rule::cleanMoney($value['scheduled_amount']),
|
||
|
|
'scheduled_amount_currency' => $value['currency'],
|
||
|
|
'scheduled_date' => CRM_Utils_Date::customFormat($value['scheduled_date'],
|
||
|
|
'%B %d'
|
||
|
|
),
|
||
|
|
);
|
||
|
|
$isNextPayment = TRUE;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
// build check box array for payments.
|
||
|
|
$payments = array();
|
||
|
|
if (!empty($overduePayments)) {
|
||
|
|
foreach ($overduePayments as $id => $payment) {
|
||
|
|
$label = ts("%1 - due on %2 (overdue)", array(
|
||
|
|
1 => CRM_Utils_Money::format(CRM_Utils_Array::value('scheduled_amount', $payment), CRM_Utils_Array::value('scheduled_amount_currency', $payment)),
|
||
|
|
2 => CRM_Utils_Array::value('scheduled_date', $payment),
|
||
|
|
));
|
||
|
|
$paymentID = CRM_Utils_Array::value('id', $payment);
|
||
|
|
$payments[] = $form->createElement('checkbox', $paymentID, NULL, $label, array('amount' => CRM_Utils_Array::value('scheduled_amount', $payment)));
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!empty($nextPayment)) {
|
||
|
|
$label = ts("%1 - due on %2", array(
|
||
|
|
1 => CRM_Utils_Money::format(CRM_Utils_Array::value('scheduled_amount', $nextPayment), CRM_Utils_Array::value('scheduled_amount_currency', $nextPayment)),
|
||
|
|
2 => CRM_Utils_Array::value('scheduled_date', $nextPayment),
|
||
|
|
));
|
||
|
|
$paymentID = CRM_Utils_Array::value('id', $nextPayment);
|
||
|
|
$payments[] = $form->createElement('checkbox', $paymentID, NULL, $label, array('amount' => CRM_Utils_Array::value('scheduled_amount', $nextPayment)));
|
||
|
|
}
|
||
|
|
// give error if empty or build form for payment.
|
||
|
|
if (empty($payments)) {
|
||
|
|
CRM_Core_Error::fatal(ts("Oops. It looks like there is no valid payment status for online payment."));
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$form->assign('is_pledge_payment', TRUE);
|
||
|
|
$form->addGroup($payments, 'pledge_amount', ts('Make Pledge Payment(s):'), '<br />');
|
||
|
|
}
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
|
||
|
|
$pledgeBlock = self::getPledgeBlock($form->_id);
|
||
|
|
|
||
|
|
// build form for pledge creation.
|
||
|
|
$pledgeOptions = array(
|
||
|
|
'0' => ts('I want to make a one-time contribution'),
|
||
|
|
'1' => ts('I pledge to contribute this amount every'),
|
||
|
|
);
|
||
|
|
$form->addRadio('is_pledge', ts('Pledge Frequency Interval'), $pledgeOptions,
|
||
|
|
NULL, array('<br/>')
|
||
|
|
);
|
||
|
|
$form->addElement('text', 'pledge_installments', ts('Installments'), array('size' => 3));
|
||
|
|
|
||
|
|
if (!empty($pledgeBlock['is_pledge_interval'])) {
|
||
|
|
$form->assign('is_pledge_interval', CRM_Utils_Array::value('is_pledge_interval', $pledgeBlock));
|
||
|
|
$form->addElement('text', 'pledge_frequency_interval', NULL, array('size' => 3));
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$form->add('hidden', 'pledge_frequency_interval', 1);
|
||
|
|
}
|
||
|
|
// Frequency unit drop-down label suffixes switch from *ly to *(s)
|
||
|
|
$freqUnitVals = explode(CRM_Core_DAO::VALUE_SEPARATOR, $pledgeBlock['pledge_frequency_unit']);
|
||
|
|
$freqUnits = array();
|
||
|
|
$frequencyUnits = CRM_Core_OptionGroup::values('recur_frequency_units');
|
||
|
|
foreach ($freqUnitVals as $key => $val) {
|
||
|
|
if (array_key_exists($val, $frequencyUnits)) {
|
||
|
|
$freqUnits[$val] = !empty($pledgeBlock['is_pledge_interval']) ? "{$frequencyUnits[$val]}(s)" : $frequencyUnits[$val];
|
||
|
|
}
|
||
|
|
}
|
||
|
|
$form->addElement('select', 'pledge_frequency_unit', NULL, $freqUnits);
|
||
|
|
// CRM-18854
|
||
|
|
if (CRM_Utils_Array::value('is_pledge_start_date_visible', $pledgeBlock)) {
|
||
|
|
if (CRM_Utils_Array::value('pledge_start_date', $pledgeBlock)) {
|
||
|
|
$defaults = array();
|
||
|
|
$date = (array) json_decode($pledgeBlock['pledge_start_date']);
|
||
|
|
list($field, $value) = each($date);
|
||
|
|
switch ($field) {
|
||
|
|
case 'contribution_date':
|
||
|
|
$form->addDate('start_date', ts('First installment payment'));
|
||
|
|
$paymentDate = $value = date('m/d/Y');
|
||
|
|
list($defaults['start_date'], $defaults['start_date_time']) = CRM_Utils_Date::setDateDefaults(NULL);
|
||
|
|
$form->assign('is_date', TRUE);
|
||
|
|
break;
|
||
|
|
|
||
|
|
case 'calendar_date':
|
||
|
|
$form->addDate('start_date', ts('First installment payment'));
|
||
|
|
list($defaults['start_date'], $defaults['start_date_time']) = CRM_Utils_Date::setDateDefaults($value);
|
||
|
|
$form->assign('is_date', TRUE);
|
||
|
|
$paymentDate = $value;
|
||
|
|
break;
|
||
|
|
|
||
|
|
case 'calendar_month':
|
||
|
|
$month = CRM_Utils_Date::getCalendarDayOfMonth();
|
||
|
|
$form->add('select', 'start_date', ts('Day of month installments paid'), $month);
|
||
|
|
$paymentDate = CRM_Pledge_BAO_Pledge::getPaymentDate($value);
|
||
|
|
list($defaults['start_date'], $defaults['start_date_time']) = CRM_Utils_Date::setDateDefaults($paymentDate);
|
||
|
|
break;
|
||
|
|
|
||
|
|
default:
|
||
|
|
break;
|
||
|
|
|
||
|
|
}
|
||
|
|
$form->setDefaults($defaults);
|
||
|
|
$form->assign('start_date_display', $paymentDate);
|
||
|
|
$form->assign('start_date_editable', FALSE);
|
||
|
|
if (CRM_Utils_Array::value('is_pledge_start_date_editable', $pledgeBlock)) {
|
||
|
|
$form->assign('start_date_editable', TRUE);
|
||
|
|
if ($field == 'calendar_month') {
|
||
|
|
$form->assign('is_date', FALSE);
|
||
|
|
$form->setDefaults(array('start_date' => $value));
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
}
|