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