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
55 * (reference ) an assoc array of name/value pairs.
56 * @param array $defaults
57 * (reference ) an assoc array to hold the flattened values.
59 * @return CRM_Member_BAO_MembershipType
61 public 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
75 * Id of the database record.
76 * @param bool $is_active
77 * Value we want to set the is_active field.
80 * DAO object on sucess, null otherwise
82 public static function setIsActive($id, $is_active) {
83 return CRM_Core_DAO
::setFieldValue('CRM_Member_DAO_MembershipType', $id, 'is_active', $is_active);
87 * Add the membership types
89 * @param array $params
90 * Reference array contains the values submitted by the form.
92 * Array contains the id (deprecated).
97 public static function add(&$params, $ids = array()) {
98 $id = CRM_Utils_Array
::value('id', $params, CRM_Utils_Array
::value('membershipType', $ids));
100 if (!isset($params['is_active'])) {
102 $params['is_active'] = FALSE;
104 if (!isset($params['domain_id'])) {
105 $params['domain_id'] = CRM_Core_Config
::domainID();
109 // action is taken depending upon the mode
110 $membershipType = new CRM_Member_DAO_MembershipType();
111 $membershipType->copyValues($params);
112 $membershipType->id
= $id;
114 // $previousID is the old organization id for membership type i.e 'member_of_contact_id'. This is used when an organization is changed.
117 $previousID = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $id, 'member_of_contact_id');
120 $membershipType->save();
122 // on update we may need to retrieve some details for the price field function - otherwise we get e-notices on attempts to retrieve
123 // name etc - the presence of previous id tells us this is an update
124 $params = array_merge(civicrm_api3('membership_type', 'getsingle', array('id' => $membershipType->id
)), $params);
126 self
::createMembershipPriceField($params, $previousID, $membershipType->id
);
127 // update all price field value for quick config when membership type is set CRM-11718
129 self
::updateAllPriceFieldValue($id, $params);
132 return $membershipType;
136 * Delete membership Types
138 * @param int $membershipTypeId
140 * @throws CRM_Core_Exception
143 public static function del($membershipTypeId) {
148 'Membership' => 'membership_type_id',
149 'MembershipBlock' => 'membership_type_default',
152 foreach ($dependancy as $name => $field) {
153 $baoString = 'CRM_Member_BAO_' . $name;
154 $dao = new $baoString();
155 $dao->$field = $membershipTypeId;
156 if ($dao->find(TRUE)) {
163 $message = ts('This membership type cannot be deleted due to following reason(s):');
164 if (in_array('Membership', $status)) {
165 $findMembersURL = CRM_Utils_System
::url('civicrm/member/search', 'reset=1');
166 $deleteURL = CRM_Utils_System
::url('civicrm/contact/search/advanced', 'reset=1');
167 $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(
168 1 => $findMembersURL,
175 if (in_array('MembershipBlock', $status)) {
176 $deleteURL = CRM_Utils_System
::url('civicrm/admin/contribute', 'reset=1');
177 $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(
181 throw new CRM_Core_Exception($message);
184 CRM_Utils_Weight
::delWeight('CRM_Member_DAO_MembershipType', $membershipTypeId);
185 //delete from membership Type table
186 $membershipType = new CRM_Member_DAO_MembershipType();
187 $membershipType->id
= $membershipTypeId;
189 //fix for membership type delete api
191 if ($membershipType->find(TRUE)) {
192 return $membershipType->delete();
199 * Convert membership Type's 'start day' & 'rollover day' to human readable formats.
201 * @param array $membershipType
202 * An array of membershipType-details.
204 public static function convertDayFormat(&$membershipType) {
206 'fixed_period_start_day',
207 'fixed_period_rollover_day',
209 foreach ($membershipType as $id => $details) {
210 foreach ($periodDays as $pDay) {
211 if (!empty($details[$pDay])) {
212 if ($details[$pDay] > 31) {
213 $month = substr($details[$pDay], 0, strlen($details[$pDay]) - 2);
214 $day = substr($details[$pDay], -2);
229 $membershipType[$id][$pDay] = $monthMap[$month] . ' ' . $day;
232 $membershipType[$id][$pDay] = $details[$pDay];
240 * Get membership Types
242 * @param bool $public
246 public static function getMembershipTypes($public = TRUE) {
247 $membershipTypes = array();
248 $membershipType = new CRM_Member_DAO_MembershipType();
249 $membershipType->is_active
= 1;
251 $membershipType->visibility
= 'Public';
253 $membershipType->orderBy(' weight');
254 $membershipType->find();
255 while ($membershipType->fetch()) {
256 $membershipTypes[$membershipType->id
] = $membershipType->name
;
258 $membershipType->free();
259 return $membershipTypes;
263 * Get membership Type Details
265 * @param int $membershipTypeId
269 public static function getMembershipTypeDetails($membershipTypeId) {
270 $membershipTypeDetails = array();
272 $membershipType = new CRM_Member_DAO_MembershipType();
273 $membershipType->is_active
= 1;
274 $membershipType->id
= $membershipTypeId;
275 if ($membershipType->find(TRUE)) {
276 CRM_Core_DAO
::storeValues($membershipType, $membershipTypeDetails);
277 $membershipType->free();
278 return $membershipTypeDetails;
286 * Calculate start date and end date for new membership
288 * @param int $membershipTypeId
289 * Membership type id.
290 * @param date $joinDate
291 * Member since ( in mysql date format ).
292 * @param date $startDate
293 * Start date ( in mysql date format ).
294 * @param null $endDate
295 * @param int $numRenewTerms
296 * How many membership terms are being added to end date (default is 1).
299 * associated array with start date, end date and join date for the membership
301 public static function getDatesForMembershipType($membershipTypeId, $joinDate = NULL, $startDate = NULL, $endDate = NULL, $numRenewTerms = 1) {
302 $membershipTypeDetails = self
::getMembershipTypeDetails($membershipTypeId);
304 // convert all dates to 'Y-m-d' format.
310 if (!empty($
$dateParam)) {
311 $
$dateParam = CRM_Utils_Date
::processDate($
$dateParam, NULL, FALSE, 'Y-m-d');
315 $joinDate = date('Y-m-d');
317 $actualStartDate = $joinDate;
319 $actualStartDate = $startDate;
322 $fixed_period_rollover = FALSE;
323 if (CRM_Utils_Array
::value('period_type', $membershipTypeDetails) == 'rolling') {
325 $startDate = $joinDate;
327 $actualStartDate = $startDate;
329 elseif (CRM_Utils_Array
::value('period_type', $membershipTypeDetails) == 'fixed') {
330 // calculate start date
331 // if !$startDate then use $joinDate
332 $toDay = explode('-', (empty($startDate) ?
$joinDate : $startDate));
337 if ($membershipTypeDetails['duration_unit'] == 'year') {
339 //get start fixed day
340 $startMonth = substr($membershipTypeDetails['fixed_period_start_day'], 0,
341 strlen($membershipTypeDetails['fixed_period_start_day']) - 2
343 $startDay = substr($membershipTypeDetails['fixed_period_start_day'], -2);
345 if (date('Y-m-d', mktime(0, 0, 0, $startMonth, $startDay, $year)) <= date('Y-m-d', mktime(0, 0, 0, $month, $day, $year))) {
346 $fixedStartDate = date('Y-m-d', mktime(0, 0, 0, $startMonth, $startDay, $year));
349 $fixedStartDate = date('Y-m-d', mktime(0, 0, 0, $startMonth, $startDay, $year - 1));
352 //get start rollover day
353 $rolloverMonth = substr($membershipTypeDetails['fixed_period_rollover_day'], 0,
354 strlen($membershipTypeDetails['fixed_period_rollover_day']) - 2
356 $rolloverDay = substr($membershipTypeDetails['fixed_period_rollover_day'], -2);
358 $fixedRolloverDate = date('Y-m-d', mktime(0, 0, 0, $rolloverMonth, $rolloverDay, $year));
360 //CRM-7825 -membership date rules are :
361 //1. Membership should not be start in future.
362 //2. rollover window should be subset of membership window.
364 //store original fixed start date as per current year.
365 $actualStartDate = $fixedStartDate;
367 //store original fixed rollover date as per current year.
368 $actualRolloverDate = $fixedRolloverDate;
370 //get the fixed end date here.
371 $dateParts = explode('-', $actualStartDate);
372 $fixedEndDate = date('Y-m-d', mktime(0, 0, 0,
375 $dateParts[0] +
($numRenewTerms * $membershipTypeDetails['duration_interval'])
378 //make sure rollover window should be
379 //subset of membership period window.
380 if ($fixedEndDate < $actualRolloverDate) {
381 $actualRolloverDate = date('Y-m-d', mktime(0, 0, 0, $rolloverMonth, $rolloverDay, $year - 1));
383 if ($actualRolloverDate < $actualStartDate) {
384 $actualRolloverDate = date('Y-m-d', mktime(0, 0, 0, $rolloverMonth, $rolloverDay, $year +
1));
387 //do check signup is in rollover window.
388 if ($actualRolloverDate <= $joinDate) {
389 $fixed_period_rollover = TRUE;
393 $startDate = $actualStartDate;
396 elseif ($membershipTypeDetails['duration_unit'] == 'month') {
397 // Check if we are on or after rollover day of the month - CRM-10585
398 // If so, set fixed_period_rollover TRUE so we increment end_date month below.
399 $dateParts = explode('-', $actualStartDate);
400 if ($dateParts[2] >= $membershipTypeDetails['fixed_period_rollover_day']) {
401 $fixed_period_rollover = TRUE;
404 // Start date is always first day of actualStartDate month
406 $actualStartDate = $startDate = $year . '-' . $month . '-01';
411 //calculate end date if it is not passed by user
413 //end date calculation
414 $date = explode('-', $actualStartDate);
419 switch ($membershipTypeDetails['duration_unit']) {
421 $year = $year +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
422 //extend membership date by duration interval.
423 if ($fixed_period_rollover) {
429 $month = $month +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
430 //duration interval is month
431 if ($fixed_period_rollover) {
438 $day = $day +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
440 if ($fixed_period_rollover) {
441 //Fix Me: Currently we don't allow rollover if
442 //duration interval is day
447 if ($membershipTypeDetails['duration_unit'] == 'lifetime') {
451 $endDate = date('Y-m-d', mktime(0, 0, 0, $month, $day - 1, $year));
455 $membershipDates = array();
458 'start_date' => 'startDate',
459 'end_date' => 'endDate',
460 'join_date' => 'joinDate',
462 foreach ($dates as $varName => $valName) {
463 $membershipDates[$varName] = CRM_Utils_Date
::customFormat($
$valName, '%Y%m%d');
466 return $membershipDates;
470 * Calculate start date and end date for renewal membership
472 * @param int $membershipId
473 * @param $changeToday
474 * @param int $membershipTypeID
475 * If provided, overrides the membership type of the $membershipID membership.
476 * @param int $numRenewTerms
477 * How many membership terms are being added to end date (default is 1).
479 * CRM-7297 Membership Upsell - Added $membershipTypeID param to facilitate calculations of dates when membership type changes
482 * array fo the start date, end date and join date of the membership
484 public static function getRenewalDatesForMembershipType($membershipId, $changeToday = NULL, $membershipTypeID = NULL, $numRenewTerms = 1) {
485 $params = array('id' => $membershipId);
486 $membershipDetails = CRM_Member_BAO_Membership
::getValues($params, $values);
487 $statusID = $membershipDetails[$membershipId]->status_id
;
488 $membershipDates = array(
489 'join_date' => CRM_Utils_Date
::customFormat($membershipDetails[$membershipId]->join_date
, '%Y%m%d'),
492 $oldPeriodType = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
493 CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $membershipId, 'membership_type_id'), 'period_type');
495 // CRM-7297 Membership Upsell
496 if (is_null($membershipTypeID)) {
497 $membershipTypeDetails = self
::getMembershipTypeDetails($membershipDetails[$membershipId]->membership_type_id
);
500 $membershipTypeDetails = self
::getMembershipTypeDetails($membershipTypeID);
502 $statusDetails = CRM_Member_BAO_MembershipStatus
::getMembershipStatus($statusID);
504 if ($statusDetails['is_current_member'] == 1) {
505 $startDate = $membershipDetails[$membershipId]->start_date
;
506 // CRM=7297 Membership Upsell: we need to handle null end_date in case we are switching
507 // from a lifetime to a different membership type
508 if (is_null($membershipDetails[$membershipId]->end_date
)) {
509 $date = date('Y-m-d');
512 $date = $membershipDetails[$membershipId]->end_date
;
514 $date = explode('-', $date);
515 $logStartDate = date('Y-m-d', mktime(0, 0, 0,
517 (double) ($date[2] +
1),
521 $date = explode('-', $logStartDate);
526 switch ($membershipTypeDetails['duration_unit']) {
528 //need to check if the upsell is from rolling to fixed and adjust accordingly
529 if ($membershipTypeDetails['period_type'] == 'fixed' && $oldPeriodType == 'rolling') {
530 $month = substr($membershipTypeDetails['fixed_period_start_day'], 0, strlen($membershipTypeDetails['fixed_period_start_day']) - 2);
531 $day = substr($membershipTypeDetails['fixed_period_start_day'], -2);
535 $year = $year +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
540 $month = $month +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
544 $day = $day +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
547 if ($membershipTypeDetails['duration_unit'] == 'lifetime') {
551 $endDate = date('Y-m-d', mktime(0, 0, 0,
557 $today = date('Y-m-d');
558 $membershipDates['today'] = CRM_Utils_Date
::customFormat($today, '%Y%m%d');
559 $membershipDates['start_date'] = CRM_Utils_Date
::customFormat($startDate, '%Y%m%d');
560 $membershipDates['end_date'] = CRM_Utils_Date
::customFormat($endDate, '%Y%m%d');
561 $membershipDates['log_start_date'] = CRM_Utils_Date
::customFormat($logStartDate, '%Y%m%d');
564 $today = date('Y-m-d');
566 $today = CRM_Utils_Date
::processDate($changeToday, NULL, FALSE, 'Y-m-d');
568 // Calculate new start/end dates when join date is today
569 $renewalDates = self
::getDatesForMembershipType($membershipTypeDetails['id'],
570 $today, NULL, NULL, $numRenewTerms
572 $membershipDates['today'] = CRM_Utils_Date
::customFormat($today, '%Y%m%d');
573 $membershipDates['start_date'] = $renewalDates['start_date'];
574 $membershipDates['end_date'] = $renewalDates['end_date'];
575 $membershipDates['log_start_date'] = $renewalDates['start_date'];
578 return $membershipDates;
582 * Retrieve all Membership Types associated
583 * with an Organization
586 * Id of Organization.
589 * array of the details of membership types
591 public static function getMembershipTypesByOrg($orgID) {
592 $membershipTypes = array();
593 $dao = new CRM_Member_DAO_MembershipType();
594 $dao->member_of_contact_id
= $orgID;
596 while ($dao->fetch()) {
597 $membershipTypes[$dao->id
] = array();
598 CRM_Core_DAO
::storeValues($dao, $membershipTypes[$dao->id
]);
600 return $membershipTypes;
604 * Retrieve all Membership Types with Member of Contact id
606 * @param array $membershipTypes
607 * array of membership type ids
609 * array of the details of membership types with Member of Contact id
611 public static function getMemberOfContactByMemTypes($membershipTypes) {
612 $memTypeOrgs = array();
613 if (empty($membershipTypes)) {
617 $result = CRM_Core_DAO
::executeQuery("SELECT id, member_of_contact_id FROM civicrm_membership_type WHERE id IN (" . implode(',', $membershipTypes) . ")");
618 while ($result->fetch()) {
619 $memTypeOrgs[$result->id
] = $result->member_of_contact_id
;
626 * The function returns all the Organization for all membershiptypes .
628 * @param int $membershipTypeId
632 public static function getMembershipTypeOrganization($membershipTypeId = NULL) {
633 $allmembershipTypes = array();
635 $membershipType = new CRM_Member_DAO_MembershipType();
637 if (isset($membershipTypeId)) {
638 $membershipType->id
= $membershipTypeId;
640 $membershipType->find();
642 while ($membershipType->fetch()) {
643 $allmembershipTypes[$membershipType->id
] = $membershipType->member_of_contact_id
;
645 return $allmembershipTypes;
649 * Funtion to retrieve organization and associated membership
653 * arrays of organization and membership types
656 public static function getMembershipTypeInfo() {
657 if (!self
::$_membershipTypeInfo) {
658 $orgs = $types = array();
660 $query = 'SELECT memType.id, memType.name, memType.member_of_contact_id, c.sort_name
661 FROM civicrm_membership_type memType INNER JOIN civicrm_contact c ON c.id = memType.member_of_contact_id
662 WHERE memType.is_active = 1 ';
663 $dao = CRM_Core_DAO
::executeQuery($query);
664 while ($dao->fetch()) {
665 $orgs[$dao->member_of_contact_id
] = $dao->sort_name
;
666 $types[$dao->member_of_contact_id
][$dao->id
] = $dao->name
;
669 self
::$_membershipTypeInfo = array($orgs, $types);
671 return self
::$_membershipTypeInfo;
676 * @param array $params
677 * @param int $previousID
678 * @param int $membershipTypeId
680 public static function createMembershipPriceField($params, $previousID, $membershipTypeId) {
682 $priceSetId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', 'default_membership_type_amount', 'id', 'name');
684 if (!empty($params['member_of_contact_id'])) {
685 $fieldName = $params['member_of_contact_id'];
688 $fieldName = $previousID;
690 $fieldLabel = 'Membership Amount';
692 $fieldParams = array(
693 'price_set_id ' => $priceSetId,
694 'name' => $fieldName,
697 CRM_Price_BAO_PriceField
::retrieve($fieldParams, $results);
698 if (empty($results)) {
699 $fieldParams = array();
700 $fieldParams['label'] = $fieldLabel;
701 $fieldParams['name'] = $fieldName;
702 $fieldParams['price_set_id'] = $priceSetId;
703 $fieldParams['html_type'] = 'Radio';
704 $fieldParams['is_display_amounts'] = $fieldParams['is_required'] = 0;
705 $fieldParams['weight'] = $fieldParams['option_weight'][1] = 1;
706 $fieldParams['option_label'][1] = $params['name'];
707 $fieldParams['option_description'][1] = CRM_Utils_Array
::value('description', $params);
709 $fieldParams['membership_type_id'][1] = $membershipTypeId;
710 $fieldParams['option_amount'][1] = empty($params['minimum_fee']) ?
0 : $params['minimum_fee'];
711 $fieldParams['financial_type_id'] = CRM_Utils_Array
::value('financial_type_id', $params);
714 CRM_Member_Form_MembershipType
::checkPreviousPriceField($previousID, $priceSetId, $membershipTypeId, $optionsIds);
715 $fieldParams['option_id'] = CRM_Utils_Array
::value('option_id', $optionsIds);
717 CRM_Price_BAO_PriceField
::create($fieldParams);
720 $fieldID = $results['id'];
721 $fieldValueParams = array(
722 'price_field_id' => $fieldID,
723 'membership_type_id' => $membershipTypeId,
726 CRM_Price_BAO_PriceFieldValue
::retrieve($fieldValueParams, $results);
727 if (!empty($results)) {
728 $results['label'] = $results['name'] = $params['name'];
729 $results['amount'] = empty($params['minimum_fee']) ?
0 : $params['minimum_fee'];
730 $optionsIds['id'] = $results['id'];
734 'price_field_id' => $fieldID,
735 'name' => $params['name'],
736 'label' => $params['name'],
737 'amount' => empty($params['minimum_fee']) ?
0 : $params['minimum_fee'],
738 'membership_type_id' => $membershipTypeId,
744 CRM_Member_Form_MembershipType
::checkPreviousPriceField($previousID, $priceSetId, $membershipTypeId, $optionsIds);
745 if (!empty($optionsIds['option_id'])) {
746 $optionsIds['id'] = current(CRM_Utils_Array
::value('option_id', $optionsIds));
749 $results['financial_type_id'] = CRM_Utils_Array
::value('financial_type_id', $params);
750 $results['description'] = CRM_Utils_Array
::value('description', $params);
751 CRM_Price_BAO_PriceFieldValue
::add($results, $optionsIds);
755 /** * This function updates all price field value for quick config
756 * price set which has membership type
758 * @param int $membershipTypeId membership type id
760 * @param array $params
762 public static function updateAllPriceFieldValue($membershipTypeId, $params) {
763 if (!empty($params['minimum_fee'])) {
764 $amount = $params['minimum_fee'];
770 $updateValues = array(
771 2 => array('financial_type_id', 'financial_type_id', 'Integer'),
772 3 => array('label', 'name', 'String'),
773 4 => array('amount', 'minimum_fee', 'Float'),
774 5 => array('description', 'description', 'String'),
777 $queryParams = array(1 => array($membershipTypeId, 'Integer'));
778 foreach ($updateValues as $key => $value) {
779 if (array_key_exists($value[1], $params)) {
780 $updateFields[] = "cpfv." . $value[0] . " = %$key";
781 if ($value[1] == 'minimum_fee') {
782 $fieldValue = $amount;
785 $fieldValue = $params[$value[1]];
787 $queryParams[$key] = array($fieldValue, $value[2]);
791 $query = "UPDATE `civicrm_price_field_value` cpfv
792 INNER JOIN civicrm_price_field cpf on cpf.id = cpfv.price_field_id
793 INNER JOIN civicrm_price_set cps on cps.id = cpf.price_set_id
794 SET " . implode(' , ', $updateFields) . " WHERE cpfv.membership_type_id = %1
795 AND cps.is_quick_config = 1 AND cps.name != 'default_membership_type_amount'";
796 CRM_Core_DAO
::executeQuery($query, $queryParams);