3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
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_Membership
extends CRM_Member_DAO_Membership
{
38 * static field for all the membership information that we can potentially import
43 static $_importableFields = NULL;
45 static $_renewalActType = NULL;
47 static $_signupActType = NULL;
49 function __construct() {
50 parent
::__construct();
54 * takes an associative array and creates a membership object
56 * the function extracts all the params it needs to initialize the created
57 * membership object. The params array could contain additional unused name/value
60 * @param array $params (reference ) an assoc array of name/value pairs
61 * @param array $ids the array that holds all the db ids
63 * @return object CRM_Member_BAO_Membership object
67 static function &add(&$params, &$ids) {
69 if (!empty($ids['membership'])) {
70 CRM_Utils_Hook
::pre('edit', 'Membership', $ids['membership'], $params);
73 $membershipObj = new CRM_Member_DAO_Membership();
74 $membershipObj->id
= $ids['membership'];
75 $membershipObj->find();
76 while ($membershipObj->fetch()) {
77 $oldStatus = $membershipObj->status_id
;
78 $oldType = $membershipObj->membership_type_id
;
82 CRM_Utils_Hook
::pre('create', 'Membership', NULL, $params);
85 if (array_key_exists('is_override', $params) && !$params['is_override']) {
86 $params['is_override'] = 'null';
89 $membership = new CRM_Member_BAO_Membership();
90 $membership->copyValues($params);
91 $membership->id
= CRM_Utils_Array
::value('membership', $ids);
96 if (empty($membership->contact_id
) ||
empty($membership->status_id
)) {
97 // this means we are in renewal mode and are just updating the membership
98 // record or this is an API update call and all fields are not present in the update record
99 // however the hooks dont care and want all data CRM-7784
100 $tempMembership = new CRM_Member_DAO_Membership();
101 $tempMembership->id
= $membership->id
;
102 $tempMembership->find(TRUE);
103 $membership = $tempMembership;
106 //get the log start date.
107 //it is set during renewal of membership.
108 $logStartDate = CRM_Utils_Array
::value('log_start_date', $params);
109 $logStartDate = ($logStartDate) ? CRM_Utils_Date
::isoToMysql($logStartDate) : CRM_Utils_Date
::isoToMysql($membership->start_date
);
110 $values = self
::getStatusANDTypeValues($membership->id
);
112 $membershipLog = array(
113 'membership_id' => $membership->id
,
114 'status_id' => $membership->status_id
,
115 'start_date' => $logStartDate,
116 'end_date' => CRM_Utils_Date
::isoToMysql($membership->end_date
),
117 'modified_date' => date('Ymd'),
118 'membership_type_id' => $values[$membership->id
]['membership_type_id'],
119 'max_related' => $membership->max_related
,
122 $session = CRM_Core_Session
::singleton();
123 // If we have an authenticated session, set modified_id to that user's contact_id, else set to membership.contact_id
124 if ($session->get('userID')) {
125 $membershipLog['modified_id'] = $session->get('userID');
127 elseif (!empty($ids['userId'])) {
128 $membershipLog['modified_id'] = $ids['userId'];
131 $membershipLog['modified_id'] = $membership->contact_id
;
134 CRM_Member_BAO_MembershipLog
::add($membershipLog, CRM_Core_DAO
::$_nullArray);
136 // reset the group contact cache since smart groups might be affected due to this
137 CRM_Contact_BAO_GroupContactCache
::remove();
139 if (!empty($ids['membership'])) {
140 if ($membership->status_id
!= $oldStatus) {
141 $allStatus = CRM_Member_BAO_Membership
::buildOptions('status_id', 'get');
142 $activityParam = array(
143 'subject' => "Status changed from {$allStatus[$oldStatus]} to {$allStatus[$membership->status_id]}",
144 'source_contact_id' => $membershipLog['modified_id'],
145 'target_contact_id' => $membership->contact_id
,
146 'source_record_id' => $membership->id
,
147 'activity_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Change Membership Status'),
150 'activity_date_time' => date('Y-m-d H:i:s'),
152 civicrm_api3('activity', 'create', $activityParam);
154 if (isset($membership->membership_type_id
) && $membership->membership_type_id
!= $oldType) {
155 $membershipTypes = CRM_Member_BAO_Membership
::buildOptions('membership_type_id', 'get');
156 $activityParam = array(
157 'subject' => "Type changed from {$membershipTypes[$oldType]} to {$membershipTypes[$membership->membership_type_id]}",
158 'source_contact_id' => $membershipLog['modified_id'],
159 'target_contact_id' => $membership->contact_id
,
160 'source_record_id' => $membership->id
,
161 'activity_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Change Membership Type'),
164 'activity_date_time' => date('Y-m-d H:i:s'),
166 civicrm_api3('activity', 'create', $activityParam);
168 CRM_Utils_Hook
::post('edit', 'Membership', $membership->id
, $membership);
171 CRM_Utils_Hook
::post('create', 'Membership', $membership->id
, $membership);
178 * Given the list of params in the params array, fetch the object
179 * and store the values in the values array
181 * @param array $params input parameters to find object
182 * @param array $values output values of the object
183 * @param boolean $active do you want only active memberships to
186 * @return CRM_Member_BAO_Membership|null the found object or null
190 static function &getValues(&$params, &$values, $active = FALSE) {
191 if (empty($params)) {
194 $membership = new CRM_Member_BAO_Membership();
196 $membership->copyValues($params);
198 $memberships = array();
199 while ($membership->fetch()) {
201 (!CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus',
202 $membership->status_id
,
209 CRM_Core_DAO
::storeValues($membership, $values[$membership->id
]);
210 $memberships[$membership->id
] = $membership;
217 * takes an associative array and creates a membership object
219 * @param array $params (reference ) an assoc array of name/value pairs
220 * @param array $ids the array that holds all the db ids
221 * @param boolean $callFromAPI Is this function called from API?
223 * @return object CRM_Member_BAO_Membership object
227 static function &create(&$params, &$ids, $skipRedirect = FALSE, $activityType = 'Membership Signup') {
228 // always calculate status if is_override/skipStatusCal is not true.
229 // giving respect to is_override during import. CRM-4012
231 // To skip status calculation we should use 'skipStatusCal'.
232 // eg pay later membership, membership update cron CRM-3984
234 if (empty($params['is_override']) && empty($params['skipStatusCal'])) {
235 $dates = array('start_date', 'end_date', 'join_date');
236 $start_date = $end_date = $join_date = NULL; // declare these out of courtesy as IDEs don't pick up the setting of them below
237 foreach ($dates as $date) {
238 $
$date = $params[$date] = CRM_Utils_Date
::processDate(CRM_Utils_Array
::value($date, $params), NULL, TRUE, 'Ymd');
241 //fix for CRM-3570, during import exclude the statuses those having is_admin = 1
242 $excludeIsAdmin = CRM_Utils_Array
::value('exclude_is_admin', $params, FALSE);
244 //CRM-3724 always skip is_admin if is_override != true.
245 if (!$excludeIsAdmin && empty($params['is_override'])) {
246 $excludeIsAdmin = TRUE;
249 $calcStatus = $calcStatus = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($start_date, $end_date, $join_date,
250 'today', $excludeIsAdmin
252 if (empty($calcStatus)) {
253 // Redirect the form in case of error
254 // @todo this redirect in the BAO layer is really bad & should be moved to the form layer
255 // however since we have no idea how (if) this is triggered we can't safely move / remove it
256 // NB I tried really hard to trigger this error from backoffice membership form in order to test it
257 // and am convinced form validation is complete on that form WRT this error.
258 $errorParams = array(
259 'message_title' => ts('No valid membership status for given dates.'),
260 'legacy_redirect_path' => 'civicrm/contact/view',
261 'legacy_redirect_query' => "reset=1&force=1&cid={$params['contact_id']}&selectedChild=member",
263 throw new CRM_Core_Exception(ts('The membership cannot be saved because the status cannot be calculated.'), 0, $errorParams);
265 $params['status_id'] = $calcStatus['id'];
268 // data cleanup only: all verifications on number of related memberships are done upstream in:
269 // CRM_Member_BAO_Membership::createRelatedMemberships()
270 // CRM_Contact_BAO_Relationship::relatedMemberships()
271 if (isset($params['owner_membership_id'])) {
272 unset($params['max_related']);
274 // if membership allows related, default max_related to value in membership_type
275 if (!array_key_exists('max_related', $params) && !empty($params['membership_type_id'])) {
276 $membershipType = CRM_Member_BAO_MembershipType
::getMembershipTypeDetails($params['membership_type_id']);
277 if (isset($membershipType['relationship_type_id'])) {
278 $params['max_related'] = CRM_Utils_Array
::value('max_related', $membershipType);
283 $transaction = new CRM_Core_Transaction();
285 $membership = self
::add($params, $ids);
287 if (is_a($membership, 'CRM_Core_Error')) {
288 $transaction->rollback();
292 // add custom field values
293 if (!empty($params['custom']) && is_array($params['custom'])
295 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_membership', $membership->id
);
298 $params['membership_id'] = $membership->id
;
299 if (isset($ids['membership'])) {
300 $ids['contribution'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipPayment',
307 //record contribution for this membership
308 if (!empty($params['contribution_status_id']) && empty($params['relate_contribution_id'])) {
309 $memInfo = array_merge($params, array('membership_id' => $membership->id
));
310 $params['contribution'] = self
::recordMembershipContribution($memInfo, $ids);
313 //insert payment record for this membership
314 if (!empty($params['relate_contribution_id'])) {
315 $mpDAO = new CRM_Member_DAO_MembershipPayment();
316 $mpDAO->membership_id
= $membership->id
;
317 $mpDAO->contribution_id
= $params['relate_contribution_id'];
318 if (!($mpDAO->find(TRUE))) {
319 CRM_Utils_Hook
::pre('create', 'MembershipPayment', NULL, $mpDAO);
321 CRM_Utils_Hook
::post('create', 'MembershipPayment', $mpDAO->id
, $mpDAO);
325 // add activity record only during create mode and renew mode
326 // also add activity if status changed CRM-3984 and CRM-2521
327 if (empty($ids['membership']) ||
328 $activityType == 'Membership Renewal' ||
!empty($params['createActivity'])) {
329 if (!empty($ids['membership'])) {
331 CRM_Core_DAO
::commonRetrieveAll('CRM_Member_DAO_Membership',
335 array('contact_id', 'membership_type_id', 'source')
338 $membership->contact_id
= $data[$membership->id
]['contact_id'];
339 $membership->membership_type_id
= $data[$membership->id
]['membership_type_id'];
340 $membership->source
= CRM_Utils_Array
::value('source', $data[$membership->id
]);
343 // since we are going to create activity record w/
344 // individual contact as a target in case of on behalf signup,
345 // so get the copy of organization id, CRM-5551
346 $realMembershipContactId = $membership->contact_id
;
348 // create activity source = individual, target = org CRM-4027
349 $targetContactID = NULL;
350 if (!empty($params['is_for_organization'])) {
351 $targetContactID = $membership->contact_id
;
352 $membership->contact_id
= CRM_Utils_Array
::value('userId', $ids);
355 if (empty($membership->contact_id
) && (!empty($membership->owner_membership_id
))) {
356 $membership->contact_id
= $realMembershipContactId;
359 if (!empty($ids['membership']) && $activityType != 'Membership Signup') {
360 CRM_Activity_BAO_Activity
::addActivity($membership, $activityType, $targetContactID);
361 } elseif (empty($ids['membership'])) {
362 CRM_Activity_BAO_Activity
::addActivity($membership, $activityType, $targetContactID);
365 // we might created activity record w/ individual
366 // contact as target so update membership object w/
367 // original organization id, CRM-5551
368 $membership->contact_id
= $realMembershipContactId;
371 $transaction->commit();
373 self
::createRelatedMemberships($params, $membership);
375 // do not add to recent items for import, CRM-4399
376 if (empty($params['skipRecentView'])) {
377 $url = CRM_Utils_System
::url('civicrm/contact/view/membership',
378 "action=view&reset=1&id={$membership->id}&cid={$membership->contact_id}&context=home"
380 if(empty($membership->membership_type_id
)){// ie in an update situation
381 $membership->find(TRUE);
383 $membershipTypes = CRM_Member_PseudoConstant
::membershipType();
384 $title = CRM_Contact_BAO_Contact
::displayName($membership->contact_id
) . ' - ' . ts('Membership Type:') . ' ' . $membershipTypes[$membership->membership_type_id
];
386 $recentOther = array();
387 if (CRM_Core_Permission
::checkActionPermission('CiviMember', CRM_Core_Action
::UPDATE
)) {
388 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/contact/view/membership',
389 "action=update&reset=1&id={$membership->id}&cid={$membership->contact_id}&context=home"
392 if (CRM_Core_Permission
::checkActionPermission('CiviMember', CRM_Core_Action
::DELETE
)) {
393 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/contact/view/membership',
394 "action=delete&reset=1&id={$membership->id}&cid={$membership->contact_id}&context=home"
398 // add the recently created Membership
399 CRM_Utils_Recent
::add($title,
403 $membership->contact_id
,
413 * Function to check the membership extended through relationship
415 * @param int $membershipId membership id
416 * @param int $contactId contact id
418 * @return Array array of contact_id of all related contacts.
421 static function checkMembershipRelationship($membershipId, $contactId, $action = CRM_Core_Action
::ADD
) {
423 $membershipTypeID = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $membershipId, 'membership_type_id');
425 $membershipType = CRM_Member_BAO_MembershipType
::getMembershipTypeDetails($membershipTypeID);
426 $relationships = array();
427 if (isset($membershipType['relationship_type_id'])) {
428 $relationships = CRM_Contact_BAO_Relationship
::getRelationship($contactId,
429 CRM_Contact_BAO_Relationship
::CURRENT
431 if ($action & CRM_Core_Action
::UPDATE
) {
432 $pastRelationships = CRM_Contact_BAO_Relationship
::getRelationship($contactId,
433 CRM_Contact_BAO_Relationship
::PAST
435 $relationships = array_merge($relationships, $pastRelationships);
439 if (!empty($relationships)) {
440 // check for each contact relationships
441 foreach ($relationships as $values) {
442 //get details of the relationship type
443 $relType = array('id' => $values['civicrm_relationship_type_id']);
444 $relValues = array();
445 CRM_Contact_BAO_RelationshipType
::retrieve($relType, $relValues);
446 // Check if contact's relationship type exists in membership type
447 $relTypeDirs = array();
448 $relTypeIds = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $membershipType['relationship_type_id']);
449 $relDirections = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $membershipType['relationship_direction']);
450 $bidirectional = FALSE;
451 foreach ($relTypeIds as $key => $value) {
452 $relTypeDirs[] = $value . '_' . $relDirections[$key];
453 if (in_array($value, $relType) &&
454 $relValues['name_a_b'] == $relValues['name_b_a']
456 $bidirectional = TRUE;
460 $relTypeDir = $values['civicrm_relationship_type_id'] . '_' . $values['rtype'];
461 if ($bidirectional ||
in_array($relTypeDir, $relTypeDirs)) {
462 // $values['status'] is going to have value for
463 // current or past relationships.
464 $contacts[$values['cid']] = $values['status'];
469 // Sort by contact_id ascending
475 * Takes a bunch of params that are needed to match certain criteria and
476 * retrieves the relevant objects. We'll tweak this function to be more
477 * full featured over a period of time. This is the inverse function of
478 * create. It also stores all the retrieved values in the default array
480 * @param array $params (reference ) an assoc array of name/value pairs
481 * @param array $defaults (reference ) an assoc array to hold the name / value pairs
482 * in a hierarchical manner
483 * @param array $ids (reference) the array that holds all the db ids
485 * @return object CRM_Member_BAO_Membership object
489 static function retrieve(&$params, &$defaults) {
490 $membership = new CRM_Member_DAO_Membership();
492 $membership->copyValues($params);
494 if ($membership->find(TRUE)) {
495 CRM_Core_DAO
::storeValues($membership, $defaults);
497 //get the membership status and type values.
498 $statusANDType = self
::getStatusANDTypeValues($membership->id
);
500 'status', 'membership_type') as $fld) {
501 $defaults[$fld] = CRM_Utils_Array
::value($fld, $statusANDType[$membership->id
]);
503 if (!empty($statusANDType[$membership->id
]['is_current_member'])) {
504 $defaults['active'] = TRUE;
517 * Function to get membership status and membership type values
519 * @param int $membershipId membership id of values to return
521 * @return array of key value pairs
524 static function getStatusANDTypeValues($membershipId) {
526 if (!$membershipId) {
530 SELECT membership.id as id,
531 status.id as status_id,
532 status.label as status,
533 status.is_current_member as is_current_member,
534 type.id as membership_type_id,
535 type.name as membership_type,
536 type.relationship_type_id as relationship_type_id
537 FROM civicrm_membership membership
538 INNER JOIN civicrm_membership_status status ON ( status.id = membership.status_id )
539 INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_type_id )
540 WHERE membership.id = %1';
541 $dao = CRM_Core_DAO
::executeQuery($sql, array(1 => array($membershipId, 'Positive')));
542 $properties = array('status', 'status_id', 'membership_type', 'membership_type_id', 'is_current_member', 'relationship_type_id');
543 while ($dao->fetch()) {
544 foreach ($properties as $property) {
545 $values[$dao->id
][$property] = $dao->$property;
553 * Function to delete membership.
554 * Wrapper for most delete calls. Use this unless you JUST want to delete related memberships w/o deleting the parent.
556 * @param int $membershipId membership id that needs to be deleted
560 * @return $results no of deleted Membership on success, false otherwise
563 static function del($membershipId) {
564 //delete related first and then delete parent.
565 self
::deleteRelatedMemberships($membershipId);
566 return self
::deleteMembership($membershipId);
570 * Function to delete membership.
572 * @param int $membershipId membership id that needs to be deleted
576 * @return $results no of deleted Membership on success, false otherwise
579 static function deleteMembership($membershipId) {
580 // CRM-12147, retrieve membership data before we delete it for hooks
581 $params = array('id' => $membershipId);
582 $memValues = array();
583 $memberships = self
::getValues($params, $memValues);
585 $membership = $memberships[$membershipId];
587 CRM_Utils_Hook
::pre('delete', 'Membership', $membershipId, $memValues);
589 $transaction = new CRM_Core_Transaction();
592 //delete activity record
593 $activityTypes = CRM_Core_PseudoConstant
::activityType(TRUE, FALSE, FALSE, 'name');
596 $deleteActivity = false;
597 $membershipActivities = array(
599 'Membership Renewal',
600 'Change Membership Status',
601 'Change Membership Type',
602 'Membership Renewal Reminder'
604 foreach($membershipActivities as $membershipActivity) {
605 $activityId = array_search($membershipActivity, $activityTypes);
607 $params['activity_type_id'][] = $activityId;
608 $deleteActivity = true;
611 if ($deleteActivity) {
612 $params['source_record_id'] = $membershipId;
613 CRM_Activity_BAO_Activity
::deleteActivity($params);
615 self
::deleteMembershipPayment($membershipId);
617 $results = $membership->delete();
618 $transaction->commit();
620 CRM_Utils_Hook
::post('delete', 'Membership', $membership->id
, $membership);
622 // delete the recently created Membership
623 $membershipRecent = array(
624 'id' => $membershipId,
625 'type' => 'Membership',
627 CRM_Utils_Recent
::del($membershipRecent);
633 * Function to delete related memberships
635 * @param int $ownerMembershipId
636 * @param int $contactId
641 static function deleteRelatedMemberships($ownerMembershipId, $contactId = NULL) {
642 if (!$ownerMembershipId && !$contactId) {
646 $membership = new CRM_Member_DAO_Membership();
647 $membership->owner_membership_id
= $ownerMembershipId;
650 $membership->contact_id
= $contactId;
654 while ($membership->fetch()) {
655 //delete related first and then delete parent.
656 self
::deleteRelatedMemberships($membership->id
);
657 self
::deleteMembership($membership->id
);
663 * Function to obtain active/inactive memberships from the list of memberships passed to it.
665 * @param array $memberships membership records
666 * @param string $status active or inactive
668 * @return array $actives array of memberships based on status
672 static function activeMembers($memberships, $status = 'active') {
674 if ($status == 'active') {
675 foreach ($memberships as $f => $v) {
676 if (!empty($v['active'])) {
682 elseif ($status == 'inactive') {
683 foreach ($memberships as $f => $v) {
684 if (empty($v['active'])) {
694 * Function to build Membership Block in Contribution Pages
696 * @param object $form form object
697 * @param int $pageId contribution page id
698 * @param boolean $formItems
699 * @param int $selectedMembershipTypeID selected membership id
700 * @param boolean $thankPage thank you page
701 * @param boolean $memContactId contact who is to be
702 * checked for having a current membership for a particular membership
706 static function buildMembershipBlock(&$form,
710 $selectedMembershipTypeID = NULL,
715 $separateMembershipPayment = FALSE;
716 if ($form->_membershipBlock
) {
717 $form->_currentMemberships
= array();
719 $membershipBlock = $form->_membershipBlock
;
720 $membershipTypeIds = $membershipTypes = $radio = array();
721 $membershipPriceset = (!empty($form->_priceSetId
) && $form->_useForMember
) ?
TRUE : FALSE;
723 $allowAutoRenewMembership = $autoRenewOption = FALSE;
724 $autoRenewMembershipTypeOptions = array();
726 $paymentProcessor = CRM_Core_PseudoConstant
::paymentProcessor(FALSE, FALSE, 'is_recur = 1');
728 $separateMembershipPayment = CRM_Utils_Array
::value('is_separate_payment', $membershipBlock);
730 if ($membershipPriceset) {
731 foreach ($form->_priceSet
['fields'] as $pField) {
732 if (empty($pField['options'])) {
735 foreach ($pField['options'] as $opId => $opValues) {
736 if (empty($opValues['membership_type_id'])) {
739 $membershipTypeIds[$opValues['membership_type_id']] = $opValues['membership_type_id'];
743 elseif (!empty($membershipBlock['membership_types'])) {
744 $membershipTypeIds = explode(',', $membershipBlock['membership_types']);
747 if (!empty($membershipTypeIds)) {
748 //set status message if wrong membershipType is included in membershipBlock
749 if (isset($form->_mid
) && !$membershipPriceset) {
750 $membershipTypeID = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership',
754 if (!in_array($membershipTypeID, $membershipTypeIds)) {
755 CRM_Core_Session
::setStatus(ts("Oops. The membership you're trying to renew appears to be invalid. Contact your site administrator if you need assistance. If you continue, you will be issued a new membership."), ts('Invalid Membership'), 'error');
759 $membershipTypeValues = self
::buildMembershipTypeValues($form, $membershipTypeIds);
760 $form->_membershipTypeValues
= $membershipTypeValues;
762 foreach ($membershipTypeIds as $value) {
763 $memType = $membershipTypeValues[$value];
764 if ($selectedMembershipTypeID != NULL) {
765 if ($memType['id'] == $selectedMembershipTypeID) {
766 $form->assign('minimum_fee',
767 CRM_Utils_Array
::value('minimum_fee', $memType)
769 $form->assign('membership_name', $memType['name']);
770 if (!$thankPage && $cid) {
771 $membership = new CRM_Member_DAO_Membership();
772 $membership->contact_id
= $cid;
773 $membership->membership_type_id
= $memType['id'];
774 if ($membership->find(TRUE)) {
775 $form->assign('renewal_mode', TRUE);
776 $memType['current_membership'] = $membership->end_date
;
777 $form->_currentMemberships
[$membership->membership_type_id
] = $membership->membership_type_id
;
780 $membershipTypes[] = $memType;
783 elseif ($memType['is_active']) {
784 $javascriptMethod = NULL;
785 $allowAutoRenewOpt = 1;
786 if (is_array($form->_paymentProcessors
)){
787 foreach ($form->_paymentProcessors
as $id => $val) {
788 if (!$val['is_recur']) {
789 $allowAutoRenewOpt = 0;
795 $javascriptMethod = array('onclick' => "return showHideAutoRenew( this.value );");
796 $autoRenewMembershipTypeOptions["autoRenewMembershipType_{$value}"] = (int)$allowAutoRenewOpt * CRM_Utils_Array
::value($value, CRM_Utils_Array
::value('auto_renew', $form->_membershipBlock
));;
798 if ($allowAutoRenewOpt) {
799 $allowAutoRenewMembership = TRUE;
802 //add membership type.
803 $radio[$memType['id']] = $form->createElement('radio', NULL, NULL, NULL,
804 $memType['id'], $javascriptMethod
807 $membership = new CRM_Member_DAO_Membership();
808 $membership->contact_id
= $cid;
809 $membership->membership_type_id
= $memType['id'];
811 //show current membership, skip pending and cancelled membership records,
812 //because we take first membership record id for renewal
813 $membership->whereAdd('status_id != 5 AND status_id !=6');
815 if (!is_null($isTest)) {
816 $membership->is_test
= $isTest;
820 $membership->orderBy('end_date DESC');
822 if ($membership->find(TRUE)) {
823 if (!$membership->end_date
) {
824 unset($radio[$memType['id']]);
825 $form->assign('islifetime', TRUE);
828 $form->assign('renewal_mode', TRUE);
829 $form->_currentMemberships
[$membership->membership_type_id
] = $membership->membership_type_id
;
830 $memType['current_membership'] = $membership->end_date
;
832 $endDate = $memType['current_membership'];
833 $form->_defaultMemTypeId
= $memType['id'];
835 if ($memType['current_membership'] < $endDate) {
836 $endDate = $memType['current_membership'];
837 $form->_defaultMemTypeId
= $memType['id'];
841 $membershipTypes[] = $memType;
846 $form->assign('showRadio', $formItems);
848 if (!$membershipPriceset) {
849 if (!$membershipBlock['is_required']) {
850 $form->assign('showRadioNoThanks', TRUE);
851 $radio[''] = $form->createElement('radio', NULL, NULL, NULL, 'no_thanks', NULL);
852 $form->addGroup($radio, 'selectMembership', NULL);
854 elseif ($membershipBlock['is_required'] && count($radio) == 1) {
855 $temp = array_keys($radio);
856 $form->add('hidden', 'selectMembership', $temp[0], array('id' => 'selectMembership'));
857 $form->assign('singleMembership', TRUE);
858 $form->assign('showRadio', FALSE);
861 $form->addGroup($radio, 'selectMembership', NULL);
864 $form->addRule('selectMembership', ts('Please select one of the memberships.'), 'required');
867 $autoRenewOption = CRM_Price_BAO_PriceSet
::checkAutoRenewForPriceSet($form->_priceSetId
);
868 $form->assign('autoRenewOption', $autoRenewOption);
871 if (!$form->_values
['is_pay_later'] && is_array($form->_paymentProcessors
) && ($allowAutoRenewMembership ||
$autoRenewOption)) {
872 $form->addElement('checkbox', 'auto_renew', ts('Please renew my membership automatically.'));
877 $form->assign('membershipBlock', $membershipBlock);
878 $form->assign('membershipTypes', $membershipTypes);
879 $form->assign('allowAutoRenewMembership', $allowAutoRenewMembership);
880 $form->assign('autoRenewMembershipTypeOptions', json_encode($autoRenewMembershipTypeOptions));
882 //give preference to user submitted auto_renew value.
883 $takeUserSubmittedAutoRenew = (!empty($_POST) ||
$form->isSubmitted()) ?
TRUE : FALSE;
884 $form->assign('takeUserSubmittedAutoRenew', $takeUserSubmittedAutoRenew);
887 return $separateMembershipPayment;
891 * Function to return Membership Block info in Contribution Pages
893 * @param int $pageId contribution page id
897 static function getMembershipBlock($pageID) {
898 $membershipBlock = array();
899 $dao = new CRM_Member_DAO_MembershipBlock();
900 $dao->entity_table
= 'civicrm_contribution_page';
902 $dao->entity_id
= $pageID;
904 if ($dao->find(TRUE)) {
905 CRM_Core_DAO
::storeValues($dao, $membershipBlock);
906 if (!empty($membershipBlock['membership_types'])) {
907 $membershipTypes = unserialize($membershipBlock['membership_types']);
908 if (!is_array($membershipTypes)) {
909 return $membershipBlock;
912 foreach ($membershipTypes as $key => $value) {
913 $membershipBlock['auto_renew'][$key] = $value;
914 $memTypes[$key] = $key;
916 $membershipBlock['membership_types'] = implode(',', $memTypes);
923 return $membershipBlock;
927 * Function to return a current membership of given contact
928 * NB: if more than one membership meets criteria, a randomly selected one is returned.
930 * @param int $contactID contact id
931 * @param int $memType membership type, null to retrieve all types
933 * @param int $membershipID if provided, then determine if it is current
934 * @param boolean $onlySameParentOrg true if only Memberships with same parent org as the $memType wanted, false otherwise
937 static function getContactMembership($contactID, $memType, $isTest, $membershipId = NULL, $onlySameParentOrg = FALSE) {
938 $dao = new CRM_Member_DAO_Membership();
940 $dao->id
= $membershipId;
942 $dao->contact_id
= $contactID;
943 $dao->membership_type_id
= $memType;
945 //fetch proper membership record.
947 $dao->is_test
= $isTest;
950 $dao->whereAdd('is_test IS NULL OR is_test = 0');
953 //avoid pending membership as current membership: CRM-3027
954 $pendingStatusId = array_search('Pending', CRM_Member_PseudoConstant
::membershipStatus());
955 $dao->whereAdd("status_id != $pendingStatusId");
957 // order by start date to find most recent membership first, CRM-4545
958 $dao->orderBy('start_date DESC');
961 if ($onlySameParentOrg && $memType) {
962 // require the same parent org as the $memType
963 $params = array('id' => $memType);
964 $defaults = $membershipType = array();
965 if (CRM_Member_BAO_MembershipType
::retrieve($params, $membershipType)) {
966 $memberTypesSameParentOrg = CRM_Member_BAO_MembershipType
::getMembershipTypesByOrg($membershipType['member_of_contact_id']);
967 $memberTypesSameParentOrgList = implode(',', array_keys($memberTypesSameParentOrg));
968 $dao->whereAdd('membership_type_id IN (' . $memberTypesSameParentOrgList . ')');
972 if ($dao->find(TRUE)) {
973 $membership = array();
974 CRM_Core_DAO
::storeValues($dao, $membership);
975 $membership['is_current_member'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus',
976 $membership['status_id'],
977 'is_current_member', 'id'
983 if ($onlySameParentOrg && $memType) {
984 // see if there is a membership that has same parent as $memType but different parent than $membershipID
986 if ( $dao->id
&& CRM_Core_Permission
::check( 'edit memberships' ) ) {
987 // CRM-10016, This is probably a backend renewal, and make sure we return the same membership thats being renewed.
993 unset($dao->membership_type_id
);
994 if ($dao->find(TRUE)) {
995 $membership = array();
996 CRM_Core_DAO
::storeValues($dao, $membership);
997 $membership['is_current_member'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus',
998 $membership['status_id'],
999 'is_current_member', 'id'
1008 * Combine all the importable fields from the lower levels object
1010 * @param string $contactType contact type
1011 * @param boolean $status
1013 * @return array array of importable Fields
1017 static function &importableFields($contactType = 'Individual', $status = TRUE) {
1018 if (!self
::$_importableFields) {
1019 if (!self
::$_importableFields) {
1020 self
::$_importableFields = array();
1024 $fields = array('' => array('title' => '- ' . ts('do not import') . ' -'));
1027 $fields = array('' => array('title' => '- ' . ts('Membership Fields') . ' -'));
1030 $tmpFields = CRM_Member_DAO_Membership
::import();
1031 $contactFields = CRM_Contact_BAO_Contact
::importableFields($contactType, NULL);
1033 // Using new Dedupe rule.
1034 $ruleParams = array(
1035 'contact_type' => $contactType,
1036 'used' => 'Unsupervised',
1038 $fieldsArray = CRM_Dedupe_BAO_Rule
::dedupeRuleFields($ruleParams);
1040 $tmpContactField = array();
1041 if (is_array($fieldsArray)) {
1042 foreach ($fieldsArray as $value) {
1043 $customFieldId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField',
1048 $value = $customFieldId ?
'custom_' . $customFieldId : $value;
1049 $tmpContactField[trim($value)] = CRM_Utils_Array
::value(trim($value), $contactFields);
1051 $title = $tmpContactField[trim($value)]['title'] . " " . ts('(match to contact)');
1054 $title = $tmpContactField[trim($value)]['title'];
1056 $tmpContactField[trim($value)]['title'] = $title;
1059 $tmpContactField['external_identifier'] = $contactFields['external_identifier'];
1060 $tmpContactField['external_identifier']['title'] = $contactFields['external_identifier']['title'] . " " . ts('(match to contact)');
1062 $tmpFields['membership_contact_id']['title'] = $tmpFields['membership_contact_id']['title'] . " " . ts('(match to contact)');;
1064 $fields = array_merge($fields, $tmpContactField);
1065 $fields = array_merge($fields, $tmpFields);
1066 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Membership'));
1067 self
::$_importableFields = $fields;
1069 return self
::$_importableFields;
1073 * function to get all exportable fields
1075 * @retun array return array of all exportable fields
1078 static function &exportableFields() {
1079 $expFieldMembership = CRM_Member_DAO_Membership
::export();
1081 $expFieldsMemType = CRM_Member_DAO_MembershipType
::export();
1082 $fields = array_merge($expFieldMembership, $expFieldsMemType);
1083 $fields = array_merge($fields, $expFieldMembership);
1084 $membershipStatus = array(
1085 'membership_status' => array('title' => 'Membership Status',
1086 'name' => 'membership_status',
1087 'type' => CRM_Utils_Type
::T_STRING
,
1088 'where' => 'civicrm_membership_status.name',
1090 //CRM-6161 fix for customdata export
1091 $fields = array_merge($fields, $membershipStatus, CRM_Core_BAO_CustomField
::getFieldsForImport('Membership'));
1096 * Function to get membership joins/renewals for a specified membership
1097 * type. Specifically, retrieves a count of memberships whose "Membership
1098 * Signup" or "Membership Renewal" activity falls in the given date range.
1099 * Dates match the pattern "yyyy-mm-dd".
1101 * @param int $membershipTypeId membership type id
1102 * @param int $startDate date on which to start counting
1103 * @param int $endDate date on which to end counting
1104 * @param bool $isTest if true, membership is for a test site
1105 * @param bool $isOwner if true, only retrieve membership records for owners //LCD
1107 * @return returns the number of members of type $membershipTypeId whose
1108 * start_date is between $startDate and $endDate
1111 public static function getMembershipStarts($membershipTypeId, $startDate, $endDate, $isTest = 0, $isOwner = 0) {
1113 $testClause = 'membership.is_test = 1';
1115 $testClause = '( membership.is_test IS NULL OR membership.is_test = 0 )';
1118 if (!self
::$_signupActType ||
!self
::$_renewalActType) {
1119 self
::_getActTypes();
1122 if (!self
::$_signupActType ||
!self
::$_renewalActType) {
1127 SELECT COUNT(DISTINCT membership.id) as member_count
1128 FROM civicrm_membership membership
1129 INNER JOIN civicrm_activity activity ON (activity.source_record_id = membership.id AND activity.activity_type_id in (%1, %2))
1130 INNER JOIN civicrm_membership_status status ON ( membership.status_id = status.id AND status.is_current_member = 1 )
1131 INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND contact.is_deleted = 0 )
1132 WHERE membership.membership_type_id = %3
1133 AND activity.activity_date_time >= '$startDate' AND activity.activity_date_time <= '$endDate 23:59:59'
1136 $query .= ($isOwner) ?
' AND owner_membership_id IS NULL' : '';
1139 1 => array(self
::$_signupActType, 'Integer'),
1140 2 => array(self
::$_renewalActType, 'Integer'),
1141 3 => array($membershipTypeId, 'Integer'),
1144 $memberCount = CRM_Core_DAO
::singleValueQuery($query, $params);
1145 return (int)$memberCount;
1149 * Function to get a count of membership for a specified membership type,
1150 * optionally for a specified date. The date must have the form yyyy-mm-dd.
1152 * If $date is omitted, this function counts as a member anyone whose
1153 * membership status_id indicates they're a current member.
1154 * If $date is given, this function counts as a member anyone who:
1155 * -- Has a start_date before $date and end_date after $date, or
1156 * -- Has a start_date before $date and is currently a member, as indicated
1157 * by the the membership's status_id.
1158 * The second condition takes care of records that have no end_date. These
1159 * are assumed to be lifetime memberships.
1161 * @param int $membershipTypeId membership type id
1162 * @param string $date the date for which to retrieve the count
1163 * @param bool $isTest if true, membership is for a test site
1164 * @param bool $isOwner if true, only retrieve membership records for owners //LCD
1166 * @return returns the number of members of type $membershipTypeId as of
1169 public static function getMembershipCount($membershipTypeId, $date = NULL, $isTest = 0, $isOwner = 0) {
1170 if (!CRM_Utils_Rule
::date($date)) {
1171 CRM_Core_Error
::fatal(ts('Invalid date "%1" (must have form yyyy-mm-dd).', array(1 => $date)));
1174 $params = array(1 => array($membershipTypeId, 'Integer'),
1175 2 => array($isTest, 'Boolean'),
1177 $query = "SELECT count(civicrm_membership.id ) as member_count
1178 FROM civicrm_membership left join civicrm_membership_status on ( civicrm_membership.status_id = civicrm_membership_status.id )
1179 WHERE civicrm_membership.membership_type_id = %1
1180 AND civicrm_membership.contact_id NOT IN (SELECT id FROM civicrm_contact WHERE is_deleted = 1)
1181 AND civicrm_membership.is_test = %2";
1183 $query .= " AND civicrm_membership_status.is_current_member = 1";
1186 $query .= " AND civicrm_membership.start_date <= '$date' AND civicrm_membership_status.is_current_member = 1";
1189 $query .= ($isOwner) ?
' AND owner_membership_id IS NULL' : '';
1190 $memberCount = CRM_Core_DAO
::singleValueQuery($query, $params);
1191 return (int)$memberCount;
1195 * Function check the status of the membership before adding membership for a contact
1197 * @param int $contactId contact id
1201 static function statusAvailabilty($contactId) {
1202 $membership = new CRM_Member_DAO_MembershipStatus();
1203 $membership->whereAdd('is_active=1');
1204 return $membership->count();
1208 * Process the Memberships
1210 * @param array $membershipParams array of membership fields
1211 * @param int $contactID contact id
1212 * @param object $form form object
1217 public static function postProcessMembership($membershipParams, $contactID, &$form, &$premiumParams,
1218 $customFieldsFormatted = NULL, $includeFieldTypes = NULL
1220 $tempParams = $membershipParams;
1221 $paymentDone = FALSE;
1223 $isTest = CRM_Utils_Array
::value('is_test', $membershipParams, FALSE);
1224 $form->assign('membership_assign', TRUE);
1226 $form->set('membershipTypeID', $membershipParams['selectMembership']);
1228 $singleMembershipTypeID = $membershipTypeID = $membershipParams['selectMembership'];
1229 if (is_array($membershipTypeID) && count($membershipTypeID) == 1) {
1230 $singleMembershipTypeID = $membershipTypeID[0];
1233 $membershipDetails = self
::buildMembershipTypeValues($form, $singleMembershipTypeID);
1234 $form->assign('membership_name', CRM_Utils_Array
::value('name', $membershipDetails));
1236 $minimumFee = CRM_Utils_Array
::value('minimum_fee', $membershipDetails);
1237 $contributionTypeId = NULL;
1238 if ($form->_values
['amount_block_is_active']) {
1239 $contributionTypeId = $form->_values
['financial_type_id'];
1242 $paymentDone = TRUE;
1243 $params['amount'] = $minimumFee;
1244 $contributionTypeId = CRM_Utils_Array
::value( 'financial_type_id', $membershipDetails );
1245 if (!$contributionTypeId) {
1246 $contributionTypeId = CRM_Utils_Array
::value('financial_type_id' ,$membershipParams);
1250 //amount must be greater than zero for
1251 //adding contribution record to contribution table.
1252 //this condition arises when separate membership payment is
1253 //enabled and contribution amount is not selected. fix for CRM-3010
1254 if ($form->_amount
> 0.0 && $membershipParams['amount']) {
1255 $result = CRM_Contribute_BAO_Contribution_Utils
::processConfirm($form, $membershipParams,
1256 $premiumParams, $contactID,
1257 $contributionTypeId,
1262 // we need to explicitly create a CMS user in case of free memberships
1263 // since the below has already been done under processConfirm for paid memberships
1264 CRM_Contribute_BAO_Contribution_Utils
::createCMSUser($membershipParams,
1265 $membershipParams['cms_contactID'],
1266 'email-' . $form->_bltID
1271 if (is_a($result[1], 'CRM_Core_Error')) {
1272 $errors[1] = CRM_Core_Error
::getMessages($result[1]);
1274 elseif (!empty($result[1])) {
1275 // Save the contribution ID so that I can be used in email receipts
1276 // For example, if you need to generate a tax receipt for the donation only.
1277 $form->_values
['contribution_other_id'] = $result[1]->id
;
1278 $contribution[1] = $result[1];
1282 $memBlockDetails = CRM_Member_BAO_Membership
::getMembershipBlock($form->_id
);
1283 if (!empty($memBlockDetails['is_separate_payment']) && !$paymentDone) {
1284 $form->_lineItem
= $form->_memLineItem
;
1285 $contributionType = new CRM_Financial_DAO_FinancialType( );
1286 $contributionType->id
= CRM_Utils_Array
::value('financial_type_id', $membershipDetails);
1287 if (!$contributionType->find(TRUE)) {
1288 CRM_Core_Error
::fatal(ts("Could not find a system table"));
1290 $tempParams['amount'] = $minimumFee;
1291 $invoiceID = md5(uniqid(rand(), TRUE));
1292 $tempParams['invoiceID'] = $invoiceID;
1294 //we don't allow recurring membership.CRM-3781.
1295 if (!empty($tempParams['is_recur'])) {
1296 $tempParams['is_recur'] = 0;
1299 if ($form->_values
['is_monetary'] && !$form->_params
['is_pay_later'] && $minimumFee > 0.0) {
1300 $payment = CRM_Core_Payment
::singleton($form->_mode
, $form->_paymentProcessor
, $form);
1302 if ($form->_contributeMode
== 'express') {
1303 $result = &$payment->doExpressCheckout($tempParams);
1306 $result = &$payment->doDirectPayment($tempParams);
1310 if (is_a($result, 'CRM_Core_Error')) {
1311 $errors[2] = CRM_Core_Error
::getMessages($result);
1314 //assign receive date when separate membership payment
1315 //and contribution amount not selected.
1316 if ($form->_amount
== 0) {
1317 $now = date('YmdHis');
1318 $form->_params
['receive_date'] = $now;
1319 $receiveDate = CRM_Utils_Date
::mysqlToIso($now);
1320 $form->set('params', $form->_params
);
1321 $form->assign('receive_date', $receiveDate);
1324 $form->set('membership_trx_id', $result['trxn_id']);
1325 $form->set('membership_amount', $minimumFee);
1327 $form->assign('membership_trx_id', $result['trxn_id']);
1328 $form->assign('membership_amount', $minimumFee);
1330 // we dont need to create the user twice, so lets disable cms_create_account
1331 // irrespective of the value, CRM-2888
1332 $tempParams['cms_create_account'] = 0;
1334 $pending = $form->_params
['is_pay_later'] ?
((CRM_Utils_Array
::value('minimum_fee', $membershipDetails, 0) > 0.0) ?
TRUE : FALSE) : FALSE;
1336 //set this variable as we are not creating pledge for
1337 //separate membership payment contribution.
1338 //so for differentiating membership contributon from
1339 //main contribution.
1340 $form->_params
['separate_membership_payment'] = 1;
1341 $contribution[2] = CRM_Contribute_Form_Contribution_Confirm
::processContribution($form,
1352 $index = !empty($memBlockDetails['is_separate_payment']) ?
2 : 1;
1354 if (empty($errors[$index])) {
1355 if (isset($membershipParams['onbehalf']) && !empty($membershipParams['onbehalf']['member_campaign_id'])) {
1356 $form->_params
['campaign_id'] = $membershipParams['onbehalf']['member_campaign_id'];
1358 if (is_array($membershipTypeID)) {
1359 $typesTerms = CRM_Utils_Array
::value('types_terms', $membershipParams, array());
1360 $createdMemberships = array();
1362 foreach ($membershipTypeID as $memType) {
1363 $numTerms = CRM_Utils_Array
::value($memType, $typesTerms, 1);
1364 $membership = self
::renewMembership($contactID, $memType,
1365 $isTest, $form, NULL,
1366 CRM_Utils_Array
::value('cms_contactID', $membershipParams),
1367 $customFieldsFormatted, CRM_Utils_Array
::value($memType, $typesTerms, 1)
1370 $createdMemberships[$memType] = $membership;
1371 if (isset($contribution[$index])) {
1372 //insert payment record
1373 $dao = new CRM_Member_DAO_MembershipPayment();
1374 $dao->membership_id
= $membership->id
;
1375 $dao->contribution_id
= $contribution[$index]->id
;
1376 //Fixed for avoiding duplicate entry error when user goes
1377 //back and forward during payment mode is notify
1378 if (!$dao->find(TRUE)) {
1379 CRM_Utils_Hook
::pre('create', 'MembershipPayment', NULL, $dao);
1381 CRM_Utils_Hook
::post('create', 'MembershipPayment', $dao->id
, $dao);
1385 if ($form->_priceSetId
&& !empty($form->_useForMember
) && !empty($form->_lineItem
)) {
1386 foreach ($form->_lineItem
[$form->_priceSetId
] as & $priceFieldOp) {
1387 if (!empty($priceFieldOp['membership_type_id']) &&
1388 isset($createdMemberships[$priceFieldOp['membership_type_id']])
1390 $membershipOb = $createdMemberships[$priceFieldOp['membership_type_id']];
1391 $priceFieldOp['start_date'] = $membershipOb->start_date ? CRM_Utils_Date
::customFormat($membershipOb->start_date
, '%d%f %b, %Y') : '-';
1392 $priceFieldOp['end_date'] = $membershipOb->end_date ? CRM_Utils_Date
::customFormat($membershipOb->end_date
, '%d%f %b, %Y') : '-';
1395 $priceFieldOp['start_date'] = $priceFieldOp['end_date'] = 'N/A';
1398 $form->_values
['lineItem'] = $form->_lineItem
;
1399 $form->assign('lineItem', $form->_lineItem
);
1403 $membership = self
::renewMembership($contactID, $membershipTypeID,
1404 $isTest, $form, NULL,
1405 CRM_Utils_Array
::value('cms_contactID', $membershipParams),
1406 $customFieldsFormatted, CRM_Utils_Array
::value('types_terms', $membershipParams, 1)
1408 if (isset($contribution[$index])) {
1409 //insert payment record
1410 $dao = new CRM_Member_DAO_MembershipPayment();
1411 $dao->membership_id
= $membership->id
;
1412 $dao->contribution_id
= $contribution[$index]->id
;
1413 //Fixed for avoiding duplicate entry error when user goes
1414 //back and forward during payment mode is notify
1415 if (!$dao->find(TRUE)) {
1416 CRM_Utils_Hook
::pre('create', 'MembershipPayment', NULL, $dao);
1418 CRM_Utils_Hook
::post('create', 'MembershipPayment', $dao->id
, $dao);
1424 if (!empty($errors)) {
1425 foreach ($errors as $error) {
1426 if (is_string($error)) {
1427 $message[] = $error;
1430 $message = ts('Payment Processor Error message') . ': ' . implode('<br/>', $message);
1431 // Redirect the form in case of error
1432 // @todo this redirect in the BAO layer is really bad & should be moved to the form layer
1433 // however since we have no idea how (if) this is triggered we can't safely move / remove it
1434 $errorParams = array(
1435 'legacy_redirect_path' => 'civicrm/contribute/transact',
1436 'legacy_redirect_query' => "_qf_Main_display=true&qfKey={$form->_params['qfKey']}",
1438 throw new CRM_Core_Exception($message, 0, $errorParams);
1442 CRM_Core_BAO_CustomValueTable
::postProcess($form->_params
,
1443 CRM_Core_DAO
::$_nullArray,
1444 'civicrm_membership',
1449 $form->_params
['membershipID'] = $membership->id
;
1450 if ($form->_contributeMode
== 'notify') {
1451 if ($form->_values
['is_monetary'] && $form->_amount
> 0.0 && !$form->_params
['is_pay_later']) {
1452 // call postprocess hook before leaving
1453 $form->postProcessHook();
1454 // this does not return
1455 $payment = CRM_Core_Payment
::singleton($form->_mode
, $form->_paymentProcessor
, $form);
1456 $payment->doTransferCheckout($form->_params
, 'contribute');
1460 $form->_values
['membership_id'] = $membership->id
;
1461 if (isset($contribution[$index]->id
)) {
1462 $form->_values
['contribution_id'] = $contribution[$index]->id
;
1465 // Do not send an email if Recurring transaction is done via Direct Mode
1466 // Email will we sent when the IPN is received.
1467 if (!empty($form->_params
['is_recur']) && $form->_contributeMode
== 'direct') {
1471 //finally send an email receipt
1472 CRM_Contribute_BAO_ContributionPage
::sendMail($contactID,
1480 * @todo - this form method needs to have the interaction with the form layer removed from it
1481 * as a BAO function. Note that the api now supports membership renewals & it is not clear this function does anything
1482 * not done by the membership.create api (with a lot less unit tests)
1484 * This method will renew / create the membership depending on
1485 * whether the given contact has a membership or not. And will add
1486 * the modified dates for membership and in the log table.
1488 * @param int $contactID id of the contact
1489 * @param int $membershipTypeID id of the new membership type
1490 * @param boolean $is_test if this is test contribution or live contribution
1491 * @param object $form form object
1492 * @param array $ipnParams array of name value pairs, to be used (for e.g source) when $form not present
1493 * @param int $modifiedID individual contact id in case of On Behalf signup (CRM-4027 )
1494 * @param int $numRenewTerms how many membership terms are being added to end date (default is 1)
1496 * @return object $membership object of membership
1502 static function renewMembership(
1507 $changeToday = NULL,
1509 $customFieldsFormatted = NULL,
1512 $statusFormat = '%Y-%m-%d';
1516 //get all active statuses of membership.
1517 $allStatus = CRM_Member_PseudoConstant
::membershipStatus();
1519 $membershipTypeDetails = CRM_Member_BAO_MembershipType
::getMembershipTypeDetails($membershipTypeID);
1521 // check is it pending. - CRM-4555
1523 //@todo this is a BAO function & should not inspect the form - the form should do this
1524 // & pass required params to the BAO
1525 if (CRM_Utils_Array
::value('minimum_fee', $membershipTypeDetails) > 0.0) {
1526 if (((isset($form->_contributeMode
) && $form->_contributeMode
== 'notify') ||
!empty($form->_params
['is_pay_later']) ||
1527 (!empty($form->_params
['is_recur']) && $form->_contributeMode
== 'direct'
1530 (($form->_values
['is_monetary'] && $form->_amount
> 0.0) ||
!empty($form->_params
['separate_membership_payment']) ||
1531 CRM_Utils_Array
::value('record_contribution', $form->_params
)
1538 //decide status here, if needed.
1539 $updateStatusId = NULL;
1540 $membershipID = NULL;
1541 //@todo would be better to accept $membershipID as an FN param & make form layer responsible for extracting it
1542 if(isset($form->_membershipId
)) {
1543 $membershipID = $form->_membershipId
;
1545 // CRM-7297 - allow membership type to be be changed during renewal so long as the parent org of new membershipType
1546 // is the same as the parent org of an existing membership of the contact
1547 $currentMembership = CRM_Member_BAO_Membership
::getContactMembership($contactID, $membershipTypeID,
1548 $is_test, $membershipID, TRUE
1550 if ($currentMembership) {
1551 $activityType = 'Membership Renewal';
1552 $form->set('renewal_mode', TRUE);
1554 // Do NOT do anything.
1555 //1. membership with status : PENDING/CANCELLED (CRM-2395)
1556 //2. Paylater/IPN renew. CRM-4556.
1557 if ($pending ||
in_array($currentMembership['status_id'], array(array_search('Pending', $allStatus),
1558 array_search('Cancelled', $allStatus),
1560 $membership = new CRM_Member_DAO_Membership();
1561 $membership->id
= $currentMembership['id'];
1562 $membership->find(TRUE);
1564 // CRM-8141 create a membership_log entry so that we will know the membership_type_id to change to when payment completed
1566 // note that we are logging the requested new membership_type_id that may be different than current membership_type_id
1567 // it will be used when payment is received to update the membership_type_id to what was paid for
1569 'membership_id' => $membership->id
,
1570 'status_id' => $membership->status_id
,
1571 'start_date' => CRM_Utils_Date
::customFormat(
1572 $membership->start_date
,
1575 'end_date' => CRM_Utils_Date
::customFormat(
1576 $membership->end_date
,
1579 'modified_date' => CRM_Utils_Date
::customFormat(
1583 'membership_type_id' => $membershipTypeID,
1584 'max_related' => $membershipTypeDetails['max_related'],
1586 $session = CRM_Core_Session
::singleton();
1587 // If we have an authenticated session, set modified_id to that user's contact_id, else set to membership.contact_id
1588 if ($session->get('userID')) {
1589 $logParams['modified_id'] = $session->get('userID');
1592 $logParams['modified_id'] = $membership->contact_id
;
1594 CRM_Member_BAO_MembershipLog
::add($logParams, CRM_Core_DAO
::$_nullArray);
1596 if (!empty($form->_params
['contributionRecurID'])) {
1597 CRM_Core_DAO
::setFieldValue('CRM_Member_DAO_Membership', $membership->id
,
1598 'contribution_recur_id', $form->_params
['contributionRecurID']
1605 //we renew expired membership, CRM-6277
1606 if (!$changeToday) {
1607 if ($form->get('renewalDate')) {
1608 $changeToday = $form->get('renewalDate');
1610 elseif (get_class($form) == 'CRM_Contribute_Form_Contribution_Confirm') {
1611 $changeToday = date('YmdHis');
1615 // Check and fix the membership if it is STALE
1616 self
::fixMembershipStatusBeforeRenew($currentMembership, $changeToday);
1618 // Now Renew the membership
1619 if (!$currentMembership['is_current_member']) {
1620 // membership is not CURRENT
1622 // CRM-7297 Membership Upsell - calculate dates based on new membership type
1623 $dates = CRM_Member_BAO_MembershipType
::getRenewalDatesForMembershipType($currentMembership['id'],
1629 $currentMembership['join_date'] = CRM_Utils_Date
::customFormat($currentMembership['join_date'], $format);
1630 $currentMembership['start_date'] = CRM_Utils_Array
::value('start_date', $dates);
1631 $currentMembership['end_date'] = CRM_Utils_Array
::value('end_date', $dates);
1632 $currentMembership['is_test'] = $is_test;
1634 if (!empty($form->_params
['membership_source'])) {
1635 $currentMembership['source'] = $form->_params
['membership_source'];
1637 elseif (isset($form->_values
['title']) && !empty($form->_values
['title'])) {
1638 $currentMembership['source'] = ts('Online Contribution:') . ' ' . $form->_values
['title'];
1641 $currentMembership['source'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership',
1642 $currentMembership['id'],
1647 if (!empty($currentMembership['id'])) {
1648 $ids['membership'] = $currentMembership['id'];
1650 $memParams = $currentMembership;
1651 $memParams['membership_type_id'] = $membershipTypeID;
1653 //set the log start date.
1654 $memParams['log_start_date'] = CRM_Utils_Date
::customFormat($dates['log_start_date'], $format);
1658 // CURRENT Membership
1659 $membership = new CRM_Member_DAO_Membership();
1660 $membership->id
= $currentMembership['id'];
1661 $membership->find(TRUE);
1662 // CRM-7297 Membership Upsell - calculate dates based on new membership type
1663 $dates = CRM_Member_BAO_MembershipType
::getRenewalDatesForMembershipType($membership->id
,
1669 // Insert renewed dates for CURRENT membership
1670 $memParams = array();
1671 $memParams['join_date'] = CRM_Utils_Date
::isoToMysql($membership->join_date
);
1672 $memParams['start_date'] = CRM_Utils_Date
::isoToMysql($membership->start_date
);
1673 $memParams['end_date'] = CRM_Utils_Array
::value('end_date', $dates);
1674 $memParams['membership_type_id'] = $membershipTypeID;
1676 //set the log start date.
1677 $memParams['log_start_date'] = CRM_Utils_Date
::customFormat($dates['log_start_date'], $format);
1678 if (empty($membership->source
)) {
1679 if (!empty($form->_params
['membership_source'])) {
1680 $memParams['source'] = $form->_params
['membership_source'];
1682 elseif (property_exists($form, '_values') && !empty($form->_values
['title'])) {
1683 $memParams['source'] = ts('Online Contribution:') . ' ' . $form->_values
['title'];
1686 $memParams['source'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership',
1687 $currentMembership['id'],
1693 if (!empty($currentMembership['id'])) {
1694 $ids['membership'] = $currentMembership['id'];
1699 $updateStatusId = array_search('Pending', $allStatus);
1705 $activityType = 'Membership Signup';
1707 'contact_id' => $contactID,
1708 'membership_type_id' => $membershipTypeID,
1712 $dates = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($membershipTypeID, NULL, NULL, NULL, $numRenewTerms);
1714 $memParams['join_date'] = CRM_Utils_Array
::value('join_date', $dates);
1715 $memParams['start_date'] = CRM_Utils_Array
::value('start_date', $dates);
1716 $memParams['end_date'] = CRM_Utils_Array
::value('end_date', $dates);
1718 $status = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate(CRM_Utils_Date
::customFormat($dates['start_date'],
1721 CRM_Utils_Date
::customFormat($dates['end_date'],
1724 CRM_Utils_Date
::customFormat($dates['join_date'],
1729 $updateStatusId = CRM_Utils_Array
::value('id', $status);
1732 // if IPN/Pay-Later set status to: PENDING
1733 $updateStatusId = array_search('Pending', $allStatus);
1736 if (!empty($form->_params
['membership_source'])) {
1737 $memParams['source'] = $form->_params
['membership_source'];
1739 elseif (!empty($form->_values
['title'])) {
1740 $memParams['source'] = ts('Online Contribution:') . ' ' . $form->_values
['title'];
1742 $memParams['contribution_recur_id'] = CRM_Utils_Array
::value('contributionRecurID', $form->_params
);
1744 $memParams['is_test'] = $is_test;
1745 $memParams['is_pay_later'] = CRM_Utils_Array
::value('is_pay_later', $form->_params
);
1749 //if we decided status here and want to skip status
1750 //calculation in create( ); then need to pass 'skipStatusCal'.
1751 if ($updateStatusId) {
1752 $memParams['status_id'] = $updateStatusId;
1753 $memParams['skipStatusCal'] = TRUE;
1756 //since we are renewing,
1757 //make status override false.
1758 $memParams['is_override'] = FALSE;
1760 //CRM-4027, create log w/ individual contact.
1762 $ids['userId'] = $modifiedID;
1763 $memParams['is_for_organization'] = TRUE;
1766 $ids['userId'] = $contactID;
1769 //inherit campaign from contrib page.
1770 if (isset($form->_values
) && is_array($form->_values
) && !empty($form->_values
)) {
1771 $campaignId = CRM_Utils_Array
::value('campaign_id', $form->_params
);
1772 if (!array_key_exists('campaign_id', $form->_params
)) {
1773 $campaignId = CRM_Utils_Array
::value('campaign_id', $form->_values
);
1775 $memParams['campaign_id'] = $campaignId;
1778 $memParams['custom'] = $customFieldsFormatted;
1779 $membership = self
::create($memParams, $ids, FALSE, $activityType);
1781 // not sure why this statement is here, seems quite odd :( - Lobo: 12/26/2010
1782 // related to: http://forum.civicrm.org/index.php/topic,11416.msg49072.html#msg49072
1783 $membership->find(TRUE);
1784 if (!empty($dates)) {
1785 $form->assign('mem_start_date',
1786 CRM_Utils_Date
::customFormat($dates['start_date'], $format)
1788 $form->assign('mem_end_date',
1789 CRM_Utils_Date
::customFormat($dates['end_date'], $format)
1797 * Method to fix membership status of stale membership
1799 * This method first checks if the membership is stale. If it is,
1800 * then status will be updated based on existing start and end
1801 * dates and log will be added for the status change.
1803 * @param array $currentMembership referance to the array
1804 * containing all values of
1805 * the current membership
1806 * @param array $changeToday array of month, day, year
1807 * values in case today needs
1808 * to be customised, null otherwise
1813 static function fixMembershipStatusBeforeRenew(&$currentMembership, $changeToday) {
1816 $today = CRM_Utils_Date
::processDate($changeToday, NULL, FALSE, 'Y-m-d');
1819 $status = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate(
1820 CRM_Utils_Array
::value('start_date', $currentMembership),
1821 CRM_Utils_Array
::value('end_date', $currentMembership),
1822 CRM_Utils_Array
::value('join_date', $currentMembership),
1827 if (empty($status) ||
1828 empty($status['id'])
1830 CRM_Core_Error
::fatal(ts('Oops, it looks like there is no valid membership status corresponding to the membership start and end dates for this membership. Contact the site administrator for assistance.'));
1833 $currentMembership['today_date'] = $today;
1835 if ($status['id'] !== $currentMembership['status_id']) {
1836 $memberDAO = new CRM_Member_DAO_Membership();
1837 $memberDAO->id
= $currentMembership['id'];
1838 $memberDAO->find(TRUE);
1840 $memberDAO->status_id
= $status['id'];
1841 $memberDAO->join_date
= CRM_Utils_Date
::isoToMysql($memberDAO->join_date
);
1842 $memberDAO->start_date
= CRM_Utils_Date
::isoToMysql($memberDAO->start_date
);
1843 $memberDAO->end_date
= CRM_Utils_Date
::isoToMysql($memberDAO->end_date
);
1845 CRM_Core_DAO
::storeValues($memberDAO, $currentMembership);
1848 $currentMembership['is_current_member'] = CRM_Core_DAO
::getFieldValue(
1849 'CRM_Member_DAO_MembershipStatus',
1850 $currentMembership['status_id'],
1856 'membership_id' => $currentMembership['id'],
1857 'status_id' => $status['id'],
1858 'start_date' => CRM_Utils_Date
::customFormat(
1859 $currentMembership['start_date'],
1862 'end_date' => CRM_Utils_Date
::customFormat(
1863 $currentMembership['end_date'],
1866 'modified_date' => CRM_Utils_Date
::customFormat(
1867 $currentMembership['today_date'],
1870 'membership_type_id' => $currentMembership['membership_type_id'],
1871 'max_related' => $currentMembership['max_related'],
1874 $session = CRM_Core_Session
::singleton();
1875 // If we have an authenticated session, set modified_id to that user's contact_id, else set to membership.contact_id
1876 if ($session->get('userID')) {
1877 $logParams['modified_id'] = $session->get('userID');
1880 $logParams['modified_id'] = $currentMembership['contact_id'];
1882 CRM_Member_BAO_MembershipLog
::add($logParams, CRM_Core_DAO
::$_nullArray);
1887 * Function to get the contribution page id from the membership record
1889 * @param int membershipId membership id
1891 * @return int $contributionPageId contribution page id
1895 static function getContributionPageId($membershipID) {
1897 SELECT c.contribution_page_id as pageID
1898 FROM civicrm_membership_payment mp, civicrm_contribution c
1899 WHERE mp.contribution_id = c.id
1900 AND c.contribution_page_id IS NOT NULL
1901 AND mp.membership_id = " . CRM_Utils_Type
::escape($membershipID, 'Integer')
1902 . " ORDER BY mp.id DESC";
1904 return CRM_Core_DAO
::singleValueQuery($query,
1905 CRM_Core_DAO
::$_nullArray
1910 * Function to updated related memberships
1912 * @param int $ownerMembershipId owner Membership Id
1913 * @param array $params formatted array of key => value..
1916 static function updateRelatedMemberships($ownerMembershipId, $params) {
1917 $membership = new CRM_Member_DAO_Membership();
1918 $membership->owner_membership_id
= $ownerMembershipId;
1919 $membership->find();
1921 while ($membership->fetch()) {
1922 $relatedMembership = new CRM_Member_DAO_Membership();
1923 $relatedMembership->id
= $membership->id
;
1924 $relatedMembership->copyValues($params);
1925 $relatedMembership->save();
1926 $relatedMembership->free();
1929 $membership->free();
1933 * Function to get list of membership fields for profile
1934 * For now we only allow custom membership fields to be in
1937 * @return return the list of membership fields
1941 static function getMembershipFields($mode = NULL) {
1942 $fields = CRM_Member_DAO_Membership
::export();
1944 unset($fields['membership_contact_id']);
1945 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Membership'));
1947 $membershipType = CRM_Member_DAO_MembershipType
::export();
1949 $membershipStatus = CRM_Member_DAO_MembershipStatus
::export();
1951 $fields = array_merge($fields, $membershipType, $membershipStatus);
1957 * function to get the sort name of a contact for a particular membership
1959 * @param int $id id of the membership
1961 * @return null|string sort name of the contact if found
1965 static function sortName($id) {
1966 $id = CRM_Utils_Type
::escape($id, 'Integer');
1969 SELECT civicrm_contact.sort_name
1970 FROM civicrm_membership, civicrm_contact
1971 WHERE civicrm_membership.contact_id = civicrm_contact.id
1972 AND civicrm_membership.id = {$id}
1974 return CRM_Core_DAO
::singleValueQuery($query, CRM_Core_DAO
::$_nullArray);
1978 * function to create memberships for related contacts
1979 * takes into account the maximum related memberships
1981 * @param array $params array of key - value pairs
1982 * @param object $membership membership object
1984 * @return null|relatedMembership array of memberships if created
1988 static function createRelatedMemberships(&$params, &$dao) {
1989 static $relatedContactIds = array();
1991 $membership = new CRM_Member_DAO_Membership();
1992 $membership->id
= $dao->id
;
1994 // required since create method doesn't return all the
1995 // parameters in the returned membership object
1996 if (!$membership->find(TRUE)) {
1999 $deceasedStatusId = array_search('Deceased', CRM_Member_PseudoConstant
::membershipStatus());
2000 // FIXME : While updating/ renewing the
2001 // membership, if the relationship is PAST then
2002 // the membership of the related contact must be
2004 // For that, getting Membership Status for which
2005 // is_current_member is 0. It works for the
2006 // generated data as there is only one membership
2007 // status having is_current_member = 0.
2008 // But this wont work exactly if there will be
2009 // more than one status having is_current_member = 0.
2010 $membershipStatus = new CRM_Member_DAO_MembershipStatus();
2011 $membershipStatus->is_current_member
= 0;
2012 if ($membershipStatus->find(TRUE)) {
2013 $expiredStatusId = $membershipStatus->id
;
2015 $expiredStatusId = array_search('Expired', CRM_Member_PseudoConstant
::membershipStatus());
2018 $allRelatedContacts = array();
2019 $relatedContacts = array();
2020 if (!is_a($membership, 'CRM_Core_Error')) {
2021 $allRelatedContacts = CRM_Member_BAO_Membership
::checkMembershipRelationship($membership->id
,
2022 $membership->contact_id
,
2023 CRM_Utils_Array
::value('action', $params)
2027 // check for loops. CRM-4213
2028 // remove repeated related contacts, which already inherited membership.
2029 $relatedContactIds[$membership->contact_id
] = TRUE;
2030 foreach ($allRelatedContacts as $cid => $status) {
2031 if (empty($relatedContactIds[$cid])) {
2032 $relatedContactIds[$cid] = TRUE;
2034 //don't create membership again for owner contact.
2035 $nestedRelationship = FALSE;
2036 if ($membership->owner_membership_id
) {
2037 $nestedRelMembership = new CRM_Member_DAO_Membership();
2038 $nestedRelMembership->id
= $membership->owner_membership_id
;
2039 $nestedRelMembership->contact_id
= $cid;
2040 $nestedRelationship = $nestedRelMembership->find(TRUE);
2041 $nestedRelMembership->free();
2043 if (!$nestedRelationship) {
2044 $relatedContacts[$cid] = $status;
2049 //lets cleanup related membership if any.
2050 if (empty($relatedContacts)) {
2051 self
::deleteRelatedMemberships($membership->id
);
2054 // Edit the params array
2055 unset($params['id']);
2056 // Reminder should be sent only to the direct membership
2057 unset($params['reminder_date']);
2058 // unset the custom value ids
2059 if (is_array(CRM_Utils_Array
::value('custom', $params))) {
2060 foreach ($params['custom'] as $k => $v) {
2061 unset($params['custom'][$k]['id']);
2064 if (!isset($params['membership_type_id'])) {
2065 $params['membership_type_id'] = $membership->membership_type_id
;
2068 // max_related should be set in the parent membership
2069 unset($params['max_related']);
2070 // Number of inherited memberships available - NULL is interpreted as unlimited, '0' as none
2071 $available = ($membership->max_related
== NULL ? PHP_INT_MAX
: $membership->max_related
);
2072 $queue = array(); // will be used to queue potential memberships to be created
2074 foreach ($relatedContacts as $contactId => $relationshipStatus) {
2075 //use existing membership record.
2076 $relMembership = new CRM_Member_DAO_Membership();
2077 $relMembership->contact_id
= $contactId;
2078 $relMembership->owner_membership_id
= $membership->id
;
2079 $relMemIds = array();
2080 if ($relMembership->find(TRUE)) {
2081 $params['id'] = $relMemIds['membership'] = $relMembership->id
;
2083 $params['contact_id'] = $contactId;
2084 $params['owner_membership_id'] = $membership->id
;
2086 // set status_id as it might have been changed for
2087 // past relationship
2088 $params['status_id'] = $membership->status_id
;
2090 if ($deceasedStatusId &&
2091 CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $contactId, 'is_deceased')
2093 $params['status_id'] = $deceasedStatusId;
2095 elseif ((CRM_Utils_Array
::value('action', $params) & CRM_Core_Action
::UPDATE
) &&
2096 ($relationshipStatus == CRM_Contact_BAO_Relationship
::PAST
)
2098 $params['status_id'] = $expiredStatusId;
2101 //don't calculate status again in create( );
2102 $params['skipStatusCal'] = TRUE;
2104 //do create activity if we changed status.
2105 if ($params['status_id'] != $relMembership->status_id
) {
2106 $params['createActivity'] = TRUE;
2109 // we should not created contribution record for related contacts, CRM-3371
2110 unset($params['contribution_status_id']);
2112 if (($params['status_id'] == $deceasedStatusId) ||
($params['status_id'] == $expiredStatusId)) {
2113 // related membership is not active so does not count towards maximum
2114 CRM_Member_BAO_Membership
::create($params, $relMemIds);
2116 // related membership already exists, so this is just an update
2117 if (isset($params['id'])) {
2118 if ($available > 0) {
2119 CRM_Member_BAO_Membership
::create($params, $relMemIds);
2121 } else { // we have run out of inherited memberships, so delete extras
2122 self
::deleteMembership($params['id']);
2124 // we need to first check if there will remain inherited memberships, so queue it up
2130 // now go over the queue and create any available related memberships
2132 while (($available > 0) && ($params = each($queue))) {
2133 CRM_Member_BAO_Membership
::create($params['value'], $relMemIds);
2140 * Delete the record that are associated with this Membership Payment
2142 * @param int $membershipId membsership id.
2144 * @return boolean true if deleted false otherwise
2147 static function deleteMembershipPayment($membershipId) {
2149 $membesrshipPayment = new CRM_Member_DAO_MembershipPayment();
2150 $membesrshipPayment->membership_id
= $membershipId;
2151 $membesrshipPayment->find();
2153 while ($membesrshipPayment->fetch()) {
2154 CRM_Contribute_BAO_Contribution
::deleteContribution($membesrshipPayment->contribution_id
);
2155 CRM_Utils_Hook
::pre('delete', 'MembershipPayment', $membesrshipPayment->id
, $membesrshipPayment);
2156 $membesrshipPayment->delete();
2157 CRM_Utils_Hook
::post('delete', 'MembershipPayment', $membesrshipPayment->id
, $membesrshipPayment);
2159 return $membesrshipPayment;
2162 static function &buildMembershipTypeValues(&$form, $membershipTypeID = NULL) {
2163 $whereClause = " WHERE domain_id = ". CRM_Core_Config
::domainID();
2165 if (is_array($membershipTypeID)) {
2166 $allIDs = implode(',', $membershipTypeID);
2167 $whereClause .= " AND id IN ( $allIDs )";
2169 elseif (is_numeric($membershipTypeID) &&
2170 $membershipTypeID > 0
2172 $whereClause .= " AND id = $membershipTypeID";
2177 FROM civicrm_membership_type
2180 $dao = CRM_Core_DAO
::executeQuery($query);
2182 $membershipTypeValues = array();
2183 $membershipTypeFields = array(
2184 'id', 'minimum_fee', 'name', 'is_active',
2185 'description', 'financial_type_id', 'auto_renew','member_of_contact_id',
2186 'relationship_type_id', 'relationship_direction', 'max_related',
2189 while ($dao->fetch()) {
2190 $membershipTypeValues[$dao->id
] = array();
2191 foreach ($membershipTypeFields as $mtField) {
2192 $membershipTypeValues[$dao->id
][$mtField] = $dao->$mtField;
2197 CRM_Utils_Hook
::membershipTypeValues($form, $membershipTypeValues);
2199 if (is_numeric($membershipTypeID) &&
2200 $membershipTypeID > 0
2202 return $membershipTypeValues[$membershipTypeID];
2205 return $membershipTypeValues;
2210 * Function to get membership record count for a Contact
2212 * @param int $contactId Contact ID
2213 * @param boolean $activeOnly
2215 * @return int count of membership records
2219 static function getContactMembershipCount($contactID, $activeOnly = FALSE) {
2220 $select = "SELECT count(*) FROM civicrm_membership ";
2221 $where = "WHERE civicrm_membership.contact_id = {$contactID} AND civicrm_membership.is_test = 0 ";
2223 // CRM-6627, all status below 3 (active, pending, grace) are considered active
2225 $select .= " INNER JOIN civicrm_membership_status ON civicrm_membership.status_id = civicrm_membership_status.id ";
2226 $where .= " and civicrm_membership_status.is_current_member = 1";
2229 $query = $select . $where;
2230 return CRM_Core_DAO
::singleValueQuery($query);
2234 * Function to check whether payment processor supports
2235 * cancellation of membership subscription
2237 * @param int $mid membership id
2243 static function isCancelSubscriptionSupported($mid, $isNotCancelled = TRUE) {
2244 $cacheKeyString = "$mid";
2245 $cacheKeyString .= $isNotCancelled ?
'_1' : '_0';
2247 static $supportsCancel = array();
2249 if (!array_key_exists($cacheKeyString, $supportsCancel)) {
2250 $supportsCancel[$cacheKeyString] = FALSE;
2251 $isCancelled = FALSE;
2253 if ($isNotCancelled) {
2254 $isCancelled = self
::isSubscriptionCancelled($mid);
2257 $paymentObject = CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($mid, 'membership', 'obj');
2258 if (!empty($paymentObject)) {
2259 $supportsCancel[$cacheKeyString] = $paymentObject->isSupported('cancelSubscription') && !$isCancelled;
2262 return $supportsCancel[$cacheKeyString];
2266 * Function to check whether subscription is already cancelled
2268 * @param int $mid membership id
2270 * @return string $status contribution status
2274 static function isSubscriptionCancelled($mid) {
2276 SELECT cr.contribution_status_id
2277 FROM civicrm_contribution_recur cr
2278 LEFT JOIN civicrm_membership mem ON ( cr.id = mem.contribution_recur_id )
2279 WHERE mem.id = %1 LIMIT 1";
2280 $params = array(1 => array($mid, 'Integer'));
2281 $statusId = CRM_Core_DAO
::singleValueQuery($sql, $params);
2282 $status = CRM_Contribute_PseudoConstant
::contributionStatus($statusId);
2283 if ($status == 'Cancelled') {
2290 * Function to get membership joins for a specified membership
2291 * type. Specifically, retrieves a count of still current memberships whose
2292 * join_date and start_date are within a specified date range. Dates match
2293 * the pattern "yyyy-mm-dd".
2295 * @param int $membershipTypeId membership type id
2296 * @param int $startDate date on which to start counting
2297 * @param int $endDate date on which to end counting
2298 * @param bool $isTest if true, membership is for a test site
2300 * @return returns the number of members of type $membershipTypeId
2301 * whose join_date is between $startDate and $endDate and
2302 * whose start_date is between $startDate and $endDate
2304 static function getMembershipJoins($membershipTypeId, $startDate, $endDate, $isTest = 0) {
2305 $testClause = 'membership.is_test = 1';
2307 $testClause = '( membership.is_test IS NULL OR membership.is_test = 0 )';
2309 if (!self
::$_signupActType) {
2310 self
::_getActTypes();
2313 if (!self
::$_signupActType) {
2318 SELECT COUNT(DISTINCT membership.id) as member_count
2319 FROM civicrm_membership membership
2320 INNER JOIN civicrm_activity activity ON (activity.source_record_id = membership.id AND activity.activity_type_id = %1)
2321 INNER JOIN civicrm_membership_status status ON ( membership.status_id = status.id AND status.is_current_member = 1 )
2322 INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND contact.is_deleted = 0 )
2323 WHERE membership.membership_type_id = %2
2324 AND activity.activity_date_time >= '$startDate' AND activity.activity_date_time <= '$endDate 23:59:59'
2328 1 => array(self
::$_signupActType, 'Integer'),
2329 2 => array($membershipTypeId, 'Integer'),
2332 $memberCount = CRM_Core_DAO
::singleValueQuery($query, $params);
2334 return (int)$memberCount;
2338 * Function to get membership renewals for a specified membership
2339 * type. Specifically, retrieves a count of still current memberships
2340 * whose join_date is before and start_date is within a specified date
2341 * range. Dates match the pattern "yyyy-mm-dd".
2343 * @param int $membershipTypeId membership type id
2344 * @param int $startDate date on which to start counting
2345 * @param int $endDate date on which to end counting
2346 * @param bool $isTest if true, membership is for a test site
2348 * @return returns the number of members of type $membershipTypeId
2349 * whose join_date is before $startDate and
2350 * whose start_date is between $startDate and $endDate
2352 static function getMembershipRenewals($membershipTypeId, $startDate, $endDate, $isTest = 0) {
2353 $testClause = 'membership.is_test = 1';
2355 $testClause = '( membership.is_test IS NULL OR membership.is_test = 0 )';
2357 if (!self
::$_renewalActType) {
2358 self
::_getActTypes();
2361 if (!self
::$_renewalActType) {
2366 SELECT COUNT(DISTINCT membership.id) as member_count
2367 FROM civicrm_membership membership
2368 INNER JOIN civicrm_activity activity ON (activity.source_record_id = membership.id AND activity.activity_type_id = %1)
2369 INNER JOIN civicrm_membership_status status ON ( membership.status_id = status.id AND status.is_current_member = 1 )
2370 INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND contact.is_deleted = 0 )
2371 WHERE membership.membership_type_id = %2
2372 AND activity.activity_date_time >= '$startDate' AND activity.activity_date_time <= '$endDate 23:59:59'
2376 1 => array(self
::$_renewalActType, 'Integer'),
2377 2 => array($membershipTypeId, 'Integer'),
2379 $memberCount = CRM_Core_DAO
::singleValueQuery($query, $params);
2381 return (int)$memberCount;
2385 * Function to process price set and line items.
2391 function processPriceSet($membershipId, $lineItem) {
2392 //FIXME : need to move this too
2393 if (!$membershipId ||
!is_array($lineItem)
2394 || CRM_Utils_System
::isNull($lineItem)
2399 foreach ($lineItem as $priceSetId => $values) {
2403 foreach ($values as $line) {
2404 $line['entity_table'] = 'civicrm_membership';
2405 $line['entity_id'] = $membershipId;
2406 CRM_Price_BAO_LineItem
::create($line);
2412 * retrieve the contribution record for the associated Membership id
2414 * @param int $membershipId membsership id.
2416 * @return contribution id
2419 static function getMembershipContributionId($membershipId) {
2421 $membesrshipPayment = new CRM_Member_DAO_MembershipPayment();
2422 $membesrshipPayment->membership_id
= $membershipId;
2423 if ($membesrshipPayment->find(TRUE)) {
2424 return $membesrshipPayment->contribution_id
;
2430 * The function checks and updates the status of all membership records for a given domain using the
2431 * calc_membership_status and update_contact_membership APIs.
2434 * Sending renewal reminders has been migrated from this job to the Scheduled Reminders function as of 4.3.
2436 * @return array $result
2439 static function updateAllMembershipStatus() {
2440 require_once 'api/api.php';
2442 //get all active statuses of membership, CRM-3984
2443 $allStatus = CRM_Member_PseudoConstant
::membershipStatus();
2444 $statusLabels = CRM_Member_PseudoConstant
::membershipStatus(NULL, NULL, 'label');
2445 $allTypes = CRM_Member_PseudoConstant
::membershipType();
2446 $contribStatus = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
2448 // get only memberships with active membership types
2450 SELECT civicrm_membership.id as membership_id,
2451 civicrm_membership.is_override as is_override,
2452 civicrm_membership.membership_type_id as membership_type_id,
2453 civicrm_membership.status_id as status_id,
2454 civicrm_membership.join_date as join_date,
2455 civicrm_membership.start_date as start_date,
2456 civicrm_membership.end_date as end_date,
2457 civicrm_membership.source as source,
2458 civicrm_contact.id as contact_id,
2459 civicrm_contact.is_deceased as is_deceased,
2460 civicrm_membership.owner_membership_id as owner_membership_id,
2461 civicrm_membership.contribution_recur_id as recur_id
2462 FROM civicrm_membership
2463 INNER JOIN civicrm_contact ON ( civicrm_membership.contact_id = civicrm_contact.id )
2464 INNER JOIN civicrm_membership_type ON
2465 (civicrm_membership.membership_type_id = civicrm_membership_type.id AND civicrm_membership_type.is_active = 1)
2466 WHERE civicrm_membership.is_test = 0";
2469 $dao = CRM_Core_DAO
::executeQuery($query, $params);
2471 $today = date('Y-m-d');
2475 $smarty = CRM_Core_Smarty
::singleton();
2477 while ($dao->fetch()) {
2481 // Put common parameters into array for easy access
2482 $memberParams = array(
2483 'id' => $dao->membership_id
,
2484 'status_id' => $dao->status_id
,
2485 'contact_id' => $dao->contact_id
,
2486 'membership_type_id' => $dao->membership_type_id
,
2487 'membership_type' => $allTypes[$dao->membership_type_id
],
2488 'join_date' => $dao->join_date
,
2489 'start_date' => $dao->start_date
,
2490 'end_date' => $dao->end_date
,
2491 'source' => $dao->source
,
2492 'skipStatusCal' => TRUE,
2493 'skipRecentView' => TRUE,
2496 $smarty->assign_by_ref('memberParams', $memberParams);
2498 //update membership record to Deceased if contact is deceased
2499 if ($dao->is_deceased
) {
2500 // check for 'Deceased' membership status, CRM-5636
2501 $deceaseStatusId = array_search('Deceased', $allStatus);
2502 if (!$deceaseStatusId) {
2503 CRM_Core_Error
::fatal(ts("Deceased Membership status is missing or not active. <a href='%1'>Click here to check</a>.", array(1 => CRM_Utils_System
::url('civicrm/admin/member/membershipStatus', 'reset=1'))));
2506 //process only when status change.
2507 if ($dao->status_id
!= $deceaseStatusId) {
2508 //take all params that need to save.
2509 $deceasedMembership = $memberParams;
2510 $deceasedMembership['status_id'] = $deceaseStatusId;
2511 $deceasedMembership['createActivity'] = TRUE;
2512 $deceasedMembership['version'] = 3;
2514 //since there is change in status.
2515 $statusChange = array('status_id' => $deceaseStatusId);
2516 $smarty->append_by_ref('memberParams', $statusChange, TRUE);
2518 $deceasedMembership['contact_id'],
2519 $deceasedMembership['membership_type_id'],
2520 $deceasedMembership['membership_type'],
2521 $deceasedMembership['join_date'],
2522 $deceasedMembership['start_date'],
2523 $deceasedMembership['end_date'],
2524 $deceasedMembership['source']
2527 //process membership record.
2528 civicrm_api('membership', 'create', $deceasedMembership);
2533 //we fetch related, since we need to check for deceased
2534 //now further processing is handle w/ main membership record.
2535 if ($dao->owner_membership_id
) {
2539 //update membership records where status is NOT - Pending OR Cancelled.
2540 //as well as membership is not override.
2541 //skipping Expired membership records -> reduced extra processing( kiran )
2542 if (!$dao->is_override
&&
2543 !in_array($dao->status_id
, array(array_search('Pending', $allStatus),
2544 array_search('Cancelled', $allStatus),
2545 array_search('Expired', $allStatus),
2549 // CRM-7248: added excludeIsAdmin param to the following fn call to prevent moving to admin statuses
2550 //get the membership status as per id.
2551 $newStatus = civicrm_api('membership_status', 'calc',
2553 'membership_id' => $dao->membership_id
, 'version' => 3, 'ignore_admin_only'=> FALSE), TRUE
2555 $statusId = CRM_Utils_Array
::value('id', $newStatus);
2557 //process only when status change.
2559 $statusId != $dao->status_id
2561 //take all params that need to save.
2562 $memParams = $memberParams;
2563 $memParams['status_id'] = $statusId;
2564 $memParams['createActivity'] = TRUE;
2565 $memParams['version'] = 3;
2567 // Unset columns which should remain unchanged from their current saved
2568 // values. This avoids race condition in which these values may have
2569 // been changed by other processes.
2571 $memParams['contact_id'],
2572 $memParams['membership_type_id'],
2573 $memParams['membership_type'],
2574 $memParams['join_date'],
2575 $memParams['start_date'],
2576 $memParams['end_date'],
2577 $memParams['source']
2579 //since there is change in status.
2580 $statusChange = array('status_id' => $statusId);
2581 $smarty->append_by_ref('memberParams', $statusChange, TRUE);
2583 //process member record.
2584 civicrm_api('membership', 'create', $memParams);
2588 // CRM_Core_Error::debug( 'fEnd', count( $GLOBALS['_DB_DATAOBJECT']['RESULTS'] ) );
2590 $result['is_error'] = 0;
2591 $result['messages'] = ts('Processed %1 membership records. Updated %2 records.', array(1 => $processCount, 2 => $updateCount));
2595 /** The function returns the membershiptypes for a particular contact
2596 * who has lifetime membership without end date.
2598 * @param array $contactMembershipType array of allMembershipTypes Key - value pairs
2602 static function getAllContactMembership($contactID, $isTest = FALSE, $onlyLifeTime = FALSE) {
2603 $contactMembershipType = array();
2605 return $contactMembershipType;
2608 $dao = new CRM_Member_DAO_Membership();
2609 $dao->contact_id
= $contactID;
2610 $pendingStatusId = array_search('Pending', CRM_Member_PseudoConstant
::membershipStatus());
2611 $dao->whereAdd("status_id != $pendingStatusId");
2614 $dao->is_test
= $isTest;
2617 $dao->whereAdd('is_test IS NULL OR is_test = 0');
2620 if ($onlyLifeTime) {
2621 $dao->whereAdd('end_date IS NULL');
2625 while ($dao->fetch()) {
2626 $membership = array();
2627 CRM_Core_DAO
::storeValues($dao, $membership);
2628 $contactMembershipType[$dao->membership_type_id
] = $membership;
2630 return $contactMembershipType;
2634 * Function to record contribution record associated with membership
2636 * @param array $params array of submitted params
2637 * @param array $ids (param in process of being removed - try to use params) array of ids
2642 static function recordMembershipContribution( &$params, $ids = array()) {
2643 $membershipId = $params['membership_id'];
2644 $contributionParams = array();
2645 $config = CRM_Core_Config
::singleton();
2646 $contributionParams['currency'] = $config->defaultCurrency
;
2647 $contributionParams['receipt_date'] = (CRM_Utils_Array
::value('receipt_date', $params)) ?
$params['receipt_date'] : 'null';
2648 $contributionParams['source'] = CRM_Utils_Array
::value('contribution_source', $params);
2649 $contributionParams['soft_credit'] = CRM_Utils_Array
::value('soft_credit', $params);
2650 $contributionParams['non_deductible_amount'] = 'null';
2651 $recordContribution = array(
2652 'contact_id', 'total_amount', 'receive_date', 'financial_type_id',
2653 'payment_instrument_id', 'trxn_id', 'invoice_id', 'is_test',
2654 'contribution_status_id', 'check_number', 'campaign_id', 'is_pay_later',
2656 foreach ($recordContribution as $f) {
2657 $contributionParams[$f] = CRM_Utils_Array
::value($f, $params);
2660 // make entry in batch entity batch table
2661 if (!empty($params['batch_id'])) {
2662 $contributionParams['batch_id'] = $params['batch_id'];
2665 if (!empty($params['contribution_contact_id'])) {
2666 // deal with possibility of a different person paying for contribution
2667 $contributionParams['contact_id'] = $params['contribution_contact_id'];
2670 if (!empty($params['processPriceSet']) &&
2671 !empty($params['lineItems'])
2673 $contributionParams['line_item'] = CRM_Utils_Array
::value('lineItems', $params, NULL);
2676 $contribution = CRM_Contribute_BAO_Contribution
::create($contributionParams, $ids);
2678 // store contribution id
2679 $params['contribution_id'] = $contribution->id
;
2682 //insert payment record for this membership
2683 if (empty($ids['contribution']) ||
!empty($params['is_recur'])) {
2684 $mpDAO = new CRM_Member_DAO_MembershipPayment();
2685 $mpDAO->membership_id
= $membershipId;
2686 $mpDAO->contribution_id
= $contribution->id
;
2687 if (!empty($params['is_recur'])) {
2691 CRM_Utils_Hook
::pre('create', 'MembershipPayment', NULL, $mpDAO);
2693 CRM_Utils_Hook
::post('create', 'MembershipPayment', $mpDAO->id
, $mpDAO);
2695 return $contribution;
2699 * Function to record line items for default membership
2703 * @param $membershipType array with membership type and organization
2705 * @param$ priceSetId priceset id
2709 static function createLineItems(&$qf, $membershipType, &$priceSetId) {
2710 $qf->_priceSetId
= $priceSetId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', 'default_membership_type_amount', 'id', 'name');
2712 $qf->_priceSet
= $priceSets = current(CRM_Price_BAO_PriceSet
::getSetDetail($priceSetId));
2714 $editedFieldParams = array(
2715 'price_set_id' => $priceSetId,
2716 'name' => $membershipType[0],
2718 $editedResults = array();
2719 CRM_Price_BAO_PriceField
::retrieve($editedFieldParams, $editedResults);
2721 if (!empty($editedResults)) {
2722 unset($qf->_priceSet
['fields']);
2723 $qf->_priceSet
['fields'][$editedResults['id']] = $priceSets['fields'][$editedResults['id']];
2724 unset($qf->_priceSet
['fields'][$editedResults['id']]['options']);
2725 $fid = $editedResults['id'];
2726 $editedFieldParams = array(
2727 'price_field_id' => $editedResults['id'],
2728 'membership_type_id' => $membershipType[1],
2730 $editedResults = array();
2731 CRM_Price_BAO_PriceFieldValue
::retrieve($editedFieldParams, $editedResults);
2732 $qf->_priceSet
['fields'][$fid]['options'][$editedResults['id']] = $priceSets['fields'][$fid]['options'][$editedResults['id']];
2733 if (!empty($qf->_params
['total_amount'])) {
2734 $qf->_priceSet
['fields'][$fid]['options'][$editedResults['id']]['amount'] = $qf->_params
['total_amount'];
2738 $fieldID = key($qf->_priceSet
['fields']);
2739 $qf->_params
['price_' . $fieldID] = CRM_Utils_Array
::value('id', $editedResults);
2742 static function _getActTypes() {
2743 $activityTypes = CRM_Core_PseudoConstant
::activityType(TRUE, FALSE, FALSE, 'name');
2744 self
::$_renewalActType = CRM_Utils_Array
::key('Membership Renewal', $activityTypes);
2745 self
::$_signupActType = CRM_Utils_Array
::key('Membership Signup', $activityTypes);