3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
35 class CRM_Contribute_BAO_ContributionRecur
extends CRM_Contribute_DAO_ContributionRecur
{
38 * funtion to create recurring contribution
40 * @param array $params (reference ) an assoc array of name/value pairs
42 * @return object activity contact object
46 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
58 * @param array $ids the array that holds all the db ids
60 * @return object CRM_Contribute_BAO_Contribution object
63 * @todo move hook calls / extended logic to create - requires changing calls to call create not add
65 static function add(&$params) {
66 if (CRM_Utils_Array
::value('id', $params)) {
67 CRM_Utils_Hook
::pre('edit', 'ContributionRecur', $params['id'], $params);
70 CRM_Utils_Hook
::pre('create', 'ContributionRecur', NULL, $params);
73 // make sure we're not creating a new recurring contribution with the same transaction ID
74 // or invoice ID as an existing recurring contribution
75 $duplicates = array();
76 if (self
::checkDuplicate($params, $duplicates)) {
77 $error = CRM_Core_Error
::singleton();
78 $d = implode(', ', $duplicates);
79 $error->push(CRM_Core_Error
::DUPLICATE_CONTRIBUTION
,
82 "Found matching recurring contribution(s): $d"
87 $recurring = new CRM_Contribute_BAO_ContributionRecur();
88 $recurring->copyValues($params);
89 $recurring->id
= CRM_Utils_Array
::value('id', $params);
91 // set currency for CRM-1496
92 if (!isset($recurring->currency
)) {
93 $config = CRM_Core_Config
::singleton();
94 $recurring->currency
= $config->defaultCurrency
;
96 $result = $recurring->save();
98 if (CRM_Utils_Array
::value('id', $params)) {
99 CRM_Utils_Hook
::post('edit', 'ContributionRecur', $recurring->id
, $recurring);
102 CRM_Utils_Hook
::post('create', 'ContributionRecur', $recurring->id
, $recurring);
109 * Check if there is a recurring contribution with the same trxn_id or invoice_id
111 * @param array $params (reference ) an assoc array of name/value pairs
112 * @param array $duplicates (reference ) store ids of duplicate contribs
114 * @return boolean true if duplicate, false otherwise
118 static function checkDuplicate($params, &$duplicates) {
119 $id = CRM_Utils_Array
::value('id', $params);
120 $trxn_id = CRM_Utils_Array
::value('trxn_id', $params);
121 $invoice_id = CRM_Utils_Array
::value('invoice_id', $params);
127 $clause[] = "trxn_id = %1";
128 $params[1] = array($trxn_id, 'String');
132 $clause[] = "invoice_id = %2";
133 $params[2] = array($invoice_id, 'String');
136 if (empty($clause)) {
140 $clause = implode(' OR ', $clause);
142 $clause = "( $clause ) AND id != %3";
143 $params[3] = array($id, 'Integer');
146 $query = "SELECT id FROM civicrm_contribution_recur WHERE $clause";
147 $dao = CRM_Core_DAO
::executeQuery($query, $params);
149 while ($dao->fetch()) {
150 $duplicates[] = $dao->id
;
156 static function getPaymentProcessor($id, $mode) {
159 SELECT r.payment_processor_id
160 FROM civicrm_contribution_recur r
162 $params = array(1 => array($id, 'Integer'));
163 $paymentProcessorID = &CRM_Core_DAO
::singleValueQuery($sql,
166 if (!$paymentProcessorID) {
170 return CRM_Financial_BAO_PaymentProcessor
::getPayment($paymentProcessorID, $mode);
174 * Function to get the number of installment done/completed for each recurring contribution
176 * @param array $ids (reference ) an array of recurring contribution ids
178 * @return array $totalCount an array of recurring ids count
182 static function getCount(&$ids) {
183 $recurID = implode(',', $ids);
184 $totalCount = array();
187 SELECT contribution_recur_id, count( contribution_recur_id ) as commpleted
188 FROM civicrm_contribution
189 WHERE contribution_recur_id IN ( {$recurID}) AND is_test = 0
190 GROUP BY contribution_recur_id";
192 $res = CRM_Core_DAO
::executeQuery($query, CRM_Core_DAO
::$_nullArray);
194 while ($res->fetch()) {
195 $totalCount[$res->contribution_recur_id
] = $res->commpleted
;
201 * Delete Recurring contribution.
203 * @return true / false.
207 static function deleteRecurContribution($recurId) {
213 $recur = new CRM_Contribute_DAO_ContributionRecur();
214 $recur->id
= $recurId;
215 $result = $recur->delete();
221 * Cancel Recurring contribution.
223 * @param integer $recurId recur contribution id.
224 * @param array $objects an array of objects that is to be cancelled like
225 * contribution, membership, event. At least contribution object is a must.
227 * @return true / false.
231 static function cancelRecurContribution($recurId, $objects, $activityParams = array()) {
236 $contributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
237 $canceledId = array_search('Cancelled', $contributionStatus);
238 $recur = new CRM_Contribute_DAO_ContributionRecur();
239 $recur->id
= $recurId;
240 $recur->whereAdd("contribution_status_id != $canceledId");
242 if ($recur->find(TRUE)) {
243 $transaction = new CRM_Core_Transaction();
244 $recur->contribution_status_id
= $canceledId;
245 $recur->start_date
= CRM_Utils_Date
::isoToMysql($recur->start_date
);
246 $recur->create_date
= CRM_Utils_Date
::isoToMysql($recur->create_date
);
247 $recur->modified_date
= CRM_Utils_Date
::isoToMysql($recur->modified_date
);
248 $recur->cancel_date
= date('YmdHis');
251 $dao = CRM_Contribute_BAO_ContributionRecur
::getSubscriptionDetails($recurId);
252 if ($dao->recur_id
) {
253 $details = CRM_Utils_Array
::value('details', $activityParams);
254 if ($dao->auto_renew
&& $dao->membership_id
) {
255 // its auto-renewal membership mode
256 $membershipTypes = CRM_Member_PseudoConstant
::membershipType();
257 $membershipType = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $dao->membership_id
, 'membership_type_id');
258 $membershipType = CRM_Utils_Array
::value($membershipType, $membershipTypes);
260 <br/>' . ts('Automatic renewal of %1 membership cancelled.', array(1 => $membershipType));
264 <br/>' . ts('The recurring contribution of %1, every %2 %3 has been cancelled.', array(
266 2 => $dao->frequency_interval
,
267 3 => $dao->frequency_unit
270 $activityParams = array(
271 'source_contact_id' => $dao->contact_id
,
272 'source_record_id' => CRM_Utils_Array
::value('source_record_id', $activityParams),
273 'activity_type_id' => CRM_Core_OptionGroup
::getValue('activity_type',
274 'Cancel Recurring Contribution',
277 'subject' => CRM_Utils_Array
::value('subject', $activityParams, ts('Recurring contribution cancelled')),
278 'details' => $details,
279 'activity_date_time' => date('YmdHis'),
280 'status_id' => CRM_Core_OptionGroup
::getValue('activity_status',
285 $session = CRM_Core_Session
::singleton();
286 $cid = $session->get('userID');
288 $activityParams['target_contact_id'][] = $activityParams['source_contact_id'];
289 $activityParams['source_contact_id'] = $cid;
291 CRM_Activity_BAO_Activity
::create($activityParams);
294 // if there are associated objects, cancel them as well
295 if ($objects == CRM_Core_DAO
::$_nullObject) {
296 $transaction->commit();
300 $baseIPN = new CRM_Core_Payment_BaseIPN();
301 return $baseIPN->cancelled($objects, $transaction);
305 // if already cancelled, return true
307 $recur->whereAdd("contribution_status_id = $canceledId");
308 if ($recur->find(TRUE)) {
317 * Function to get list of recurring contribution of contact Ids
319 * @param int $contactId Contact ID
321 * @return return the list of recurring contribution fields
326 static function getRecurContributions($contactId) {
328 $recurDAO = new CRM_Contribute_DAO_ContributionRecur();
329 $recurDAO->contact_id
= $contactId;
331 $contributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus();
333 while ($recurDAO->fetch()) {
334 $params[$recurDAO->id
]['id'] = $recurDAO->id
;
335 $params[$recurDAO->id
]['contactId'] = $recurDAO->contact_id
;
336 $params[$recurDAO->id
]['start_date'] = $recurDAO->start_date
;
337 $params[$recurDAO->id
]['end_date'] = $recurDAO->end_date
;
338 $params[$recurDAO->id
]['next_sched_contribution_date'] = $recurDAO->next_sched_contribution_date
;
339 $params[$recurDAO->id
]['amount'] = $recurDAO->amount
;
340 $params[$recurDAO->id
]['currency'] = $recurDAO->currency
;
341 $params[$recurDAO->id
]['frequency_unit'] = $recurDAO->frequency_unit
;
342 $params[$recurDAO->id
]['frequency_interval'] = $recurDAO->frequency_interval
;
343 $params[$recurDAO->id
]['installments'] = $recurDAO->installments
;
344 $params[$recurDAO->id
]['contribution_status_id'] = $recurDAO->contribution_status_id
;
345 $params[$recurDAO->id
]['contribution_status'] = CRM_Utils_Array
::value($recurDAO->contribution_status_id
, $contributionStatus);
346 $params[$recurDAO->id
]['is_test'] = $recurDAO->is_test
;
347 $params[$recurDAO->id
]['payment_processor_id'] = $recurDAO->payment_processor_id
;
354 * update the is_active flag in the db
356 * @param int $id id of the database record
357 * @param boolean $is_active value we want to set the is_active field
359 * @return Object DAO object on sucess, null otherwise
362 static function setIsActive($id, $is_active) {
364 return self
::cancelRecurContribution($id, CRM_Core_DAO
::$_nullObject);
369 static function getSubscriptionDetails($entityID, $entity = 'recur') {
371 SELECT rec.id as recur_id,
372 rec.processor_id as subscription_id,
373 rec.frequency_interval,
380 con.id as contribution_id,
381 con.contribution_page_id,
385 if ($entity == 'recur') {
387 FROM civicrm_contribution_recur rec
388 INNER JOIN civicrm_contribution con ON ( con.contribution_recur_id = rec.id )
389 LEFT JOIN civicrm_membership_payment mp ON ( mp.contribution_id = con.id )
393 elseif ($entity == 'contribution') {
395 FROM civicrm_contribution con
396 INNER JOIN civicrm_contribution_recur rec ON ( con.contribution_recur_id = rec.id )
397 LEFT JOIN civicrm_membership_payment mp ON ( mp.contribution_id = con.id )
400 elseif ($entity == 'membership') {
402 FROM civicrm_membership_payment mp
403 INNER JOIN civicrm_membership mem ON ( mp.membership_id = mem.id )
404 INNER JOIN civicrm_contribution_recur rec ON ( mem.contribution_recur_id = rec.id )
405 INNER JOIN civicrm_contribution con ON ( con.id = mp.contribution_id )
406 WHERE mp.membership_id = %1";
409 $dao = CRM_Core_DAO
::executeQuery($sql, array(1 => array($entityID, 'Integer')));
414 return CRM_Core_DAO
::$_nullObject;
418 static function setSubscriptionContext() {
419 // handle context redirection for subscription url
420 $session = CRM_Core_Session
::singleton();
421 if ($session->get('userID')) {
423 $cid = CRM_Utils_Request
::retrieve('cid', 'Integer', $this, FALSE);
424 $mid = CRM_Utils_Request
::retrieve('mid', 'Integer', $this, FALSE);
425 $qfkey = CRM_Utils_Request
::retrieve('key', 'String', $this, FALSE);
426 $context = CRM_Utils_Request
::retrieve('context', 'String', $this, FALSE);
430 $url = CRM_Utils_System
::url('civicrm/contact/view',
431 "reset=1&selectedChild=contribute&cid={$cid}"
436 $url = CRM_Utils_System
::url('civicrm/contact/view',
437 "reset=1&selectedChild=member&cid={$cid}"
442 $url = CRM_Utils_System
::url('civicrm/user', "reset=1&id={$cid}");
449 $url = CRM_Utils_System
::url('civicrm/member', "force=1&context={$context}&key={$qfkey}");
453 $url = CRM_Utils_System
::url('civicrm/member/search', "force=1&context={$context}&key={$qfkey}");
458 $session->pushUserContext($url);