3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.3 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
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 function __construct() {
48 parent
::__construct();
52 * Takes a bunch of params that are needed to match certain criteria and
53 * retrieves the relevant objects. Typically the valid params are only
54 * contact_id. We'll tweak this function to be more full featured over a period
55 * of time. This is the inverse function of create. It also stores all the retrieved
56 * values in the default array
58 * @param array $params (reference ) an assoc array of name/value pairs
59 * @param array $defaults (reference ) an assoc array to hold the flattened values
61 * @return object CRM_Member_BAO_MembershipType object
65 static function retrieve(&$params, &$defaults) {
66 $membershipType = new CRM_Member_DAO_MembershipType();
67 $membershipType->copyValues($params);
68 if ($membershipType->find(TRUE)) {
69 CRM_Core_DAO
::storeValues($membershipType, $defaults);
70 return $membershipType;
76 * update the is_active flag in the db
78 * @param int $id id of the database record
79 * @param boolean $is_active value we want to set the is_active field
81 * @return Object DAO object on sucess, null otherwise
84 static function setIsActive($id, $is_active) {
85 return CRM_Core_DAO
::setFieldValue('CRM_Member_DAO_MembershipType', $id, 'is_active', $is_active);
89 * function to add the membership types
91 * @param array $params reference array contains the values submitted by the form
92 * @param array $ids reference array contains the id
99 static function add(&$params, &$ids) {
100 $params['is_active'] = CRM_Utils_Array
::value('is_active', $params, FALSE);
102 // action is taken depending upon the mode
103 $membershipType = new CRM_Member_DAO_MembershipType();
105 $membershipType->copyValues($params);
107 $membershipType->domain_id
= CRM_Core_Config
::domainID();
109 $membershipType->id
= CRM_Utils_Array
::value('membershipType', $ids);
111 // $previousID is the old organization id for memberhip type i.e 'member_of_contact_id'. This is used when an oganization is changed.
113 if ($membershipType->id
) {
114 $previousID = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $membershipType->id
, 'member_of_contact_id');
117 $membershipType->save();
119 self
::createMembershipPriceField($params, $ids, $previousID, $membershipType->id
);
120 // update all price field value for quick config when membership type is set CRM-11718
121 if (CRM_Utils_Array
::value('membershipType', $ids)) {
122 self
::updateAllPriceFieldValue($ids['membershipType'], $params);
125 return $membershipType;
129 * Function to delete membership Types
131 * @param int $membershipTypeId
134 static function del($membershipTypeId, $skipRedirect = FALSE) {
139 'Membership' => 'membership_type_id',
140 'MembershipBlock' => 'membership_type_default',
143 foreach ($dependancy as $name => $field) {
144 $baoString = 'CRM_Member_BAO_' . $name;
145 $dao = new $baoString();
146 $dao->$field = $membershipTypeId;
147 if ($dao->find(TRUE)) {
156 $message = ts('This membership type cannot be deleted due to following reason(s):');
157 if (in_array('Membership', $status)) {
158 $findMembersURL = CRM_Utils_System
::url('civicrm/member/search', 'reset=1');
159 $deleteURL = CRM_Utils_System
::url('civicrm/contact/search/advanced', 'reset=1');
160 $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));
164 if (in_array('MembershipBlock', $status)) {
165 $deleteURL = CRM_Utils_System
::url('civicrm/admin/contribute', 'reset=1');
166 $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));
167 throw new CRM_Core_Exception($message);
170 CRM_Utils_Weight
::delWeight('CRM_Member_DAO_MembershipType', $membershipTypeId);
171 //delete from membership Type table
172 $membershipType = new CRM_Member_DAO_MembershipType();
173 $membershipType->id
= $membershipTypeId;
175 //fix for membership type delete api
177 if ($membershipType->find(TRUE)) {
178 $membershipType->delete();
186 * Function to convert membership Type's 'start day' & 'rollover day' to human readable formats.
188 * @param array $membershipType an array of membershipType-details.
191 static function convertDayFormat(&$membershipType) {
193 'fixed_period_start_day',
194 'fixed_period_rollover_day',
196 foreach ($membershipType as $id => $details) {
197 foreach ($periodDays as $pDay) {
198 if (CRM_Utils_Array
::value($pDay, $details)) {
199 if ($details[$pDay] > 31) {
200 $month = substr($details[$pDay], 0, strlen($details[$pDay]) - 2);
201 $day = substr($details[$pDay], -2);
216 $membershipType[$id][$pDay] = $monthMap[$month] . ' ' . $day;
219 $membershipType[$id][$pDay] = $details[$pDay];
227 * Function to get membership Types
229 * @param int $membershipTypeId
232 static function getMembershipTypes($public = TRUE) {
233 $membershipTypes = array();
234 $membershipType = new CRM_Member_DAO_MembershipType();
235 $membershipType->is_active
= 1;
237 $membershipType->visibility
= 'Public';
239 $membershipType->orderBy(' weight');
240 $membershipType->find();
241 while ($membershipType->fetch()) {
242 $membershipTypes[$membershipType->id
] = $membershipType->name
;
244 $membershipType->free();
245 return $membershipTypes;
249 * Function to get membership Type Details
251 * @param int $membershipTypeId
254 static function getMembershipTypeDetails($membershipTypeId) {
255 $membershipTypeDetails = array();
257 $membershipType = new CRM_Member_DAO_MembershipType();
258 $membershipType->is_active
= 1;
259 $membershipType->id
= $membershipTypeId;
260 if ($membershipType->find(TRUE)) {
261 CRM_Core_DAO
::storeValues($membershipType, $membershipTypeDetails);
262 $membershipType->free();
263 return $membershipTypeDetails;
271 * Function to calculate start date and end date for new membership
273 * @param int $membershipTypeId membership type id
274 * @param date $joinDate member since ( in mysql date format )
275 * @param date $startDate start date ( in mysql date format )
276 * @param int $numRenewTerms how many membership terms are being added to end date (default is 1)
278 * @return array associated array with start date, end date and join date for the membership
281 public static function getDatesForMembershipType($membershipTypeId, $joinDate = NULL, $startDate = NULL, $endDate = NULL, $numRenewTerms = 1) {
282 $membershipTypeDetails = self
::getMembershipTypeDetails($membershipTypeId);
284 // convert all dates to 'Y-m-d' format.
286 'joinDate', 'startDate', 'endDate') as $dateParam) {
287 if (!empty($
$dateParam)) {
288 $
$dateParam = CRM_Utils_Date
::processDate($
$dateParam, NULL, FALSE, 'Y-m-d');
292 $joinDate = date('Y-m-d');
294 $actualStartDate = $joinDate;
296 $actualStartDate = $startDate;
299 $fixed_period_rollover = FALSE;
300 if (CRM_Utils_Array
::value('period_type', $membershipTypeDetails) == 'rolling') {
302 $startDate = $joinDate;
304 $actualStartDate = $startDate;
306 elseif (CRM_Utils_Array
::value('period_type', $membershipTypeDetails) == 'fixed') {
307 //calculate start date
309 // today is always join date, in case of Online join date
310 // is equal to current system date
311 $toDay = explode('-', $joinDate);
313 // get year from join date
317 if ($membershipTypeDetails['duration_unit'] == 'year') {
319 //get start fixed day
320 $startMonth = substr($membershipTypeDetails['fixed_period_start_day'], 0,
321 strlen($membershipTypeDetails['fixed_period_start_day']) - 2
323 $startDay = substr($membershipTypeDetails['fixed_period_start_day'], -2);
325 $fixedStartDate = date('Y-m-d', mktime(0, 0, 0, $startMonth, $startDay, $year));
327 //get start rollover day
328 $rolloverMonth = substr($membershipTypeDetails['fixed_period_rollover_day'], 0,
329 strlen($membershipTypeDetails['fixed_period_rollover_day']) - 2
331 $rolloverDay = substr($membershipTypeDetails['fixed_period_rollover_day'], -2);
333 $fixedRolloverDate = date('Y-m-d', mktime(0, 0, 0, $rolloverMonth, $rolloverDay, $year));
335 //CRM-7825 -membership date rules are :
336 //1. Membership should not be start in future.
337 //2. rollover window should be subset of membership window.
339 //store original fixed start date as per current year.
340 $actualStartDate = $fixedStartDate;
342 //store original fixed rollover date as per current year.
343 $actualRolloverDate = $fixedRolloverDate;
345 //make sure membership should not start in future.
346 if ($joinDate < $actualStartDate) {
347 $actualStartDate = date('Y-m-d', mktime(0, 0, 0, $startMonth, $startDay, $year - 1));
350 //get the fixed end date here.
351 $dateParts = explode('-', $actualStartDate);
352 $fixedEndDate = date('Y-m-d', mktime(0, 0, 0,
355 $dateParts[0] +
($numRenewTerms * $membershipTypeDetails['duration_interval'])
358 //make sure rollover window should be
359 //subset of membership period window.
360 if ($fixedEndDate < $actualRolloverDate) {
361 $actualRolloverDate = date('Y-m-d', mktime(0, 0, 0, $rolloverMonth, $rolloverDay, $year - 1));
363 if ($actualRolloverDate < $actualStartDate) {
364 $actualRolloverDate = date('Y-m-d', mktime(0, 0, 0, $rolloverMonth, $rolloverDay, $year +
1));
367 //do check signup is in rollover window.
368 if ($actualRolloverDate <= $joinDate) {
369 $fixed_period_rollover = TRUE;
373 $startDate = $actualStartDate;
376 elseif ($membershipTypeDetails['duration_unit'] == 'month') {
377 // Check if we are on or after rollover day of the month - CRM-10585
378 // If so, set fixed_period_rollover TRUE so we increment end_date month below.
379 $dateParts = explode('-', $actualStartDate);
380 if ($dateParts[2] >= $membershipTypeDetails['fixed_period_rollover_day']){
381 $fixed_period_rollover = True;
384 // Start date is always first day of actualStartDate month
386 $actualStartDate = $startDate = $year . '-' . $month . '-01';
391 //calculate end date if it is not passed by user
393 //end date calculation
394 $date = explode('-', $actualStartDate);
399 switch ($membershipTypeDetails['duration_unit']) {
401 $year = $year +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
402 //extend membership date by duration interval.
403 if ($fixed_period_rollover) {
409 $month = $month +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
410 //duration interval is month
411 if ($fixed_period_rollover) {
418 $day = $day +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
420 if ($fixed_period_rollover) {
421 //Fix Me: Currently we don't allow rollover if
422 //duration interval is day
427 if ($membershipTypeDetails['duration_unit'] == 'lifetime') {
431 $endDate = date('Y-m-d', mktime(0, 0, 0, $month, $day - 1, $year));
435 $membershipDates = array();
438 'start_date' => 'startDate',
439 'end_date' => 'endDate',
440 'join_date' => 'joinDate',
442 foreach ($dates as $varName => $valName) {
443 $membershipDates[$varName] = CRM_Utils_Date
::customFormat($
$valName, '%Y%m%d');
446 return $membershipDates;
450 * Function to calculate start date and end date for renewal membership
452 * @param int $membershipId
453 * @param $changeToday
454 * @param int $membershipTypeID - if provided, overrides the membership type of the $membershipID membership
455 * @param int $numRenewTerms how many membership terms are being added to end date (default is 1)
457 * CRM-7297 Membership Upsell - Added $membershipTypeID param to facilitate calculations of dates when membership type changes
459 * @return Array array fo the start date, end date and join date of the membership
462 public static function getRenewalDatesForMembershipType($membershipId, $changeToday = NULL, $membershipTypeID = NULL, $numRenewTerms = 1) {
463 $params = array('id' => $membershipId);
464 $membershipDetails = CRM_Member_BAO_Membership
::getValues($params, $values);
465 $statusID = $membershipDetails[$membershipId]->status_id
;
467 $oldPeriodType = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
468 CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $membershipId, 'membership_type_id'), 'period_type');
470 // CRM-7297 Membership Upsell
471 if (is_null($membershipTypeID)) {
472 $membershipTypeDetails = self
::getMembershipTypeDetails($membershipDetails[$membershipId]->membership_type_id
);
475 $membershipTypeDetails = self
::getMembershipTypeDetails($membershipTypeID);
477 $statusDetails = CRM_Member_BAO_MembershipStatus
::getMembershipStatus($statusID);
479 if ($statusDetails['is_current_member'] == 1) {
480 $startDate = $membershipDetails[$membershipId]->start_date
;
481 // CRM=7297 Membership Upsell: we need to handle null end_date in case we are switching
482 // from a lifetime to a different membership type
483 if (is_null($membershipDetails[$membershipId]->end_date
)) {
484 $date = date('Y-m-d');
487 $date = $membershipDetails[$membershipId]->end_date
;
489 $date = explode('-', $date);
490 $logStartDate = date('Y-m-d', mktime(0, 0, 0,
492 (double)($date[2] +
1),
496 $date = explode('-', $logStartDate);
501 switch ($membershipTypeDetails['duration_unit']) {
503 //need to check if the upsell is from rolling to fixed and adjust accordingly
504 if ($membershipTypeDetails['period_type'] == 'fixed' && $oldPeriodType == 'rolling' ) {
505 $month = substr($membershipTypeDetails['fixed_period_start_day'], 0, strlen($membershipTypeDetails['fixed_period_start_day']) - 2);
506 $day = substr($membershipTypeDetails['fixed_period_start_day'], -2);
509 $year = $year +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
514 $month = $month +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
518 $day = $day +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
521 if ($membershipTypeDetails['duration_unit'] == 'lifetime') {
525 $endDate = date('Y-m-d', mktime(0, 0, 0,
531 $today = date('Y-m-d');
532 $membershipDates = array();
533 $membershipDates['today'] = CRM_Utils_Date
::customFormat($today, '%Y%m%d');
534 $membershipDates['start_date'] = CRM_Utils_Date
::customFormat($startDate, '%Y%m%d');
535 $membershipDates['end_date'] = CRM_Utils_Date
::customFormat($endDate, '%Y%m%d');
536 $membershipDates['log_start_date'] = CRM_Utils_Date
::customFormat($logStartDate, '%Y%m%d');
539 $today = date('Y-m-d');
541 $today = CRM_Utils_Date
::processDate($changeToday, NULL, FALSE, 'Y-m-d');
543 // Calculate new start/end dates when join date is today
544 $renewalDates = self
::getDatesForMembershipType($membershipTypeDetails['id'],
545 $today, NULL, NULL, $numRenewTerms
547 $membershipDates = array();
548 $membershipDates['today'] = CRM_Utils_Date
::customFormat($today, '%Y%m%d');
549 $membershipDates['start_date'] = $renewalDates['start_date'];
550 $membershipDates['end_date'] = $renewalDates['end_date'];
551 $membershipDates['log_start_date'] = $renewalDates['start_date'];
554 return $membershipDates;
558 * Function to retrieve all Membership Types associated
559 * with an Organization
561 * @param int $orgID Id of Organization
563 * @return Array array of the details of membership types
566 static function getMembershipTypesByOrg($orgID) {
567 $membershipTypes = array();
568 $dao = new CRM_Member_DAO_MembershipType();
569 $dao->member_of_contact_id
= $orgID;
571 while ($dao->fetch()) {
572 $membershipTypes[$dao->id
] = array();
573 CRM_Core_DAO
::storeValues($dao, $membershipTypes[$dao->id
]);
575 return $membershipTypes;
579 * Function to retrieve all Membership Types with Member of Contact id
581 * @param array membership types
583 * @return Array array of the details of membership types with Member of Contact id
586 static function getMemberOfContactByMemTypes($membershipTypes) {
587 $memTypeOrgs = array();
588 if (empty($membershipTypes)) {
592 $result = CRM_Core_DAO
::executeQuery("SELECT id, member_of_contact_id FROM civicrm_membership_type WHERE id IN (" . implode(',', $membershipTypes) . ")");
593 while ($result->fetch()) {
594 $memTypeOrgs[$result->id
] = $result->member_of_contact_id
;
600 /** The function returns all the Organization for all membershiptypes .
601 * @param array $allmembershipTypes array of allMembershipTypes
602 * with organization id Key - value pairs.
605 static function getMembershipTypeOrganization($membershipTypeId = NULL) {
606 $allmembershipTypes = array();
608 $membershipType = new CRM_Member_DAO_MembershipType();
610 if (isset($membershipTypeId)) {
611 $membershipType->id
= $membershipTypeId;
613 $membershipType->find();
615 while ($membershipType->fetch()) {
616 $allmembershipTypes[$membershipType->id
] = $membershipType->member_of_contact_id
;
618 return $allmembershipTypes;
622 * Funtion to retrieve organization and associated membership
625 * @return array arrays of organization and membership types
630 static function getMembershipTypeInfo() {
631 if (!self
::$_membershipTypeInfo) {
632 $orgs = $types = array();
634 $query = 'SELECT memType.id, memType.name, memType.member_of_contact_id, c.sort_name
635 FROM civicrm_membership_type memType INNER JOIN civicrm_contact c ON c.id = memType.member_of_contact_id
636 WHERE memType.is_active = 1 ';
637 $dao = CRM_Core_DAO
::executeQuery( $query );
638 while ($dao->fetch()) {
639 $orgs[$dao->member_of_contact_id
] = $dao->sort_name
;
640 $types[$dao->member_of_contact_id
][$dao->id
] = $dao->name
;
643 self
::$_membershipTypeInfo = array($orgs, $types);
645 return self
::$_membershipTypeInfo;
649 public static function createMembershipPriceField($params, $ids, $previousID, $membershipTypeId) {
651 $priceSetId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', 'default_membership_type_amount', 'id', 'name');
653 if (CRM_Utils_Array
::value('member_of_contact_id', $params)) {
654 $fieldName = $params['member_of_contact_id'];
657 $fieldName = $previousID;
659 $fieldLabel = 'Membership Amount';
661 $fieldParams = array(
662 'price_set_id ' => $priceSetId,
663 'name' => $fieldName,
666 CRM_Price_BAO_PriceField
::retrieve($fieldParams, $results);
667 if (empty($results)) {
668 $fieldParams = array();
669 $fieldParams['label'] = $fieldLabel;
670 $fieldParams['name'] = $fieldName;
671 $fieldParams['price_set_id'] = $priceSetId;
672 $fieldParams['html_type'] = 'Radio';
673 $fieldParams['is_display_amounts'] = $fieldParams['is_required'] = 0;
674 $fieldParams['weight'] = $fieldParams['option_weight'][1] = 1;
675 $fieldParams['option_label'][1] = $params['name'];
676 $fieldParams['option_description'][1] = CRM_Utils_Array
::value('description', $params);
678 $fieldParams['membership_type_id'][1] = $membershipTypeId;
679 $fieldParams['option_amount'][1] = empty($params['minimum_fee']) ?
0 : $params['minimum_fee'];
680 $fieldParams['financial_type_id'] = CRM_Utils_Array
::value('financial_type_id', $params);
683 CRM_Member_Form_MembershipType
::checkPreviousPriceField($previousID, $priceSetId, $membershipTypeId, $optionsIds);
684 $fieldParams['option_id'] = CRM_Utils_Array
::value('option_id', $optionsIds);
686 $priceField = CRM_Price_BAO_PriceField
::create($fieldParams);
689 $fieldID = $results['id'];
690 $fieldValueParams = array(
691 'price_field_id' => $fieldID,
692 'membership_type_id' => $membershipTypeId,
695 CRM_Price_BAO_PriceFieldValue
::retrieve($fieldValueParams, $results);
696 if (!empty($results)) {
697 $results['label'] = $results['name'] = $params['name'];
698 $results['amount'] = empty($params['minimum_fee']) ?
0 : $params['minimum_fee'];
699 $optionsIds['id'] = $results['id'];
703 'price_field_id' => $fieldID,
704 'name' => $params['name'],
705 'label' => $params['name'],
706 'amount' => empty($params['minimum_fee']) ?
0 : $params['minimum_fee'],
707 'membership_type_id' => $membershipTypeId,
713 CRM_Member_Form_MembershipType
::checkPreviousPriceField($previousID, $priceSetId, $membershipTypeId, $optionsIds);
714 if (CRM_Utils_Array
::value('option_id', $optionsIds)) {
715 $optionsIds['id'] = current(CRM_Utils_Array
::value('option_id', $optionsIds));
718 $results['financial_type_id'] = CRM_Utils_Array
::value('financial_type_id', $params);
719 $results['description'] = CRM_Utils_Array
::value('description', $params);
720 CRM_Price_BAO_PriceFieldValue
::add($results, $optionsIds);
724 /** This function updates all price field value for quick config
725 * price set which has membership type
727 * @param integer membership type id
729 * @param integer financial type id
731 static function updateAllPriceFieldValue($membershipTypeId, $params) {
732 if (CRM_Utils_Array
::value('minimum_fee', $params)){
733 $amount = $params['minimum_fee'];
739 $updateValues = array(
740 2 => array('financial_type_id', 'financial_type_id', 'Integer'),
741 3 => array('label', 'name', 'String'),
742 4 => array('amount', 'minimum_fee', 'Float'),
743 5 => array('description', 'description', 'String'),
746 $queryParams = array(1 => array($membershipTypeId, 'Integer'));
747 foreach ($updateValues as $key => $value) {
748 if (array_key_exists($value[1], $params)) {
749 $updateFields[] = "cpfv." . $value[0] . " = %$key";
750 if ($value[1] == 'minimum_fee') {
751 $fieldValue = $amount;
754 $fieldValue = $params[$value[1]];
756 $queryParams[$key] = array($fieldValue, $value[2]);
760 $query = "UPDATE `civicrm_price_field_value` cpfv
761 INNER JOIN civicrm_price_field cpf on cpf.id = cpfv.price_field_id
762 INNER JOIN civicrm_price_set cps on cps.id = cpf.price_set_id
763 SET " . implode(' , ', $updateFields) . " WHERE cpfv.membership_type_id = %1
764 AND cps.is_quick_config = 1 AND cps.name != 'default_membership_type_amount'";
765 CRM_Core_DAO
::executeQuery($query, $queryParams);