Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
bc77d7c0 | 4 | | Copyright CiviCRM LLC. All rights reserved. | |
6a488035 | 5 | | | |
bc77d7c0 TO |
6 | | This work is published under the GNU AGPLv3 license with some | |
7 | | permitted exceptions and without any warranty. For full license | | |
8 | | and copyright information, see https://civicrm.org/licensing | | |
6a488035 | 9 | +--------------------------------------------------------------------+ |
d25dd0ee | 10 | */ |
6a488035 TO |
11 | |
12 | /** | |
13 | * | |
14 | * @package CRM | |
ca5cec67 | 15 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
6a488035 | 16 | */ |
6552bd20 | 17 | class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType implements \Civi\Test\HookInterface { |
6a488035 TO |
18 | |
19 | /** | |
4c429c82 | 20 | * Static holder for the default Membership Type. |
971e129b | 21 | * @var int |
6a488035 | 22 | */ |
971e129b | 23 | public static $_defaultMembershipType = NULL; |
6a488035 | 24 | |
971e129b | 25 | public static $_membershipTypeInfo = []; |
6a488035 | 26 | |
6a488035 | 27 | /** |
4c429c82 | 28 | * Fetch object based on array of properties. |
6a488035 | 29 | * |
b2363ea8 TO |
30 | * @param array $params |
31 | * (reference ) an assoc array of name/value pairs. | |
32 | * @param array $defaults | |
33 | * (reference ) an assoc array to hold the flattened values. | |
6a488035 | 34 | * |
16b10e64 | 35 | * @return CRM_Member_BAO_MembershipType |
6a488035 | 36 | */ |
00be9182 | 37 | public static function retrieve(&$params, &$defaults) { |
6a488035 TO |
38 | $membershipType = new CRM_Member_DAO_MembershipType(); |
39 | $membershipType->copyValues($params); | |
40 | if ($membershipType->find(TRUE)) { | |
41 | CRM_Core_DAO::storeValues($membershipType, $defaults); | |
42 | return $membershipType; | |
43 | } | |
44 | return NULL; | |
45 | } | |
46 | ||
47 | /** | |
4c429c82 | 48 | * Update the is_active flag in the db. |
6a488035 | 49 | * |
b2363ea8 TO |
50 | * @param int $id |
51 | * Id of the database record. | |
52 | * @param bool $is_active | |
53 | * Value we want to set the is_active field. | |
6a488035 | 54 | * |
8a4fede3 | 55 | * @return bool |
56 | * true if we found and updated the object, else false | |
6a488035 | 57 | */ |
00be9182 | 58 | public static function setIsActive($id, $is_active) { |
6a488035 TO |
59 | return CRM_Core_DAO::setFieldValue('CRM_Member_DAO_MembershipType', $id, 'is_active', $is_active); |
60 | } | |
61 | ||
62 | /** | |
4c429c82 | 63 | * Add the membership types. |
6a488035 | 64 | * |
b2363ea8 TO |
65 | * @param array $params |
66 | * Reference array contains the values submitted by the form. | |
67 | * @param array $ids | |
68 | * Array contains the id (deprecated). | |
6a488035 | 69 | * |
000e4e8d MW |
70 | * @return \CRM_Member_DAO_MembershipType |
71 | * @throws \CiviCRM_API3_Exception | |
6a488035 | 72 | */ |
be2fb01f | 73 | public static function add(&$params, $ids = []) { |
000e4e8d MW |
74 | // DEPRECATED Check if membershipType ID was passed in via $ids |
75 | if (empty($params['id'])) { | |
76 | if (isset($ids['membershipType'])) { | |
77 | Civi::log()->warning('Deprecated: Passing membershipType by $ids array in CRM_Member_BAO_MembershipType::add'); | |
78 | } | |
9c1bc317 | 79 | $params['id'] = $ids['membershipType'] ?? NULL; |
000e4e8d MW |
80 | } |
81 | ||
82 | $hook = empty($params['id']) ? 'create' : 'edit'; | |
83 | CRM_Utils_Hook::pre($hook, 'MembershipType', CRM_Utils_Array::value('id', $params), $params); | |
84 | ||
9c1bc317 | 85 | $membershipTypeId = $params['id'] ?? NULL; |
000e4e8d | 86 | |
0c3819e1 EM |
87 | if (!$membershipTypeId && !isset($params['domain_id'])) { |
88 | $params['domain_id'] = CRM_Core_Config::domainID(); | |
36e3b794 | 89 | } |
6a488035 | 90 | |
301db4f8 | 91 | // $previousID is the old organization id for membership type i.e 'member_of_contact_id'. This is used when an organization is changed. |
6a488035 | 92 | $previousID = NULL; |
000e4e8d MW |
93 | if ($membershipTypeId) { |
94 | $previousID = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $membershipTypeId, 'member_of_contact_id'); | |
6a488035 TO |
95 | } |
96 | ||
000e4e8d MW |
97 | // action is taken depending upon the mode |
98 | $membershipType = new CRM_Member_DAO_MembershipType(); | |
99 | $membershipType->copyValues($params); | |
6a488035 | 100 | $membershipType->save(); |
000e4e8d MW |
101 | |
102 | if ($membershipTypeId) { | |
806e9b71 EM |
103 | // on update we may need to retrieve some details for the price field function - otherwise we get e-notices on attempts to retrieve |
104 | // name etc - the presence of previous id tells us this is an update | |
be2fb01f | 105 | $params = array_merge(civicrm_api3('membership_type', 'getsingle', ['id' => $membershipType->id]), $params); |
806e9b71 | 106 | } |
301db4f8 | 107 | self::createMembershipPriceField($params, $previousID, $membershipType->id); |
6a488035 | 108 | // update all price field value for quick config when membership type is set CRM-11718 |
000e4e8d MW |
109 | if ($membershipTypeId) { |
110 | self::updateAllPriceFieldValue($membershipTypeId, $params); | |
6a488035 | 111 | } |
000e4e8d MW |
112 | |
113 | CRM_Utils_Hook::post($hook, 'MembershipType', $membershipType->id, $membershipType); | |
114 | ||
452b9e04 | 115 | self::flush(); |
6a488035 TO |
116 | return $membershipType; |
117 | } | |
118 | ||
452b9e04 | 119 | /** |
4c429c82 EM |
120 | * Flush anywhere that membership types might be cached. |
121 | * | |
452b9e04 EM |
122 | * @throws \CiviCRM_API3_Exception |
123 | */ | |
c8881afb | 124 | public static function flush() { |
452b9e04 | 125 | CRM_Member_PseudoConstant::membershipType(NULL, TRUE); |
be2fb01f CW |
126 | civicrm_api3('membership', 'getfields', ['cache_clear' => 1, 'fieldname' => 'membership_type_id']); |
127 | civicrm_api3('profile', 'getfields', ['action' => 'submit', 'cache_clear' => 1]); | |
eb151aab | 128 | Civi::cache('metadata')->clear(); |
452b9e04 EM |
129 | } |
130 | ||
6a488035 | 131 | /** |
4c429c82 | 132 | * Delete membership Types. |
6a488035 TO |
133 | * |
134 | * @param int $membershipTypeId | |
77b97be7 | 135 | * |
406a87bd | 136 | * @deprecated |
77b97be7 | 137 | * @throws CRM_Core_Exception |
406a87bd | 138 | * @return bool |
6a488035 | 139 | */ |
00be9182 | 140 | public static function del($membershipTypeId) { |
406a87bd CW |
141 | try { |
142 | static::deleteRecord(['id' => $membershipTypeId]); | |
143 | return TRUE; | |
6a488035 | 144 | } |
406a87bd CW |
145 | catch (CRM_Core_Exception $e) { |
146 | return FALSE; | |
6a488035 | 147 | } |
6a488035 TO |
148 | } |
149 | ||
6552bd20 CW |
150 | /** |
151 | * Callback for hook_civicrm_pre(). | |
152 | * @param \Civi\Core\Event\PreEvent $event | |
153 | * @throws CRM_Core_Exception | |
154 | */ | |
155 | public static function on_hook_civicrm_pre(\Civi\Core\Event\PreEvent $event) { | |
156 | if ($event->action === 'delete' && $event->entity === 'RelationshipType') { | |
157 | // When deleting relationship type, remove from membership types | |
158 | $mems = civicrm_api3('MembershipType', 'get', [ | |
159 | 'relationship_type_id' => ['LIKE' => "%{$event->id}%"], | |
160 | 'return' => ['id', 'relationship_type_id', 'relationship_direction'], | |
161 | ]); | |
162 | foreach ($mems['values'] as $membershipType) { | |
163 | $pos = array_search($event->id, $membershipType['relationship_type_id']); | |
164 | // Api call may have returned false positives but currently the relationship_type_id uses | |
165 | // nonstandard serialization which makes anything more accurate impossible. | |
166 | if ($pos !== FALSE) { | |
167 | unset($membershipType['relationship_type_id'][$pos], $membershipType['relationship_direction'][$pos]); | |
168 | civicrm_api3('MembershipType', 'create', $membershipType); | |
169 | } | |
170 | } | |
171 | } | |
406a87bd CW |
172 | if ($event->action === 'delete' && $event->entity === 'MembershipType') { |
173 | // Check dependencies. | |
174 | $check = FALSE; | |
175 | $status = []; | |
176 | $dependency = [ | |
177 | 'Membership' => 'membership_type_id', | |
178 | 'MembershipBlock' => 'membership_type_default', | |
179 | ]; | |
180 | ||
181 | foreach ($dependency as $name => $field) { | |
182 | $baoString = 'CRM_Member_BAO_' . $name; | |
183 | $dao = new $baoString(); | |
184 | $dao->$field = $event->id; | |
185 | if ($dao->find(TRUE)) { | |
186 | $check = TRUE; | |
187 | $status[] = $name; | |
188 | } | |
189 | } | |
190 | if ($check) { | |
191 | $cnt = 1; | |
192 | $message = ts('This membership type cannot be deleted due to following reason(s):'); | |
193 | if (in_array('Membership', $status)) { | |
194 | $findMembersURL = CRM_Utils_System::url('civicrm/member/search', 'reset=1'); | |
195 | $deleteURL = CRM_Utils_System::url('civicrm/contact/search/advanced', 'reset=1'); | |
196 | $message .= '<br/>' . ts('%3. There are some contacts who have this membership type assigned to them. Search for contacts with this membership type from <a href=\'%1\'>Find Members</a>. If you are still getting this message after deleting these memberships, there may be contacts in the Trash (deleted) with this membership type. Try using <a href="%2">Advanced Search</a> and checking "Search in Trash".', [ | |
197 | 1 => $findMembersURL, | |
198 | 2 => $deleteURL, | |
199 | 3 => $cnt, | |
200 | ]); | |
201 | $cnt++; | |
202 | } | |
203 | ||
204 | if (in_array('MembershipBlock', $status)) { | |
205 | $deleteURL = CRM_Utils_System::url('civicrm/admin/contribute', 'reset=1'); | |
206 | $message .= ts('%2. This Membership Type is used in an <a href=\'%1\'>Online Contribution page</a>. Uncheck this membership type in the Memberships tab.', [ | |
207 | 1 => $deleteURL, | |
208 | 2 => $cnt, | |
209 | ]); | |
210 | throw new CRM_Core_Exception($message); | |
211 | } | |
212 | } | |
213 | CRM_Utils_Weight::delWeight('CRM_Member_DAO_MembershipType', $event->id); | |
214 | } | |
6552bd20 CW |
215 | } |
216 | ||
6a488035 | 217 | /** |
4c429c82 | 218 | * Convert membership type's 'start day' & 'rollover day' to human readable formats. |
6a488035 | 219 | * |
b2363ea8 TO |
220 | * @param array $membershipType |
221 | * An array of membershipType-details. | |
6a488035 | 222 | */ |
00be9182 | 223 | public static function convertDayFormat(&$membershipType) { |
be2fb01f | 224 | $periodDays = [ |
6a488035 TO |
225 | 'fixed_period_start_day', |
226 | 'fixed_period_rollover_day', | |
be2fb01f | 227 | ]; |
6a488035 TO |
228 | foreach ($membershipType as $id => $details) { |
229 | foreach ($periodDays as $pDay) { | |
a7488080 | 230 | if (!empty($details[$pDay])) { |
6a488035 | 231 | if ($details[$pDay] > 31) { |
353ffa53 TO |
232 | $month = substr($details[$pDay], 0, strlen($details[$pDay]) - 2); |
233 | $day = substr($details[$pDay], -2); | |
be2fb01f | 234 | $monthMap = [ |
6a488035 TO |
235 | '1' => 'Jan', |
236 | '2' => 'Feb', | |
237 | '3' => 'Mar', | |
238 | '4' => 'Apr', | |
239 | '5' => 'May', | |
240 | '6' => 'Jun', | |
241 | '7' => 'Jul', | |
242 | '8' => 'Aug', | |
243 | '9' => 'Sep', | |
244 | '10' => 'Oct', | |
245 | '11' => 'Nov', | |
246 | '12' => 'Dec', | |
be2fb01f | 247 | ]; |
6a488035 TO |
248 | $membershipType[$id][$pDay] = $monthMap[$month] . ' ' . $day; |
249 | } | |
250 | else { | |
251 | $membershipType[$id][$pDay] = $details[$pDay]; | |
252 | } | |
253 | } | |
254 | } | |
255 | } | |
256 | } | |
257 | ||
258 | /** | |
4c429c82 | 259 | * Get membership Types. |
6a488035 | 260 | * |
eb151aab | 261 | * @deprecated use getAllMembershipTypes. |
262 | * | |
77b97be7 EM |
263 | * @param bool $public |
264 | * | |
265 | * @return array | |
6a488035 | 266 | */ |
00be9182 | 267 | public static function getMembershipTypes($public = TRUE) { |
be2fb01f | 268 | $membershipTypes = []; |
6a488035 TO |
269 | $membershipType = new CRM_Member_DAO_MembershipType(); |
270 | $membershipType->is_active = 1; | |
271 | if ($public) { | |
272 | $membershipType->visibility = 'Public'; | |
273 | } | |
274 | $membershipType->orderBy(' weight'); | |
275 | $membershipType->find(); | |
276 | while ($membershipType->fetch()) { | |
277 | $membershipTypes[$membershipType->id] = $membershipType->name; | |
278 | } | |
6a488035 TO |
279 | return $membershipTypes; |
280 | } | |
281 | ||
282 | /** | |
4c429c82 | 283 | * Get membership Type Details. |
6a488035 | 284 | * |
eb151aab | 285 | * @deprecated use getMembershipType. |
286 | * | |
6a488035 | 287 | * @param int $membershipTypeId |
77b97be7 EM |
288 | * |
289 | * @return array|null | |
6a488035 | 290 | */ |
00be9182 | 291 | public static function getMembershipTypeDetails($membershipTypeId) { |
be2fb01f | 292 | $membershipTypeDetails = []; |
6a488035 TO |
293 | |
294 | $membershipType = new CRM_Member_DAO_MembershipType(); | |
295 | $membershipType->is_active = 1; | |
296 | $membershipType->id = $membershipTypeId; | |
297 | if ($membershipType->find(TRUE)) { | |
298 | CRM_Core_DAO::storeValues($membershipType, $membershipTypeDetails); | |
6a488035 TO |
299 | return $membershipTypeDetails; |
300 | } | |
301 | else { | |
302 | return NULL; | |
303 | } | |
304 | } | |
305 | ||
306 | /** | |
4c429c82 | 307 | * Calculate start date and end date for new membership. |
6a488035 | 308 | * |
b2363ea8 TO |
309 | * @param int $membershipTypeId |
310 | * Membership type id. | |
87ad884a | 311 | * @param string $joinDate |
b2363ea8 | 312 | * Member since ( in mysql date format ). |
87ad884a | 313 | * @param string $startDate |
b2363ea8 | 314 | * Start date ( in mysql date format ). |
da6b46f4 | 315 | * @param null $endDate |
b2363ea8 TO |
316 | * @param int $numRenewTerms |
317 | * How many membership terms are being added to end date (default is 1). | |
6a488035 | 318 | * |
a6c01b45 CW |
319 | * @return array |
320 | * associated array with start date, end date and join date for the membership | |
6a488035 TO |
321 | */ |
322 | public static function getDatesForMembershipType($membershipTypeId, $joinDate = NULL, $startDate = NULL, $endDate = NULL, $numRenewTerms = 1) { | |
323 | $membershipTypeDetails = self::getMembershipTypeDetails($membershipTypeId); | |
324 | ||
4c429c82 | 325 | // Convert all dates to 'Y-m-d' format. |
be2fb01f | 326 | foreach ([ |
c5c263ca AH |
327 | 'joinDate', |
328 | 'startDate', | |
329 | 'endDate', | |
be2fb01f | 330 | ] as $dateParam) { |
6a488035 TO |
331 | if (!empty($$dateParam)) { |
332 | $$dateParam = CRM_Utils_Date::processDate($$dateParam, NULL, FALSE, 'Y-m-d'); | |
333 | } | |
334 | } | |
335 | if (!$joinDate) { | |
42347843 | 336 | $joinDate = CRM_Utils_Time::date('Y-m-d'); |
6a488035 TO |
337 | } |
338 | $actualStartDate = $joinDate; | |
339 | if ($startDate) { | |
340 | $actualStartDate = $startDate; | |
341 | } | |
342 | ||
343 | $fixed_period_rollover = FALSE; | |
344 | if (CRM_Utils_Array::value('period_type', $membershipTypeDetails) == 'rolling') { | |
345 | if (!$startDate) { | |
346 | $startDate = $joinDate; | |
347 | } | |
348 | $actualStartDate = $startDate; | |
349 | } | |
350 | elseif (CRM_Utils_Array::value('period_type', $membershipTypeDetails) == 'fixed') { | |
5ae96933 DG |
351 | // calculate start date |
352 | // if !$startDate then use $joinDate | |
353 | $toDay = explode('-', (empty($startDate) ? $joinDate : $startDate)); | |
6a488035 TO |
354 | $year = $toDay[0]; |
355 | $month = $toDay[1]; | |
f7660a39 | 356 | $day = $toDay[2]; |
6a488035 TO |
357 | |
358 | if ($membershipTypeDetails['duration_unit'] == 'year') { | |
359 | ||
360 | //get start fixed day | |
361 | $startMonth = substr($membershipTypeDetails['fixed_period_start_day'], 0, | |
362 | strlen($membershipTypeDetails['fixed_period_start_day']) - 2 | |
363 | ); | |
364 | $startDay = substr($membershipTypeDetails['fixed_period_start_day'], -2); | |
365 | ||
f7660a39 | 366 | if (date('Y-m-d', mktime(0, 0, 0, $startMonth, $startDay, $year)) <= date('Y-m-d', mktime(0, 0, 0, $month, $day, $year))) { |
4c429c82 | 367 | $actualStartDate = date('Y-m-d', mktime(0, 0, 0, $startMonth, $startDay, $year)); |
f7660a39 DG |
368 | } |
369 | else { | |
4c429c82 | 370 | $actualStartDate = date('Y-m-d', mktime(0, 0, 0, $startMonth, $startDay, $year - 1)); |
f7660a39 | 371 | } |
82d11b3f | 372 | |
4c429c82 | 373 | $fixed_period_rollover = self::isDuringFixedAnnualRolloverPeriod($joinDate, $membershipTypeDetails, $year, $actualStartDate); |
6a488035 TO |
374 | |
375 | if (!$startDate) { | |
376 | $startDate = $actualStartDate; | |
377 | } | |
378 | } | |
379 | elseif ($membershipTypeDetails['duration_unit'] == 'month') { | |
380 | // Check if we are on or after rollover day of the month - CRM-10585 | |
381 | // If so, set fixed_period_rollover TRUE so we increment end_date month below. | |
382 | $dateParts = explode('-', $actualStartDate); | |
9b873358 | 383 | if ($dateParts[2] >= $membershipTypeDetails['fixed_period_rollover_day']) { |
b09fe5ed | 384 | $fixed_period_rollover = TRUE; |
6a488035 | 385 | } |
03e04002 | 386 | |
6a488035 TO |
387 | // Start date is always first day of actualStartDate month |
388 | if (!$startDate) { | |
389 | $actualStartDate = $startDate = $year . '-' . $month . '-01'; | |
390 | } | |
391 | } | |
392 | } | |
393 | ||
4c429c82 | 394 | // Calculate end date if it is not passed by user. |
6a488035 TO |
395 | if (!$endDate) { |
396 | //end date calculation | |
353ffa53 TO |
397 | $date = explode('-', $actualStartDate); |
398 | $year = $date[0]; | |
6a488035 | 399 | $month = $date[1]; |
353ffa53 | 400 | $day = $date[2]; |
6a488035 TO |
401 | |
402 | switch ($membershipTypeDetails['duration_unit']) { | |
403 | case 'year': | |
404 | $year = $year + ($numRenewTerms * $membershipTypeDetails['duration_interval']); | |
405 | //extend membership date by duration interval. | |
406 | if ($fixed_period_rollover) { | |
407 | $year += 1; | |
408 | } | |
409 | break; | |
410 | ||
411 | case 'month': | |
412 | $month = $month + ($numRenewTerms * $membershipTypeDetails['duration_interval']); | |
413 | //duration interval is month | |
414 | if ($fixed_period_rollover) { | |
415 | //CRM-10585 | |
416 | $month += 1; | |
417 | } | |
418 | break; | |
419 | ||
420 | case 'day': | |
421 | $day = $day + ($numRenewTerms * $membershipTypeDetails['duration_interval']); | |
422 | ||
423 | if ($fixed_period_rollover) { | |
424 | //Fix Me: Currently we don't allow rollover if | |
425 | //duration interval is day | |
426 | } | |
427 | break; | |
428 | } | |
429 | ||
430 | if ($membershipTypeDetails['duration_unit'] == 'lifetime') { | |
431 | $endDate = NULL; | |
432 | } | |
433 | else { | |
434 | $endDate = date('Y-m-d', mktime(0, 0, 0, $month, $day - 1, $year)); | |
435 | } | |
436 | } | |
437 | ||
be2fb01f | 438 | $membershipDates = [ |
c8881afb | 439 | 'start_date' => CRM_Utils_Date::customFormat($startDate, '%Y%m%d'), |
edc9b94e EM |
440 | 'end_date' => CRM_Utils_Date::customFormat($endDate, '%Y%m%d'), |
441 | 'join_date' => CRM_Utils_Date::customFormat($joinDate, '%Y%m%d'), | |
be2fb01f | 442 | ]; |
6a488035 TO |
443 | |
444 | return $membershipDates; | |
445 | } | |
446 | ||
87ad884a | 447 | /** |
fe482240 | 448 | * Does this membership start between the rollover date and the start of the next period. |
87ad884a EM |
449 | * (in which case they will get an extra membership period) |
450 | * ie if annual memberships run June - May & the rollover is in May memberships between | |
451 | * May and June will return TRUE and between June and May will return FALSE | |
452 | * | |
453 | * @param string $startDate start date of current membership period | |
87ad884a | 454 | * @param array $membershipTypeDetails |
81d97e72 | 455 | * @param int $year |
e9ac29eb | 456 | * @param string $actualStartDate |
87ad884a EM |
457 | * @return bool is this in the window where the membership gets an extra part-period added |
458 | */ | |
70a87708 | 459 | public static function isDuringFixedAnnualRolloverPeriod($startDate, $membershipTypeDetails, $year, $actualStartDate) { |
87ad884a EM |
460 | |
461 | $rolloverMonth = substr($membershipTypeDetails['fixed_period_rollover_day'], 0, | |
462 | strlen($membershipTypeDetails['fixed_period_rollover_day']) - 2 | |
463 | ); | |
464 | $rolloverDay = substr($membershipTypeDetails['fixed_period_rollover_day'], -2); | |
465 | ||
8454b618 | 466 | $calculatedRolloverDate = date('Y-m-d', mktime(0, 0, 0, $rolloverMonth, $rolloverDay, $year)); |
87ad884a EM |
467 | |
468 | //CRM-7825 -membership date rules are : | |
469 | //1. Membership should not be start in future. | |
470 | //2. rollover window should be subset of membership window. | |
471 | ||
87ad884a EM |
472 | //get the fixed end date here. |
473 | $dateParts = explode('-', $actualStartDate); | |
8454b618 | 474 | $endDateOfFirstYearMembershipPeriod = date('Y-m-d', mktime(0, 0, 0, |
87ad884a EM |
475 | $dateParts[1], |
476 | $dateParts[2] - 1, | |
6f1c82f5 | 477 | $dateParts[0] + 1 |
87ad884a EM |
478 | )); |
479 | ||
8454b618 EM |
480 | //we know the month and day of the rollover date but not the year (we're just |
481 | //using the start date year at the moment. So if it's after the end | |
482 | // of the first year of membership then it's the next period & we'll adjust back a year. If it's | |
483 | // before the start_date then it's too early & we'll adjust forward. | |
484 | if ($endDateOfFirstYearMembershipPeriod < $calculatedRolloverDate) { | |
485 | $calculatedRolloverDate = date('Y-m-d', mktime(0, 0, 0, $rolloverMonth, $rolloverDay, $year - 1)); | |
87ad884a | 486 | } |
8454b618 EM |
487 | if ($calculatedRolloverDate < $actualStartDate) { |
488 | $calculatedRolloverDate = date('Y-m-d', mktime(0, 0, 0, $rolloverMonth, $rolloverDay, $year + 1)); | |
87ad884a EM |
489 | } |
490 | ||
8454b618 | 491 | if ($calculatedRolloverDate <= $startDate) { |
87ad884a EM |
492 | return TRUE; |
493 | } | |
494 | return FALSE; | |
495 | } | |
496 | ||
6a488035 | 497 | /** |
055e2441 | 498 | * Calculate start date and end date for membership updates. |
499 | * | |
500 | * Note that this function is called by the api for any membership update although it was | |
501 | * originally written for renewal (which feels a bit fragile but hey....). | |
6a488035 TO |
502 | * |
503 | * @param int $membershipId | |
504 | * @param $changeToday | |
b4d1a1bf | 505 | * If provided, specify an alternative date to use as "today" for renewal |
b2363ea8 TO |
506 | * @param int $membershipTypeID |
507 | * If provided, overrides the membership type of the $membershipID membership. | |
508 | * @param int $numRenewTerms | |
509 | * How many membership terms are being added to end date (default is 1). | |
6a488035 TO |
510 | * |
511 | * CRM-7297 Membership Upsell - Added $membershipTypeID param to facilitate calculations of dates when membership type changes | |
512 | * | |
5396af74 | 513 | * @return array |
a6c01b45 | 514 | * array fo the start date, end date and join date of the membership |
6a488035 TO |
515 | */ |
516 | public static function getRenewalDatesForMembershipType($membershipId, $changeToday = NULL, $membershipTypeID = NULL, $numRenewTerms = 1) { | |
be2fb01f | 517 | $params = ['id' => $membershipId]; |
6a488035 | 518 | $membershipDetails = CRM_Member_BAO_Membership::getValues($params, $values); |
055e2441 | 519 | $membershipDetails = $membershipDetails[$membershipId]; |
520 | $statusID = $membershipDetails->status_id; | |
be2fb01f | 521 | $membershipDates = []; |
055e2441 | 522 | if (!empty($membershipDetails->join_date)) { |
523 | $membershipDates['join_date'] = CRM_Utils_Date::customFormat($membershipDetails->join_date, '%Y%m%d'); | |
524 | } | |
6a488035 TO |
525 | |
526 | $oldPeriodType = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', | |
353ffa53 | 527 | CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $membershipId, 'membership_type_id'), 'period_type'); |
6a488035 TO |
528 | |
529 | // CRM-7297 Membership Upsell | |
530 | if (is_null($membershipTypeID)) { | |
055e2441 | 531 | $membershipTypeDetails = self::getMembershipTypeDetails($membershipDetails->membership_type_id); |
6a488035 TO |
532 | } |
533 | else { | |
534 | $membershipTypeDetails = self::getMembershipTypeDetails($membershipTypeID); | |
535 | } | |
536 | $statusDetails = CRM_Member_BAO_MembershipStatus::getMembershipStatus($statusID); | |
537 | ||
538 | if ($statusDetails['is_current_member'] == 1) { | |
055e2441 | 539 | $startDate = $membershipDetails->start_date; |
6a488035 TO |
540 | // CRM=7297 Membership Upsell: we need to handle null end_date in case we are switching |
541 | // from a lifetime to a different membership type | |
055e2441 | 542 | if (is_null($membershipDetails->end_date)) { |
42347843 | 543 | $date = CRM_Utils_Time::date('Y-m-d'); |
6a488035 TO |
544 | } |
545 | else { | |
055e2441 | 546 | $date = $membershipDetails->end_date; |
6a488035 | 547 | } |
353ffa53 | 548 | $date = explode('-', $date); |
3bd63a4b MW |
549 | // We have to add 1 day first in case it's the end of the month, then subtract afterwards |
550 | // eg. 2018-02-28 should renew to 2018-03-31, if we just added 1 month we'd get 2018-03-28 | |
6a488035 | 551 | $logStartDate = date('Y-m-d', mktime(0, 0, 0, |
353ffa53 TO |
552 | (double) $date[1], |
553 | (double) ($date[2] + 1), | |
554 | (double) $date[0] | |
555 | )); | |
6a488035 | 556 | |
353ffa53 TO |
557 | $date = explode('-', $logStartDate); |
558 | $year = $date[0]; | |
6a488035 | 559 | $month = $date[1]; |
353ffa53 | 560 | $day = $date[2]; |
6a488035 TO |
561 | |
562 | switch ($membershipTypeDetails['duration_unit']) { | |
563 | case 'year': | |
564 | //need to check if the upsell is from rolling to fixed and adjust accordingly | |
481a74f4 | 565 | if ($membershipTypeDetails['period_type'] == 'fixed' && $oldPeriodType == 'rolling') { |
6a488035 TO |
566 | $month = substr($membershipTypeDetails['fixed_period_start_day'], 0, strlen($membershipTypeDetails['fixed_period_start_day']) - 2); |
567 | $day = substr($membershipTypeDetails['fixed_period_start_day'], -2); | |
568 | $year += 1; | |
0db6c3e1 TO |
569 | } |
570 | else { | |
b09fe5ed | 571 | $year = $year + ($numRenewTerms * $membershipTypeDetails['duration_interval']); |
6a488035 TO |
572 | } |
573 | break; | |
574 | ||
575 | case 'month': | |
576 | $month = $month + ($numRenewTerms * $membershipTypeDetails['duration_interval']); | |
577 | break; | |
578 | ||
579 | case 'day': | |
580 | $day = $day + ($numRenewTerms * $membershipTypeDetails['duration_interval']); | |
581 | break; | |
582 | } | |
583 | if ($membershipTypeDetails['duration_unit'] == 'lifetime') { | |
584 | $endDate = NULL; | |
585 | } | |
586 | else { | |
587 | $endDate = date('Y-m-d', mktime(0, 0, 0, | |
353ffa53 TO |
588 | $month, |
589 | $day - 1, | |
590 | $year | |
591 | )); | |
6a488035 | 592 | } |
42347843 | 593 | $today = CRM_Utils_Time::date('Y-m-d'); |
6a488035 TO |
594 | $membershipDates['today'] = CRM_Utils_Date::customFormat($today, '%Y%m%d'); |
595 | $membershipDates['start_date'] = CRM_Utils_Date::customFormat($startDate, '%Y%m%d'); | |
596 | $membershipDates['end_date'] = CRM_Utils_Date::customFormat($endDate, '%Y%m%d'); | |
597 | $membershipDates['log_start_date'] = CRM_Utils_Date::customFormat($logStartDate, '%Y%m%d'); | |
598 | } | |
599 | else { | |
42347843 | 600 | $today = CRM_Utils_Time::date('Y-m-d'); |
6a488035 TO |
601 | if ($changeToday) { |
602 | $today = CRM_Utils_Date::processDate($changeToday, NULL, FALSE, 'Y-m-d'); | |
603 | } | |
604 | // Calculate new start/end dates when join date is today | |
605 | $renewalDates = self::getDatesForMembershipType($membershipTypeDetails['id'], | |
606 | $today, NULL, NULL, $numRenewTerms | |
607 | ); | |
6a488035 TO |
608 | $membershipDates['today'] = CRM_Utils_Date::customFormat($today, '%Y%m%d'); |
609 | $membershipDates['start_date'] = $renewalDates['start_date']; | |
610 | $membershipDates['end_date'] = $renewalDates['end_date']; | |
611 | $membershipDates['log_start_date'] = $renewalDates['start_date']; | |
41dcb974 | 612 | // CRM-18503 - set join_date as today in case the membership type is fixed. |
613 | if ($membershipTypeDetails['period_type'] == 'fixed' && !isset($membershipDates['join_date'])) { | |
614 | $membershipDates['join_date'] = $renewalDates['join_date']; | |
615 | } | |
6a488035 | 616 | } |
055e2441 | 617 | if (!isset($membershipDates['join_date'])) { |
618 | $membershipDates['join_date'] = $membershipDates['start_date']; | |
619 | } | |
6a488035 TO |
620 | |
621 | return $membershipDates; | |
622 | } | |
623 | ||
6a488035 | 624 | /** |
fe482240 | 625 | * Retrieve all Membership Types with Member of Contact id. |
6a488035 | 626 | * |
5396af74 | 627 | * @param array $membershipTypes |
628 | * array of membership type ids | |
629 | * @return array | |
a6c01b45 | 630 | * array of the details of membership types with Member of Contact id |
6a488035 | 631 | */ |
00be9182 | 632 | public static function getMemberOfContactByMemTypes($membershipTypes) { |
be2fb01f | 633 | $memTypeOrganizations = []; |
6a488035 | 634 | if (empty($membershipTypes)) { |
b204fd50 | 635 | return $memTypeOrganizations; |
6a488035 TO |
636 | } |
637 | ||
638 | $result = CRM_Core_DAO::executeQuery("SELECT id, member_of_contact_id FROM civicrm_membership_type WHERE id IN (" . implode(',', $membershipTypes) . ")"); | |
639 | while ($result->fetch()) { | |
b204fd50 | 640 | $memTypeOrganizations[$result->id] = $result->member_of_contact_id; |
6a488035 TO |
641 | } |
642 | ||
b204fd50 | 643 | return $memTypeOrganizations; |
6a488035 TO |
644 | } |
645 | ||
77b97be7 | 646 | /** |
e0b2d43b | 647 | * The function returns all the Organization for all membershipTypes . |
6a488035 | 648 | * |
c490a46a | 649 | * @param int $membershipTypeId |
77b97be7 EM |
650 | * |
651 | * @return array | |
6a488035 | 652 | */ |
00be9182 | 653 | public static function getMembershipTypeOrganization($membershipTypeId = NULL) { |
be2fb01f | 654 | $allMembershipTypes = []; |
6a488035 TO |
655 | |
656 | $membershipType = new CRM_Member_DAO_MembershipType(); | |
657 | ||
658 | if (isset($membershipTypeId)) { | |
659 | $membershipType->id = $membershipTypeId; | |
660 | } | |
661 | $membershipType->find(); | |
662 | ||
663 | while ($membershipType->fetch()) { | |
b204fd50 | 664 | $allMembershipTypes[$membershipType->id] = $membershipType->member_of_contact_id; |
6a488035 | 665 | } |
b204fd50 | 666 | return $allMembershipTypes; |
6a488035 TO |
667 | } |
668 | ||
669 | /** | |
87ad884a | 670 | * Function to retrieve organization and associated membership |
6a488035 TO |
671 | * types |
672 | * | |
a6c01b45 CW |
673 | * @return array |
674 | * arrays of organization and membership types | |
6a488035 | 675 | * |
6a488035 | 676 | */ |
00be9182 | 677 | public static function getMembershipTypeInfo() { |
6a488035 | 678 | if (!self::$_membershipTypeInfo) { |
be2fb01f | 679 | $orgs = $types = []; |
6a488035 TO |
680 | |
681 | $query = 'SELECT memType.id, memType.name, memType.member_of_contact_id, c.sort_name | |
682 | FROM civicrm_membership_type memType INNER JOIN civicrm_contact c ON c.id = memType.member_of_contact_id | |
683 | WHERE memType.is_active = 1 '; | |
481a74f4 | 684 | $dao = CRM_Core_DAO::executeQuery($query); |
6a488035 TO |
685 | while ($dao->fetch()) { |
686 | $orgs[$dao->member_of_contact_id] = $dao->sort_name; | |
687 | $types[$dao->member_of_contact_id][$dao->id] = $dao->name; | |
688 | } | |
689 | ||
be2fb01f | 690 | self::$_membershipTypeInfo = [$orgs, $types]; |
6a488035 TO |
691 | } |
692 | return self::$_membershipTypeInfo; | |
693 | } | |
694 | ||
bb3a214a | 695 | /** |
c490a46a | 696 | * @param array $params |
100fef9d CW |
697 | * @param int $previousID |
698 | * @param int $membershipTypeId | |
bb3a214a | 699 | */ |
301db4f8 | 700 | public static function createMembershipPriceField($params, $previousID, $membershipTypeId) { |
6a488035 | 701 | |
9da8dc8c | 702 | $priceSetId = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', 'default_membership_type_amount', 'id', 'name'); |
6a488035 | 703 | |
a7488080 | 704 | if (!empty($params['member_of_contact_id'])) { |
6a488035 TO |
705 | $fieldName = $params['member_of_contact_id']; |
706 | } | |
707 | else { | |
708 | $fieldName = $previousID; | |
709 | } | |
353ffa53 TO |
710 | $fieldLabel = 'Membership Amount'; |
711 | $optionsIds = NULL; | |
be2fb01f | 712 | $fieldParams = [ |
6a488035 TO |
713 | 'price_set_id ' => $priceSetId, |
714 | 'name' => $fieldName, | |
be2fb01f CW |
715 | ]; |
716 | $results = []; | |
9da8dc8c | 717 | CRM_Price_BAO_PriceField::retrieve($fieldParams, $results); |
6a488035 | 718 | if (empty($results)) { |
be2fb01f | 719 | $fieldParams = []; |
6a488035 TO |
720 | $fieldParams['label'] = $fieldLabel; |
721 | $fieldParams['name'] = $fieldName; | |
722 | $fieldParams['price_set_id'] = $priceSetId; | |
723 | $fieldParams['html_type'] = 'Radio'; | |
724 | $fieldParams['is_display_amounts'] = $fieldParams['is_required'] = 0; | |
725 | $fieldParams['weight'] = $fieldParams['option_weight'][1] = 1; | |
726 | $fieldParams['option_label'][1] = $params['name']; | |
9c1bc317 | 727 | $fieldParams['option_description'][1] = $params['description'] ?? NULL; |
03e04002 | 728 | |
6a488035 TO |
729 | $fieldParams['membership_type_id'][1] = $membershipTypeId; |
730 | $fieldParams['option_amount'][1] = empty($params['minimum_fee']) ? 0 : $params['minimum_fee']; | |
9c1bc317 | 731 | $fieldParams['financial_type_id'] = $params['financial_type_id'] ?? NULL; |
6a488035 TO |
732 | |
733 | if ($previousID) { | |
734 | CRM_Member_Form_MembershipType::checkPreviousPriceField($previousID, $priceSetId, $membershipTypeId, $optionsIds); | |
9c1bc317 | 735 | $fieldParams['option_id'] = $optionsIds['option_id'] ?? NULL; |
6a488035 | 736 | } |
806e9b71 | 737 | CRM_Price_BAO_PriceField::create($fieldParams); |
03e04002 | 738 | } |
6a488035 TO |
739 | else { |
740 | $fieldID = $results['id']; | |
be2fb01f | 741 | $fieldValueParams = [ |
6a488035 TO |
742 | 'price_field_id' => $fieldID, |
743 | 'membership_type_id' => $membershipTypeId, | |
be2fb01f CW |
744 | ]; |
745 | $results = []; | |
9da8dc8c | 746 | CRM_Price_BAO_PriceFieldValue::retrieve($fieldValueParams, $results); |
6a488035 | 747 | if (!empty($results)) { |
353ffa53 | 748 | $results['label'] = $results['name'] = $params['name']; |
6a488035 | 749 | $results['amount'] = empty($params['minimum_fee']) ? 0 : $params['minimum_fee']; |
03e04002 | 750 | } |
6a488035 | 751 | else { |
be2fb01f | 752 | $results = [ |
6a488035 TO |
753 | 'price_field_id' => $fieldID, |
754 | 'name' => $params['name'], | |
755 | 'label' => $params['name'], | |
756 | 'amount' => empty($params['minimum_fee']) ? 0 : $params['minimum_fee'], | |
757 | 'membership_type_id' => $membershipTypeId, | |
758 | 'is_active' => 1, | |
be2fb01f | 759 | ]; |
6a488035 TO |
760 | } |
761 | ||
762 | if ($previousID) { | |
763 | CRM_Member_Form_MembershipType::checkPreviousPriceField($previousID, $priceSetId, $membershipTypeId, $optionsIds); | |
a7488080 | 764 | if (!empty($optionsIds['option_id'])) { |
f3601685 | 765 | $results['id'] = current($optionsIds['option_id']); |
6a488035 TO |
766 | } |
767 | } | |
9c1bc317 CW |
768 | $results['financial_type_id'] = $params['financial_type_id'] ?? NULL; |
769 | $results['description'] = $params['description'] ?? NULL; | |
f3601685 | 770 | CRM_Price_BAO_PriceFieldValue::add($results); |
6a488035 TO |
771 | } |
772 | } | |
773 | ||
be2e0c6a TO |
774 | /** |
775 | * This function updates all price field value for quick config | |
6a488035 TO |
776 | * price set which has membership type |
777 | * | |
87ad884a | 778 | * @param int $membershipTypeId membership type id |
6a488035 | 779 | * |
87ad884a | 780 | * @param array $params |
6a488035 | 781 | */ |
00be9182 | 782 | public static function updateAllPriceFieldValue($membershipTypeId, $params) { |
be2fb01f CW |
783 | $defaults = []; |
784 | $fieldsToUpdate = [ | |
5afcf706 JP |
785 | 'financial_type_id' => 'financial_type_id', |
786 | 'name' => 'label', | |
787 | 'minimum_fee' => 'amount', | |
788 | 'description' => 'description', | |
789 | 'visibility' => 'visibility_id', | |
be2fb01f | 790 | ]; |
5afcf706 JP |
791 | $priceFieldValueBAO = new CRM_Price_BAO_PriceFieldValue(); |
792 | $priceFieldValueBAO->membership_type_id = $membershipTypeId; | |
793 | $priceFieldValueBAO->find(); | |
794 | while ($priceFieldValueBAO->fetch()) { | |
be2fb01f | 795 | $updateParams = [ |
5afcf706 JP |
796 | 'id' => $priceFieldValueBAO->id, |
797 | 'price_field_id' => $priceFieldValueBAO->price_field_id, | |
be2fb01f | 798 | ]; |
5afcf706 | 799 | //Get priceset details. |
be2fb01f | 800 | $fieldParams = ['fid' => $priceFieldValueBAO->price_field_id]; |
5afcf706 | 801 | $setID = CRM_Price_BAO_PriceSet::getSetId($fieldParams); |
be2fb01f | 802 | $setParams = ['id' => $setID]; |
5afcf706 JP |
803 | $setValues = CRM_Price_BAO_PriceSet::retrieve($setParams, $defaults); |
804 | if (!empty($setValues->is_quick_config) && $setValues->name != 'default_membership_type_amount') { | |
805 | foreach ($fieldsToUpdate as $key => $value) { | |
806 | if ($value == 'visibility_id' && !empty($params['visibility'])) { | |
807 | $updateParams['visibility_id'] = CRM_Price_BAO_PriceField::getVisibilityOptionID(strtolower($params['visibility'])); | |
808 | } | |
809 | else { | |
9c1bc317 | 810 | $updateParams[$value] = $params[$key] ?? NULL; |
5afcf706 | 811 | } |
0e09eaf5 | 812 | } |
5afcf706 | 813 | CRM_Price_BAO_PriceFieldValue::add($updateParams); |
0e09eaf5 PN |
814 | } |
815 | } | |
03e04002 | 816 | } |
96025800 | 817 | |
eb151aab | 818 | /** |
819 | * Cached wrapper for membership types. | |
820 | * | |
821 | * Since this is used from the batched script caching helps. | |
822 | * | |
24eeccd0 | 823 | * Caching is by domain - if that hits any issues we should add a new function getDomainMembershipTypes |
824 | * or similar rather than 'just add another param'! but this is closer to earlier behaviour so 'should' be OK. | |
825 | * | |
e0b2d43b MW |
826 | * @return array |
827 | * List of membershipType details keyed by membershipTypeID | |
eb151aab | 828 | * @throws \CiviCRM_API3_Exception |
829 | */ | |
d568dbe0 EM |
830 | public static function getAllMembershipTypes(): array { |
831 | $cacheString = __CLASS__ . __FUNCTION__ . CRM_Core_Config::domainID() . '_' . CRM_Core_I18n::getLocale(); | |
24eeccd0 | 832 | if (!Civi::cache('metadata')->has($cacheString)) { |
322b59f0 | 833 | $types = civicrm_api3('MembershipType', 'get', ['options' => ['limit' => 0, 'sort' => 'weight']])['values']; |
49bbb50e | 834 | $taxRates = CRM_Core_PseudoConstant::getTaxRates(); |
2d227fa3 | 835 | $keys = ['description', 'relationship_type_id', 'relationship_direction', 'max_related', 'auto_renew']; |
322b59f0 | 836 | // In order to avoid down-stream e-notices we undo api v3 filtering of NULL values. This is covered |
837 | // in Unit tests & ideally we might switch to apiv4 but I would argue we should build caching | |
838 | // of metadata entities like this directly into apiv4. | |
839 | foreach ($types as $id => $type) { | |
840 | foreach ($keys as $key) { | |
841 | if (!isset($type[$key])) { | |
842 | $types[$id][$key] = NULL; | |
843 | } | |
844 | } | |
845 | if (isset($type['contribution_type_id'])) { | |
846 | unset($types[$id]['contribution_type_id']); | |
847 | } | |
49bbb50e | 848 | $types[$id]['tax_rate'] = (float) ($taxRates[$type['financial_type_id']] ?? 0.0); |
849 | $multiplier = 1; | |
850 | if ($types[$id]['tax_rate'] !== 0.0) { | |
851 | $multiplier += ($types[$id]['tax_rate'] / 100); | |
852 | } | |
4e089fd0 AM |
853 | if (!array_key_exists('minimum_fee', $types[$id])) { |
854 | $types[$id]['minimum_fee'] = 0; | |
855 | } | |
49bbb50e | 856 | $types[$id]['minimum_fee_with_tax'] = (float) $types[$id]['minimum_fee'] * $multiplier; |
322b59f0 | 857 | } |
24eeccd0 | 858 | Civi::cache('metadata')->set($cacheString, $types); |
eb151aab | 859 | } |
24eeccd0 | 860 | return Civi::cache('metadata')->get($cacheString); |
eb151aab | 861 | } |
862 | ||
863 | /** | |
864 | * Get a specific membership type (leveraging the cache). | |
865 | * | |
866 | * @param int $id | |
867 | * | |
868 | * @return mixed | |
869 | * @throws \CiviCRM_API3_Exception | |
870 | */ | |
871 | public static function getMembershipType($id) { | |
872 | return self::getAllMembershipTypes()[$id]; | |
873 | } | |
874 | ||
6a488035 | 875 | } |