3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
35 class CRM_Member_BAO_MembershipType
extends CRM_Member_DAO_MembershipType
{
38 * Static holder for the default LT
40 static $_defaultMembershipType = NULL;
42 static $_membershipTypeInfo = array();
47 public function __construct() {
48 parent
::__construct();
52 * Fetch object based on array of properties
54 * @param array $params (reference ) an assoc array of name/value pairs
55 * @param array $defaults (reference ) an assoc array to hold the flattened values
57 * @return CRM_Member_BAO_MembershipType object
60 public static function retrieve(&$params, &$defaults) {
61 $membershipType = new CRM_Member_DAO_MembershipType();
62 $membershipType->copyValues($params);
63 if ($membershipType->find(TRUE)) {
64 CRM_Core_DAO
::storeValues($membershipType, $defaults);
65 return $membershipType;
71 * Update the is_active flag in the db
73 * @param int $id id of the database record
74 * @param boolean $is_active value we want to set the is_active field
76 * @return Object DAO object on sucess, null otherwise
79 public static function setIsActive($id, $is_active) {
80 return CRM_Core_DAO
::setFieldValue('CRM_Member_DAO_MembershipType', $id, 'is_active', $is_active);
84 * Add the membership types
86 * @param array $params reference array contains the values submitted by the form
87 * @param array $ids array contains the id (deprecated)
93 public static function add(&$params, $ids = array()) {
94 $id = CRM_Utils_Array
::value('id', $params, CRM_Utils_Array
::value('membershipType', $ids));
96 if (!isset($params['is_active'])) {
98 $params['is_active'] = FALSE;
100 if (!isset($params['domain_id'])) {
101 $params['domain_id'] = CRM_Core_Config
::domainID();
105 // action is taken depending upon the mode
106 $membershipType = new CRM_Member_DAO_MembershipType();
107 $membershipType->copyValues($params);
108 $membershipType->id
= $id;
110 // $previousID is the old organization id for membership type i.e 'member_of_contact_id'. This is used when an organization is changed.
113 $previousID = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $id, 'member_of_contact_id');
116 $membershipType->save();
118 // on update we may need to retrieve some details for the price field function - otherwise we get e-notices on attempts to retrieve
119 // name etc - the presence of previous id tells us this is an update
120 $params = array_merge(civicrm_api3('membership_type', 'getsingle', array('id' => $membershipType->id
)), $params);
122 self
::createMembershipPriceField($params, $previousID, $membershipType->id
);
123 // update all price field value for quick config when membership type is set CRM-11718
125 self
::updateAllPriceFieldValue($id, $params);
128 return $membershipType;
132 * Delete membership Types
134 * @param int $membershipTypeId
136 * @throws CRM_Core_Exception
140 public static function del($membershipTypeId) {
145 'Membership' => 'membership_type_id',
146 'MembershipBlock' => 'membership_type_default',
149 foreach ($dependancy as $name => $field) {
150 $baoString = 'CRM_Member_BAO_' . $name;
151 $dao = new $baoString();
152 $dao->$field = $membershipTypeId;
153 if ($dao->find(TRUE)) {
160 $message = ts('This membership type cannot be deleted due to following reason(s):');
161 if (in_array('Membership', $status)) {
162 $findMembersURL = CRM_Utils_System
::url('civicrm/member/search', 'reset=1');
163 $deleteURL = CRM_Utils_System
::url('civicrm/contact/search/advanced', 'reset=1');
164 $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(1 => $findMembersURL, 2 => $deleteURL, 3 => $cnt));
168 if (in_array('MembershipBlock', $status)) {
169 $deleteURL = CRM_Utils_System
::url('civicrm/admin/contribute', 'reset=1');
170 $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(1 => $deleteURL, 2 => $cnt));
171 throw new CRM_Core_Exception($message);
174 CRM_Utils_Weight
::delWeight('CRM_Member_DAO_MembershipType', $membershipTypeId);
175 //delete from membership Type table
176 $membershipType = new CRM_Member_DAO_MembershipType();
177 $membershipType->id
= $membershipTypeId;
179 //fix for membership type delete api
181 if ($membershipType->find(TRUE)) {
182 return $membershipType->delete();
189 * Convert membership Type's 'start day' & 'rollover day' to human readable formats.
191 * @param array $membershipType an array of membershipType-details.
194 public static function convertDayFormat(&$membershipType) {
196 'fixed_period_start_day',
197 'fixed_period_rollover_day',
199 foreach ($membershipType as $id => $details) {
200 foreach ($periodDays as $pDay) {
201 if (!empty($details[$pDay])) {
202 if ($details[$pDay] > 31) {
203 $month = substr($details[$pDay], 0, strlen($details[$pDay]) - 2);
204 $day = substr($details[$pDay], -2);
219 $membershipType[$id][$pDay] = $monthMap[$month] . ' ' . $day;
222 $membershipType[$id][$pDay] = $details[$pDay];
230 * Get membership Types
232 * @param bool $public
237 public static function getMembershipTypes($public = TRUE) {
238 $membershipTypes = array();
239 $membershipType = new CRM_Member_DAO_MembershipType();
240 $membershipType->is_active
= 1;
242 $membershipType->visibility
= 'Public';
244 $membershipType->orderBy(' weight');
245 $membershipType->find();
246 while ($membershipType->fetch()) {
247 $membershipTypes[$membershipType->id
] = $membershipType->name
;
249 $membershipType->free();
250 return $membershipTypes;
254 * Get membership Type Details
256 * @param int $membershipTypeId
261 public static function getMembershipTypeDetails($membershipTypeId) {
262 $membershipTypeDetails = array();
264 $membershipType = new CRM_Member_DAO_MembershipType();
265 $membershipType->is_active
= 1;
266 $membershipType->id
= $membershipTypeId;
267 if ($membershipType->find(TRUE)) {
268 CRM_Core_DAO
::storeValues($membershipType, $membershipTypeDetails);
269 $membershipType->free();
270 return $membershipTypeDetails;
278 * Calculate start date and end date for new membership
280 * @param int $membershipTypeId membership type id
281 * @param date $joinDate member since ( in mysql date format )
282 * @param date $startDate start date ( in mysql date format )
283 * @param null $endDate
284 * @param int $numRenewTerms how many membership terms are being added to end date (default is 1)
286 * @return array associated array with start date, end date and join date for the membership
289 public static function getDatesForMembershipType($membershipTypeId, $joinDate = NULL, $startDate = NULL, $endDate = NULL, $numRenewTerms = 1) {
290 $membershipTypeDetails = self
::getMembershipTypeDetails($membershipTypeId);
292 // convert all dates to 'Y-m-d' format.
294 'joinDate', 'startDate', 'endDate') as $dateParam) {
295 if (!empty($
$dateParam)) {
296 $
$dateParam = CRM_Utils_Date
::processDate($
$dateParam, NULL, FALSE, 'Y-m-d');
300 $joinDate = date('Y-m-d');
302 $actualStartDate = $joinDate;
304 $actualStartDate = $startDate;
307 $fixed_period_rollover = FALSE;
308 if (CRM_Utils_Array
::value('period_type', $membershipTypeDetails) == 'rolling') {
310 $startDate = $joinDate;
312 $actualStartDate = $startDate;
314 elseif (CRM_Utils_Array
::value('period_type', $membershipTypeDetails) == 'fixed') {
315 // calculate start date
316 // if !$startDate then use $joinDate
317 $toDay = explode('-', (empty($startDate) ?
$joinDate : $startDate));
322 if ($membershipTypeDetails['duration_unit'] == 'year') {
324 //get start fixed day
325 $startMonth = substr($membershipTypeDetails['fixed_period_start_day'], 0,
326 strlen($membershipTypeDetails['fixed_period_start_day']) - 2
328 $startDay = substr($membershipTypeDetails['fixed_period_start_day'], -2);
330 if (date('Y-m-d', mktime(0, 0, 0, $startMonth, $startDay, $year)) <= date('Y-m-d', mktime(0, 0, 0, $month, $day, $year))) {
331 $fixedStartDate = date('Y-m-d', mktime(0, 0, 0, $startMonth, $startDay, $year));
334 $fixedStartDate = date('Y-m-d', mktime(0, 0, 0, $startMonth, $startDay, $year - 1));
337 //get start rollover day
338 $rolloverMonth = substr($membershipTypeDetails['fixed_period_rollover_day'], 0,
339 strlen($membershipTypeDetails['fixed_period_rollover_day']) - 2
341 $rolloverDay = substr($membershipTypeDetails['fixed_period_rollover_day'], -2);
343 $fixedRolloverDate = date('Y-m-d', mktime(0, 0, 0, $rolloverMonth, $rolloverDay, $year));
345 //CRM-7825 -membership date rules are :
346 //1. Membership should not be start in future.
347 //2. rollover window should be subset of membership window.
349 //store original fixed start date as per current year.
350 $actualStartDate = $fixedStartDate;
352 //store original fixed rollover date as per current year.
353 $actualRolloverDate = $fixedRolloverDate;
355 //get the fixed end date here.
356 $dateParts = explode('-', $actualStartDate);
357 $fixedEndDate = date('Y-m-d', mktime(0, 0, 0,
360 $dateParts[0] +
($numRenewTerms * $membershipTypeDetails['duration_interval'])
363 //make sure rollover window should be
364 //subset of membership period window.
365 if ($fixedEndDate < $actualRolloverDate) {
366 $actualRolloverDate = date('Y-m-d', mktime(0, 0, 0, $rolloverMonth, $rolloverDay, $year - 1));
368 if ($actualRolloverDate < $actualStartDate) {
369 $actualRolloverDate = date('Y-m-d', mktime(0, 0, 0, $rolloverMonth, $rolloverDay, $year +
1));
372 //do check signup is in rollover window.
373 if ($actualRolloverDate <= $joinDate) {
374 $fixed_period_rollover = TRUE;
378 $startDate = $actualStartDate;
381 elseif ($membershipTypeDetails['duration_unit'] == 'month') {
382 // Check if we are on or after rollover day of the month - CRM-10585
383 // If so, set fixed_period_rollover TRUE so we increment end_date month below.
384 $dateParts = explode('-', $actualStartDate);
385 if ($dateParts[2] >= $membershipTypeDetails['fixed_period_rollover_day']){
386 $fixed_period_rollover = True;
389 // Start date is always first day of actualStartDate month
391 $actualStartDate = $startDate = $year . '-' . $month . '-01';
396 //calculate end date if it is not passed by user
398 //end date calculation
399 $date = explode('-', $actualStartDate);
404 switch ($membershipTypeDetails['duration_unit']) {
406 $year = $year +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
407 //extend membership date by duration interval.
408 if ($fixed_period_rollover) {
414 $month = $month +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
415 //duration interval is month
416 if ($fixed_period_rollover) {
423 $day = $day +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
425 if ($fixed_period_rollover) {
426 //Fix Me: Currently we don't allow rollover if
427 //duration interval is day
432 if ($membershipTypeDetails['duration_unit'] == 'lifetime') {
436 $endDate = date('Y-m-d', mktime(0, 0, 0, $month, $day - 1, $year));
440 $membershipDates = array();
443 'start_date' => 'startDate',
444 'end_date' => 'endDate',
445 'join_date' => 'joinDate',
447 foreach ($dates as $varName => $valName) {
448 $membershipDates[$varName] = CRM_Utils_Date
::customFormat($
$valName, '%Y%m%d');
451 return $membershipDates;
455 * Calculate start date and end date for renewal membership
457 * @param int $membershipId
458 * @param $changeToday
459 * @param int $membershipTypeID - if provided, overrides the membership type of the $membershipID membership
460 * @param int $numRenewTerms how many membership terms are being added to end date (default is 1)
462 * CRM-7297 Membership Upsell - Added $membershipTypeID param to facilitate calculations of dates when membership type changes
464 * @return Array array fo the start date, end date and join date of the membership
467 public static function getRenewalDatesForMembershipType($membershipId, $changeToday = NULL, $membershipTypeID = NULL, $numRenewTerms = 1) {
468 $params = array('id' => $membershipId);
469 $membershipDetails = CRM_Member_BAO_Membership
::getValues($params, $values);
470 $statusID = $membershipDetails[$membershipId]->status_id
;
471 $membershipDates = array(
472 'join_date' => CRM_Utils_Date
::customFormat($membershipDetails[$membershipId]->join_date
, '%Y%m%d'),
475 $oldPeriodType = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
476 CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $membershipId, 'membership_type_id'), 'period_type');
478 // CRM-7297 Membership Upsell
479 if (is_null($membershipTypeID)) {
480 $membershipTypeDetails = self
::getMembershipTypeDetails($membershipDetails[$membershipId]->membership_type_id
);
483 $membershipTypeDetails = self
::getMembershipTypeDetails($membershipTypeID);
485 $statusDetails = CRM_Member_BAO_MembershipStatus
::getMembershipStatus($statusID);
487 if ($statusDetails['is_current_member'] == 1) {
488 $startDate = $membershipDetails[$membershipId]->start_date
;
489 // CRM=7297 Membership Upsell: we need to handle null end_date in case we are switching
490 // from a lifetime to a different membership type
491 if (is_null($membershipDetails[$membershipId]->end_date
)) {
492 $date = date('Y-m-d');
495 $date = $membershipDetails[$membershipId]->end_date
;
497 $date = explode('-', $date);
498 $logStartDate = date('Y-m-d', mktime(0, 0, 0,
500 (double)($date[2] +
1),
504 $date = explode('-', $logStartDate);
509 switch ($membershipTypeDetails['duration_unit']) {
511 //need to check if the upsell is from rolling to fixed and adjust accordingly
512 if ($membershipTypeDetails['period_type'] == 'fixed' && $oldPeriodType == 'rolling' ) {
513 $month = substr($membershipTypeDetails['fixed_period_start_day'], 0, strlen($membershipTypeDetails['fixed_period_start_day']) - 2);
514 $day = substr($membershipTypeDetails['fixed_period_start_day'], -2);
517 $year = $year +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
522 $month = $month +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
526 $day = $day +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
529 if ($membershipTypeDetails['duration_unit'] == 'lifetime') {
533 $endDate = date('Y-m-d', mktime(0, 0, 0,
539 $today = date('Y-m-d');
540 $membershipDates['today'] = CRM_Utils_Date
::customFormat($today, '%Y%m%d');
541 $membershipDates['start_date'] = CRM_Utils_Date
::customFormat($startDate, '%Y%m%d');
542 $membershipDates['end_date'] = CRM_Utils_Date
::customFormat($endDate, '%Y%m%d');
543 $membershipDates['log_start_date'] = CRM_Utils_Date
::customFormat($logStartDate, '%Y%m%d');
546 $today = date('Y-m-d');
548 $today = CRM_Utils_Date
::processDate($changeToday, NULL, FALSE, 'Y-m-d');
550 // Calculate new start/end dates when join date is today
551 $renewalDates = self
::getDatesForMembershipType($membershipTypeDetails['id'],
552 $today, NULL, NULL, $numRenewTerms
554 $membershipDates['today'] = CRM_Utils_Date
::customFormat($today, '%Y%m%d');
555 $membershipDates['start_date'] = $renewalDates['start_date'];
556 $membershipDates['end_date'] = $renewalDates['end_date'];
557 $membershipDates['log_start_date'] = $renewalDates['start_date'];
560 return $membershipDates;
564 * Retrieve all Membership Types associated
565 * with an Organization
567 * @param int $orgID Id of Organization
569 * @return Array array of the details of membership types
572 public static function getMembershipTypesByOrg($orgID) {
573 $membershipTypes = array();
574 $dao = new CRM_Member_DAO_MembershipType();
575 $dao->member_of_contact_id
= $orgID;
577 while ($dao->fetch()) {
578 $membershipTypes[$dao->id
] = array();
579 CRM_Core_DAO
::storeValues($dao, $membershipTypes[$dao->id
]);
581 return $membershipTypes;
585 * Retrieve all Membership Types with Member of Contact id
587 * @param array membership types
589 * @return Array array of the details of membership types with Member of Contact id
592 public static function getMemberOfContactByMemTypes($membershipTypes) {
593 $memTypeOrgs = array();
594 if (empty($membershipTypes)) {
598 $result = CRM_Core_DAO
::executeQuery("SELECT id, member_of_contact_id FROM civicrm_membership_type WHERE id IN (" . implode(',', $membershipTypes) . ")");
599 while ($result->fetch()) {
600 $memTypeOrgs[$result->id
] = $result->member_of_contact_id
;
607 * The function returns all the Organization for all membershiptypes .
609 * @param int $membershipTypeId
613 public static function getMembershipTypeOrganization($membershipTypeId = NULL) {
614 $allmembershipTypes = array();
616 $membershipType = new CRM_Member_DAO_MembershipType();
618 if (isset($membershipTypeId)) {
619 $membershipType->id
= $membershipTypeId;
621 $membershipType->find();
623 while ($membershipType->fetch()) {
624 $allmembershipTypes[$membershipType->id
] = $membershipType->member_of_contact_id
;
626 return $allmembershipTypes;
630 * Funtion to retrieve organization and associated membership
633 * @return array arrays of organization and membership types
637 public static function getMembershipTypeInfo() {
638 if (!self
::$_membershipTypeInfo) {
639 $orgs = $types = array();
641 $query = 'SELECT memType.id, memType.name, memType.member_of_contact_id, c.sort_name
642 FROM civicrm_membership_type memType INNER JOIN civicrm_contact c ON c.id = memType.member_of_contact_id
643 WHERE memType.is_active = 1 ';
644 $dao = CRM_Core_DAO
::executeQuery( $query );
645 while ($dao->fetch()) {
646 $orgs[$dao->member_of_contact_id
] = $dao->sort_name
;
647 $types[$dao->member_of_contact_id
][$dao->id
] = $dao->name
;
650 self
::$_membershipTypeInfo = array($orgs, $types);
652 return self
::$_membershipTypeInfo;
657 * @param array $params
658 * @param int $previousID
659 * @param int $membershipTypeId
661 public static function createMembershipPriceField($params, $previousID, $membershipTypeId) {
663 $priceSetId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', 'default_membership_type_amount', 'id', 'name');
665 if (!empty($params['member_of_contact_id'])) {
666 $fieldName = $params['member_of_contact_id'];
669 $fieldName = $previousID;
671 $fieldLabel = 'Membership Amount';
673 $fieldParams = array(
674 'price_set_id ' => $priceSetId,
675 'name' => $fieldName,
678 CRM_Price_BAO_PriceField
::retrieve($fieldParams, $results);
679 if (empty($results)) {
680 $fieldParams = array();
681 $fieldParams['label'] = $fieldLabel;
682 $fieldParams['name'] = $fieldName;
683 $fieldParams['price_set_id'] = $priceSetId;
684 $fieldParams['html_type'] = 'Radio';
685 $fieldParams['is_display_amounts'] = $fieldParams['is_required'] = 0;
686 $fieldParams['weight'] = $fieldParams['option_weight'][1] = 1;
687 $fieldParams['option_label'][1] = $params['name'];
688 $fieldParams['option_description'][1] = CRM_Utils_Array
::value('description', $params);
690 $fieldParams['membership_type_id'][1] = $membershipTypeId;
691 $fieldParams['option_amount'][1] = empty($params['minimum_fee']) ?
0 : $params['minimum_fee'];
692 $fieldParams['financial_type_id'] = CRM_Utils_Array
::value('financial_type_id', $params);
695 CRM_Member_Form_MembershipType
::checkPreviousPriceField($previousID, $priceSetId, $membershipTypeId, $optionsIds);
696 $fieldParams['option_id'] = CRM_Utils_Array
::value('option_id', $optionsIds);
698 CRM_Price_BAO_PriceField
::create($fieldParams);
701 $fieldID = $results['id'];
702 $fieldValueParams = array(
703 'price_field_id' => $fieldID,
704 'membership_type_id' => $membershipTypeId,
707 CRM_Price_BAO_PriceFieldValue
::retrieve($fieldValueParams, $results);
708 if (!empty($results)) {
709 $results['label'] = $results['name'] = $params['name'];
710 $results['amount'] = empty($params['minimum_fee']) ?
0 : $params['minimum_fee'];
711 $optionsIds['id'] = $results['id'];
715 'price_field_id' => $fieldID,
716 'name' => $params['name'],
717 'label' => $params['name'],
718 'amount' => empty($params['minimum_fee']) ?
0 : $params['minimum_fee'],
719 'membership_type_id' => $membershipTypeId,
725 CRM_Member_Form_MembershipType
::checkPreviousPriceField($previousID, $priceSetId, $membershipTypeId, $optionsIds);
726 if (!empty($optionsIds['option_id'])) {
727 $optionsIds['id'] = current(CRM_Utils_Array
::value('option_id', $optionsIds));
730 $results['financial_type_id'] = CRM_Utils_Array
::value('financial_type_id', $params);
731 $results['description'] = CRM_Utils_Array
::value('description', $params);
732 CRM_Price_BAO_PriceFieldValue
::add($results, $optionsIds);
736 /** This function updates all price field value for quick config
737 * price set which has membership type
739 * @param integer membership type id
741 * @param integer financial type id
743 public static function updateAllPriceFieldValue($membershipTypeId, $params) {
744 if (!empty($params['minimum_fee'])){
745 $amount = $params['minimum_fee'];
751 $updateValues = array(
752 2 => array('financial_type_id', 'financial_type_id', 'Integer'),
753 3 => array('label', 'name', 'String'),
754 4 => array('amount', 'minimum_fee', 'Float'),
755 5 => array('description', 'description', 'String'),
758 $queryParams = array(1 => array($membershipTypeId, 'Integer'));
759 foreach ($updateValues as $key => $value) {
760 if (array_key_exists($value[1], $params)) {
761 $updateFields[] = "cpfv." . $value[0] . " = %$key";
762 if ($value[1] == 'minimum_fee') {
763 $fieldValue = $amount;
766 $fieldValue = $params[$value[1]];
768 $queryParams[$key] = array($fieldValue, $value[2]);
772 $query = "UPDATE `civicrm_price_field_value` cpfv
773 INNER JOIN civicrm_price_field cpf on cpf.id = cpfv.price_field_id
774 INNER JOIN civicrm_price_set cps on cps.id = cpf.price_set_id
775 SET " . implode(' , ', $updateFields) . " WHERE cpfv.membership_type_id = %1
776 AND cps.is_quick_config = 1 AND cps.name != 'default_membership_type_amount'";
777 CRM_Core_DAO
::executeQuery($query, $queryParams);