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
41 * (reference ) an assoc array of name/value pairs.
44 * 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
58 * (reference ) an assoc array of name/value pairs.
60 * @return CRM_Contribute_BAO_Contribution
61 * @todo move hook calls / extended logic to create - requires changing calls to call create not add
63 public static function add(&$params) {
64 if (!empty($params['id'])) {
65 CRM_Utils_Hook
::pre('edit', 'ContributionRecur', $params['id'], $params);
68 CRM_Utils_Hook
::pre('create', 'ContributionRecur', NULL, $params);
71 // make sure we're not creating a new recurring contribution with the same transaction ID
72 // or invoice ID as an existing recurring contribution
73 $duplicates = array();
74 if (self
::checkDuplicate($params, $duplicates)) {
75 $error = CRM_Core_Error
::singleton();
76 $d = implode(', ', $duplicates);
77 $error->push(CRM_Core_Error
::DUPLICATE_CONTRIBUTION
,
80 "Found matching recurring contribution(s): $d"
85 $recurring = new CRM_Contribute_BAO_ContributionRecur();
86 $recurring->copyValues($params);
87 $recurring->id
= CRM_Utils_Array
::value('id', $params);
89 // set currency for CRM-1496
90 if (!isset($recurring->currency
)) {
91 $config = CRM_Core_Config
::singleton();
92 $recurring->currency
= $config->defaultCurrency
;
94 $result = $recurring->save();
96 if (!empty($params['id'])) {
97 CRM_Utils_Hook
::post('edit', 'ContributionRecur', $recurring->id
, $recurring);
100 CRM_Utils_Hook
::post('create', 'ContributionRecur', $recurring->id
, $recurring);
107 * Check if there is a recurring contribution with the same trxn_id or invoice_id
109 * @param array $params
110 * (reference ) an assoc array of name/value pairs.
111 * @param array $duplicates
112 * (reference ) store ids of duplicate contribs.
115 * 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
182 * (reference ) an array of recurring contribution ids.
185 * 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
212 public static function deleteRecurContribution($recurId) {
218 $recur = new CRM_Contribute_DAO_ContributionRecur();
219 $recur->id
= $recurId;
220 $result = $recur->delete();
226 * Cancel Recurring contribution.
228 * @param int $recurId
229 * Recur contribution id.
230 * @param array $objects
231 * 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
238 public static function cancelRecurContribution($recurId, $objects, $activityParams = array()) {
243 $contributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
244 $canceledId = array_search('Cancelled', $contributionStatus);
245 $recur = new CRM_Contribute_DAO_ContributionRecur();
246 $recur->id
= $recurId;
247 $recur->whereAdd("contribution_status_id != $canceledId");
249 if ($recur->find(TRUE)) {
250 $transaction = new CRM_Core_Transaction();
251 $recur->contribution_status_id
= $canceledId;
252 $recur->start_date
= CRM_Utils_Date
::isoToMysql($recur->start_date
);
253 $recur->create_date
= CRM_Utils_Date
::isoToMysql($recur->create_date
);
254 $recur->modified_date
= CRM_Utils_Date
::isoToMysql($recur->modified_date
);
255 $recur->cancel_date
= date('YmdHis');
258 $dao = CRM_Contribute_BAO_ContributionRecur
::getSubscriptionDetails($recurId);
259 if ($dao && $dao->recur_id
) {
260 $details = CRM_Utils_Array
::value('details', $activityParams);
261 if ($dao->auto_renew
&& $dao->membership_id
) {
262 // its auto-renewal membership mode
263 $membershipTypes = CRM_Member_PseudoConstant
::membershipType();
264 $membershipType = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $dao->membership_id
, 'membership_type_id');
265 $membershipType = CRM_Utils_Array
::value($membershipType, $membershipTypes);
267 <br/>' . ts('Automatic renewal of %1 membership cancelled.', array(1 => $membershipType));
271 <br/>' . ts('The recurring contribution of %1, every %2 %3 has been cancelled.', array(
273 2 => $dao->frequency_interval
,
274 3 => $dao->frequency_unit
,
277 $activityParams = array(
278 'source_contact_id' => $dao->contact_id
,
279 'source_record_id' => CRM_Utils_Array
::value('source_record_id', $activityParams),
280 'activity_type_id' => CRM_Core_OptionGroup
::getValue('activity_type',
281 'Cancel Recurring Contribution',
284 'subject' => CRM_Utils_Array
::value('subject', $activityParams, ts('Recurring contribution cancelled')),
285 'details' => $details,
286 'activity_date_time' => date('YmdHis'),
287 'status_id' => CRM_Core_OptionGroup
::getValue('activity_status',
292 $session = CRM_Core_Session
::singleton();
293 $cid = $session->get('userID');
295 $activityParams['target_contact_id'][] = $activityParams['source_contact_id'];
296 $activityParams['source_contact_id'] = $cid;
298 CRM_Activity_BAO_Activity
::create($activityParams);
301 // if there are associated objects, cancel them as well
302 if ($objects == CRM_Core_DAO
::$_nullObject) {
303 $transaction->commit();
307 $baseIPN = new CRM_Core_Payment_BaseIPN();
308 return $baseIPN->cancelled($objects, $transaction);
312 // if already cancelled, return true
314 $recur->whereAdd("contribution_status_id = $canceledId");
315 if ($recur->find(TRUE)) {
324 * Get list of recurring contribution of contact Ids
326 * @param int $contactId
330 * list of recurring contribution fields
333 public static function getRecurContributions($contactId) {
335 $recurDAO = new CRM_Contribute_DAO_ContributionRecur();
336 $recurDAO->contact_id
= $contactId;
338 $contributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus();
340 while ($recurDAO->fetch()) {
341 $params[$recurDAO->id
]['id'] = $recurDAO->id
;
342 $params[$recurDAO->id
]['contactId'] = $recurDAO->contact_id
;
343 $params[$recurDAO->id
]['start_date'] = $recurDAO->start_date
;
344 $params[$recurDAO->id
]['end_date'] = $recurDAO->end_date
;
345 $params[$recurDAO->id
]['next_sched_contribution_date'] = $recurDAO->next_sched_contribution_date
;
346 $params[$recurDAO->id
]['amount'] = $recurDAO->amount
;
347 $params[$recurDAO->id
]['currency'] = $recurDAO->currency
;
348 $params[$recurDAO->id
]['frequency_unit'] = $recurDAO->frequency_unit
;
349 $params[$recurDAO->id
]['frequency_interval'] = $recurDAO->frequency_interval
;
350 $params[$recurDAO->id
]['installments'] = $recurDAO->installments
;
351 $params[$recurDAO->id
]['contribution_status_id'] = $recurDAO->contribution_status_id
;
352 $params[$recurDAO->id
]['contribution_status'] = CRM_Utils_Array
::value($recurDAO->contribution_status_id
, $contributionStatus);
353 $params[$recurDAO->id
]['is_test'] = $recurDAO->is_test
;
354 $params[$recurDAO->id
]['payment_processor_id'] = $recurDAO->payment_processor_id
;
361 * @param int $entityID
362 * @param string $entity
364 * @return null|Object
366 public static function getSubscriptionDetails($entityID, $entity = 'recur') {
368 SELECT rec.id as recur_id,
369 rec.processor_id as subscription_id,
370 rec.frequency_interval,
377 con.id as contribution_id,
378 con.contribution_page_id,
382 if ($entity == 'recur') {
384 FROM civicrm_contribution_recur rec
385 LEFT JOIN civicrm_contribution con ON ( con.contribution_recur_id = rec.id )
386 LEFT JOIN civicrm_membership_payment mp ON ( mp.contribution_id = con.id )
390 elseif ($entity == 'contribution') {
392 FROM civicrm_contribution con
393 INNER JOIN civicrm_contribution_recur rec ON ( con.contribution_recur_id = rec.id )
394 LEFT JOIN civicrm_membership_payment mp ON ( mp.contribution_id = con.id )
397 elseif ($entity == 'membership') {
399 FROM civicrm_membership_payment mp
400 INNER JOIN civicrm_membership mem ON ( mp.membership_id = mem.id )
401 INNER JOIN civicrm_contribution_recur rec ON ( mem.contribution_recur_id = rec.id )
402 INNER JOIN civicrm_contribution con ON ( con.id = mp.contribution_id )
403 WHERE mp.membership_id = %1";
406 $dao = CRM_Core_DAO
::executeQuery($sql, array(1 => array($entityID, 'Integer')));
411 return CRM_Core_DAO
::$_nullObject;
415 public static function setSubscriptionContext() {
416 // handle context redirection for subscription url
417 $session = CRM_Core_Session
::singleton();
418 if ($session->get('userID')) {
420 $cid = CRM_Utils_Request
::retrieve('cid', 'Integer');
421 $mid = CRM_Utils_Request
::retrieve('mid', 'Integer');
422 $qfkey = CRM_Utils_Request
::retrieve('key', 'String');
423 $context = CRM_Utils_Request
::retrieve('context', 'String');
427 $url = CRM_Utils_System
::url('civicrm/contact/view',
428 "reset=1&selectedChild=contribute&cid={$cid}"
433 $url = CRM_Utils_System
::url('civicrm/contact/view',
434 "reset=1&selectedChild=member&cid={$cid}"
439 $url = CRM_Utils_System
::url('civicrm/user', "reset=1&id={$cid}");
446 $url = CRM_Utils_System
::url('civicrm/member', "force=1&context={$context}&key={$qfkey}");
450 $url = CRM_Utils_System
::url('civicrm/member/search', "force=1&context={$context}&key={$qfkey}");
455 $session->pushUserContext($url);