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