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