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_Contribute_BAO_ContributionRecur
extends CRM_Contribute_DAO_ContributionRecur
{
38 * Create recurring contribution
40 * @param array $params (reference ) an assoc array of name/value pairs
42 * @return object activity contact object
46 public static function create(&$params) {
47 return self
::add($params);
51 * Takes an associative array and creates a contribution object
53 * the function extract all the params it needs to initialize the create a
54 * contribution object. the params array could contain additional unused name/value
57 * @param array $params (reference ) an assoc array of name/value pairs
59 * @return CRM_Contribute_BAO_Contribution object
62 * @todo move hook calls / extended logic to create - requires changing calls to call create not add
64 public static function add(&$params) {
65 if (!empty($params['id'])) {
66 CRM_Utils_Hook
::pre('edit', 'ContributionRecur', $params['id'], $params);
69 CRM_Utils_Hook
::pre('create', 'ContributionRecur', NULL, $params);
72 // make sure we're not creating a new recurring contribution with the same transaction ID
73 // or invoice ID as an existing recurring contribution
74 $duplicates = array();
75 if (self
::checkDuplicate($params, $duplicates)) {
76 $error = CRM_Core_Error
::singleton();
77 $d = implode(', ', $duplicates);
78 $error->push(CRM_Core_Error
::DUPLICATE_CONTRIBUTION
,
81 "Found matching recurring contribution(s): $d"
86 $recurring = new CRM_Contribute_BAO_ContributionRecur();
87 $recurring->copyValues($params);
88 $recurring->id
= CRM_Utils_Array
::value('id', $params);
90 // set currency for CRM-1496
91 if (!isset($recurring->currency
)) {
92 $config = CRM_Core_Config
::singleton();
93 $recurring->currency
= $config->defaultCurrency
;
95 $result = $recurring->save();
97 if (!empty($params['id'])) {
98 CRM_Utils_Hook
::post('edit', 'ContributionRecur', $recurring->id
, $recurring);
101 CRM_Utils_Hook
::post('create', 'ContributionRecur', $recurring->id
, $recurring);
108 * Check if there is a recurring contribution with the same trxn_id or invoice_id
110 * @param array $params (reference ) an assoc array of name/value pairs
111 * @param array $duplicates (reference ) store ids of duplicate contribs
113 * @return boolean true if duplicate, false otherwise
117 public static function checkDuplicate($params, &$duplicates) {
118 $id = CRM_Utils_Array
::value('id', $params);
119 $trxn_id = CRM_Utils_Array
::value('trxn_id', $params);
120 $invoice_id = CRM_Utils_Array
::value('invoice_id', $params);
126 $clause[] = "trxn_id = %1";
127 $params[1] = array($trxn_id, 'String');
131 $clause[] = "invoice_id = %2";
132 $params[2] = array($invoice_id, 'String');
135 if (empty($clause)) {
139 $clause = implode(' OR ', $clause);
141 $clause = "( $clause ) AND id != %3";
142 $params[3] = array($id, 'Integer');
145 $query = "SELECT id FROM civicrm_contribution_recur WHERE $clause";
146 $dao = CRM_Core_DAO
::executeQuery($query, $params);
148 while ($dao->fetch()) {
149 $duplicates[] = $dao->id
;
161 public static function getPaymentProcessor($id, $mode) {
164 SELECT r.payment_processor_id
165 FROM civicrm_contribution_recur r
167 $params = array(1 => array($id, 'Integer'));
168 $paymentProcessorID = &CRM_Core_DAO
::singleValueQuery($sql,
171 if (!$paymentProcessorID) {
175 return CRM_Financial_BAO_PaymentProcessor
::getPayment($paymentProcessorID, $mode);
179 * Get the number of installment done/completed for each recurring contribution
181 * @param array $ids (reference ) an array of recurring contribution ids
183 * @return array $totalCount an array of recurring ids count
187 public static function getCount(&$ids) {
188 $recurID = implode(',', $ids);
189 $totalCount = array();
192 SELECT contribution_recur_id, count( contribution_recur_id ) as commpleted
193 FROM civicrm_contribution
194 WHERE contribution_recur_id IN ( {$recurID}) AND is_test = 0
195 GROUP BY contribution_recur_id";
197 $res = CRM_Core_DAO
::executeQuery($query, CRM_Core_DAO
::$_nullArray);
199 while ($res->fetch()) {
200 $totalCount[$res->contribution_recur_id
] = $res->commpleted
;
206 * Delete Recurring contribution.
208 * @param int $recurId
214 public static function deleteRecurContribution($recurId) {
220 $recur = new CRM_Contribute_DAO_ContributionRecur();
221 $recur->id
= $recurId;
222 $result = $recur->delete();
228 * Cancel Recurring contribution.
230 * @param integer $recurId recur contribution id.
231 * @param array $objects an array of objects that is to be cancelled like
232 * contribution, membership, event. At least contribution object is a must.
234 * @param array $activityParams
240 public static function cancelRecurContribution($recurId, $objects, $activityParams = array()) {
245 $contributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
246 $canceledId = array_search('Cancelled', $contributionStatus);
247 $recur = new CRM_Contribute_DAO_ContributionRecur();
248 $recur->id
= $recurId;
249 $recur->whereAdd("contribution_status_id != $canceledId");
251 if ($recur->find(TRUE)) {
252 $transaction = new CRM_Core_Transaction();
253 $recur->contribution_status_id
= $canceledId;
254 $recur->start_date
= CRM_Utils_Date
::isoToMysql($recur->start_date
);
255 $recur->create_date
= CRM_Utils_Date
::isoToMysql($recur->create_date
);
256 $recur->modified_date
= CRM_Utils_Date
::isoToMysql($recur->modified_date
);
257 $recur->cancel_date
= date('YmdHis');
260 $dao = CRM_Contribute_BAO_ContributionRecur
::getSubscriptionDetails($recurId);
261 if ($dao && $dao->recur_id
) {
262 $details = CRM_Utils_Array
::value('details', $activityParams);
263 if ($dao->auto_renew
&& $dao->membership_id
) {
264 // its auto-renewal membership mode
265 $membershipTypes = CRM_Member_PseudoConstant
::membershipType();
266 $membershipType = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $dao->membership_id
, 'membership_type_id');
267 $membershipType = CRM_Utils_Array
::value($membershipType, $membershipTypes);
269 <br/>' . ts('Automatic renewal of %1 membership cancelled.', array(1 => $membershipType));
273 <br/>' . ts('The recurring contribution of %1, every %2 %3 has been cancelled.', array(
275 2 => $dao->frequency_interval
,
276 3 => $dao->frequency_unit
279 $activityParams = array(
280 'source_contact_id' => $dao->contact_id
,
281 'source_record_id' => CRM_Utils_Array
::value('source_record_id', $activityParams),
282 'activity_type_id' => CRM_Core_OptionGroup
::getValue('activity_type',
283 'Cancel Recurring Contribution',
286 'subject' => CRM_Utils_Array
::value('subject', $activityParams, ts('Recurring contribution cancelled')),
287 'details' => $details,
288 'activity_date_time' => date('YmdHis'),
289 'status_id' => CRM_Core_OptionGroup
::getValue('activity_status',
294 $session = CRM_Core_Session
::singleton();
295 $cid = $session->get('userID');
297 $activityParams['target_contact_id'][] = $activityParams['source_contact_id'];
298 $activityParams['source_contact_id'] = $cid;
300 CRM_Activity_BAO_Activity
::create($activityParams);
303 // if there are associated objects, cancel them as well
304 if ($objects == CRM_Core_DAO
::$_nullObject) {
305 $transaction->commit();
309 $baseIPN = new CRM_Core_Payment_BaseIPN();
310 return $baseIPN->cancelled($objects, $transaction);
314 // if already cancelled, return true
316 $recur->whereAdd("contribution_status_id = $canceledId");
317 if ($recur->find(TRUE)) {
326 * Get list of recurring contribution of contact Ids
328 * @param int $contactId Contact ID
330 * @return array list of recurring contribution fields
335 public static function getRecurContributions($contactId) {
337 $recurDAO = new CRM_Contribute_DAO_ContributionRecur();
338 $recurDAO->contact_id
= $contactId;
340 $contributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus();
342 while ($recurDAO->fetch()) {
343 $params[$recurDAO->id
]['id'] = $recurDAO->id
;
344 $params[$recurDAO->id
]['contactId'] = $recurDAO->contact_id
;
345 $params[$recurDAO->id
]['start_date'] = $recurDAO->start_date
;
346 $params[$recurDAO->id
]['end_date'] = $recurDAO->end_date
;
347 $params[$recurDAO->id
]['next_sched_contribution_date'] = $recurDAO->next_sched_contribution_date
;
348 $params[$recurDAO->id
]['amount'] = $recurDAO->amount
;
349 $params[$recurDAO->id
]['currency'] = $recurDAO->currency
;
350 $params[$recurDAO->id
]['frequency_unit'] = $recurDAO->frequency_unit
;
351 $params[$recurDAO->id
]['frequency_interval'] = $recurDAO->frequency_interval
;
352 $params[$recurDAO->id
]['installments'] = $recurDAO->installments
;
353 $params[$recurDAO->id
]['contribution_status_id'] = $recurDAO->contribution_status_id
;
354 $params[$recurDAO->id
]['contribution_status'] = CRM_Utils_Array
::value($recurDAO->contribution_status_id
, $contributionStatus);
355 $params[$recurDAO->id
]['is_test'] = $recurDAO->is_test
;
356 $params[$recurDAO->id
]['payment_processor_id'] = $recurDAO->payment_processor_id
;
363 * @param int $entityID
364 * @param string $entity
366 * @return null|Object
368 public static function getSubscriptionDetails($entityID, $entity = 'recur') {
370 SELECT rec.id as recur_id,
371 rec.processor_id as subscription_id,
372 rec.frequency_interval,
379 con.id as contribution_id,
380 con.contribution_page_id,
384 if ($entity == 'recur') {
386 FROM civicrm_contribution_recur rec
387 LEFT JOIN civicrm_contribution con ON ( con.contribution_recur_id = rec.id )
388 LEFT JOIN civicrm_membership_payment mp ON ( mp.contribution_id = con.id )
392 elseif ($entity == 'contribution') {
394 FROM civicrm_contribution con
395 INNER JOIN civicrm_contribution_recur rec ON ( con.contribution_recur_id = rec.id )
396 LEFT JOIN civicrm_membership_payment mp ON ( mp.contribution_id = con.id )
399 elseif ($entity == 'membership') {
401 FROM civicrm_membership_payment mp
402 INNER JOIN civicrm_membership mem ON ( mp.membership_id = mem.id )
403 INNER JOIN civicrm_contribution_recur rec ON ( mem.contribution_recur_id = rec.id )
404 INNER JOIN civicrm_contribution con ON ( con.id = mp.contribution_id )
405 WHERE mp.membership_id = %1";
408 $dao = CRM_Core_DAO
::executeQuery($sql, array(1 => array($entityID, 'Integer')));
413 return CRM_Core_DAO
::$_nullObject;
417 public static function setSubscriptionContext() {
418 // handle context redirection for subscription url
419 $session = CRM_Core_Session
::singleton();
420 if ($session->get('userID')) {
422 $cid = CRM_Utils_Request
::retrieve('cid', 'Integer');
423 $mid = CRM_Utils_Request
::retrieve('mid', 'Integer');
424 $qfkey = CRM_Utils_Request
::retrieve('key', 'String');
425 $context = CRM_Utils_Request
::retrieve('context', 'String');
429 $url = CRM_Utils_System
::url('civicrm/contact/view',
430 "reset=1&selectedChild=contribute&cid={$cid}"
435 $url = CRM_Utils_System
::url('civicrm/contact/view',
436 "reset=1&selectedChild=member&cid={$cid}"
441 $url = CRM_Utils_System
::url('civicrm/user', "reset=1&id={$cid}");
448 $url = CRM_Utils_System
::url('civicrm/member', "force=1&context={$context}&key={$qfkey}");
452 $url = CRM_Utils_System
::url('civicrm/member/search', "force=1&context={$context}&key={$qfkey}");
457 $session->pushUserContext($url);