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