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