3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
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 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
61 static function retrieve(&$params, &$defaults) {
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;
72 * Update the is_active flag in the db
74 * @param int $id id of the database record
75 * @param boolean $is_active value we want to set the is_active field
77 * @return Object DAO object on sucess, null otherwise
80 static function setIsActive($id, $is_active) {
81 return CRM_Core_DAO
::setFieldValue('CRM_Member_DAO_MembershipType', $id, 'is_active', $is_active);
85 * Add the membership types
87 * @param array $params reference array contains the values submitted by the form
88 * @param array $ids array contains the id (deprecated)
95 static function add(&$params, $ids = array()) {
96 $id = CRM_Utils_Array
::value('id', $params, CRM_Utils_Array
::value('membershipType', $ids));
98 if (!isset($params['is_active'])) {
100 $params['is_active'] = FALSE;
102 if (!isset($params['domain_id'])) {
103 $params['domain_id'] = CRM_Core_Config
::domainID();
107 // action is taken depending upon the mode
108 $membershipType = new CRM_Member_DAO_MembershipType();
109 $membershipType->copyValues($params);
110 $membershipType->id
= $id;
112 // $previousID is the old organization id for membership type i.e 'member_of_contact_id'. This is used when an organization is changed.
115 $previousID = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $id, 'member_of_contact_id');
118 $membershipType->save();
120 // on update we may need to retrieve some details for the price field function - otherwise we get e-notices on attempts to retrieve
121 // name etc - the presence of previous id tells us this is an update
122 $params = array_merge(civicrm_api3('membership_type', 'getsingle', array('id' => $membershipType->id
)), $params);
124 self
::createMembershipPriceField($params, $previousID, $membershipType->id
);
125 // update all price field value for quick config when membership type is set CRM-11718
127 self
::updateAllPriceFieldValue($id, $params);
130 return $membershipType;
134 * Delete membership Types
136 * @param int $membershipTypeId
138 * @throws CRM_Core_Exception
142 static function del($membershipTypeId) {
147 'Membership' => 'membership_type_id',
148 'MembershipBlock' => 'membership_type_default',
151 foreach ($dependancy as $name => $field) {
152 $baoString = 'CRM_Member_BAO_' . $name;
153 $dao = new $baoString();
154 $dao->$field = $membershipTypeId;
155 if ($dao->find(TRUE)) {
162 $message = ts('This membership type cannot be deleted due to following reason(s):');
163 if (in_array('Membership', $status)) {
164 $findMembersURL = CRM_Utils_System
::url('civicrm/member/search', 'reset=1');
165 $deleteURL = CRM_Utils_System
::url('civicrm/contact/search/advanced', 'reset=1');
166 $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));
170 if (in_array('MembershipBlock', $status)) {
171 $deleteURL = CRM_Utils_System
::url('civicrm/admin/contribute', 'reset=1');
172 $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));
173 throw new CRM_Core_Exception($message);
176 CRM_Utils_Weight
::delWeight('CRM_Member_DAO_MembershipType', $membershipTypeId);
177 //delete from membership Type table
178 $membershipType = new CRM_Member_DAO_MembershipType();
179 $membershipType->id
= $membershipTypeId;
181 //fix for membership type delete api
183 if ($membershipType->find(TRUE)) {
184 return $membershipType->delete();
191 * Convert membership Type's 'start day' & 'rollover day' to human readable formats.
193 * @param array $membershipType an array of membershipType-details.
196 static function convertDayFormat(&$membershipType) {
198 'fixed_period_start_day',
199 'fixed_period_rollover_day',
201 foreach ($membershipType as $id => $details) {
202 foreach ($periodDays as $pDay) {
203 if (!empty($details[$pDay])) {
204 if ($details[$pDay] > 31) {
205 $month = substr($details[$pDay], 0, strlen($details[$pDay]) - 2);
206 $day = substr($details[$pDay], -2);
221 $membershipType[$id][$pDay] = $monthMap[$month] . ' ' . $day;
224 $membershipType[$id][$pDay] = $details[$pDay];
232 * Get membership Types
234 * @param bool $public
239 static function getMembershipTypes($public = TRUE) {
240 $membershipTypes = array();
241 $membershipType = new CRM_Member_DAO_MembershipType();
242 $membershipType->is_active
= 1;
244 $membershipType->visibility
= 'Public';
246 $membershipType->orderBy(' weight');
247 $membershipType->find();
248 while ($membershipType->fetch()) {
249 $membershipTypes[$membershipType->id
] = $membershipType->name
;
251 $membershipType->free();
252 return $membershipTypes;
256 * Get membership Type Details
258 * @param int $membershipTypeId
263 static function getMembershipTypeDetails($membershipTypeId) {
264 $membershipTypeDetails = array();
266 $membershipType = new CRM_Member_DAO_MembershipType();
267 $membershipType->is_active
= 1;
268 $membershipType->id
= $membershipTypeId;
269 if ($membershipType->find(TRUE)) {
270 CRM_Core_DAO
::storeValues($membershipType, $membershipTypeDetails);
271 $membershipType->free();
272 return $membershipTypeDetails;
280 * Calculate start date and end date for new membership
282 * @param int $membershipTypeId membership type id
283 * @param date $joinDate member since ( in mysql date format )
284 * @param date $startDate start date ( in mysql date format )
285 * @param null $endDate
286 * @param int $numRenewTerms how many membership terms are being added to end date (default is 1)
288 * @return array associated array with start date, end date and join date for the membership
291 public static function getDatesForMembershipType($membershipTypeId, $joinDate = NULL, $startDate = NULL, $endDate = NULL, $numRenewTerms = 1) {
292 $membershipTypeDetails = self
::getMembershipTypeDetails($membershipTypeId);
294 // convert all dates to 'Y-m-d' format.
296 'joinDate', 'startDate', 'endDate') as $dateParam) {
297 if (!empty($
$dateParam)) {
298 $
$dateParam = CRM_Utils_Date
::processDate($
$dateParam, NULL, FALSE, 'Y-m-d');
302 $joinDate = date('Y-m-d');
304 $actualStartDate = $joinDate;
306 $actualStartDate = $startDate;
309 $fixed_period_rollover = FALSE;
310 if (CRM_Utils_Array
::value('period_type', $membershipTypeDetails) == 'rolling') {
312 $startDate = $joinDate;
314 $actualStartDate = $startDate;
316 elseif (CRM_Utils_Array
::value('period_type', $membershipTypeDetails) == 'fixed') {
317 // calculate start date
318 // if !$startDate then use $joinDate
319 $toDay = explode('-', (empty($startDate) ?
$joinDate : $startDate));
324 if ($membershipTypeDetails['duration_unit'] == 'year') {
326 //get start fixed day
327 $startMonth = substr($membershipTypeDetails['fixed_period_start_day'], 0,
328 strlen($membershipTypeDetails['fixed_period_start_day']) - 2
330 $startDay = substr($membershipTypeDetails['fixed_period_start_day'], -2);
332 if (date('Y-m-d', mktime(0, 0, 0, $startMonth, $startDay, $year)) <= date('Y-m-d', mktime(0, 0, 0, $month, $day, $year))) {
333 $fixedStartDate = date('Y-m-d', mktime(0, 0, 0, $startMonth, $startDay, $year));
336 $fixedStartDate = date('Y-m-d', mktime(0, 0, 0, $startMonth, $startDay, $year - 1));
339 //get start rollover day
340 $rolloverMonth = substr($membershipTypeDetails['fixed_period_rollover_day'], 0,
341 strlen($membershipTypeDetails['fixed_period_rollover_day']) - 2
343 $rolloverDay = substr($membershipTypeDetails['fixed_period_rollover_day'], -2);
345 $fixedRolloverDate = date('Y-m-d', mktime(0, 0, 0, $rolloverMonth, $rolloverDay, $year));
347 //CRM-7825 -membership date rules are :
348 //1. Membership should not be start in future.
349 //2. rollover window should be subset of membership window.
351 //store original fixed start date as per current year.
352 $actualStartDate = $fixedStartDate;
354 //store original fixed rollover date as per current year.
355 $actualRolloverDate = $fixedRolloverDate;
357 //get the fixed end date here.
358 $dateParts = explode('-', $actualStartDate);
359 $fixedEndDate = date('Y-m-d', mktime(0, 0, 0,
362 $dateParts[0] +
($numRenewTerms * $membershipTypeDetails['duration_interval'])
365 //make sure rollover window should be
366 //subset of membership period window.
367 if ($fixedEndDate < $actualRolloverDate) {
368 $actualRolloverDate = date('Y-m-d', mktime(0, 0, 0, $rolloverMonth, $rolloverDay, $year - 1));
370 if ($actualRolloverDate < $actualStartDate) {
371 $actualRolloverDate = date('Y-m-d', mktime(0, 0, 0, $rolloverMonth, $rolloverDay, $year +
1));
374 //do check signup is in rollover window.
375 if ($actualRolloverDate <= $joinDate) {
376 $fixed_period_rollover = TRUE;
380 $startDate = $actualStartDate;
383 elseif ($membershipTypeDetails['duration_unit'] == 'month') {
384 // Check if we are on or after rollover day of the month - CRM-10585
385 // If so, set fixed_period_rollover TRUE so we increment end_date month below.
386 $dateParts = explode('-', $actualStartDate);
387 if ($dateParts[2] >= $membershipTypeDetails['fixed_period_rollover_day']){
388 $fixed_period_rollover = True;
391 // Start date is always first day of actualStartDate month
393 $actualStartDate = $startDate = $year . '-' . $month . '-01';
398 //calculate end date if it is not passed by user
400 //end date calculation
401 $date = explode('-', $actualStartDate);
406 switch ($membershipTypeDetails['duration_unit']) {
408 $year = $year +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
409 //extend membership date by duration interval.
410 if ($fixed_period_rollover) {
416 $month = $month +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
417 //duration interval is month
418 if ($fixed_period_rollover) {
425 $day = $day +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
427 if ($fixed_period_rollover) {
428 //Fix Me: Currently we don't allow rollover if
429 //duration interval is day
434 if ($membershipTypeDetails['duration_unit'] == 'lifetime') {
438 $endDate = date('Y-m-d', mktime(0, 0, 0, $month, $day - 1, $year));
442 $membershipDates = array();
445 'start_date' => 'startDate',
446 'end_date' => 'endDate',
447 'join_date' => 'joinDate',
449 foreach ($dates as $varName => $valName) {
450 $membershipDates[$varName] = CRM_Utils_Date
::customFormat($
$valName, '%Y%m%d');
453 return $membershipDates;
457 * Calculate start date and end date for renewal membership
459 * @param int $membershipId
460 * @param $changeToday
461 * @param int $membershipTypeID - if provided, overrides the membership type of the $membershipID membership
462 * @param int $numRenewTerms how many membership terms are being added to end date (default is 1)
464 * CRM-7297 Membership Upsell - Added $membershipTypeID param to facilitate calculations of dates when membership type changes
466 * @return Array array fo the start date, end date and join date of the membership
469 public static function getRenewalDatesForMembershipType($membershipId, $changeToday = NULL, $membershipTypeID = NULL, $numRenewTerms = 1) {
470 $params = array('id' => $membershipId);
471 $membershipDetails = CRM_Member_BAO_Membership
::getValues($params, $values);
472 $statusID = $membershipDetails[$membershipId]->status_id
;
473 $membershipDates = array(
474 'join_date' => CRM_Utils_Date
::customFormat($membershipDetails[$membershipId]->join_date
, '%Y%m%d'),
477 $oldPeriodType = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
478 CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $membershipId, 'membership_type_id'), 'period_type');
480 // CRM-7297 Membership Upsell
481 if (is_null($membershipTypeID)) {
482 $membershipTypeDetails = self
::getMembershipTypeDetails($membershipDetails[$membershipId]->membership_type_id
);
485 $membershipTypeDetails = self
::getMembershipTypeDetails($membershipTypeID);
487 $statusDetails = CRM_Member_BAO_MembershipStatus
::getMembershipStatus($statusID);
489 if ($statusDetails['is_current_member'] == 1) {
490 $startDate = $membershipDetails[$membershipId]->start_date
;
491 // CRM=7297 Membership Upsell: we need to handle null end_date in case we are switching
492 // from a lifetime to a different membership type
493 if (is_null($membershipDetails[$membershipId]->end_date
)) {
494 $date = date('Y-m-d');
497 $date = $membershipDetails[$membershipId]->end_date
;
499 $date = explode('-', $date);
500 $logStartDate = date('Y-m-d', mktime(0, 0, 0,
502 (double)($date[2] +
1),
506 $date = explode('-', $logStartDate);
511 switch ($membershipTypeDetails['duration_unit']) {
513 //need to check if the upsell is from rolling to fixed and adjust accordingly
514 if ($membershipTypeDetails['period_type'] == 'fixed' && $oldPeriodType == 'rolling' ) {
515 $month = substr($membershipTypeDetails['fixed_period_start_day'], 0, strlen($membershipTypeDetails['fixed_period_start_day']) - 2);
516 $day = substr($membershipTypeDetails['fixed_period_start_day'], -2);
519 $year = $year +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
524 $month = $month +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
528 $day = $day +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
531 if ($membershipTypeDetails['duration_unit'] == 'lifetime') {
535 $endDate = date('Y-m-d', mktime(0, 0, 0,
541 $today = date('Y-m-d');
542 $membershipDates['today'] = CRM_Utils_Date
::customFormat($today, '%Y%m%d');
543 $membershipDates['start_date'] = CRM_Utils_Date
::customFormat($startDate, '%Y%m%d');
544 $membershipDates['end_date'] = CRM_Utils_Date
::customFormat($endDate, '%Y%m%d');
545 $membershipDates['log_start_date'] = CRM_Utils_Date
::customFormat($logStartDate, '%Y%m%d');
548 $today = date('Y-m-d');
550 $today = CRM_Utils_Date
::processDate($changeToday, NULL, FALSE, 'Y-m-d');
552 // Calculate new start/end dates when join date is today
553 $renewalDates = self
::getDatesForMembershipType($membershipTypeDetails['id'],
554 $today, NULL, NULL, $numRenewTerms
556 $membershipDates['today'] = CRM_Utils_Date
::customFormat($today, '%Y%m%d');
557 $membershipDates['start_date'] = $renewalDates['start_date'];
558 $membershipDates['end_date'] = $renewalDates['end_date'];
559 $membershipDates['log_start_date'] = $renewalDates['start_date'];
562 return $membershipDates;
566 * Retrieve all Membership Types associated
567 * with an Organization
569 * @param int $orgID Id of Organization
571 * @return Array array of the details of membership types
574 static function getMembershipTypesByOrg($orgID) {
575 $membershipTypes = array();
576 $dao = new CRM_Member_DAO_MembershipType();
577 $dao->member_of_contact_id
= $orgID;
579 while ($dao->fetch()) {
580 $membershipTypes[$dao->id
] = array();
581 CRM_Core_DAO
::storeValues($dao, $membershipTypes[$dao->id
]);
583 return $membershipTypes;
587 * Retrieve all Membership Types with Member of Contact id
589 * @param array membership types
591 * @return Array array of the details of membership types with Member of Contact id
594 static function getMemberOfContactByMemTypes($membershipTypes) {
595 $memTypeOrgs = array();
596 if (empty($membershipTypes)) {
600 $result = CRM_Core_DAO
::executeQuery("SELECT id, member_of_contact_id FROM civicrm_membership_type WHERE id IN (" . implode(',', $membershipTypes) . ")");
601 while ($result->fetch()) {
602 $memTypeOrgs[$result->id
] = $result->member_of_contact_id
;
609 * The function returns all the Organization for all membershiptypes .
611 * @param int $membershipTypeId
615 static function getMembershipTypeOrganization($membershipTypeId = NULL) {
616 $allmembershipTypes = array();
618 $membershipType = new CRM_Member_DAO_MembershipType();
620 if (isset($membershipTypeId)) {
621 $membershipType->id
= $membershipTypeId;
623 $membershipType->find();
625 while ($membershipType->fetch()) {
626 $allmembershipTypes[$membershipType->id
] = $membershipType->member_of_contact_id
;
628 return $allmembershipTypes;
632 * Funtion to retrieve organization and associated membership
635 * @return array arrays of organization and membership types
640 static function getMembershipTypeInfo() {
641 if (!self
::$_membershipTypeInfo) {
642 $orgs = $types = array();
644 $query = 'SELECT memType.id, memType.name, memType.member_of_contact_id, c.sort_name
645 FROM civicrm_membership_type memType INNER JOIN civicrm_contact c ON c.id = memType.member_of_contact_id
646 WHERE memType.is_active = 1 ';
647 $dao = CRM_Core_DAO
::executeQuery( $query );
648 while ($dao->fetch()) {
649 $orgs[$dao->member_of_contact_id
] = $dao->sort_name
;
650 $types[$dao->member_of_contact_id
][$dao->id
] = $dao->name
;
653 self
::$_membershipTypeInfo = array($orgs, $types);
655 return self
::$_membershipTypeInfo;
660 * @param array $params
661 * @param int $previousID
662 * @param int $membershipTypeId
664 public static function createMembershipPriceField($params, $previousID, $membershipTypeId) {
666 $priceSetId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', 'default_membership_type_amount', 'id', 'name');
668 if (!empty($params['member_of_contact_id'])) {
669 $fieldName = $params['member_of_contact_id'];
672 $fieldName = $previousID;
674 $fieldLabel = 'Membership Amount';
676 $fieldParams = array(
677 'price_set_id ' => $priceSetId,
678 'name' => $fieldName,
681 CRM_Price_BAO_PriceField
::retrieve($fieldParams, $results);
682 if (empty($results)) {
683 $fieldParams = array();
684 $fieldParams['label'] = $fieldLabel;
685 $fieldParams['name'] = $fieldName;
686 $fieldParams['price_set_id'] = $priceSetId;
687 $fieldParams['html_type'] = 'Radio';
688 $fieldParams['is_display_amounts'] = $fieldParams['is_required'] = 0;
689 $fieldParams['weight'] = $fieldParams['option_weight'][1] = 1;
690 $fieldParams['option_label'][1] = $params['name'];
691 $fieldParams['option_description'][1] = CRM_Utils_Array
::value('description', $params);
693 $fieldParams['membership_type_id'][1] = $membershipTypeId;
694 $fieldParams['option_amount'][1] = empty($params['minimum_fee']) ?
0 : $params['minimum_fee'];
695 $fieldParams['financial_type_id'] = CRM_Utils_Array
::value('financial_type_id', $params);
698 CRM_Member_Form_MembershipType
::checkPreviousPriceField($previousID, $priceSetId, $membershipTypeId, $optionsIds);
699 $fieldParams['option_id'] = CRM_Utils_Array
::value('option_id', $optionsIds);
701 CRM_Price_BAO_PriceField
::create($fieldParams);
704 $fieldID = $results['id'];
705 $fieldValueParams = array(
706 'price_field_id' => $fieldID,
707 'membership_type_id' => $membershipTypeId,
710 CRM_Price_BAO_PriceFieldValue
::retrieve($fieldValueParams, $results);
711 if (!empty($results)) {
712 $results['label'] = $results['name'] = $params['name'];
713 $results['amount'] = empty($params['minimum_fee']) ?
0 : $params['minimum_fee'];
714 $optionsIds['id'] = $results['id'];
718 'price_field_id' => $fieldID,
719 'name' => $params['name'],
720 'label' => $params['name'],
721 'amount' => empty($params['minimum_fee']) ?
0 : $params['minimum_fee'],
722 'membership_type_id' => $membershipTypeId,
728 CRM_Member_Form_MembershipType
::checkPreviousPriceField($previousID, $priceSetId, $membershipTypeId, $optionsIds);
729 if (!empty($optionsIds['option_id'])) {
730 $optionsIds['id'] = current(CRM_Utils_Array
::value('option_id', $optionsIds));
733 $results['financial_type_id'] = CRM_Utils_Array
::value('financial_type_id', $params);
734 $results['description'] = CRM_Utils_Array
::value('description', $params);
735 CRM_Price_BAO_PriceFieldValue
::add($results, $optionsIds);
739 /** This function updates all price field value for quick config
740 * price set which has membership type
742 * @param integer membership type id
744 * @param integer financial type id
746 static function updateAllPriceFieldValue($membershipTypeId, $params) {
747 if (!empty($params['minimum_fee'])){
748 $amount = $params['minimum_fee'];
754 $updateValues = array(
755 2 => array('financial_type_id', 'financial_type_id', 'Integer'),
756 3 => array('label', 'name', 'String'),
757 4 => array('amount', 'minimum_fee', 'Float'),
758 5 => array('description', 'description', 'String'),
761 $queryParams = array(1 => array($membershipTypeId, 'Integer'));
762 foreach ($updateValues as $key => $value) {
763 if (array_key_exists($value[1], $params)) {
764 $updateFields[] = "cpfv." . $value[0] . " = %$key";
765 if ($value[1] == 'minimum_fee') {
766 $fieldValue = $amount;
769 $fieldValue = $params[$value[1]];
771 $queryParams[$key] = array($fieldValue, $value[2]);
775 $query = "UPDATE `civicrm_price_field_value` cpfv
776 INNER JOIN civicrm_price_field cpf on cpf.id = cpfv.price_field_id
777 INNER JOIN civicrm_price_set cps on cps.id = cpf.price_set_id
778 SET " . implode(' , ', $updateFields) . " WHERE cpfv.membership_type_id = %1
779 AND cps.is_quick_config = 1 AND cps.name != 'default_membership_type_amount'";
780 CRM_Core_DAO
::executeQuery($query, $queryParams);