projects / civicrm-core.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Merge pull request #1337 from eileenmcnaughton/CRM-13148
[civicrm-core.git] / CRM / Member / BAO / Membership.php
1 <?php
2 /*
3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.3 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
9 | |
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. |
13 | |
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. |
18 | |
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 +--------------------------------------------------------------------+
26 */
27
28 /**
29 *
30 * @package CRM
31 * @copyright CiviCRM LLC (c) 2004-2013
32 * $Id$
33 *
34 */
35 class CRM_Member_BAO_Membership extends CRM_Member_DAO_Membership {
36
37 /**
38 * static field for all the membership information that we can potentially import
39 *
40 * @var array
41 * @static
42 */
43 static $_importableFields = NULL;
44
45 static $_renewalActType = NULL;
46
47 static $_signupActType = NULL;
48
49 function __construct() {
50 parent::__construct();
51 }
52
53 /**
54 * takes an associative array and creates a membership object
55 *
56 * the function extracts all the params it needs to initialize the created
57 * membership object. The params array could contain additional unused name/value
58 * pairs
59 *
60 * @param array $params (reference ) an assoc array of name/value pairs
61 * @param array $ids the array that holds all the db ids
62 *
63 * @return object CRM_Member_BAO_Membership object
64 * @access public
65 * @static
66 */
67 static function &add(&$params, &$ids) {
68
69 if (CRM_Utils_Array::value('membership', $ids)) {
70 CRM_Utils_Hook::pre('edit', 'Membership', $ids['membership'], $params);
71 $oldStatus = NULL;
72 $oldType = NULL;
73 $membershipObj = new CRM_Member_DAO_Membership();
74 $membershipObj->id = $ids['membership'];
75 $membershipObj->find();
76 while ($membershipObj->fetch()) {
77 $oldStatus = $membershipObj->status_id;
78 $oldType = $membershipObj->membership_type_id;
79 }
80 }
81 else {
82 CRM_Utils_Hook::pre('create', 'Membership', NULL, $params);
83 }
84
85 if (array_key_exists('is_override', $params) && !$params['is_override']) {
86 $params['is_override'] = 'null';
87 }
88
89 $membership = new CRM_Member_BAO_Membership();
90 $membership->copyValues($params);
91 $membership->id = CRM_Utils_Array::value('membership', $ids);
92
93 $membership->save();
94 $membership->free();
95
96 if (empty($membership->contact_id) || empty($membership->status_id)) {
97 // this means we are in renewal mode and are just updating the membership
98 // record or this is an API update call and all fields are not present in the update record
99 // however the hooks dont care and want all data CRM-7784
100 $tempMembership = new CRM_Member_DAO_Membership();
101 $tempMembership->id = $membership->id;
102 $tempMembership->find(TRUE);
103 $membership = $tempMembership;
104 }
105
106 //get the log start date.
107 //it is set during renewal of membership.
108 $logStartDate = CRM_Utils_array::value('log_start_date', $params);
109 $logStartDate = ($logStartDate) ? CRM_Utils_Date::isoToMysql($logStartDate) : CRM_Utils_Date::isoToMysql($membership->start_date);
110 $values = self::getStatusANDTypeValues($membership->id);
111
112 $membershipLog = array(
113 'membership_id' => $membership->id,
114 'status_id' => $membership->status_id,
115 'start_date' => $logStartDate,
116 'end_date' => CRM_Utils_Date::isoToMysql($membership->end_date),
117 'modified_date' => date('Ymd'),
118 'membership_type_id' => $values[$membership->id]['membership_type_id'],
119 'max_related' => $membership->max_related,
120 );
121
122 $session = CRM_Core_Session::singleton();
123 // If we have an authenticated session, set modified_id to that user's contact_id, else set to membership.contact_id
124 if ($session->get('userID')) {
125 $membershipLog['modified_id'] = $session->get('userID');
126 }
127 elseif (!empty($ids['userId'])) {
128 $membershipLog['modified_id'] = $ids['userId'];
129 }
130 else {
131 $membershipLog['modified_id'] = $membership->contact_id;
132 }
133
134 CRM_Member_BAO_MembershipLog::add($membershipLog, CRM_Core_DAO::$_nullArray);
135
136 // reset the group contact cache since smart groups might be affected due to this
137 CRM_Contact_BAO_GroupContactCache::remove();
138
139 if (CRM_Utils_Array::value('membership', $ids)) {
140 if ($membership->status_id != $oldStatus) {
141 $allStatus = CRM_Member_BAO_Membership::buildOptions('status_id', 'get');
142 $activityParam = array(
143 'subject' => "Status changed from {$allStatus[$oldStatus]} to {$allStatus[$membership->status_id]}",
144 'source_contact_id' => $membershipLog['modified_id'],
145 'target_contact_id' => $membership->contact_id,
146 'source_record_id' => $membership->id,
147 'activity_type_id' => CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Change Membership Status'),
148 'status_id' => 2,
149 'priority_id' => 2,
150 'activity_date_time' => date('Y-m-d H:i:s'),
151 );
152 civicrm_api3('activity', 'create', $activityParam);
153 }
154 if (isset($membership->membership_type_id) && $membership->membership_type_id != $oldType) {
155 $membershipTypes = CRM_Member_BAO_Membership::buildOptions('membership_type_id', 'get');
156 $activityParam = array(
157 'subject' => "Type changed from {$membershipTypes[$oldType]} to {$membershipTypes[$membership->membership_type_id]}",
158 'source_contact_id' => $membershipLog['modified_id'],
159 'target_contact_id' => $membership->contact_id,
160 'source_record_id' => $membership->id,
161 'activity_type_id' => CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Change Membership Status'),
162 'status_id' => 2,
163 'priority_id' => 2,
164 'activity_date_time' => date('Y-m-d H:i:s'),
165 );
166 civicrm_api3('activity', 'create', $activityParam);
167 }
168 CRM_Utils_Hook::post('edit', 'Membership', $membership->id, $membership);
169 }
170 else {
171 CRM_Utils_Hook::post('create', 'Membership', $membership->id, $membership);
172 }
173
174 return $membership;
175 }
176
177 /**
178 * Given the list of params in the params array, fetch the object
179 * and store the values in the values array
180 *
181 * @param array $params input parameters to find object
182 * @param array $values output values of the object
183 * @param boolean $active do you want only active memberships to
184 * be returned
185 *
186 * @return CRM_Member_BAO_Membership|null the found object or null
187 * @access public
188 * @static
189 */
190 static function &getValues(&$params, &$values, $active = FALSE) {
191 if (empty($params)) {
192 return NULL;
193 }
194 $membership = new CRM_Member_BAO_Membership();
195
196 $membership->copyValues($params);
197 $membership->find();
198 $memberships = array();
199 while ($membership->fetch()) {
200 if ($active &&
201 (!CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipStatus',
202 $membership->status_id,
203 'is_current_member'
204 ))
205 ) {
206 continue;
207 }
208
209 CRM_Core_DAO::storeValues($membership, $values[$membership->id]);
210 $memberships[$membership->id] = $membership;
211 }
212
213 return $memberships;
214 }
215
216 /**
217 * takes an associative array and creates a membership object
218 *
219 * @param array $params (reference ) an assoc array of name/value pairs
220 * @param array $ids the array that holds all the db ids
221 * @param boolean $callFromAPI Is this function called from API?
222 *
223 * @return object CRM_Member_BAO_Membership object
224 * @access public
225 * @static
226 */
227 static function &create(&$params, &$ids, $skipRedirect = FALSE, $activityType = 'Membership Signup') {
228 // always calculate status if is_override/skipStatusCal is not true.
229 // giving respect to is_override during import. CRM-4012
230
231 // To skip status calculation we should use 'skipStatusCal'.
232 // eg pay later membership, membership update cron CRM-3984
233
234 if (!CRM_Utils_Array::value('is_override', $params) &&
235 !CRM_Utils_Array::value('skipStatusCal', $params)
236 ) {
237 $dates = array('start_date', 'end_date', 'join_date');
238 foreach ($dates as $date) {
239 $$date = CRM_Utils_Date::processDate(CRM_Utils_Array::value($date, $params), NULL, TRUE, 'Ymd');
240 }
241
242 //fix for CRM-3570, during import exclude the statuses those having is_admin = 1
243 $excludeIsAdmin = CRM_Utils_Array::value('exclude_is_admin', $params, FALSE);
244
245 //CRM-3724 always skip is_admin if is_override != true.
246 if (!$excludeIsAdmin &&
247 !CRM_Utils_Array::value('is_override', $params)
248 ) {
249 $excludeIsAdmin = TRUE;
250 }
251
252 $calcStatus = $calcStatus = CRM_Member_BAO_MembershipStatus::getMembershipStatusByDate($start_date, $end_date, $join_date,
253 'today', $excludeIsAdmin
254 );
255 if (empty($calcStatus)) {
256 // Redirect the form in case of error
257 // @todo this redirect in the BAO layer is really bad & should be moved to the form layer
258 // however since we have no idea how (if) this is triggered we can't safely move / remove it
259 // NB I tried really hard to trigger this error from backoffice membership form in order to test it
260 // and am convinced form validation is complete on that form WRT this error.
261 $errorParams = array(
262 'message_title' => ts('No valid membership status for given dates.'),
263 'legacy_redirect_path' => 'civicrm/contact/view',
264 'legacy_redirect_query' => "reset=1&force=1&cid={$params['contact_id']}&selectedChild=member",
265 );
266 throw new CRM_Core_Exception(ts('The membership cannot be saved because the status cannot be calculated.'), 0, $errorParams);
267 }
268 $params['status_id'] = $calcStatus['id'];
269 }
270
271 // data cleanup only: all verifications on number of related memberships are done upstream in:
272 // CRM_Member_BAO_Membership::createRelatedMemberships()
273 // CRM_Contact_BAO_Relationship::relatedMemberships()
274 if (isset($params['owner_membership_id'])) {
275 unset($params['max_related']);
276 } else {
277 // if membership allows related, default max_related to value in membership_type
278 if (!array_key_exists('max_related', $params) && !empty($params['membership_type_id'])) {
279 $membershipType = CRM_Member_BAO_MembershipType::getMembershipTypeDetails($params['membership_type_id']);
280 if (isset($membershipType['relationship_type_id'])) {
281 $params['max_related'] = CRM_Utils_Array::value('max_related', $membershipType);
282 }
283 }
284 }
285
286 $transaction = new CRM_Core_Transaction();
287
288 $membership = self::add($params, $ids);
289
290 if (is_a($membership, 'CRM_Core_Error')) {
291 $transaction->rollback();
292 return $membership;
293 }
294
295 // add custom field values
296 if (CRM_Utils_Array::value('custom', $params)
297 && is_array($params['custom'])
298 ) {
299 CRM_Core_BAO_CustomValueTable::store($params['custom'], 'civicrm_membership', $membership->id);
300 }
301
302 $params['membership_id'] = $membership->id;
303 if (isset($ids['membership'])) {
304 $ids['contribution'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipPayment',
305 $ids['membership'],
306 'contribution_id',
307 'membership_id'
308 );
309 }
310
311 //record contribution for this membership
312 if (CRM_Utils_Array::value('contribution_status_id', $params) && !CRM_Utils_Array::value('relate_contribution_id', $params)) {
313 $params['contribution'] = self::recordMembershipContribution( array_merge($params, array('membership_id' => $membership->id)), $ids);
314 }
315
316 //insert payment record for this membership
317 if (CRM_Utils_Array::value('relate_contribution_id', $params)) {
318 $mpDAO = new CRM_Member_DAO_MembershipPayment();
319 $mpDAO->membership_id = $membership->id;
320 $mpDAO->contribution_id = $params['relate_contribution_id'];
321 if (!($mpDAO->find(TRUE))) {
322 CRM_Utils_Hook::pre('create', 'MembershipPayment', NULL, $mpDAO);
323 $mpDAO->save();
324 CRM_Utils_Hook::post('create', 'MembershipPayment', $mpDAO->id, $mpDAO);
325 }
326 }
327
328 // add activity record only during create mode and renew mode
329 // also add activity if status changed CRM-3984 and CRM-2521
330 if (!CRM_Utils_Array::value('membership', $ids) ||
331 $activityType == 'Membership Renewal' ||
332 CRM_Utils_Array::value('createActivity', $params)
333 ) {
334 if (CRM_Utils_Array::value('membership', $ids)) {
335 CRM_Core_DAO::commonRetrieveAll('CRM_Member_DAO_Membership',
336 'id',
337 $membership->id,
338 $data,
339 array('contact_id', 'membership_type_id', 'source')
340 );
341
342 $membership->contact_id = $data[$membership->id]['contact_id'];
343 $membership->membership_type_id = $data[$membership->id]['membership_type_id'];
344 $membership->source = CRM_Utils_Array::value('source', $data[$membership->id]);
345 }
346
347 // since we are going to create activity record w/
348 // individual contact as a target in case of on behalf signup,
349 // so get the copy of organization id, CRM-5551
350 $realMembershipContactId = $membership->contact_id;
351
352 // create activity source = individual, target = org CRM-4027
353 $targetContactID = NULL;
354 if (CRM_Utils_Array::value('is_for_organization', $params)) {
355 $targetContactID = $membership->contact_id;
356 $membership->contact_id = CRM_Utils_Array::value('userId', $ids);
357 }
358
359 if (empty($membership->contact_id) && (!empty($membership->owner_membership_id))) {
360 $membership->contact_id = $realMembershipContactId;
361 }
362
363 if (CRM_Utils_Array::value('membership', $ids) && $activityType != 'Membership Signup') {
364 CRM_Activity_BAO_Activity::addActivity($membership, $activityType, $targetContactID);
365 } elseif (!CRM_Utils_Array::value('membership', $ids)) {
366 CRM_Activity_BAO_Activity::addActivity($membership, $activityType, $targetContactID);
367 }
368
369 // we might created activity record w/ individual
370 // contact as target so update membership object w/
371 // original organization id, CRM-5551
372 $membership->contact_id = $realMembershipContactId;
373 }
374
375 $transaction->commit();
376
377 self::createRelatedMemberships($params, $membership);
378
379 // do not add to recent items for import, CRM-4399
380 if (!CRM_Utils_Array::value('skipRecentView', $params)) {
381 $url = CRM_Utils_System::url('civicrm/contact/view/membership',
382 "action=view&reset=1&id={$membership->id}&cid={$membership->contact_id}&context=home"
383 );
384 if(empty($membership->membership_type_id)){// ie in an update situation
385 $membership->find(TRUE);
386 }
387 $membershipTypes = CRM_Member_PseudoConstant::membershipType();
388 $title = CRM_Contact_BAO_Contact::displayName($membership->contact_id) . ' - ' . ts('Membership Type:') . ' ' . $membershipTypes[$membership->membership_type_id];
389
390 $recentOther = array();
391 if (CRM_Core_Permission::checkActionPermission('CiviMember', CRM_Core_Action::UPDATE)) {
392 $recentOther['editUrl'] = CRM_Utils_System::url('civicrm/contact/view/membership',
393 "action=update&reset=1&id={$membership->id}&cid={$membership->contact_id}&context=home"
394 );
395 }
396 if (CRM_Core_Permission::checkActionPermission('CiviMember', CRM_Core_Action::DELETE)) {
397 $recentOther['deleteUrl'] = CRM_Utils_System::url('civicrm/contact/view/membership',
398 "action=delete&reset=1&id={$membership->id}&cid={$membership->contact_id}&context=home"
399 );
400 }
401
402 // add the recently created Membership
403 CRM_Utils_Recent::add($title,
404 $url,
405 $membership->id,
406 'Membership',
407 $membership->contact_id,
408 NULL,
409 $recentOther
410 );
411 }
412
413 return $membership;
414 }
415
416 /**
417 * Function to check the membership extended through relationship
418 *
419 * @param int $membershipId membership id
420 * @param int $contactId contact id
421 *
422 * @return Array array of contact_id of all related contacts.
423 * @static
424 */
425 static function checkMembershipRelationship($membershipId, $contactId, $action = CRM_Core_Action::ADD) {
426 $contacts = array();
427 $membershipTypeID = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $membershipId, 'membership_type_id');
428
429 $membershipType = CRM_Member_BAO_MembershipType::getMembershipTypeDetails($membershipTypeID);
430 $relationships = array();
431 if (isset($membershipType['relationship_type_id'])) {
432 $relationships = CRM_Contact_BAO_Relationship::getRelationship($contactId,
433 CRM_Contact_BAO_Relationship::CURRENT
434 );
435 if ($action & CRM_Core_Action::UPDATE) {
436 $pastRelationships = CRM_Contact_BAO_Relationship::getRelationship($contactId,
437 CRM_Contact_BAO_Relationship::PAST
438 );
439 $relationships = array_merge($relationships, $pastRelationships);
440 }
441 }
442
443 if (!empty($relationships)) {
444 // check for each contact relationships
445 foreach ($relationships as $values) {
446 //get details of the relationship type
447 $relType = array('id' => $values['civicrm_relationship_type_id']);
448 $relValues = array();
449 CRM_Contact_BAO_RelationshipType::retrieve($relType, $relValues);
450 // Check if contact's relationship type exists in membership type
451 $relTypeDirs = array();
452 $relTypeIds = explode(CRM_Core_DAO::VALUE_SEPARATOR, $membershipType['relationship_type_id']);
453 $relDirections = explode(CRM_Core_DAO::VALUE_SEPARATOR, $membershipType['relationship_direction']);
454 $bidirectional = FALSE;
455 foreach ($relTypeIds as $key => $value) {
456 $relTypeDirs[] = $value . '_' . $relDirections[$key];
457 if (in_array($value, $relType) &&
458 $relValues['name_a_b'] == $relValues['name_b_a']
459 ) {
460 $bidirectional = TRUE;
461 break;
462 }
463 }
464 $relTypeDir = $values['civicrm_relationship_type_id'] . '_' . $values['rtype'];
465 if ($bidirectional || in_array($relTypeDir, $relTypeDirs)) {
466 // $values['status'] is going to have value for
467 // current or past relationships.
468 $contacts[$values['cid']] = $values['status'];
469 }
470 }
471 }
472
473 // Sort by contact_id ascending
474 ksort($contacts);
475 return $contacts;
476 }
477
478 /**
479 * Takes a bunch of params that are needed to match certain criteria and
480 * retrieves the relevant objects. We'll tweak this function to be more
481 * full featured over a period of time. This is the inverse function of
482 * create. It also stores all the retrieved values in the default array
483 *
484 * @param array $params (reference ) an assoc array of name/value pairs
485 * @param array $defaults (reference ) an assoc array to hold the name / value pairs
486 * in a hierarchical manner
487 * @param array $ids (reference) the array that holds all the db ids
488 *
489 * @return object CRM_Member_BAO_Membership object
490 * @access public
491 * @static
492 */
493 static function retrieve(&$params, &$defaults) {
494 $membership = new CRM_Member_DAO_Membership();
495
496 $membership->copyValues($params);
497
498 if ($membership->find(TRUE)) {
499 CRM_Core_DAO::storeValues($membership, $defaults);
500
501 //get the membership status and type values.
502 $statusANDType = self::getStatusANDTypeValues($membership->id);
503 foreach (array(
504 'status', 'membership_type') as $fld) {
505 $defaults[$fld] = CRM_Utils_Array::value($fld, $statusANDType[$membership->id]);
506 }
507 if (CRM_Utils_Array::value('is_current_member', $statusANDType[$membership->id])) {
508 $defaults['active'] = TRUE;
509 }
510
511 $membership->free();
512
513 return $membership;
514 }
515
516 return NULL;
517 }
518
519 /**
520 *
521 * Function to get membership status and membership type values
522 *
523 * @param int $membershipId membership id of values to return
524 *
525 * @return array of key value pairs
526 * @access public
527 */
528 static function getStatusANDTypeValues($membershipId) {
529 $values = array();
530 if (!$membershipId) {
531 return $values;
532 }
533 $sql = '
534 SELECT membership.id as id,
535 status.id as status_id,
536 status.label as status,
537 status.is_current_member as is_current_member,
538 type.id as membership_type_id,
539 type.name as membership_type,
540 type.relationship_type_id as relationship_type_id
541 FROM civicrm_membership membership
542 INNER JOIN civicrm_membership_status status ON ( status.id = membership.status_id )
543 INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_type_id )
544 WHERE membership.id = %1';
545 $dao = CRM_Core_DAO::executeQuery($sql, array(1 => array($membershipId, 'Positive')));
546 $properties = array('status', 'status_id', 'membership_type', 'membership_type_id', 'is_current_member', 'relationship_type_id');
547 while ($dao->fetch()) {
548 foreach ($properties as $property) {
549 $values[$dao->id][$property] = $dao->$property;
550 }
551 }
552
553 return $values;
554 }
555
556 /**
557 * Function to delete membership.
558 * Wrapper for most delete calls. Use this unless you JUST want to delete related memberships w/o deleting the parent.
559 *
560 * @param int $membershipId membership id that needs to be deleted
561 *
562 * @static
563 *
564 * @return $results no of deleted Membership on success, false otherwise
565 * @access public
566 */
567 static function del($membershipId) {
568 //delete related first and then delete parent.
569 self::deleteRelatedMemberships($membershipId);
570 return self::deleteMembership($membershipId);
571 }
572
573 /**
574 * Function to delete membership.
575 *
576 * @param int $membershipId membership id that needs to be deleted
577 *
578 * @static
579 *
580 * @return $results no of deleted Membership on success, false otherwise
581 * @access public
582 */
583 static function deleteMembership($membershipId) {
584 // CRM-12147, retrieve membership data before we delete it for hooks
585 $params = array('id' => $membershipId);
586 $memValues = array();
587 $memberships = self::getValues($params, $memValues);
588
589 $membership = $memberships[$membershipId];
590
591 CRM_Utils_Hook::pre('delete', 'Membership', $membershipId, $memValues);
592
593 $transaction = new CRM_Core_Transaction();
594
595 $results = NULL;
596 //delete activity record
597 $activityTypes = CRM_Core_PseudoConstant::activityType(TRUE, FALSE, FALSE, 'name');
598
599 $params = array();
600 $deleteActivity = false;
601 $membershipActivities = array(
602 'Membership Signup',
603 'Membership Renewal',
604 'Change Membership Status',
605 'Change Membership Type',
606 'Membership Renewal Reminder'
607 );
608 foreach($membershipActivities as $membershipActivity) {
609 $activityId = array_search($membershipActivity, $activityTypes);
610 if ($activityId) {
611 $params['activity_type_id'][] = $activityId;
612 $deleteActivity = true;
613 }
614 }
615 if ($deleteActivity) {
616 $params['source_record_id'] = $membershipId;
617 CRM_Activity_BAO_Activity::deleteActivity($params);
618 }
619 self::deleteMembershipPayment($membershipId);
620
621 $results = $membership->delete();
622 $transaction->commit();
623
624 CRM_Utils_Hook::post('delete', 'Membership', $membership->id, $membership);
625
626 // delete the recently created Membership
627 $membershipRecent = array(
628 'id' => $membershipId,
629 'type' => 'Membership',
630 );
631 CRM_Utils_Recent::del($membershipRecent);
632
633 return $results;
634 }
635
636 /**
637 * Function to delete related memberships
638 *
639 * @param int $ownerMembershipId
640 * @param int $contactId
641 *
642 * @return null
643 * @static
644 */
645 static function deleteRelatedMemberships($ownerMembershipId, $contactId = NULL) {
646 if (!$ownerMembershipId && !$contactId) {
647 return;
648 }
649
650 $membership = new CRM_Member_DAO_Membership();
651 $membership->owner_membership_id = $ownerMembershipId;
652
653 if ($contactId) {
654 $membership->contact_id = $contactId;
655 }
656
657 $membership->find();
658 while ($membership->fetch()) {
659 //delete related first and then delete parent.
660 self::deleteRelatedMemberships($membership->id);
661 self::deleteMembership($membership->id);
662 }
663 $membership->free();
664 }
665
666 /**
667 * Function to obtain active/inactive memberships from the list of memberships passed to it.
668 *
669 * @param array $memberships membership records
670 * @param string $status active or inactive
671 *
672 * @return array $actives array of memberships based on status
673 * @static
674 * @access public
675 */
676 static function activeMembers($memberships, $status = 'active') {
677 $actives = array();
678 if ($status == 'active') {
679 foreach ($memberships as $f => $v) {
680 if (CRM_Utils_Array::value('active', $v)) {
681 $actives[$f] = $v;
682 }
683 }
684 return $actives;
685 }
686 elseif ($status == 'inactive') {
687 foreach ($memberships as $f => $v) {
688 if (!CRM_Utils_Array::value('active', $v)) {
689 $actives[$f] = $v;
690 }
691 }
692 return $actives;
693 }
694 return NULL;
695 }
696
697 /**
698 * Function to build Membership Block in Contribution Pages
699 *
700 * @param object $form form object
701 * @param int $pageId contribution page id
702 * @param boolean $formItems
703 * @param int $selectedMembershipTypeID selected membership id
704 * @param boolean $thankPage thank you page
705 * @param boolean $memContactId contact who is to be
706 * checked for having a current membership for a particular membership
707 *
708 * @static
709 */
710 static function buildMembershipBlock(&$form,
711 $pageID,
712 $cid,
713 $formItems = FALSE,
714 $selectedMembershipTypeID = NULL,
715 $thankPage = FALSE,
716 $isTest = NULL
717 ) {
718
719 $separateMembershipPayment = FALSE;
720 if ($form->_membershipBlock) {
721 $form->_currentMemberships = array();
722
723 $membershipBlock = $form->_membershipBlock;
724 $membershipTypeIds = $membershipTypes = $radio = array();
725 $membershipPriceset = (!empty($form->_priceSetId) && $form->_useForMember) ? TRUE : FALSE;
726
727 $allowAutoRenewMembership = $autoRenewOption = FALSE;
728 $autoRenewMembershipTypeOptions = array();
729
730 $paymentProcessor = CRM_Core_PseudoConstant::paymentProcessor(FALSE, FALSE, 'is_recur = 1');
731
732 $separateMembershipPayment = CRM_Utils_Array::value('is_separate_payment', $membershipBlock);
733
734 if ($membershipPriceset) {
735 foreach ($form->_priceSet['fields'] as $pField) {
736 if (empty($pField['options'])) {
737 continue;
738 }
739 foreach ($pField['options'] as $opId => $opValues) {
740 if (!CRM_Utils_Array::value('membership_type_id', $opValues)) {
741 continue;
742 }
743 $membershipTypeIds[$opValues['membership_type_id']] = $opValues['membership_type_id'];
744 }
745 }
746 }
747 elseif (CRM_Utils_Array::value('membership_types', $membershipBlock)) {
748 $membershipTypeIds = explode(',', $membershipBlock['membership_types']);
749 }
750
751 if (!empty($membershipTypeIds)) {
752 //set status message if wrong membershipType is included in membershipBlock
753 if (isset($form->_mid) && !$membershipPriceset) {
754 $membershipTypeID = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership',
755 $form->_mid,
756 'membership_type_id'
757 );
758 if (!in_array($membershipTypeID, $membershipTypeIds)) {
759 CRM_Core_Session::setStatus(ts("Oops. The membership you're trying to renew appears to be invalid. Contact your site administrator if you need assistance. If you continue, you will be issued a new membership."), ts('Invalid Membership'), 'error');
760 }
761 }
762
763 $membershipTypeValues = self::buildMembershipTypeValues($form, $membershipTypeIds);
764 $form->_membershipTypeValues = $membershipTypeValues;
765 $endDate = NULL;
766 foreach ($membershipTypeIds as $value) {
767 $memType = $membershipTypeValues[$value];
768 if ($selectedMembershipTypeID != NULL) {
769 if ($memType['id'] == $selectedMembershipTypeID) {
770 $form->assign('minimum_fee',
771 CRM_Utils_Array::value('minimum_fee', $memType)
772 );
773 $form->assign('membership_name', $memType['name']);
774 if (!$thankPage && $cid) {
775 $membership = new CRM_Member_DAO_Membership();
776 $membership->contact_id = $cid;
777 $membership->membership_type_id = $memType['id'];
778 if ($membership->find(TRUE)) {
779 $form->assign('renewal_mode', TRUE);
780 $memType['current_membership'] = $membership->end_date;
781 $form->_currentMemberships[$membership->membership_type_id] = $membership->membership_type_id;
782 }
783 }
784 $membershipTypes[] = $memType;
785 }
786 }
787 elseif ($memType['is_active']) {
788 $javascriptMethod = NULL;
789 $allowAutoRenewOpt = 1;
790 if (is_array($form->_paymentProcessors)){
791 foreach ($form->_paymentProcessors as $id => $val) {
792 if (!$val['is_recur']) {
793 $allowAutoRenewOpt = 0;
794 continue;
795 }
796 }
797 }
798
799 $javascriptMethod = array('onclick' => "return showHideAutoRenew( this.value );");
800 $autoRenewMembershipTypeOptions["autoRenewMembershipType_{$value}"] = (int)$allowAutoRenewOpt * CRM_Utils_Array::value($value, CRM_Utils_Array::value('auto_renew', $form->_membershipBlock));;
801
802 if ($allowAutoRenewOpt) {
803 $allowAutoRenewMembership = TRUE;
804 }
805
806 //add membership type.
807 $radio[$memType['id']] = $form->createElement('radio', NULL, NULL, NULL,
808 $memType['id'], $javascriptMethod
809 );
810 if ($cid) {
811 $membership = new CRM_Member_DAO_Membership();
812 $membership->contact_id = $cid;
813 $membership->membership_type_id = $memType['id'];
814
815 //show current membership, skip pending and cancelled membership records,
816 //because we take first membership record id for renewal
817 $membership->whereAdd('status_id != 5 AND status_id !=6');
818
819 if (!is_null($isTest)) {
820 $membership->is_test = $isTest;
821 }
822
823 //CRM-4297
824 $membership->orderBy('end_date DESC');
825
826 if ($membership->find(TRUE)) {
827 if (!$membership->end_date) {
828 unset($radio[$memType['id']]);
829 $form->assign('islifetime', TRUE);
830 continue;
831 }
832 $form->assign('renewal_mode', TRUE);
833 $form->_currentMemberships[$membership->membership_type_id] = $membership->membership_type_id;
834 $memType['current_membership'] = $membership->end_date;
835 if (!$endDate) {
836 $endDate = $memType['current_membership'];
837 $form->_defaultMemTypeId = $memType['id'];
838 }
839 if ($memType['current_membership'] < $endDate) {
840 $endDate = $memType['current_membership'];
841 $form->_defaultMemTypeId = $memType['id'];
842 }
843 }
844 }
845 $membershipTypes[] = $memType;
846 }
847 }
848 }
849
850 $form->assign('showRadio', $formItems);
851 if ($formItems) {
852 if (!$membershipPriceset) {
853 if (!$membershipBlock['is_required']) {
854 $form->assign('showRadioNoThanks', TRUE);
855 $radio[''] = $form->createElement('radio', NULL, NULL, NULL, 'no_thanks', NULL);
856 $form->addGroup($radio, 'selectMembership', NULL);
857 }
858 elseif ($membershipBlock['is_required'] && count($radio) == 1) {
859 $temp = array_keys($radio);
860 $form->add('hidden', 'selectMembership', $temp[0], array('id' => 'selectMembership'));
861 $form->assign('singleMembership', TRUE);
862 $form->assign('showRadio', FALSE);
863 }
864 else {
865 $form->addGroup($radio, 'selectMembership', NULL);
866 }
867
868 $form->addRule('selectMembership', ts('Please select one of the memberships.'), 'required');
869 }
870 else {
871 $autoRenewOption = CRM_Price_BAO_PriceSet::checkAutoRenewForPriceSet($form->_priceSetId);
872 $form->assign('autoRenewOption', $autoRenewOption);
873 }
874
875 if (!$form->_values['is_pay_later'] && is_array($form->_paymentProcessors) && ($allowAutoRenewMembership || $autoRenewOption)) {
876 $form->addElement('checkbox', 'auto_renew', ts('Please renew my membership automatically.'));
877 }
878
879 }
880
881 $form->assign('membershipBlock', $membershipBlock);
882 $form->assign('membershipTypes', $membershipTypes);
883 $form->assign('allowAutoRenewMembership', $allowAutoRenewMembership);
884 $form->assign('autoRenewMembershipTypeOptions', json_encode($autoRenewMembershipTypeOptions));
885
886 //give preference to user submitted auto_renew value.
887 $takeUserSubmittedAutoRenew = (!empty($_POST) || $form->isSubmitted()) ? TRUE : FALSE;
888 $form->assign('takeUserSubmittedAutoRenew', $takeUserSubmittedAutoRenew);
889 }
890
891 return $separateMembershipPayment;
892 }
893
894 /**
895 * Function to return Membership Block info in Contribution Pages
896 *
897 * @param int $pageId contribution page id
898 *
899 * @static
900 */
901 static function getMembershipBlock($pageID) {
902 $membershipBlock = array();
903 $dao = new CRM_Member_DAO_MembershipBlock();
904 $dao->entity_table = 'civicrm_contribution_page';
905
906 $dao->entity_id = $pageID;
907 $dao->is_active = 1;
908 if ($dao->find(TRUE)) {
909 CRM_Core_DAO::storeValues($dao, $membershipBlock);
910 if (CRM_Utils_Array::value('membership_types', $membershipBlock)) {
911 $membershipTypes = unserialize($membershipBlock['membership_types']);
912 if (!is_array($membershipTypes)) {
913 return $membershipBlock;
914 }
915 $memTypes = array();
916 foreach ($membershipTypes as $key => $value) {
917 $membershipBlock['auto_renew'][$key] = $value;
918 $memTypes[$key] = $key;
919 }
920 $membershipBlock['membership_types'] = implode(',', $memTypes);
921 }
922 }
923 else {
924 return NULL;
925 }
926
927 return $membershipBlock;
928 }
929
930 /**
931 * Function to return a current membership of given contact
932 * NB: if more than one membership meets criteria, a randomly selected one is returned.
933 *
934 * @param int $contactID contact id
935 * @param int $memType membership type, null to retrieve all types
936 * @param int $isTest
937 * @param int $membershipID if provided, then determine if it is current
938 * @param boolean $onlySameParentOrg true if only Memberships with same parent org as the $memType wanted, false otherwise
939 * @static
940 */
941 static function getContactMembership($contactID, $memType, $isTest, $membershipId = NULL, $onlySameParentOrg = FALSE) {
942 $dao = new CRM_Member_DAO_Membership();
943 if ($membershipId) {
944 $dao->id = $membershipId;
945 }
946 $dao->contact_id = $contactID;
947 $dao->membership_type_id = $memType;
948
949 //fetch proper membership record.
950 if ($isTest) {
951 $dao->is_test = $isTest;
952 }
953 else {
954 $dao->whereAdd('is_test IS NULL OR is_test = 0');
955 }
956
957 //avoid pending membership as current membership: CRM-3027
958 $pendingStatusId = array_search('Pending', CRM_Member_PseudoConstant::membershipStatus());
959 $dao->whereAdd("status_id != $pendingStatusId");
960
961 // order by start date to find most recent membership first, CRM-4545
962 $dao->orderBy('start_date DESC');
963
964 // CRM-8141
965 if ($onlySameParentOrg && $memType) {
966 // require the same parent org as the $memType
967 $params = array('id' => $memType);
968 $defaults = array();
969 if (CRM_Member_BAO_MembershipType::retrieve($params, $membershipType)) {
970 $memberTypesSameParentOrg = CRM_Member_BAO_MembershipType::getMembershipTypesByOrg($membershipType['member_of_contact_id']);
971 $memberTypesSameParentOrgList = implode(',', array_keys($memberTypesSameParentOrg));
972 $dao->whereAdd('membership_type_id IN (' . $memberTypesSameParentOrgList . ')');
973 }
974 }
975
976 if ($dao->find(TRUE)) {
977 $membership = array();
978 CRM_Core_DAO::storeValues($dao, $membership);
979 $membership['is_current_member'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipStatus',
980 $membership['status_id'],
981 'is_current_member', 'id'
982 );
983 return $membership;
984 }
985
986 // CRM-8141
987 if ($onlySameParentOrg && $memType) {
988 // see if there is a membership that has same parent as $memType but different parent than $membershipID
989
990 if ( $dao->id && CRM_Core_Permission::check( 'edit memberships' ) ) {
991 // CRM-10016, This is probably a backend renewal, and make sure we return the same membership thats being renewed.
992 $dao->whereAdd ( );
993 } else {
994 unset($dao->id);
995 }
996
997 unset($dao->membership_type_id);
998 if ($dao->find(TRUE)) {
999 $membership = array();
1000 CRM_Core_DAO::storeValues($dao, $membership);
1001 $membership['is_current_member'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipStatus',
1002 $membership['status_id'],
1003 'is_current_member', 'id'
1004 );
1005 return $membership;
1006 }
1007 }
1008 return FALSE;
1009 }
1010
1011 /**
1012 * Combine all the importable fields from the lower levels object
1013 *
1014 * @param string $contactType contact type
1015 * @param boolean $status
1016 *
1017 * @return array array of importable Fields
1018 * @access public
1019 * @static
1020 */
1021 static function &importableFields($contactType = 'Individual', $status = TRUE) {
1022 if (!self::$_importableFields) {
1023 if (!self::$_importableFields) {
1024 self::$_importableFields = array();
1025 }
1026
1027 if (!$status) {
1028 $fields = array('' => array('title' => '- ' . ts('do not import') . ' -'));
1029 }
1030 else {
1031 $fields = array('' => array('title' => '- ' . ts('Membership Fields') . ' -'));
1032 }
1033
1034 $tmpFields = CRM_Member_DAO_Membership::import();
1035 $contactFields = CRM_Contact_BAO_Contact::importableFields($contactType, NULL);
1036
1037 // Using new Dedupe rule.
1038 $ruleParams = array(
1039 'contact_type' => $contactType,
1040 'used' => 'Unsupervised',
1041 );
1042 $fieldsArray = CRM_Dedupe_BAO_Rule::dedupeRuleFields($ruleParams);
1043
1044 $tmpContactField = array();
1045 if (is_array($fieldsArray)) {
1046 foreach ($fieldsArray as $value) {
1047 $customFieldId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField',
1048 $value,
1049 'id',
1050 'column_name'
1051 );
1052 $value = $customFieldId ? 'custom_' . $customFieldId : $value;
1053 $tmpContactField[trim($value)] = CRM_Utils_Array::value(trim($value), $contactFields);
1054 if (!$status) {
1055 $title = $tmpContactField[trim($value)]['title'] . " " . ts('(match to contact)');
1056 }
1057 else {
1058 $title = $tmpContactField[trim($value)]['title'];
1059 }
1060 $tmpContactField[trim($value)]['title'] = $title;
1061 }
1062 }
1063 $tmpContactField['external_identifier'] = $contactFields['external_identifier'];
1064 $tmpContactField['external_identifier']['title'] = $contactFields['external_identifier']['title'] . " " . ts('(match to contact)');
1065
1066 $tmpFields['membership_contact_id']['title'] = $tmpFields['membership_contact_id']['title'] . " " . ts('(match to contact)');;
1067
1068 $fields = array_merge($fields, $tmpContactField);
1069 $fields = array_merge($fields, $tmpFields);
1070 $fields = array_merge($fields, CRM_Core_BAO_CustomField::getFieldsForImport('Membership'));
1071 self::$_importableFields = $fields;
1072 }
1073 return self::$_importableFields;
1074 }
1075
1076 /**
1077 * function to get all exportable fields
1078 *
1079 * @retun array return array of all exportable fields
1080 * @static
1081 */
1082 static function &exportableFields() {
1083 $expFieldMembership = CRM_Member_DAO_Membership::export();
1084 //campaign fields.
1085 if (isset($expFieldMembership['member_campaign_id'])) {
1086 $expFieldMembership['member_campaign'] = array('title' => ts('Campaign Title'));
1087 }
1088
1089 $expFieldsMemType = CRM_Member_DAO_MembershipType::export();
1090 $fields = array_merge($expFieldMembership, $expFieldsMemType);
1091 $fields = array_merge($fields, $expFieldMembership);
1092 $membershipStatus = array(
1093 'membership_status' => array('title' => 'Membership Status',
1094 'name' => 'membership_status',
1095 'type' => CRM_Utils_Type::T_STRING,
1096 'where' => 'civicrm_membership_status.name',
1097 ));
1098 //CRM-6161 fix for customdata export
1099 $fields = array_merge($fields, $membershipStatus, CRM_Core_BAO_CustomField::getFieldsForImport('Membership'));
1100 return $fields;
1101 }
1102
1103 /**
1104 * Function to get membership joins/renewals for a specified membership
1105 * type. Specifically, retrieves a count of memberships whose "Membership
1106 * Signup" or "Membership Renewal" activity falls in the given date range.
1107 * Dates match the pattern "yyyy-mm-dd".
1108 *
1109 * @param int $membershipTypeId membership type id
1110 * @param int $startDate date on which to start counting
1111 * @param int $endDate date on which to end counting
1112 * @param bool $isTest if true, membership is for a test site
1113 * @param bool $isOwner if true, only retrieve membership records for owners //LCD
1114 *
1115 * @return returns the number of members of type $membershipTypeId whose
1116 * start_date is between $startDate and $endDate
1117 */
1118 //LCD
1119 public static function getMembershipStarts($membershipTypeId, $startDate, $endDate, $isTest = 0, $isOwner = 0) {
1120
1121 $testClause = 'membership.is_test = 1';
1122 if (!$isTest) {
1123 $testClause = '( membership.is_test IS NULL OR membership.is_test = 0 )';
1124 }
1125
1126 if (!self::$_signupActType || !self::$_renewalActType) {
1127 self::_getActTypes();
1128 }
1129
1130 if (!self::$_signupActType || !self::$_renewalActType) {
1131 return 0;
1132 }
1133
1134 $query = "
1135 SELECT COUNT(DISTINCT membership.id) as member_count
1136 FROM civicrm_membership membership
1137 INNER JOIN civicrm_activity activity ON (activity.source_record_id = membership.id AND activity.activity_type_id in (%1, %2))
1138 INNER JOIN civicrm_membership_status status ON ( membership.status_id = status.id AND status.is_current_member = 1 )
1139 INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND contact.is_deleted = 0 )
1140 WHERE membership.membership_type_id = %3
1141 AND activity.activity_date_time >= '$startDate' AND activity.activity_date_time <= '$endDate 23:59:59'
1142 AND {$testClause}";
1143
1144 $query .= ($isOwner) ? ' AND owner_membership_id IS NULL' : '';
1145
1146 $params = array(
1147 1 => array(self::$_signupActType, 'Integer'),
1148 2 => array(self::$_renewalActType, 'Integer'),
1149 3 => array($membershipTypeId, 'Integer'),
1150 );
1151
1152 $memberCount = CRM_Core_DAO::singleValueQuery($query, $params);
1153 return (int)$memberCount;
1154 }
1155
1156 /**
1157 * Function to get a count of membership for a specified membership type,
1158 * optionally for a specified date. The date must have the form yyyy-mm-dd.
1159 *
1160 * If $date is omitted, this function counts as a member anyone whose
1161 * membership status_id indicates they're a current member.
1162 * If $date is given, this function counts as a member anyone who:
1163 * -- Has a start_date before $date and end_date after $date, or
1164 * -- Has a start_date before $date and is currently a member, as indicated
1165 * by the the membership's status_id.
1166 * The second condition takes care of records that have no end_date. These
1167 * are assumed to be lifetime memberships.
1168 *
1169 * @param int $membershipTypeId membership type id
1170 * @param string $date the date for which to retrieve the count
1171 * @param bool $isTest if true, membership is for a test site
1172 * @param bool $isOwner if true, only retrieve membership records for owners //LCD
1173 *
1174 * @return returns the number of members of type $membershipTypeId as of
1175 * $date.
1176 */
1177 public static function getMembershipCount($membershipTypeId, $date = NULL, $isTest = 0, $isOwner = 0) {
1178 if (!CRM_Utils_Rule::date($date)) {
1179 CRM_Core_Error::fatal(ts('Invalid date "%1" (must have form yyyy-mm-dd).', array(1 => $date)));
1180 }
1181
1182 $params = array(1 => array($membershipTypeId, 'Integer'),
1183 2 => array($isTest, 'Boolean'),
1184 );
1185 $query = "SELECT count(civicrm_membership.id ) as member_count
1186 FROM civicrm_membership left join civicrm_membership_status on ( civicrm_membership.status_id = civicrm_membership_status.id )
1187 WHERE civicrm_membership.membership_type_id = %1
1188 AND civicrm_membership.contact_id NOT IN (SELECT id FROM civicrm_contact WHERE is_deleted = 1)
1189 AND civicrm_membership.is_test = %2";
1190 if (!$date) {
1191 $query .= " AND civicrm_membership_status.is_current_member = 1";
1192 }
1193 else {
1194 $query .= " AND civicrm_membership.start_date <= '$date' AND civicrm_membership_status.is_current_member = 1";
1195 }
1196 // LCD
1197 $query .= ($isOwner) ? ' AND owner_membership_id IS NULL' : '';
1198 $memberCount = CRM_Core_DAO::singleValueQuery($query, $params);
1199 return (int)$memberCount;
1200 }
1201
1202 /**
1203 * Function check the status of the membership before adding membership for a contact
1204 *
1205 * @param int $contactId contact id
1206 *
1207 * @return
1208 */
1209 static function statusAvailabilty($contactId) {
1210 $membership = new CRM_Member_DAO_MembershipStatus();
1211 $membership->whereAdd('is_active=1');
1212 return $membership->count();
1213 }
1214
1215 /**
1216 * Process the Memberships
1217 *
1218 * @param array $membershipParams array of membership fields
1219 * @param int $contactID contact id
1220 * @param object $form form object
1221 *
1222 * @return void
1223 * @access public
1224 */
1225 public static function postProcessMembership($membershipParams, $contactID, &$form, &$premiumParams,
1226 $customFieldsFormatted = NULL, $includeFieldTypes = NULL
1227 ) {
1228 $tempParams = $membershipParams;
1229 $paymentDone = FALSE;
1230 $result = NULL;
1231 $isTest = CRM_Utils_Array::value('is_test', $membershipParams, FALSE);
1232 $form->assign('membership_assign', TRUE);
1233
1234 $form->set('membershipTypeID', $membershipParams['selectMembership']);
1235
1236 $singleMembershipTypeID = $membershipTypeID = $membershipParams['selectMembership'];
1237 if (is_array($membershipTypeID) && count($membershipTypeID) == 1) {
1238 $singleMembershipTypeID = $membershipTypeID[0];
1239 }
1240
1241 $membershipDetails = self::buildMembershipTypeValues($form, $singleMembershipTypeID);
1242 $form->assign('membership_name', CRM_Utils_Array::value('name', $membershipDetails));
1243
1244 $minimumFee = CRM_Utils_Array::value('minimum_fee', $membershipDetails);
1245 $contributionTypeId = NULL;
1246 if ($form->_values['amount_block_is_active']) {
1247 $contributionTypeId = $form->_values['financial_type_id'];
1248 }
1249 else {
1250 $paymentDone = TRUE;
1251 $params['amount'] = $minimumFee;
1252 $contributionTypeId = CRM_Utils_Array::value( 'financial_type_id', $membershipDetails );
1253 if (!$contributionTypeId) {
1254 $contributionTypeId = CRM_Utils_Array::value('financial_type_id' ,$membershipParams);
1255 }
1256 }
1257
1258 //amount must be greater than zero for
1259 //adding contribution record to contribution table.
1260 //this condition arises when separate membership payment is
1261 //enabled and contribution amount is not selected. fix for CRM-3010
1262 if ($form->_amount > 0.0 && $membershipParams['amount']) {
1263 $result = CRM_Contribute_BAO_Contribution_Utils::processConfirm($form, $membershipParams,
1264 $premiumParams, $contactID,
1265 $contributionTypeId,
1266 'membership'
1267 );
1268 }
1269 else {
1270 // we need to explicitly create a CMS user in case of free memberships
1271 // since the below has already been done under processConfirm for paid memberships
1272 CRM_Contribute_BAO_Contribution_Utils::createCMSUser($membershipParams,
1273 $membershipParams['cms_contactID'],
1274 'email-' . $form->_bltID
1275 );
1276 }
1277
1278 $errors = array();
1279 if (is_a($result[1], 'CRM_Core_Error')) {
1280 $errors[1] = CRM_Core_Error::getMessages($result[1]);
1281 }
1282 elseif (CRM_Utils_Array::value(1, $result)) {
1283 // Save the contribution ID so that I can be used in email receipts
1284 // For example, if you need to generate a tax receipt for the donation only.
1285 $form->_values['contribution_other_id'] = $result[1]->id;
1286 $contribution[1] = $result[1];
1287 }
1288
1289
1290 $memBlockDetails = CRM_Member_BAO_Membership::getMembershipBlock($form->_id);
1291 if (CRM_Utils_Array::value('is_separate_payment', $memBlockDetails) && !$paymentDone) {
1292 $form->_lineItem = $form->_memLineItem;
1293 $contributionType = new CRM_Financial_DAO_FinancialType( );
1294 $contributionType->id = CRM_Utils_Array::value('financial_type_id', $membershipDetails);
1295 if (!$contributionType->find(TRUE)) {
1296 CRM_Core_Error::fatal(ts("Could not find a system table"));
1297 }
1298 $tempParams['amount'] = $minimumFee;
1299 $invoiceID = md5(uniqid(rand(), TRUE));
1300 $tempParams['invoiceID'] = $invoiceID;
1301
1302 //we don't allow recurring membership.CRM-3781.
1303 if (CRM_Utils_Array::value('is_recur', $tempParams)) {
1304 $tempParams['is_recur'] = 0;
1305 }
1306 $result = NULL;
1307 if ($form->_values['is_monetary'] && !$form->_params['is_pay_later'] && $minimumFee > 0.0) {
1308 $payment = CRM_Core_Payment::singleton($form->_mode, $form->_paymentProcessor, $form);
1309
1310 if ($form->_contributeMode == 'express') {
1311 $result = &$payment->doExpressCheckout($tempParams);
1312 }
1313 else {
1314 $result = &$payment->doDirectPayment($tempParams);
1315 }
1316 }
1317
1318 if (is_a($result, 'CRM_Core_Error')) {
1319 $errors[2] = CRM_Core_Error::getMessages($result);
1320 }
1321 else {
1322 //assign receive date when separate membership payment
1323 //and contribution amount not selected.
1324 if ($form->_amount == 0) {
1325 $now = date('YmdHis');
1326 $form->_params['receive_date'] = $now;
1327 $receiveDate = CRM_Utils_Date::mysqlToIso($now);
1328 $form->set('params', $form->_params);
1329 $form->assign('receive_date', $receiveDate);
1330 }
1331
1332 $form->set('membership_trx_id', $result['trxn_id']);
1333 $form->set('membership_amount', $minimumFee);
1334
1335 $form->assign('membership_trx_id', $result['trxn_id']);
1336 $form->assign('membership_amount', $minimumFee);
1337
1338 // we dont need to create the user twice, so lets disable cms_create_account
1339 // irrespective of the value, CRM-2888
1340 $tempParams['cms_create_account'] = 0;
1341
1342 $pending = $form->_params['is_pay_later'] ? ((CRM_Utils_Array::value('minimum_fee', $membershipDetails, 0) > 0.0) ? TRUE : FALSE) : FALSE;
1343
1344 //set this variable as we are not creating pledge for
1345 //separate membership payment contribution.
1346 //so for differentiating membership contributon from
1347 //main contribution.
1348 $form->_params['separate_membership_payment'] = 1;
1349 $contribution[2] = CRM_Contribute_Form_Contribution_Confirm::processContribution($form,
1350 $tempParams,
1351 $result,
1352 $contactID,
1353 $contributionType,
1354 TRUE,
1355 $pending
1356 );
1357 }
1358 }
1359
1360 $index = CRM_Utils_Array::value('is_separate_payment', $memBlockDetails) ? 2 : 1;
1361
1362 if (!CRM_Utils_Array::value($index, $errors)) {
1363 if (isset($membershipParams['onbehalf']) &&
1364 CRM_Utils_Array::value('member_campaign_id', $membershipParams['onbehalf'])) {
1365 $form->_params['campaign_id'] = $membershipParams['onbehalf']['member_campaign_id'];
1366 }
1367 if (is_array($membershipTypeID)) {
1368 $typesTerms = CRM_Utils_Array::value('types_terms', $membershipParams, array());
1369 $createdMemberships = array();
1370
1371 foreach ($membershipTypeID as $memType) {
1372 $numTerms = CRM_Utils_Array::value($memType, $typesTerms, 1);
1373 $membership = self::renewMembership($contactID, $memType,
1374 $isTest, $form, NULL,
1375 CRM_Utils_Array::value('cms_contactID', $membershipParams),
1376 $customFieldsFormatted, CRM_Utils_Array::value($memType, $typesTerms, 1)
1377 );
1378
1379 $createdMemberships[$memType] = $membership;
1380 if (isset($contribution[$index])) {
1381 //insert payment record
1382 $dao = new CRM_Member_DAO_MembershipPayment();
1383 $dao->membership_id = $membership->id;
1384 $dao->contribution_id = $contribution[$index]->id;
1385 //Fixed for avoiding duplicate entry error when user goes
1386 //back and forward during payment mode is notify
1387 if (!$dao->find(TRUE)) {
1388 CRM_Utils_Hook::pre('create', 'MembershipPayment', NULL, $dao);
1389 $dao->save();
1390 CRM_Utils_Hook::post('create', 'MembershipPayment', $dao->id, $dao);
1391 }
1392 }
1393 }
1394 if ($form->_priceSetId && !empty($form->_useForMember) && !empty($form->_lineItem)) {
1395 foreach ($form->_lineItem[$form->_priceSetId] as & $priceFieldOp) {
1396 if (CRM_Utils_Array::value('membership_type_id', $priceFieldOp) &&
1397 isset($createdMemberships[$priceFieldOp['membership_type_id']])
1398 ) {
1399 $membershipOb = $createdMemberships[$priceFieldOp['membership_type_id']];
1400 $priceFieldOp['start_date'] = $membershipOb->start_date ? CRM_Utils_Date::customFormat($membershipOb->start_date, '%d%f %b, %Y') : '-';
1401 $priceFieldOp['end_date'] = $membershipOb->end_date ? CRM_Utils_Date::customFormat($membershipOb->end_date, '%d%f %b, %Y') : '-';
1402 }
1403 else {
1404 $priceFieldOp['start_date'] = $priceFieldOp['end_date'] = 'N/A';
1405 }
1406 }
1407 $form->_values['lineItem'] = $form->_lineItem;
1408 $form->assign('lineItem', $form->_lineItem);
1409 }
1410 }
1411 else {
1412 $membership = self::renewMembership($contactID, $membershipTypeID,
1413 $isTest, $form, NULL,
1414 CRM_Utils_Array::value('cms_contactID', $membershipParams),
1415 $customFieldsFormatted, CRM_Utils_Array::value('types_terms', $membershipParams, 1)
1416 );
1417 if (isset($contribution[$index])) {
1418 //insert payment record
1419 $dao = new CRM_Member_DAO_MembershipPayment();
1420 $dao->membership_id = $membership->id;
1421 $dao->contribution_id = $contribution[$index]->id;
1422 //Fixed for avoiding duplicate entry error when user goes
1423 //back and forward during payment mode is notify
1424 if (!$dao->find(TRUE)) {
1425 CRM_Utils_Hook::pre('create', 'MembershipPayment', NULL, $dao);
1426 $dao->save();
1427 CRM_Utils_Hook::post('create', 'MembershipPayment', $dao->id, $dao);
1428 }
1429 }
1430 }
1431 }
1432
1433 if (!empty($errors)) {
1434 foreach ($errors as $error) {
1435 if (is_string($error)) {
1436 $message[] = $error;
1437 }
1438 }
1439 $message = ts('Payment Processor Error message') . ': ' . implode('<br/>', $message);
1440 // Redirect the form in case of error
1441 // @todo this redirect in the BAO layer is really bad & should be moved to the form layer
1442 // however since we have no idea how (if) this is triggered we can't safely move / remove it
1443 $errorParams = array(
1444 'legacy_redirect_path' => 'civicrm/contribute/transact',
1445 'legacy_redirect_query' => "_qf_Main_display=true&qfKey={$form->_params['qfKey']}",
1446 );
1447 throw new CiviCRM_Exception($message, 0, $errorParams);
1448 }
1449
1450 // CRM-7851
1451 CRM_Core_BAO_CustomValueTable::postProcess($form->_params,
1452 CRM_Core_DAO::$_nullArray,
1453 'civicrm_membership',
1454 $membership->id,
1455 'Membership'
1456 );
1457
1458 $form->_params['membershipID'] = $membership->id;
1459 if ($form->_contributeMode == 'notify') {
1460 if ($form->_values['is_monetary'] && $form->_amount > 0.0 && !$form->_params['is_pay_later']) {
1461 // call postprocess hook before leaving
1462 $form->postProcessHook();
1463 // this does not return
1464 $payment = CRM_Core_Payment::singleton($form->_mode, $form->_paymentProcessor, $form);
1465 $payment->doTransferCheckout($form->_params, 'contribute');
1466 }
1467 }
1468
1469 $form->_values['membership_id'] = $membership->id;
1470 if (isset($contribution[$index]->id)) {
1471 $form->_values['contribution_id'] = $contribution[$index]->id;
1472 }
1473
1474 // Do not send an email if Recurring transaction is done via Direct Mode
1475 // Email will we sent when the IPN is received.
1476 if (CRM_Utils_Array::value('is_recur', $form->_params) && $form->_contributeMode == 'direct') {
1477 return TRUE;
1478 }
1479
1480 //finally send an email receipt
1481 CRM_Contribute_BAO_ContributionPage::sendMail($contactID,
1482 $form->_values,
1483 $isTest, FALSE,
1484 $includeFieldTypes
1485 );
1486 }
1487
1488 /**
1489 * This method will renew / create the membership depending on
1490 * whether the given contact has a membership or not. And will add
1491 * the modified dates for membership and in the log table.
1492 *
1493 * @param int $contactID id of the contact
1494 * @param int $membershipTypeID id of the new membership type
1495 * @param boolean $is_test if this is test contribution or live contribution
1496 * @param object $form form object
1497 * @param array $ipnParams array of name value pairs, to be used (for e.g source) when $form not present
1498 * @param int $modifiedID individual contact id in case of On Behalf signup (CRM-4027 )
1499 * @param int $numRenewTerms how many membership terms are being added to end date (default is 1)
1500 *
1501 * @return object $membership object of membership
1502 *
1503 * @static
1504 * @access public
1505 *
1506 **/
1507 static function renewMembership(
1508 $contactID,
1509 $membershipTypeID,
1510 $is_test,
1511 &$form,
1512 $changeToday = NULL,
1513 $modifiedID = NULL,
1514 $customFieldsFormatted = NULL,
1515 $numRenewTerms = 1
1516 ) {
1517 $statusFormat = '%Y-%m-%d';
1518 $format = '%Y%m%d';
1519 $ids = array();
1520
1521 //get all active statuses of membership.
1522 $allStatus = CRM_Member_PseudoConstant::membershipStatus();
1523
1524 $membershipTypeDetails = CRM_Member_BAO_MembershipType::getMembershipTypeDetails($membershipTypeID);
1525
1526 // check is it pending. - CRM-4555
1527 $pending = FALSE;
1528 if (CRM_Utils_Array::value('minimum_fee', $membershipTypeDetails) > 0.0) {
1529 if (((isset($form->_contributeMode) && $form->_contributeMode == 'notify') ||
1530 CRM_Utils_Array::value('is_pay_later', $form->_params) ||
1531 (CRM_Utils_Array::value('is_recur', $form->_params)
1532 && $form->_contributeMode == 'direct'
1533 )
1534 ) &&
1535 (($form->_values['is_monetary'] && $form->_amount > 0.0) ||
1536 CRM_Utils_Array::value('separate_membership_payment', $form->_params) ||
1537 CRM_Utils_Array::value('record_contribution', $form->_params)
1538 )
1539 ) {
1540 $pending = TRUE;
1541 }
1542 }
1543
1544 //decide status here, if needed.
1545 $updateStatusId = NULL;
1546
1547 // CRM-7297 - allow membership type to be be changed during renewal so long as the parent org of new membershipType
1548 // is the same as the parent org of an existing membership of the contact
1549 $currentMembership = CRM_Member_BAO_Membership::getContactMembership($contactID, $membershipTypeID,
1550 $is_test, $form->_membershipId, TRUE
1551 );
1552 if ($currentMembership) {
1553 $activityType = 'Membership Renewal';
1554 $form->set('renewal_mode', TRUE);
1555
1556 // Do NOT do anything.
1557 //1. membership with status : PENDING/CANCELLED (CRM-2395)
1558 //2. Paylater/IPN renew. CRM-4556.
1559 if ($pending || in_array($currentMembership['status_id'], array(array_search('Pending', $allStatus),
1560 array_search('Cancelled', $allStatus),
1561 ))) {
1562 $membership = new CRM_Member_DAO_Membership();
1563 $membership->id = $currentMembership['id'];
1564 $membership->find(TRUE);
1565
1566 // CRM-8141 create a membership_log entry so that we will know the membership_type_id to change to when payment completed
1567 $format = '%Y%m%d';
1568 // note that we are logging the requested new membership_type_id that may be different than current membership_type_id
1569 // it will be used when payment is received to update the membership_type_id to what was paid for
1570 $logParams = array(
1571 'membership_id' => $membership->id,
1572 'status_id' => $membership->status_id,
1573 'start_date' => CRM_Utils_Date::customFormat(
1574 $membership->start_date,
1575 $format
1576 ),
1577 'end_date' => CRM_Utils_Date::customFormat(
1578 $membership->end_date,
1579 $format
1580 ),
1581 'modified_date' => CRM_Utils_Date::customFormat(
1582 date('Ymd'),
1583 $format
1584 ),
1585 'membership_type_id' => $membershipTypeID,
1586 'max_related' => $membershipTypeDetails['max_related'],
1587 );
1588 $session = CRM_Core_Session::singleton();
1589 // If we have an authenticated session, set modified_id to that user's contact_id, else set to membership.contact_id
1590 if ($session->get('userID')) {
1591 $logParams['modified_id'] = $session->get('userID');
1592 }
1593 else {
1594 $logParams['modified_id'] = $membership->contact_id;
1595 }
1596 CRM_Member_BAO_MembershipLog::add($logParams, CRM_Core_DAO::$_nullArray);
1597
1598 if (CRM_Utils_Array::value('contributionRecurID', $form->_params)) {
1599 CRM_Core_DAO::setFieldValue('CRM_Member_DAO_Membership', $membership->id,
1600 'contribution_recur_id', $form->_params['contributionRecurID']
1601 );
1602 }
1603
1604 return $membership;
1605 }
1606
1607 //we renew expired membership, CRM-6277
1608 if (!$changeToday) {
1609 if ($form->get('renewalDate')) {
1610 $changeToday = $form->get('renewalDate');
1611 }
1612 elseif (get_class($form) == 'CRM_Contribute_Form_Contribution_Confirm') {
1613 $changeToday = date('YmdHis');
1614 }
1615 }
1616
1617 // Check and fix the membership if it is STALE
1618 self::fixMembershipStatusBeforeRenew($currentMembership, $changeToday);
1619
1620 // Now Renew the membership
1621 if (!$currentMembership['is_current_member']) {
1622 // membership is not CURRENT
1623
1624 // CRM-7297 Membership Upsell - calculate dates based on new membership type
1625 $dates = CRM_Member_BAO_MembershipType::getRenewalDatesForMembershipType($currentMembership['id'],
1626 $changeToday,
1627 $membershipTypeID,
1628 $numRenewTerms
1629 );
1630
1631 $currentMembership['join_date'] = CRM_Utils_Date::customFormat($currentMembership['join_date'], $format);
1632 $currentMembership['start_date'] = CRM_Utils_Array::value('start_date', $dates);
1633 $currentMembership['end_date'] = CRM_Utils_Array::value('end_date', $dates);
1634 $currentMembership['is_test'] = $is_test;
1635
1636 if (CRM_Utils_Array::value('membership_source', $form->_params)) {
1637 $currentMembership['source'] = $form->_params['membership_source'];
1638 }
1639 elseif (isset($form->_values['title']) && !empty($form->_values['title'])) {
1640 $currentMembership['source'] = ts('Online Contribution:') . ' ' . $form->_values['title'];
1641 }
1642 else {
1643 $currentMembership['source'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership',
1644 $currentMembership['id'],
1645 'source'
1646 );
1647 }
1648
1649 if (CRM_Utils_Array::value('id', $currentMembership)) {
1650 $ids['membership'] = $currentMembership['id'];
1651 }
1652 $memParams = $currentMembership;
1653 $memParams['membership_type_id'] = $membershipTypeID;
1654
1655 //set the log start date.
1656 $memParams['log_start_date'] = CRM_Utils_Date::customFormat($dates['log_start_date'], $format);
1657 }
1658 else {
1659
1660 // CURRENT Membership
1661 $membership = new CRM_Member_DAO_Membership();
1662 $membership->id = $currentMembership['id'];
1663 $membership->find(TRUE);
1664 // CRM-7297 Membership Upsell - calculate dates based on new membership type
1665 $dates = CRM_Member_BAO_MembershipType::getRenewalDatesForMembershipType($membership->id,
1666 $changeToday,
1667 $membershipTypeID,
1668 $numRenewTerms
1669 );
1670
1671 // Insert renewed dates for CURRENT membership
1672 $memParams = array();
1673 $memParams['join_date'] = CRM_Utils_Date::isoToMysql($membership->join_date);
1674 $memParams['start_date'] = CRM_Utils_Date::isoToMysql($membership->start_date);
1675 $memParams['end_date'] = CRM_Utils_Array::value('end_date', $dates);
1676 $memParams['membership_type_id'] = $membershipTypeID;
1677
1678 //set the log start date.
1679 $memParams['log_start_date'] = CRM_Utils_Date::customFormat($dates['log_start_date'], $format);
1680 if (empty($membership->source)) {
1681 if (CRM_Utils_Array::value('membership_source', $form->_params)) {
1682 $memParams['source'] = $form->_params['membership_source'];
1683 }
1684 elseif (property_exists($form, '_values') && CRM_Utils_Array::value('title', $form->_values)) {
1685 $memParams['source'] = ts('Online Contribution:') . ' ' . $form->_values['title'];
1686 }
1687 else {
1688 $memParams['source'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership',
1689 $currentMembership['id'],
1690 'source'
1691 );
1692 }
1693 }
1694
1695 if (CRM_Utils_Array::value('id', $currentMembership)) {
1696 $ids['membership'] = $currentMembership['id'];
1697 }
1698 }
1699 //CRM-4555
1700 if ($pending) {
1701 $updateStatusId = array_search('Pending', $allStatus);
1702 }
1703 }
1704 else {
1705 // NEW Membership
1706
1707 $activityType = 'Membership Signup';
1708 $memParams = array(
1709 'contact_id' => $contactID,
1710 'membership_type_id' => $membershipTypeID,
1711 );
1712
1713 if (!$pending) {
1714 $dates = CRM_Member_BAO_MembershipType::getDatesForMembershipType($membershipTypeID, NULL, NULL, NULL, $numRenewTerms);
1715
1716 $memParams['join_date'] = CRM_Utils_Array::value('join_date', $dates);
1717 $memParams['start_date'] = CRM_Utils_Array::value('start_date', $dates);
1718 $memParams['end_date'] = CRM_Utils_Array::value('end_date', $dates);
1719
1720 $status = CRM_Member_BAO_MembershipStatus::getMembershipStatusByDate(CRM_Utils_Date::customFormat($dates['start_date'],
1721 $statusFormat
1722 ),
1723 CRM_Utils_Date::customFormat($dates['end_date'],
1724 $statusFormat
1725 ),
1726 CRM_Utils_Date::customFormat($dates['join_date'],
1727 $statusFormat
1728 ),
1729 'today', TRUE
1730 );
1731 $updateStatusId = CRM_Utils_Array::value('id', $status);
1732 }
1733 else {
1734 // if IPN/Pay-Later set status to: PENDING
1735 $updateStatusId = array_search('Pending', $allStatus);
1736 }
1737
1738 if (CRM_Utils_Array::value('membership_source', $form->_params)) {
1739 $memParams['source'] = $form->_params['membership_source'];
1740 }
1741 elseif (CRM_Utils_Array::value('title', $form->_values)) {
1742 $memParams['source'] = ts('Online Contribution:') . ' ' . $form->_values['title'];
1743 }
1744 $memParams['contribution_recur_id'] = CRM_Utils_Array::value('contributionRecurID', $form->_params);
1745
1746 $memParams['is_test'] = $is_test;
1747 $memParams['is_pay_later'] = CRM_Utils_Array::value('is_pay_later', $form->_params);
1748 }
1749
1750 //CRM-4555
1751 //if we decided status here and want to skip status
1752 //calculation in create( ); then need to pass 'skipStatusCal'.
1753 if ($updateStatusId) {
1754 $memParams['status_id'] = $updateStatusId;
1755 $memParams['skipStatusCal'] = TRUE;
1756 }
1757
1758 //since we are renewing,
1759 //make status override false.
1760 $memParams['is_override'] = FALSE;
1761
1762 //CRM-4027, create log w/ individual contact.
1763 if ($modifiedID) {
1764 $ids['userId'] = $modifiedID;
1765 $memParams['is_for_organization'] = TRUE;
1766 }
1767 else {
1768 $ids['userId'] = $contactID;
1769 }
1770
1771 //inherit campaign from contrib page.
1772 if (isset($form->_values) && is_array($form->_values) && !empty($form->_values)) {
1773 $campaignId = CRM_Utils_Array::value('campaign_id', $form->_params);
1774 if (!array_key_exists('campaign_id', $form->_params)) {
1775 $campaignId = CRM_Utils_Array::value('campaign_id', $form->_values);
1776 }
1777 $memParams['campaign_id'] = $campaignId;
1778 }
1779
1780 $memParams['custom'] = $customFieldsFormatted;
1781 $membership = self::create($memParams, $ids, FALSE, $activityType);
1782
1783 // not sure why this statement is here, seems quite odd :( - Lobo: 12/26/2010
1784 // related to: http://forum.civicrm.org/index.php/topic,11416.msg49072.html#msg49072
1785 $membership->find(TRUE);
1786 if (!empty($dates)) {
1787 $form->assign('mem_start_date',
1788 CRM_Utils_Date::customFormat($dates['start_date'], $format)
1789 );
1790 $form->assign('mem_end_date',
1791 CRM_Utils_Date::customFormat($dates['end_date'], $format)
1792 );
1793 }
1794
1795 return $membership;
1796 }
1797
1798 /**
1799 * Method to fix membership status of stale membership
1800 *
1801 * This method first checks if the membership is stale. If it is,
1802 * then status will be updated based on existing start and end
1803 * dates and log will be added for the status change.
1804 *
1805 * @param array $currentMembership referance to the array
1806 * containing all values of
1807 * the current membership
1808 * @param array $changeToday array of month, day, year
1809 * values in case today needs
1810 * to be customised, null otherwise
1811 *
1812 * @return void
1813 * @static
1814 */
1815 static function fixMembershipStatusBeforeRenew(&$currentMembership, $changeToday) {
1816 $today = NULL;
1817 if ($changeToday) {
1818 $today = CRM_Utils_Date::processDate($changeToday, NULL, FALSE, 'Y-m-d');
1819 }
1820
1821 $status = CRM_Member_BAO_MembershipStatus::getMembershipStatusByDate(
1822 CRM_Utils_Array::value('start_date', $currentMembership),
1823 CRM_Utils_Array::value('end_date', $currentMembership),
1824 CRM_Utils_Array::value('join_date', $currentMembership),
1825 $today,
1826 TRUE
1827 );
1828
1829 if (empty($status) ||
1830 empty($status['id'])
1831 ) {
1832 CRM_Core_Error::fatal(ts('Oops, it looks like there is no valid membership status corresponding to the membership start and end dates for this membership. Contact the site administrator for assistance.'));
1833 }
1834
1835 $currentMembership['today_date'] = $today;
1836
1837 if ($status['id'] !== $currentMembership['status_id']) {
1838 $memberDAO = new CRM_Member_DAO_Membership();
1839 $memberDAO->id = $currentMembership['id'];
1840 $memberDAO->find(TRUE);
1841
1842 $memberDAO->status_id = $status['id'];
1843 $memberDAO->join_date = CRM_Utils_Date::isoToMysql($memberDAO->join_date);
1844 $memberDAO->start_date = CRM_Utils_Date::isoToMysql($memberDAO->start_date);
1845 $memberDAO->end_date = CRM_Utils_Date::isoToMysql($memberDAO->end_date);
1846 $memberDAO->save();
1847 CRM_Core_DAO::storeValues($memberDAO, $currentMembership);
1848 $memberDAO->free();
1849
1850 $currentMembership['is_current_member'] = CRM_Core_DAO::getFieldValue(
1851 'CRM_Member_DAO_MembershipStatus',
1852 $currentMembership['status_id'],
1853 'is_current_member'
1854 );
1855 $format = '%Y%m%d';
1856
1857 $logParams = array(
1858 'membership_id' => $currentMembership['id'],
1859 'status_id' => $status['id'],
1860 'start_date' => CRM_Utils_Date::customFormat(
1861 $currentMembership['start_date'],
1862 $format
1863 ),
1864 'end_date' => CRM_Utils_Date::customFormat(
1865 $currentMembership['end_date'],
1866 $format
1867 ),
1868 'modified_date' => CRM_Utils_Date::customFormat(
1869 $currentMembership['today_date'],
1870 $format
1871 ),
1872 'membership_type_id' => $currentMembership['membership_type_id'],
1873 'max_related' => $currentMembership['max_related'],
1874 );
1875
1876 $session = CRM_Core_Session::singleton();
1877 // If we have an authenticated session, set modified_id to that user's contact_id, else set to membership.contact_id
1878 if ($session->get('userID')) {
1879 $logParams['modified_id'] = $session->get('userID');
1880 }
1881 else {
1882 $logParams['modified_id'] = $currentMembership['contact_id'];
1883 }
1884 CRM_Member_BAO_MembershipLog::add($logParams, CRM_Core_DAO::$_nullArray);
1885 }
1886 }
1887
1888 /**
1889 * Function to get the contribution page id from the membership record
1890 *
1891 * @param int membershipId membership id
1892 *
1893 * @return int $contributionPageId contribution page id
1894 * @access public
1895 * @static
1896 */
1897 static function getContributionPageId($membershipID) {
1898 $query = "
1899 SELECT c.contribution_page_id as pageID
1900 FROM civicrm_membership_payment mp, civicrm_contribution c
1901 WHERE mp.contribution_id = c.id
1902 AND c.contribution_page_id IS NOT NULL
1903 AND mp.membership_id = " . CRM_Utils_Type::escape($membershipID, 'Integer')
1904 . " ORDER BY mp.id DESC";
1905
1906 return CRM_Core_DAO::singleValueQuery($query,
1907 CRM_Core_DAO::$_nullArray
1908 );
1909 }
1910
1911 /**
1912 * Function to updated related memberships
1913 *
1914 * @param int $ownerMembershipId owner Membership Id
1915 * @param array $params formatted array of key => value..
1916 * @static
1917 */
1918 static function updateRelatedMemberships($ownerMembershipId, $params) {
1919 $membership = new CRM_Member_DAO_Membership();
1920 $membership->owner_membership_id = $ownerMembershipId;
1921 $membership->find();
1922
1923 while ($membership->fetch()) {
1924 $relatedMembership = new CRM_Member_DAO_Membership();
1925 $relatedMembership->id = $membership->id;
1926 $relatedMembership->copyValues($params);
1927 $relatedMembership->save();
1928 $relatedMembership->free();
1929 }
1930
1931 $membership->free();
1932 }
1933
1934 /**
1935 * Function to get list of membership fields for profile
1936 * For now we only allow custom membership fields to be in
1937 * profile
1938 *
1939 * @return return the list of membership fields
1940 * @static
1941 * @access public
1942 */
1943 static function getMembershipFields($mode = NULL) {
1944 $fields = CRM_Member_DAO_Membership::export();
1945
1946 //campaign fields.
1947 if (isset($fields['member_campaign_id'])) {
1948 if ($mode == CRM_Export_Form_Select::MEMBER_EXPORT) {
1949 $fields['member_campaign'] = array('title' => ts('Campaign Title'));
1950 }
1951 else {
1952 $fields['member_campaign_id']['title'] = ts('Campaign');
1953 }
1954 }
1955
1956 unset($fields['membership_contact_id']);
1957 $fields = array_merge($fields, CRM_Core_BAO_CustomField::getFieldsForImport('Membership'));
1958
1959 $membershipType = CRM_Member_DAO_MembershipType::export();
1960
1961 $membershipStatus = CRM_Member_DAO_MembershipStatus::export();
1962
1963 $fields = array_merge($fields, $membershipType, $membershipStatus);
1964
1965 return $fields;
1966 }
1967
1968 /**
1969 * function to get the sort name of a contact for a particular membership
1970 *
1971 * @param int $id id of the membership
1972 *
1973 * @return null|string sort name of the contact if found
1974 * @static
1975 * @access public
1976 */
1977 static function sortName($id) {
1978 $id = CRM_Utils_Type::escape($id, 'Integer');
1979
1980 $query = "
1981 SELECT civicrm_contact.sort_name
1982 FROM civicrm_membership, civicrm_contact
1983 WHERE civicrm_membership.contact_id = civicrm_contact.id
1984 AND civicrm_membership.id = {$id}
1985 ";
1986 return CRM_Core_DAO::singleValueQuery($query, CRM_Core_DAO::$_nullArray);
1987 }
1988
1989 /**
1990 * function to create memberships for related contacts
1991 * takes into account the maximum related memberships
1992 *
1993 * @param array $params array of key - value pairs
1994 * @param object $membership membership object
1995 *
1996 * @return null|relatedMembership array of memberships if created
1997 * @static
1998 * @access public
1999 */
2000 static function createRelatedMemberships(&$params, &$dao) {
2001 static $relatedContactIds = array();
2002
2003 $membership = new CRM_Member_DAO_Membership();
2004 $membership->id = $dao->id;
2005
2006 // required since create method doesn't return all the
2007 // parameters in the returned membership object
2008 if (!$membership->find(TRUE)) {
2009 return;
2010 }
2011 $deceasedStatusId = array_search('Deceased', CRM_Member_PseudoConstant::membershipStatus());
2012 // FIXME : While updating/ renewing the
2013 // membership, if the relationship is PAST then
2014 // the membership of the related contact must be
2015 // expired.
2016 // For that, getting Membership Status for which
2017 // is_current_member is 0. It works for the
2018 // generated data as there is only one membership
2019 // status having is_current_member = 0.
2020 // But this wont work exactly if there will be
2021 // more than one status having is_current_member = 0.
2022 $membershipStatus = new CRM_Member_DAO_MembershipStatus();
2023 $membershipStatus->is_current_member = 0;
2024 if ($membershipStatus->find(TRUE)) {
2025 $expiredStatusId = $membershipStatus->id;
2026 } else {
2027 $expiredStatusId = array_search('Expired', CRM_Member_PseudoConstant::membershipStatus());
2028 }
2029
2030 $allRelatedContacts = array();
2031 $relatedContacts = array();
2032 if (!is_a($membership, 'CRM_Core_Error')) {
2033 $allRelatedContacts = CRM_Member_BAO_Membership::checkMembershipRelationship($membership->id,
2034 $membership->contact_id,
2035 CRM_Utils_Array::value('action', $params)
2036 );
2037 }
2038
2039 // check for loops. CRM-4213
2040 // remove repeated related contacts, which already inherited membership.
2041 $relatedContactIds[$membership->contact_id] = TRUE;
2042 foreach ($allRelatedContacts as $cid => $status) {
2043 if (!CRM_Utils_Array::value($cid, $relatedContactIds)) {
2044 $relatedContactIds[$cid] = TRUE;
2045
2046 //don't create membership again for owner contact.
2047 $nestedRelationship = FALSE;
2048 if ($membership->owner_membership_id) {
2049 $nestedRelMembership = new CRM_Member_DAO_Membership();
2050 $nestedRelMembership->id = $membership->owner_membership_id;
2051 $nestedRelMembership->contact_id = $cid;
2052 $nestedRelationship = $nestedRelMembership->find(TRUE);
2053 $nestedRelMembership->free();
2054 }
2055 if (!$nestedRelationship) {
2056 $relatedContacts[$cid] = $status;
2057 }
2058 }
2059 }
2060
2061 //lets cleanup related membership if any.
2062 if (empty($relatedContacts)) {
2063 self::deleteRelatedMemberships($membership->id);
2064 }
2065 else {
2066 // Edit the params array
2067 unset($params['id']);
2068 // Reminder should be sent only to the direct membership
2069 unset($params['reminder_date']);
2070 // unset the custom value ids
2071 if (is_array(CRM_Utils_Array::value('custom', $params))) {
2072 foreach ($params['custom'] as $k => $v) {
2073 unset($params['custom'][$k]['id']);
2074 }
2075 }
2076 if (!isset($params['membership_type_id'])) {
2077 $params['membership_type_id'] = $membership->membership_type_id;
2078 }
2079
2080 // max_related should be set in the parent membership
2081 unset($params['max_related']);
2082 // Number of inherited memberships available - NULL is interpreted as unlimited, '0' as none
2083 $available = ($membership->max_related == NULL ? PHP_INT_MAX : $membership->max_related);
2084 $queue = array(); // will be used to queue potential memberships to be created
2085
2086 foreach ($relatedContacts as $contactId => $relationshipStatus) {
2087 //use existing membership record.
2088 $relMembership = new CRM_Member_DAO_Membership();
2089 $relMembership->contact_id = $contactId;
2090 $relMembership->owner_membership_id = $membership->id;
2091 $relMemIds = array();
2092 if ($relMembership->find(TRUE)) {
2093 $params['id'] = $relMemIds['membership'] = $relMembership->id;
2094 }
2095 $params['contact_id'] = $contactId;
2096 $params['owner_membership_id'] = $membership->id;
2097
2098 // set status_id as it might have been changed for
2099 // past relationship
2100 $params['status_id'] = $membership->status_id;
2101
2102 if ($deceasedStatusId &&
2103 CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $contactId, 'is_deceased')
2104 ) {
2105 $params['status_id'] = $deceasedStatusId;
2106 }
2107 elseif ((CRM_Utils_Array::value('action', $params) & CRM_Core_Action::UPDATE) &&
2108 ($relationshipStatus == CRM_Contact_BAO_Relationship::PAST)
2109 ) {
2110 $params['status_id'] = $expiredStatusId;
2111 }
2112
2113 //don't calculate status again in create( );
2114 $params['skipStatusCal'] = TRUE;
2115
2116 //do create activity if we changed status.
2117 if ($params['status_id'] != $relMembership->status_id) {
2118 $params['createActivity'] = TRUE;
2119 }
2120
2121 // we should not created contribution record for related contacts, CRM-3371
2122 unset($params['contribution_status_id']);
2123
2124 if (($params['status_id'] == $deceasedStatusId) || ($params['status_id'] == $expiredStatusId)) {
2125 // related membership is not active so does not count towards maximum
2126 CRM_Member_BAO_Membership::create($params, $relMemIds);
2127 } else {
2128 // related membership already exists, so this is just an update
2129 if (isset($params['id'])) {
2130 if ($available > 0) {
2131 CRM_Member_BAO_Membership::create($params, $relMemIds);
2132 $available --;
2133 } else { // we have run out of inherited memberships, so delete extras
2134 self::deleteMembership($params['id']);
2135 }
2136 // we need to first check if there will remain inherited memberships, so queue it up
2137 } else {
2138 $queue[] = $params;
2139 }
2140 }
2141 }
2142 // now go over the queue and create any available related memberships
2143 reset($queue);
2144 while (($available > 0) && ($params = each($queue))) {
2145 CRM_Member_BAO_Membership::create($params['value'], $relMemIds);
2146 $available --;
2147 }
2148 }
2149 }
2150
2151 /**
2152 * Delete the record that are associated with this Membership Payment
2153 *
2154 * @param int $membershipId membsership id.
2155 *
2156 * @return boolean true if deleted false otherwise
2157 * @access public
2158 */
2159 static function deleteMembershipPayment($membershipId) {
2160
2161 $membesrshipPayment = new CRM_Member_DAO_MembershipPayment();
2162 $membesrshipPayment->membership_id = $membershipId;
2163 $membesrshipPayment->find();
2164
2165 while ($membesrshipPayment->fetch()) {
2166 CRM_Contribute_BAO_Contribution::deleteContribution($membesrshipPayment->contribution_id);
2167 CRM_Utils_Hook::pre('delete', 'MembershipPayment', $membesrshipPayment->id, $membesrshipPayment);
2168 $membesrshipPayment->delete();
2169 CRM_Utils_Hook::post('delete', 'MembershipPayment', $membesrshipPayment->id, $membesrshipPayment);
2170 }
2171 return $membesrshipPayment;
2172 }
2173
2174 static function &buildMembershipTypeValues(&$form, $membershipTypeID = NULL) {
2175 $whereClause = " WHERE domain_id = ". CRM_Core_Config::domainID();
2176
2177 if (is_array($membershipTypeID)) {
2178 $allIDs = implode(',', $membershipTypeID);
2179 $whereClause .= " AND id IN ( $allIDs )";
2180 }
2181 elseif (is_numeric($membershipTypeID) &&
2182 $membershipTypeID > 0
2183 ) {
2184 $whereClause .= " AND id = $membershipTypeID";
2185 }
2186
2187 $query = "
2188 SELECT *
2189 FROM civicrm_membership_type
2190 $whereClause;
2191 ";
2192 $dao = CRM_Core_DAO::executeQuery($query);
2193
2194 $membershipTypeValues = array();
2195 $membershipTypeFields = array(
2196 'id', 'minimum_fee', 'name', 'is_active',
2197 'description', 'financial_type_id', 'auto_renew','member_of_contact_id',
2198 'relationship_type_id', 'relationship_direction', 'max_related',
2199 );
2200
2201 while ($dao->fetch()) {
2202 $membershipTypeValues[$dao->id] = array();
2203 foreach ($membershipTypeFields as $mtField) {
2204 $membershipTypeValues[$dao->id][$mtField] = $dao->$mtField;
2205 }
2206 }
2207 $dao->free();
2208
2209 CRM_Utils_Hook::membershipTypeValues($form, $membershipTypeValues);
2210
2211 if (is_numeric($membershipTypeID) &&
2212 $membershipTypeID > 0
2213 ) {
2214 return $membershipTypeValues[$membershipTypeID];
2215 }
2216 else {
2217 return $membershipTypeValues;
2218 }
2219 }
2220
2221 /**
2222 * Function to get membership record count for a Contact
2223 *
2224 * @param int $contactId Contact ID
2225 * @param boolean $activeOnly
2226 *
2227 * @return int count of membership records
2228 * @access public
2229 * @static
2230 */
2231 static function getContactMembershipCount($contactID, $activeOnly = FALSE) {
2232 $select = "SELECT count(*) FROM civicrm_membership ";
2233 $where = "WHERE civicrm_membership.contact_id = {$contactID} AND civicrm_membership.is_test = 0 ";
2234
2235 // CRM-6627, all status below 3 (active, pending, grace) are considered active
2236 if ($activeOnly) {
2237 $select .= " INNER JOIN civicrm_membership_status ON civicrm_membership.status_id = civicrm_membership_status.id ";
2238 $where .= " and civicrm_membership_status.is_current_member = 1";
2239 }
2240
2241 $query = $select . $where;
2242 return CRM_Core_DAO::singleValueQuery($query);
2243 }
2244
2245 /**
2246 * Function to check whether payment processor supports
2247 * cancellation of membership subscription
2248 *
2249 * @param int $mid membership id
2250 *
2251 * @return boolean
2252 * @access public
2253 * @static
2254 */
2255 static function isCancelSubscriptionSupported($mid, $isNotCancelled = TRUE) {
2256 $cacheKeyString = "$mid";
2257 $cacheKeyString .= $isNotCancelled ? '_1' : '_0';
2258
2259 static $supportsCancel = array();
2260
2261 if (!array_key_exists($cacheKeyString, $supportsCancel)) {
2262 $supportsCancel[$cacheKeyString] = FALSE;
2263 $isCancelled = FALSE;
2264
2265 if ($isNotCancelled) {
2266 $isCancelled = self::isSubscriptionCancelled($mid);
2267 }
2268
2269 $paymentObject = CRM_Financial_BAO_PaymentProcessor::getProcessorForEntity($mid, 'membership', 'obj');
2270 if (!empty($paymentObject)) {
2271 $supportsCancel[$cacheKeyString] = $paymentObject->isSupported('cancelSubscription') && !$isCancelled;
2272 }
2273 }
2274 return $supportsCancel[$cacheKeyString];
2275 }
2276
2277 /**
2278 * Function to check whether subscription is already cancelled
2279 *
2280 * @param int $mid membership id
2281 *
2282 * @return string $status contribution status
2283 * @access public
2284 * @static
2285 */
2286 static function isSubscriptionCancelled($mid) {
2287 $sql = "
2288 SELECT cr.contribution_status_id
2289 FROM civicrm_contribution_recur cr
2290 LEFT JOIN civicrm_membership mem ON ( cr.id = mem.contribution_recur_id )
2291 WHERE mem.id = %1 LIMIT 1";
2292 $params = array(1 => array($mid, 'Integer'));
2293 $statusId = CRM_Core_DAO::singleValueQuery($sql, $params);
2294 $status = CRM_Contribute_PseudoConstant::contributionStatus($statusId);
2295 if ($status == 'Cancelled') {
2296 return TRUE;
2297 }
2298 return FALSE;
2299 }
2300
2301 /**
2302 * Function to get membership joins for a specified membership
2303 * type. Specifically, retrieves a count of still current memberships whose
2304 * join_date and start_date are within a specified date range. Dates match
2305 * the pattern "yyyy-mm-dd".
2306 *
2307 * @param int $membershipTypeId membership type id
2308 * @param int $startDate date on which to start counting
2309 * @param int $endDate date on which to end counting
2310 * @param bool $isTest if true, membership is for a test site
2311 *
2312 * @return returns the number of members of type $membershipTypeId
2313 * whose join_date is between $startDate and $endDate and
2314 * whose start_date is between $startDate and $endDate
2315 */
2316 static function getMembershipJoins($membershipTypeId, $startDate, $endDate, $isTest = 0) {
2317 $testClause = 'membership.is_test = 1';
2318 if (!$isTest) {
2319 $testClause = '( membership.is_test IS NULL OR membership.is_test = 0 )';
2320 }
2321 if (!self::$_signupActType) {
2322 self::_getActTypes();
2323 }
2324
2325 if (!self::$_signupActType) {
2326 return 0;
2327 }
2328
2329 $query = "
2330 SELECT COUNT(DISTINCT membership.id) as member_count
2331 FROM civicrm_membership membership
2332 INNER JOIN civicrm_activity activity ON (activity.source_record_id = membership.id AND activity.activity_type_id = %1)
2333 INNER JOIN civicrm_membership_status status ON ( membership.status_id = status.id AND status.is_current_member = 1 )
2334 INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND contact.is_deleted = 0 )
2335 WHERE membership.membership_type_id = %2
2336 AND activity.activity_date_time >= '$startDate' AND activity.activity_date_time <= '$endDate 23:59:59'
2337 AND {$testClause}";
2338
2339 $params = array(
2340 1 => array(self::$_signupActType, 'Integer'),
2341 2 => array($membershipTypeId, 'Integer'),
2342 );
2343
2344 $memberCount = CRM_Core_DAO::singleValueQuery($query, $params);
2345
2346 return (int)$memberCount;
2347 }
2348
2349 /**
2350 * Function to get membership renewals for a specified membership
2351 * type. Specifically, retrieves a count of still current memberships
2352 * whose join_date is before and start_date is within a specified date
2353 * range. Dates match the pattern "yyyy-mm-dd".
2354 *
2355 * @param int $membershipTypeId membership type id
2356 * @param int $startDate date on which to start counting
2357 * @param int $endDate date on which to end counting
2358 * @param bool $isTest if true, membership is for a test site
2359 *
2360 * @return returns the number of members of type $membershipTypeId
2361 * whose join_date is before $startDate and
2362 * whose start_date is between $startDate and $endDate
2363 */
2364 static function getMembershipRenewals($membershipTypeId, $startDate, $endDate, $isTest = 0) {
2365 $testClause = 'membership.is_test = 1';
2366 if (!$isTest) {
2367 $testClause = '( membership.is_test IS NULL OR membership.is_test = 0 )';
2368 }
2369 if (!self::$_renewalActType) {
2370 self::_getActTypes();
2371 }
2372
2373 if (!self::$_renewalActType) {
2374 return 0;
2375 }
2376
2377 $query = "
2378 SELECT COUNT(DISTINCT membership.id) as member_count
2379 FROM civicrm_membership membership
2380 INNER JOIN civicrm_activity activity ON (activity.source_record_id = membership.id AND activity.activity_type_id = %1)
2381 INNER JOIN civicrm_membership_status status ON ( membership.status_id = status.id AND status.is_current_member = 1 )
2382 INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND contact.is_deleted = 0 )
2383 WHERE membership.membership_type_id = %2
2384 AND activity.activity_date_time >= '$startDate' AND activity.activity_date_time <= '$endDate 23:59:59'
2385 AND {$testClause}";
2386
2387 $params = array(
2388 1 => array(self::$_renewalActType, 'Integer'),
2389 2 => array($membershipTypeId, 'Integer'),
2390 );
2391 $memberCount = CRM_Core_DAO::singleValueQuery($query, $params);
2392
2393 return (int)$memberCount;
2394 }
2395
2396 /**
2397 * Function to process price set and line items.
2398 *
2399 * @access public
2400 *
2401 * @return None
2402 */
2403 function processPriceSet($membershipId, $lineItem) {
2404 //FIXME : need to move this too
2405 if (!$membershipId || !is_array($lineItem)
2406 || CRM_Utils_system::isNull($lineItem)
2407 ) {
2408 return;
2409 }
2410
2411 foreach ($lineItem as $priceSetId => $values) {
2412 if (!$priceSetId) {
2413 continue;
2414 }
2415 foreach ($values as $line) {
2416 $line['entity_table'] = 'civicrm_membership';
2417 $line['entity_id'] = $membershipId;
2418 CRM_Price_BAO_LineItem::create($line);
2419 }
2420 }
2421 }
2422
2423 /**
2424 * retrieve the contribution record for the associated Membership id
2425 *
2426 * @param int $membershipId membsership id.
2427 *
2428 * @return contribution id
2429 * @access public
2430 */
2431 static function getMembershipContributionId($membershipId) {
2432
2433 $membesrshipPayment = new CRM_Member_DAO_MembershipPayment();
2434 $membesrshipPayment->membership_id = $membershipId;
2435 if ($membesrshipPayment->find(TRUE)) {
2436 return $membesrshipPayment->contribution_id;
2437 }
2438 return NULL;
2439 }
2440
2441 /**
2442 * The function checks and updates the status of all membership records for a given domain using the
2443 * calc_membership_status and update_contact_membership APIs.
2444 *
2445 * IMPORTANT:
2446 * Sending renewal reminders has been migrated from this job to the Scheduled Reminders function as of 4.3.
2447 *
2448 * @return array $result
2449 * @access public
2450 */
2451 static function updateAllMembershipStatus() {
2452 require_once 'api/api.php';
2453
2454 //get all active statuses of membership, CRM-3984
2455 $allStatus = CRM_Member_PseudoConstant::membershipStatus();
2456 $statusLabels = CRM_Member_PseudoConstant::membershipStatus(NULL, NULL, 'label');
2457 $allTypes = CRM_Member_PseudoConstant::membershipType();
2458 $contribStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
2459
2460 $query = "
2461 SELECT civicrm_membership.id as membership_id,
2462 civicrm_membership.is_override as is_override,
2463 civicrm_membership.membership_type_id as membership_type_id,
2464 civicrm_membership.status_id as status_id,
2465 civicrm_membership.join_date as join_date,
2466 civicrm_membership.start_date as start_date,
2467 civicrm_membership.end_date as end_date,
2468 civicrm_membership.source as source,
2469 civicrm_contact.id as contact_id,
2470 civicrm_contact.is_deceased as is_deceased,
2471 civicrm_membership.owner_membership_id as owner_membership_id,
2472 civicrm_membership.contribution_recur_id as recur_id
2473 FROM civicrm_membership
2474 INNER JOIN civicrm_contact ON ( civicrm_membership.contact_id = civicrm_contact.id )
2475 WHERE civicrm_membership.is_test = 0";
2476
2477 $params = array();
2478 $dao = CRM_Core_DAO::executeQuery($query, $params);
2479
2480 $today = date('Y-m-d');
2481 $processCount = 0;
2482 $updateCount = 0;
2483
2484 $smarty = CRM_Core_Smarty::singleton();
2485
2486 while ($dao->fetch()) {
2487 // echo ".";
2488 $processCount++;
2489
2490 /**
2491 $count++;
2492 echo $dao->contact_id . ', '. CRM_Utils_System::memory( ) . "<p>\n";
2493
2494 CRM_Core_Error::debug( 'fBegin', count( $GLOBALS['_DB_DATAOBJECT']['RESULTS'] ) );
2495 if ( $count > 2 ) {
2496 foreach ( $GLOBALS['_DB_DATAOBJECT']['RESULTS'] as $r ) {
2497 CRM_Core_Error::debug( 'r', $r->query );
2498 }
2499 // CRM_Core_Error::debug( 'f', $GLOBALS['_DB_DATAOBJECT']['RESULTS'] );
2500 exit( );
2501 }
2502 **/
2503
2504 // Put common parameters into array for easy access
2505 $memberParams = array(
2506 'id' => $dao->membership_id,
2507 'status_id' => $dao->status_id,
2508 'contact_id' => $dao->contact_id,
2509 'membership_type_id' => $dao->membership_type_id,
2510 'membership_type' => $allTypes[$dao->membership_type_id],
2511 'join_date' => $dao->join_date,
2512 'start_date' => $dao->start_date,
2513 'end_date' => $dao->end_date,
2514 'source' => $dao->source,
2515 'skipStatusCal' => TRUE,
2516 'skipRecentView' => TRUE,
2517 );
2518
2519 $smarty->assign_by_ref('memberParams', $memberParams);
2520
2521 //update membership record to Deceased if contact is deceased
2522 if ($dao->is_deceased) {
2523 // check for 'Deceased' membership status, CRM-5636
2524 $deceaseStatusId = array_search('Deceased', $allStatus);
2525 if (!$deceaseStatusId) {
2526 CRM_Core_Error::fatal(ts("Deceased Membership status is missing or not active. <a href='%1'>Click here to check</a>.", array(1 => CRM_Utils_System::url('civicrm/admin/member/membershipStatus', 'reset=1'))));
2527 }
2528
2529 //process only when status change.
2530 if ($dao->status_id != $deceaseStatusId) {
2531 //take all params that need to save.
2532 $deceasedMembership = $memberParams;
2533 $deceasedMembership['status_id'] = $deceaseStatusId;
2534 $deceasedMembership['createActivity'] = TRUE;
2535 $deceasedMembership['version'] = 3;
2536
2537 //since there is change in status.
2538 $statusChange = array('status_id' => $deceaseStatusId);
2539 $smarty->append_by_ref('memberParams', $statusChange, TRUE);
2540 unset(
2541 $deceasedMembership['contact_id'],
2542 $deceasedMembership['membership_type_id'],
2543 $deceasedMembership['membership_type'],
2544 $deceasedMembership['join_date'],
2545 $deceasedMembership['start_date'],
2546 $deceasedMembership['end_date'],
2547 $deceasedMembership['source']
2548 );
2549
2550 //process membership record.
2551 civicrm_api('membership', 'create', $deceasedMembership);
2552 }
2553 continue;
2554 }
2555
2556 //we fetch related, since we need to check for deceased
2557 //now further processing is handle w/ main membership record.
2558 if ($dao->owner_membership_id) {
2559 continue;
2560 }
2561
2562 //update membership records where status is NOT - Pending OR Cancelled.
2563 //as well as membership is not override.
2564 //skipping Expired membership records -> reduced extra processing( kiran )
2565 if (!$dao->is_override &&
2566 !in_array($dao->status_id, array(array_search('Pending', $allStatus),
2567 array_search('Cancelled', $allStatus),
2568 array_search('Expired', $allStatus),
2569 ))
2570 ) {
2571
2572 // CRM-7248: added excludeIsAdmin param to the following fn call to prevent moving to admin statuses
2573 //get the membership status as per id.
2574 $newStatus = civicrm_api('membership_status', 'calc',
2575 array(
2576 'membership_id' => $dao->membership_id, 'version' => 3, 'ignore_admin_only'=> FALSE), TRUE
2577 );
2578 $statusId = CRM_Utils_Array::value('id', $newStatus);
2579
2580 //process only when status change.
2581 if ($statusId &&
2582 $statusId != $dao->status_id
2583 ) {
2584 //take all params that need to save.
2585 $memParams = $memberParams;
2586 $memParams['status_id'] = $statusId;
2587 $memParams['createActivity'] = TRUE;
2588 $memParams['version'] = 3;
2589
2590 // Unset columns which should remain unchanged from their current saved
2591 // values. This avoids race condition in which these values may have
2592 // been changed by other processes.
2593 unset(
2594 $memParams['contact_id'],
2595 $memParams['membership_type_id'],
2596 $memParams['membership_type'],
2597 $memParams['join_date'],
2598 $memParams['start_date'],
2599 $memParams['end_date'],
2600 $memParams['source']
2601 );
2602 //since there is change in status.
2603 $statusChange = array('status_id' => $statusId);
2604 $smarty->append_by_ref('memberParams', $statusChange, TRUE);
2605
2606 //process member record.
2607 civicrm_api('membership', 'create', $memParams);
2608 $updateCount++;
2609 }
2610 }
2611 // CRM_Core_Error::debug( 'fEnd', count( $GLOBALS['_DB_DATAOBJECT']['RESULTS'] ) );
2612 }
2613 $result['is_error'] = 0;
2614 $result['messages'] = ts('Processed %1 membership records. Updated %2 records.', array(1 => $processCount, 2 => $updateCount));
2615 return $result;
2616 }
2617
2618 /** The function returns the membershiptypes for a particular contact
2619 * who has lifetime membership without end date.
2620 *
2621 * @param array $contactMembershipType array of allMembershipTypes Key - value pairs
2622 *
2623 */
2624
2625 static function getAllContactMembership($contactID, $isTest = FALSE, $onlyLifeTime = FALSE) {
2626 $contactMembershipType = array();
2627 if (!$contactID) {
2628 return $contactMembershipType;
2629 }
2630
2631 $dao = new CRM_Member_DAO_Membership();
2632 $dao->contact_id = $contactID;
2633 $pendingStatusId = array_search('Pending', CRM_Member_PseudoConstant::membershipStatus());
2634 $dao->whereAdd("status_id != $pendingStatusId");
2635
2636 if ($isTest) {
2637 $dao->is_test = $isTest;
2638 }
2639 else {
2640 $dao->whereAdd('is_test IS NULL OR is_test = 0');
2641 }
2642
2643 if ($onlyLifeTime) {
2644 $dao->whereAdd('end_date IS NULL');
2645 }
2646
2647 $dao->find();
2648 while ($dao->fetch()) {
2649 $membership = array();
2650 CRM_Core_DAO::storeValues($dao, $membership);
2651 $contactMembershipType[$dao->membership_type_id] = $membership;
2652 }
2653 return $contactMembershipType;
2654 }
2655
2656 /**
2657 * Function to record contribution record associated with membership
2658 *
2659 * @param array $params array of submitted params
2660 * @param array $ids (param in process of being removed - try to use params) array of ids
2661 *
2662 * @return void
2663 * @static
2664 */
2665 static function recordMembershipContribution( &$params, $ids = array()) {
2666 $membershipId = $params['membership_id'];
2667 $contributionParams = array();
2668 $config = CRM_Core_Config::singleton();
2669 $contributionParams['currency'] = $config->defaultCurrency;
2670 $contributionParams['receipt_date'] = (CRM_Utils_Array::value('receipt_date', $params)) ? $params['receipt_date'] : 'null';
2671 $contributionParams['source'] = CRM_Utils_Array::value('contribution_source', $params);
2672 $contributionParams['soft_credit'] = CRM_Utils_Array::value('soft_credit', $params);
2673 $contributionParams['non_deductible_amount'] = 'null';
2674 $recordContribution = array(
2675 'contact_id', 'total_amount', 'receive_date', 'financial_type_id',
2676 'payment_instrument_id', 'trxn_id', 'invoice_id', 'is_test',
2677 'honor_contact_id', 'honor_type_id',
2678 'contribution_status_id', 'check_number', 'campaign_id', 'is_pay_later',
2679 );
2680 foreach ($recordContribution as $f) {
2681 $contributionParams[$f] = CRM_Utils_Array::value($f, $params);
2682 }
2683
2684 // make entry in batch entity batch table
2685 if (CRM_Utils_Array::value('batch_id', $params)) {
2686 $contributionParams['batch_id'] = $params['batch_id'];
2687 }
2688
2689 if ( CRM_Utils_Array::value('contribution_contact_id', $params) ) {
2690 // deal with possibility of a different person paying for contribution
2691 $contributionParams['contact_id'] = $params['contribution_contact_id'];
2692 }
2693
2694 if (CRM_Utils_Array::value('processPriceSet', $params) &&
2695 !empty($params['lineItems'])
2696 ) {
2697 $contributionParams['line_item'] = CRM_Utils_Array::value('lineItems', $params, NULL);
2698 }
2699
2700 $contribution = CRM_Contribute_BAO_Contribution::create($contributionParams, $ids);
2701
2702 // store contribution id
2703 $params['contribution_id'] = $contribution->id;
2704
2705
2706 //insert payment record for this membership
2707 if (!CRM_Utils_Array::value('contribution', $ids) ||
2708 CRM_Utils_Array::value('is_recur', $params)
2709 ) {
2710 $mpDAO = new CRM_Member_DAO_MembershipPayment();
2711 $mpDAO->membership_id = $membershipId;
2712 $mpDAO->contribution_id = $contribution->id;
2713 if (CRM_Utils_Array::value('is_recur', $params)) {
2714 $mpDAO->find();
2715 }
2716
2717 CRM_Utils_Hook::pre('create', 'MembershipPayment', NULL, $mpDAO);
2718 $mpDAO->save();
2719 CRM_Utils_Hook::post('create', 'MembershipPayment', $mpDAO->id, $mpDAO);
2720 }
2721 return $contribution;
2722 }
2723
2724 /**
2725 * Function to record line items for default membership
2726 *
2727 * @param $qf object
2728 *
2729 * @param $membershipType array with membership type and organization
2730 *
2731 * @param$ priceSetId priceset id
2732 * @access public
2733 * @static
2734 */
2735 static function createLineItems(&$qf, $membershipType, &$priceSetId) {
2736 $qf->_priceSetId = $priceSetId = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', 'default_membership_type_amount', 'id', 'name');
2737 if ($priceSetId) {
2738 $qf->_priceSet = $priceSets = current(CRM_Price_BAO_PriceSet::getSetDetail($priceSetId));
2739 }
2740 $editedFieldParams = array(
2741 'price_set_id' => $priceSetId,
2742 'name' => $membershipType[0],
2743 );
2744 $editedResults = array();
2745 CRM_Price_BAO_PriceField::retrieve($editedFieldParams, $editedResults);
2746
2747 if (!empty($editedResults)) {
2748 unset($qf->_priceSet['fields']);
2749 $qf->_priceSet['fields'][$editedResults['id']] = $priceSets['fields'][$editedResults['id']];
2750 unset($qf->_priceSet['fields'][$editedResults['id']]['options']);
2751 $fid = $editedResults['id'];
2752 $editedFieldParams = array(
2753 'price_field_id' => $editedResults['id'],
2754 'membership_type_id' => $membershipType[1],
2755 );
2756 $editedResults = array();
2757 CRM_Price_BAO_PriceFieldValue::retrieve($editedFieldParams, $editedResults);
2758 $qf->_priceSet['fields'][$fid]['options'][$editedResults['id']] = $priceSets['fields'][$fid]['options'][$editedResults['id']];
2759 if (CRM_Utils_Array::value('total_amount', $qf->_params)) {
2760 $qf->_priceSet['fields'][$fid]['options'][$editedResults['id']]['amount'] = $qf->_params['total_amount'];
2761 }
2762 }
2763
2764 $fieldID = key($qf->_priceSet['fields']);
2765 $qf->_params['price_' . $fieldID] = CRM_Utils_Array::value('id', $editedResults);
2766 }
2767
2768 static function _getActTypes() {
2769 $activityTypes = CRM_Core_PseudoConstant::activityType(TRUE, FALSE, FALSE, 'name');
2770 self::$_renewalActType = CRM_Utils_Array::key('Membership Renewal', $activityTypes);
2771 self::$_signupActType = CRM_Utils_Array::key('Membership Signup', $activityTypes);
2772 }
2773 }
2774