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 (CRM_Utils_Array
::value('membership', $ids)) {
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 (CRM_Utils_Array
::value('membership', $ids)) {
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 (!CRM_Utils_Array
::value('is_override', $params) &&
235 !CRM_Utils_Array
::value('skipStatusCal', $params)
237 $dates = array('start_date', 'end_date', 'join_date');
238 foreach ($dates as $date) {
239 $
$date = $params[$date] = CRM_Utils_Date
::processDate(CRM_Utils_Array
::value($date, $params), NULL, TRUE, 'Ymd');
242 //fix for CRM-3570, during import exclude the statuses those having is_admin = 1
243 $excludeIsAdmin = CRM_Utils_Array
::value('exclude_is_admin', $params, FALSE);
245 //CRM-3724 always skip is_admin if is_override != true.
246 if (!$excludeIsAdmin &&
247 !CRM_Utils_Array
::value('is_override', $params)
249 $excludeIsAdmin = TRUE;
252 $calcStatus = $calcStatus = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($start_date, $end_date, $join_date,
253 'today', $excludeIsAdmin
255 if (empty($calcStatus)) {
256 // Redirect the form in case of error
257 // @todo this redirect in the BAO layer is really bad & should be moved to the form layer
258 // however since we have no idea how (if) this is triggered we can't safely move / remove it
259 // NB I tried really hard to trigger this error from backoffice membership form in order to test it
260 // and am convinced form validation is complete on that form WRT this error.
261 $errorParams = array(
262 'message_title' => ts('No valid membership status for given dates.'),
263 'legacy_redirect_path' => 'civicrm/contact/view',
264 'legacy_redirect_query' => "reset=1&force=1&cid={$params['contact_id']}&selectedChild=member",
266 throw new CRM_Core_Exception(ts('The membership cannot be saved because the status cannot be calculated.'), 0, $errorParams);
268 $params['status_id'] = $calcStatus['id'];
271 // data cleanup only: all verifications on number of related memberships are done upstream in:
272 // CRM_Member_BAO_Membership::createRelatedMemberships()
273 // CRM_Contact_BAO_Relationship::relatedMemberships()
274 if (isset($params['owner_membership_id'])) {
275 unset($params['max_related']);
277 // if membership allows related, default max_related to value in membership_type
278 if (!array_key_exists('max_related', $params) && !empty($params['membership_type_id'])) {
279 $membershipType = CRM_Member_BAO_MembershipType
::getMembershipTypeDetails($params['membership_type_id']);
280 if (isset($membershipType['relationship_type_id'])) {
281 $params['max_related'] = CRM_Utils_Array
::value('max_related', $membershipType);
286 $transaction = new CRM_Core_Transaction();
288 $membership = self
::add($params, $ids);
290 if (is_a($membership, 'CRM_Core_Error')) {
291 $transaction->rollback();
295 // add custom field values
296 if (CRM_Utils_Array
::value('custom', $params)
297 && is_array($params['custom'])
299 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_membership', $membership->id
);
302 $params['membership_id'] = $membership->id
;
303 if (isset($ids['membership'])) {
304 $ids['contribution'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipPayment',
311 //record contribution for this membership
312 if (CRM_Utils_Array
::value('contribution_status_id', $params) && !CRM_Utils_Array
::value('relate_contribution_id', $params)) {
313 $memInfo = array_merge($params, array('membership_id' => $membership->id
));
314 $params['contribution'] = self
::recordMembershipContribution($memInfo, $ids);
317 //insert payment record for this membership
318 if (CRM_Utils_Array
::value('relate_contribution_id', $params)) {
319 $mpDAO = new CRM_Member_DAO_MembershipPayment();
320 $mpDAO->membership_id
= $membership->id
;
321 $mpDAO->contribution_id
= $params['relate_contribution_id'];
322 if (!($mpDAO->find(TRUE))) {
323 CRM_Utils_Hook
::pre('create', 'MembershipPayment', NULL, $mpDAO);
325 CRM_Utils_Hook
::post('create', 'MembershipPayment', $mpDAO->id
, $mpDAO);
329 // add activity record only during create mode and renew mode
330 // also add activity if status changed CRM-3984 and CRM-2521
331 if (!CRM_Utils_Array
::value('membership', $ids) ||
332 $activityType == 'Membership Renewal' ||
333 CRM_Utils_Array
::value('createActivity', $params)
335 if (CRM_Utils_Array
::value('membership', $ids)) {
336 CRM_Core_DAO
::commonRetrieveAll('CRM_Member_DAO_Membership',
340 array('contact_id', 'membership_type_id', 'source')
343 $membership->contact_id
= $data[$membership->id
]['contact_id'];
344 $membership->membership_type_id
= $data[$membership->id
]['membership_type_id'];
345 $membership->source
= CRM_Utils_Array
::value('source', $data[$membership->id
]);
348 // since we are going to create activity record w/
349 // individual contact as a target in case of on behalf signup,
350 // so get the copy of organization id, CRM-5551
351 $realMembershipContactId = $membership->contact_id
;
353 // create activity source = individual, target = org CRM-4027
354 $targetContactID = NULL;
355 if (CRM_Utils_Array
::value('is_for_organization', $params)) {
356 $targetContactID = $membership->contact_id
;
357 $membership->contact_id
= CRM_Utils_Array
::value('userId', $ids);
360 if (empty($membership->contact_id
) && (!empty($membership->owner_membership_id
))) {
361 $membership->contact_id
= $realMembershipContactId;
364 if (CRM_Utils_Array
::value('membership', $ids) && $activityType != 'Membership Signup') {
365 CRM_Activity_BAO_Activity
::addActivity($membership, $activityType, $targetContactID);
366 } elseif (!CRM_Utils_Array
::value('membership', $ids)) {
367 CRM_Activity_BAO_Activity
::addActivity($membership, $activityType, $targetContactID);
370 // we might created activity record w/ individual
371 // contact as target so update membership object w/
372 // original organization id, CRM-5551
373 $membership->contact_id
= $realMembershipContactId;
376 $transaction->commit();
378 self
::createRelatedMemberships($params, $membership);
380 // do not add to recent items for import, CRM-4399
381 if (!CRM_Utils_Array
::value('skipRecentView', $params)) {
382 $url = CRM_Utils_System
::url('civicrm/contact/view/membership',
383 "action=view&reset=1&id={$membership->id}&cid={$membership->contact_id}&context=home"
385 if(empty($membership->membership_type_id
)){// ie in an update situation
386 $membership->find(TRUE);
388 $membershipTypes = CRM_Member_PseudoConstant
::membershipType();
389 $title = CRM_Contact_BAO_Contact
::displayName($membership->contact_id
) . ' - ' . ts('Membership Type:') . ' ' . $membershipTypes[$membership->membership_type_id
];
391 $recentOther = array();
392 if (CRM_Core_Permission
::checkActionPermission('CiviMember', CRM_Core_Action
::UPDATE
)) {
393 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/contact/view/membership',
394 "action=update&reset=1&id={$membership->id}&cid={$membership->contact_id}&context=home"
397 if (CRM_Core_Permission
::checkActionPermission('CiviMember', CRM_Core_Action
::DELETE
)) {
398 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/contact/view/membership',
399 "action=delete&reset=1&id={$membership->id}&cid={$membership->contact_id}&context=home"
403 // add the recently created Membership
404 CRM_Utils_Recent
::add($title,
408 $membership->contact_id
,
418 * Function to check the membership extended through relationship
420 * @param int $membershipId membership id
421 * @param int $contactId contact id
423 * @return Array array of contact_id of all related contacts.
426 static function checkMembershipRelationship($membershipId, $contactId, $action = CRM_Core_Action
::ADD
) {
428 $membershipTypeID = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $membershipId, 'membership_type_id');
430 $membershipType = CRM_Member_BAO_MembershipType
::getMembershipTypeDetails($membershipTypeID);
431 $relationships = array();
432 if (isset($membershipType['relationship_type_id'])) {
433 $relationships = CRM_Contact_BAO_Relationship
::getRelationship($contactId,
434 CRM_Contact_BAO_Relationship
::CURRENT
436 if ($action & CRM_Core_Action
::UPDATE
) {
437 $pastRelationships = CRM_Contact_BAO_Relationship
::getRelationship($contactId,
438 CRM_Contact_BAO_Relationship
::PAST
440 $relationships = array_merge($relationships, $pastRelationships);
444 if (!empty($relationships)) {
445 // check for each contact relationships
446 foreach ($relationships as $values) {
447 //get details of the relationship type
448 $relType = array('id' => $values['civicrm_relationship_type_id']);
449 $relValues = array();
450 CRM_Contact_BAO_RelationshipType
::retrieve($relType, $relValues);
451 // Check if contact's relationship type exists in membership type
452 $relTypeDirs = array();
453 $relTypeIds = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $membershipType['relationship_type_id']);
454 $relDirections = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $membershipType['relationship_direction']);
455 $bidirectional = FALSE;
456 foreach ($relTypeIds as $key => $value) {
457 $relTypeDirs[] = $value . '_' . $relDirections[$key];
458 if (in_array($value, $relType) &&
459 $relValues['name_a_b'] == $relValues['name_b_a']
461 $bidirectional = TRUE;
465 $relTypeDir = $values['civicrm_relationship_type_id'] . '_' . $values['rtype'];
466 if ($bidirectional ||
in_array($relTypeDir, $relTypeDirs)) {
467 // $values['status'] is going to have value for
468 // current or past relationships.
469 $contacts[$values['cid']] = $values['status'];
474 // Sort by contact_id ascending
480 * Takes a bunch of params that are needed to match certain criteria and
481 * retrieves the relevant objects. We'll tweak this function to be more
482 * full featured over a period of time. This is the inverse function of
483 * create. It also stores all the retrieved values in the default array
485 * @param array $params (reference ) an assoc array of name/value pairs
486 * @param array $defaults (reference ) an assoc array to hold the name / value pairs
487 * in a hierarchical manner
488 * @param array $ids (reference) the array that holds all the db ids
490 * @return object CRM_Member_BAO_Membership object
494 static function retrieve(&$params, &$defaults) {
495 $membership = new CRM_Member_DAO_Membership();
497 $membership->copyValues($params);
499 if ($membership->find(TRUE)) {
500 CRM_Core_DAO
::storeValues($membership, $defaults);
502 //get the membership status and type values.
503 $statusANDType = self
::getStatusANDTypeValues($membership->id
);
505 'status', 'membership_type') as $fld) {
506 $defaults[$fld] = CRM_Utils_Array
::value($fld, $statusANDType[$membership->id
]);
508 if (CRM_Utils_Array
::value('is_current_member', $statusANDType[$membership->id
])) {
509 $defaults['active'] = TRUE;
522 * Function to get membership status and membership type values
524 * @param int $membershipId membership id of values to return
526 * @return array of key value pairs
529 static function getStatusANDTypeValues($membershipId) {
531 if (!$membershipId) {
535 SELECT membership.id as id,
536 status.id as status_id,
537 status.label as status,
538 status.is_current_member as is_current_member,
539 type.id as membership_type_id,
540 type.name as membership_type,
541 type.relationship_type_id as relationship_type_id
542 FROM civicrm_membership membership
543 INNER JOIN civicrm_membership_status status ON ( status.id = membership.status_id )
544 INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_type_id )
545 WHERE membership.id = %1';
546 $dao = CRM_Core_DAO
::executeQuery($sql, array(1 => array($membershipId, 'Positive')));
547 $properties = array('status', 'status_id', 'membership_type', 'membership_type_id', 'is_current_member', 'relationship_type_id');
548 while ($dao->fetch()) {
549 foreach ($properties as $property) {
550 $values[$dao->id
][$property] = $dao->$property;
558 * Function to delete membership.
559 * Wrapper for most delete calls. Use this unless you JUST want to delete related memberships w/o deleting the parent.
561 * @param int $membershipId membership id that needs to be deleted
565 * @return $results no of deleted Membership on success, false otherwise
568 static function del($membershipId) {
569 //delete related first and then delete parent.
570 self
::deleteRelatedMemberships($membershipId);
571 return self
::deleteMembership($membershipId);
575 * Function to delete membership.
577 * @param int $membershipId membership id that needs to be deleted
581 * @return $results no of deleted Membership on success, false otherwise
584 static function deleteMembership($membershipId) {
585 // CRM-12147, retrieve membership data before we delete it for hooks
586 $params = array('id' => $membershipId);
587 $memValues = array();
588 $memberships = self
::getValues($params, $memValues);
590 $membership = $memberships[$membershipId];
592 CRM_Utils_Hook
::pre('delete', 'Membership', $membershipId, $memValues);
594 $transaction = new CRM_Core_Transaction();
597 //delete activity record
598 $activityTypes = CRM_Core_PseudoConstant
::activityType(TRUE, FALSE, FALSE, 'name');
601 $deleteActivity = false;
602 $membershipActivities = array(
604 'Membership Renewal',
605 'Change Membership Status',
606 'Change Membership Type',
607 'Membership Renewal Reminder'
609 foreach($membershipActivities as $membershipActivity) {
610 $activityId = array_search($membershipActivity, $activityTypes);
612 $params['activity_type_id'][] = $activityId;
613 $deleteActivity = true;
616 if ($deleteActivity) {
617 $params['source_record_id'] = $membershipId;
618 CRM_Activity_BAO_Activity
::deleteActivity($params);
620 self
::deleteMembershipPayment($membershipId);
622 $results = $membership->delete();
623 $transaction->commit();
625 CRM_Utils_Hook
::post('delete', 'Membership', $membership->id
, $membership);
627 // delete the recently created Membership
628 $membershipRecent = array(
629 'id' => $membershipId,
630 'type' => 'Membership',
632 CRM_Utils_Recent
::del($membershipRecent);
638 * Function to delete related memberships
640 * @param int $ownerMembershipId
641 * @param int $contactId
646 static function deleteRelatedMemberships($ownerMembershipId, $contactId = NULL) {
647 if (!$ownerMembershipId && !$contactId) {
651 $membership = new CRM_Member_DAO_Membership();
652 $membership->owner_membership_id
= $ownerMembershipId;
655 $membership->contact_id
= $contactId;
659 while ($membership->fetch()) {
660 //delete related first and then delete parent.
661 self
::deleteRelatedMemberships($membership->id
);
662 self
::deleteMembership($membership->id
);
668 * Function to obtain active/inactive memberships from the list of memberships passed to it.
670 * @param array $memberships membership records
671 * @param string $status active or inactive
673 * @return array $actives array of memberships based on status
677 static function activeMembers($memberships, $status = 'active') {
679 if ($status == 'active') {
680 foreach ($memberships as $f => $v) {
681 if (CRM_Utils_Array
::value('active', $v)) {
687 elseif ($status == 'inactive') {
688 foreach ($memberships as $f => $v) {
689 if (!CRM_Utils_Array
::value('active', $v)) {
699 * Function to build Membership Block in Contribution Pages
701 * @param object $form form object
702 * @param int $pageId contribution page id
703 * @param boolean $formItems
704 * @param int $selectedMembershipTypeID selected membership id
705 * @param boolean $thankPage thank you page
706 * @param boolean $memContactId contact who is to be
707 * checked for having a current membership for a particular membership
711 static function buildMembershipBlock(&$form,
715 $selectedMembershipTypeID = NULL,
720 $separateMembershipPayment = FALSE;
721 if ($form->_membershipBlock
) {
722 $form->_currentMemberships
= array();
724 $membershipBlock = $form->_membershipBlock
;
725 $membershipTypeIds = $membershipTypes = $radio = array();
726 $membershipPriceset = (!empty($form->_priceSetId
) && $form->_useForMember
) ?
TRUE : FALSE;
728 $allowAutoRenewMembership = $autoRenewOption = FALSE;
729 $autoRenewMembershipTypeOptions = array();
731 $paymentProcessor = CRM_Core_PseudoConstant
::paymentProcessor(FALSE, FALSE, 'is_recur = 1');
733 $separateMembershipPayment = CRM_Utils_Array
::value('is_separate_payment', $membershipBlock);
735 if ($membershipPriceset) {
736 foreach ($form->_priceSet
['fields'] as $pField) {
737 if (empty($pField['options'])) {
740 foreach ($pField['options'] as $opId => $opValues) {
741 if (!CRM_Utils_Array
::value('membership_type_id', $opValues)) {
744 $membershipTypeIds[$opValues['membership_type_id']] = $opValues['membership_type_id'];
748 elseif (CRM_Utils_Array
::value('membership_types', $membershipBlock)) {
749 $membershipTypeIds = explode(',', $membershipBlock['membership_types']);
752 if (!empty($membershipTypeIds)) {
753 //set status message if wrong membershipType is included in membershipBlock
754 if (isset($form->_mid
) && !$membershipPriceset) {
755 $membershipTypeID = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership',
759 if (!in_array($membershipTypeID, $membershipTypeIds)) {
760 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');
764 $membershipTypeValues = self
::buildMembershipTypeValues($form, $membershipTypeIds);
765 $form->_membershipTypeValues
= $membershipTypeValues;
767 foreach ($membershipTypeIds as $value) {
768 $memType = $membershipTypeValues[$value];
769 if ($selectedMembershipTypeID != NULL) {
770 if ($memType['id'] == $selectedMembershipTypeID) {
771 $form->assign('minimum_fee',
772 CRM_Utils_Array
::value('minimum_fee', $memType)
774 $form->assign('membership_name', $memType['name']);
775 if (!$thankPage && $cid) {
776 $membership = new CRM_Member_DAO_Membership();
777 $membership->contact_id
= $cid;
778 $membership->membership_type_id
= $memType['id'];
779 if ($membership->find(TRUE)) {
780 $form->assign('renewal_mode', TRUE);
781 $memType['current_membership'] = $membership->end_date
;
782 $form->_currentMemberships
[$membership->membership_type_id
] = $membership->membership_type_id
;
785 $membershipTypes[] = $memType;
788 elseif ($memType['is_active']) {
789 $javascriptMethod = NULL;
790 $allowAutoRenewOpt = 1;
791 if (is_array($form->_paymentProcessors
)){
792 foreach ($form->_paymentProcessors
as $id => $val) {
793 if (!$val['is_recur']) {
794 $allowAutoRenewOpt = 0;
800 $javascriptMethod = array('onclick' => "return showHideAutoRenew( this.value );");
801 $autoRenewMembershipTypeOptions["autoRenewMembershipType_{$value}"] = (int)$allowAutoRenewOpt * CRM_Utils_Array
::value($value, CRM_Utils_Array
::value('auto_renew', $form->_membershipBlock
));;
803 if ($allowAutoRenewOpt) {
804 $allowAutoRenewMembership = TRUE;
807 //add membership type.
808 $radio[$memType['id']] = $form->createElement('radio', NULL, NULL, NULL,
809 $memType['id'], $javascriptMethod
812 $membership = new CRM_Member_DAO_Membership();
813 $membership->contact_id
= $cid;
814 $membership->membership_type_id
= $memType['id'];
816 //show current membership, skip pending and cancelled membership records,
817 //because we take first membership record id for renewal
818 $membership->whereAdd('status_id != 5 AND status_id !=6');
820 if (!is_null($isTest)) {
821 $membership->is_test
= $isTest;
825 $membership->orderBy('end_date DESC');
827 if ($membership->find(TRUE)) {
828 if (!$membership->end_date
) {
829 unset($radio[$memType['id']]);
830 $form->assign('islifetime', TRUE);
833 $form->assign('renewal_mode', TRUE);
834 $form->_currentMemberships
[$membership->membership_type_id
] = $membership->membership_type_id
;
835 $memType['current_membership'] = $membership->end_date
;
837 $endDate = $memType['current_membership'];
838 $form->_defaultMemTypeId
= $memType['id'];
840 if ($memType['current_membership'] < $endDate) {
841 $endDate = $memType['current_membership'];
842 $form->_defaultMemTypeId
= $memType['id'];
846 $membershipTypes[] = $memType;
851 $form->assign('showRadio', $formItems);
853 if (!$membershipPriceset) {
854 if (!$membershipBlock['is_required']) {
855 $form->assign('showRadioNoThanks', TRUE);
856 $radio[''] = $form->createElement('radio', NULL, NULL, NULL, 'no_thanks', NULL);
857 $form->addGroup($radio, 'selectMembership', NULL);
859 elseif ($membershipBlock['is_required'] && count($radio) == 1) {
860 $temp = array_keys($radio);
861 $form->add('hidden', 'selectMembership', $temp[0], array('id' => 'selectMembership'));
862 $form->assign('singleMembership', TRUE);
863 $form->assign('showRadio', FALSE);
866 $form->addGroup($radio, 'selectMembership', NULL);
869 $form->addRule('selectMembership', ts('Please select one of the memberships.'), 'required');
872 $autoRenewOption = CRM_Price_BAO_PriceSet
::checkAutoRenewForPriceSet($form->_priceSetId
);
873 $form->assign('autoRenewOption', $autoRenewOption);
876 if (!$form->_values
['is_pay_later'] && is_array($form->_paymentProcessors
) && ($allowAutoRenewMembership ||
$autoRenewOption)) {
877 $form->addElement('checkbox', 'auto_renew', ts('Please renew my membership automatically.'));
882 $form->assign('membershipBlock', $membershipBlock);
883 $form->assign('membershipTypes', $membershipTypes);
884 $form->assign('allowAutoRenewMembership', $allowAutoRenewMembership);
885 $form->assign('autoRenewMembershipTypeOptions', json_encode($autoRenewMembershipTypeOptions));
887 //give preference to user submitted auto_renew value.
888 $takeUserSubmittedAutoRenew = (!empty($_POST) ||
$form->isSubmitted()) ?
TRUE : FALSE;
889 $form->assign('takeUserSubmittedAutoRenew', $takeUserSubmittedAutoRenew);
892 return $separateMembershipPayment;
896 * Function to return Membership Block info in Contribution Pages
898 * @param int $pageId contribution page id
902 static function getMembershipBlock($pageID) {
903 $membershipBlock = array();
904 $dao = new CRM_Member_DAO_MembershipBlock();
905 $dao->entity_table
= 'civicrm_contribution_page';
907 $dao->entity_id
= $pageID;
909 if ($dao->find(TRUE)) {
910 CRM_Core_DAO
::storeValues($dao, $membershipBlock);
911 if (CRM_Utils_Array
::value('membership_types', $membershipBlock)) {
912 $membershipTypes = unserialize($membershipBlock['membership_types']);
913 if (!is_array($membershipTypes)) {
914 return $membershipBlock;
917 foreach ($membershipTypes as $key => $value) {
918 $membershipBlock['auto_renew'][$key] = $value;
919 $memTypes[$key] = $key;
921 $membershipBlock['membership_types'] = implode(',', $memTypes);
928 return $membershipBlock;
932 * Function to return a current membership of given contact
933 * NB: if more than one membership meets criteria, a randomly selected one is returned.
935 * @param int $contactID contact id
936 * @param int $memType membership type, null to retrieve all types
938 * @param int $membershipID if provided, then determine if it is current
939 * @param boolean $onlySameParentOrg true if only Memberships with same parent org as the $memType wanted, false otherwise
942 static function getContactMembership($contactID, $memType, $isTest, $membershipId = NULL, $onlySameParentOrg = FALSE) {
943 $dao = new CRM_Member_DAO_Membership();
945 $dao->id
= $membershipId;
947 $dao->contact_id
= $contactID;
948 $dao->membership_type_id
= $memType;
950 //fetch proper membership record.
952 $dao->is_test
= $isTest;
955 $dao->whereAdd('is_test IS NULL OR is_test = 0');
958 //avoid pending membership as current membership: CRM-3027
959 $pendingStatusId = array_search('Pending', CRM_Member_PseudoConstant
::membershipStatus());
960 $dao->whereAdd("status_id != $pendingStatusId");
962 // order by start date to find most recent membership first, CRM-4545
963 $dao->orderBy('start_date DESC');
966 if ($onlySameParentOrg && $memType) {
967 // require the same parent org as the $memType
968 $params = array('id' => $memType);
970 if (CRM_Member_BAO_MembershipType
::retrieve($params, $membershipType)) {
971 $memberTypesSameParentOrg = CRM_Member_BAO_MembershipType
::getMembershipTypesByOrg($membershipType['member_of_contact_id']);
972 $memberTypesSameParentOrgList = implode(',', array_keys($memberTypesSameParentOrg));
973 $dao->whereAdd('membership_type_id IN (' . $memberTypesSameParentOrgList . ')');
977 if ($dao->find(TRUE)) {
978 $membership = array();
979 CRM_Core_DAO
::storeValues($dao, $membership);
980 $membership['is_current_member'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus',
981 $membership['status_id'],
982 'is_current_member', 'id'
988 if ($onlySameParentOrg && $memType) {
989 // see if there is a membership that has same parent as $memType but different parent than $membershipID
991 if ( $dao->id
&& CRM_Core_Permission
::check( 'edit memberships' ) ) {
992 // CRM-10016, This is probably a backend renewal, and make sure we return the same membership thats being renewed.
998 unset($dao->membership_type_id
);
999 if ($dao->find(TRUE)) {
1000 $membership = array();
1001 CRM_Core_DAO
::storeValues($dao, $membership);
1002 $membership['is_current_member'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus',
1003 $membership['status_id'],
1004 'is_current_member', 'id'
1013 * Combine all the importable fields from the lower levels object
1015 * @param string $contactType contact type
1016 * @param boolean $status
1018 * @return array array of importable Fields
1022 static function &importableFields($contactType = 'Individual', $status = TRUE) {
1023 if (!self
::$_importableFields) {
1024 if (!self
::$_importableFields) {
1025 self
::$_importableFields = array();
1029 $fields = array('' => array('title' => '- ' . ts('do not import') . ' -'));
1032 $fields = array('' => array('title' => '- ' . ts('Membership Fields') . ' -'));
1035 $tmpFields = CRM_Member_DAO_Membership
::import();
1036 $contactFields = CRM_Contact_BAO_Contact
::importableFields($contactType, NULL);
1038 // Using new Dedupe rule.
1039 $ruleParams = array(
1040 'contact_type' => $contactType,
1041 'used' => 'Unsupervised',
1043 $fieldsArray = CRM_Dedupe_BAO_Rule
::dedupeRuleFields($ruleParams);
1045 $tmpContactField = array();
1046 if (is_array($fieldsArray)) {
1047 foreach ($fieldsArray as $value) {
1048 $customFieldId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField',
1053 $value = $customFieldId ?
'custom_' . $customFieldId : $value;
1054 $tmpContactField[trim($value)] = CRM_Utils_Array
::value(trim($value), $contactFields);
1056 $title = $tmpContactField[trim($value)]['title'] . " " . ts('(match to contact)');
1059 $title = $tmpContactField[trim($value)]['title'];
1061 $tmpContactField[trim($value)]['title'] = $title;
1064 $tmpContactField['external_identifier'] = $contactFields['external_identifier'];
1065 $tmpContactField['external_identifier']['title'] = $contactFields['external_identifier']['title'] . " " . ts('(match to contact)');
1067 $tmpFields['membership_contact_id']['title'] = $tmpFields['membership_contact_id']['title'] . " " . ts('(match to contact)');;
1069 $fields = array_merge($fields, $tmpContactField);
1070 $fields = array_merge($fields, $tmpFields);
1071 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Membership'));
1072 self
::$_importableFields = $fields;
1074 return self
::$_importableFields;
1078 * function to get all exportable fields
1080 * @retun array return array of all exportable fields
1083 static function &exportableFields() {
1084 $expFieldMembership = CRM_Member_DAO_Membership
::export();
1086 if (isset($expFieldMembership['member_campaign_id'])) {
1087 $expFieldMembership['member_campaign'] = array('title' => ts('Campaign Title'));
1090 $expFieldsMemType = CRM_Member_DAO_MembershipType
::export();
1091 $fields = array_merge($expFieldMembership, $expFieldsMemType);
1092 $fields = array_merge($fields, $expFieldMembership);
1093 $membershipStatus = array(
1094 'membership_status' => array('title' => 'Membership Status',
1095 'name' => 'membership_status',
1096 'type' => CRM_Utils_Type
::T_STRING
,
1097 'where' => 'civicrm_membership_status.name',
1099 //CRM-6161 fix for customdata export
1100 $fields = array_merge($fields, $membershipStatus, CRM_Core_BAO_CustomField
::getFieldsForImport('Membership'));
1105 * Function to get membership joins/renewals for a specified membership
1106 * type. Specifically, retrieves a count of memberships whose "Membership
1107 * Signup" or "Membership Renewal" activity falls in the given date range.
1108 * Dates match the pattern "yyyy-mm-dd".
1110 * @param int $membershipTypeId membership type id
1111 * @param int $startDate date on which to start counting
1112 * @param int $endDate date on which to end counting
1113 * @param bool $isTest if true, membership is for a test site
1114 * @param bool $isOwner if true, only retrieve membership records for owners //LCD
1116 * @return returns the number of members of type $membershipTypeId whose
1117 * start_date is between $startDate and $endDate
1120 public static function getMembershipStarts($membershipTypeId, $startDate, $endDate, $isTest = 0, $isOwner = 0) {
1122 $testClause = 'membership.is_test = 1';
1124 $testClause = '( membership.is_test IS NULL OR membership.is_test = 0 )';
1127 if (!self
::$_signupActType ||
!self
::$_renewalActType) {
1128 self
::_getActTypes();
1131 if (!self
::$_signupActType ||
!self
::$_renewalActType) {
1136 SELECT COUNT(DISTINCT membership.id) as member_count
1137 FROM civicrm_membership membership
1138 INNER JOIN civicrm_activity activity ON (activity.source_record_id = membership.id AND activity.activity_type_id in (%1, %2))
1139 INNER JOIN civicrm_membership_status status ON ( membership.status_id = status.id AND status.is_current_member = 1 )
1140 INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND contact.is_deleted = 0 )
1141 WHERE membership.membership_type_id = %3
1142 AND activity.activity_date_time >= '$startDate' AND activity.activity_date_time <= '$endDate 23:59:59'
1145 $query .= ($isOwner) ?
' AND owner_membership_id IS NULL' : '';
1148 1 => array(self
::$_signupActType, 'Integer'),
1149 2 => array(self
::$_renewalActType, 'Integer'),
1150 3 => array($membershipTypeId, 'Integer'),
1153 $memberCount = CRM_Core_DAO
::singleValueQuery($query, $params);
1154 return (int)$memberCount;
1158 * Function to get a count of membership for a specified membership type,
1159 * optionally for a specified date. The date must have the form yyyy-mm-dd.
1161 * If $date is omitted, this function counts as a member anyone whose
1162 * membership status_id indicates they're a current member.
1163 * If $date is given, this function counts as a member anyone who:
1164 * -- Has a start_date before $date and end_date after $date, or
1165 * -- Has a start_date before $date and is currently a member, as indicated
1166 * by the the membership's status_id.
1167 * The second condition takes care of records that have no end_date. These
1168 * are assumed to be lifetime memberships.
1170 * @param int $membershipTypeId membership type id
1171 * @param string $date the date for which to retrieve the count
1172 * @param bool $isTest if true, membership is for a test site
1173 * @param bool $isOwner if true, only retrieve membership records for owners //LCD
1175 * @return returns the number of members of type $membershipTypeId as of
1178 public static function getMembershipCount($membershipTypeId, $date = NULL, $isTest = 0, $isOwner = 0) {
1179 if (!CRM_Utils_Rule
::date($date)) {
1180 CRM_Core_Error
::fatal(ts('Invalid date "%1" (must have form yyyy-mm-dd).', array(1 => $date)));
1183 $params = array(1 => array($membershipTypeId, 'Integer'),
1184 2 => array($isTest, 'Boolean'),
1186 $query = "SELECT count(civicrm_membership.id ) as member_count
1187 FROM civicrm_membership left join civicrm_membership_status on ( civicrm_membership.status_id = civicrm_membership_status.id )
1188 WHERE civicrm_membership.membership_type_id = %1
1189 AND civicrm_membership.contact_id NOT IN (SELECT id FROM civicrm_contact WHERE is_deleted = 1)
1190 AND civicrm_membership.is_test = %2";
1192 $query .= " AND civicrm_membership_status.is_current_member = 1";
1195 $query .= " AND civicrm_membership.start_date <= '$date' AND civicrm_membership_status.is_current_member = 1";
1198 $query .= ($isOwner) ?
' AND owner_membership_id IS NULL' : '';
1199 $memberCount = CRM_Core_DAO
::singleValueQuery($query, $params);
1200 return (int)$memberCount;
1204 * Function check the status of the membership before adding membership for a contact
1206 * @param int $contactId contact id
1210 static function statusAvailabilty($contactId) {
1211 $membership = new CRM_Member_DAO_MembershipStatus();
1212 $membership->whereAdd('is_active=1');
1213 return $membership->count();
1217 * Process the Memberships
1219 * @param array $membershipParams array of membership fields
1220 * @param int $contactID contact id
1221 * @param object $form form object
1226 public static function postProcessMembership($membershipParams, $contactID, &$form, &$premiumParams,
1227 $customFieldsFormatted = NULL, $includeFieldTypes = NULL
1229 $tempParams = $membershipParams;
1230 $paymentDone = FALSE;
1232 $isTest = CRM_Utils_Array
::value('is_test', $membershipParams, FALSE);
1233 $form->assign('membership_assign', TRUE);
1235 $form->set('membershipTypeID', $membershipParams['selectMembership']);
1237 $singleMembershipTypeID = $membershipTypeID = $membershipParams['selectMembership'];
1238 if (is_array($membershipTypeID) && count($membershipTypeID) == 1) {
1239 $singleMembershipTypeID = $membershipTypeID[0];
1242 $membershipDetails = self
::buildMembershipTypeValues($form, $singleMembershipTypeID);
1243 $form->assign('membership_name', CRM_Utils_Array
::value('name', $membershipDetails));
1245 $minimumFee = CRM_Utils_Array
::value('minimum_fee', $membershipDetails);
1246 $contributionTypeId = NULL;
1247 if ($form->_values
['amount_block_is_active']) {
1248 $contributionTypeId = $form->_values
['financial_type_id'];
1251 $paymentDone = TRUE;
1252 $params['amount'] = $minimumFee;
1253 $contributionTypeId = CRM_Utils_Array
::value( 'financial_type_id', $membershipDetails );
1254 if (!$contributionTypeId) {
1255 $contributionTypeId = CRM_Utils_Array
::value('financial_type_id' ,$membershipParams);
1259 //amount must be greater than zero for
1260 //adding contribution record to contribution table.
1261 //this condition arises when separate membership payment is
1262 //enabled and contribution amount is not selected. fix for CRM-3010
1263 if ($form->_amount
> 0.0 && $membershipParams['amount']) {
1264 $result = CRM_Contribute_BAO_Contribution_Utils
::processConfirm($form, $membershipParams,
1265 $premiumParams, $contactID,
1266 $contributionTypeId,
1271 // we need to explicitly create a CMS user in case of free memberships
1272 // since the below has already been done under processConfirm for paid memberships
1273 CRM_Contribute_BAO_Contribution_Utils
::createCMSUser($membershipParams,
1274 $membershipParams['cms_contactID'],
1275 'email-' . $form->_bltID
1280 if (is_a($result[1], 'CRM_Core_Error')) {
1281 $errors[1] = CRM_Core_Error
::getMessages($result[1]);
1283 elseif (CRM_Utils_Array
::value(1, $result)) {
1284 // Save the contribution ID so that I can be used in email receipts
1285 // For example, if you need to generate a tax receipt for the donation only.
1286 $form->_values
['contribution_other_id'] = $result[1]->id
;
1287 $contribution[1] = $result[1];
1291 $memBlockDetails = CRM_Member_BAO_Membership
::getMembershipBlock($form->_id
);
1292 if (CRM_Utils_Array
::value('is_separate_payment', $memBlockDetails) && !$paymentDone) {
1293 $form->_lineItem
= $form->_memLineItem
;
1294 $contributionType = new CRM_Financial_DAO_FinancialType( );
1295 $contributionType->id
= CRM_Utils_Array
::value('financial_type_id', $membershipDetails);
1296 if (!$contributionType->find(TRUE)) {
1297 CRM_Core_Error
::fatal(ts("Could not find a system table"));
1299 $tempParams['amount'] = $minimumFee;
1300 $invoiceID = md5(uniqid(rand(), TRUE));
1301 $tempParams['invoiceID'] = $invoiceID;
1303 //we don't allow recurring membership.CRM-3781.
1304 if (CRM_Utils_Array
::value('is_recur', $tempParams)) {
1305 $tempParams['is_recur'] = 0;
1308 if ($form->_values
['is_monetary'] && !$form->_params
['is_pay_later'] && $minimumFee > 0.0) {
1309 $payment = CRM_Core_Payment
::singleton($form->_mode
, $form->_paymentProcessor
, $form);
1311 if ($form->_contributeMode
== 'express') {
1312 $result = &$payment->doExpressCheckout($tempParams);
1315 $result = &$payment->doDirectPayment($tempParams);
1319 if (is_a($result, 'CRM_Core_Error')) {
1320 $errors[2] = CRM_Core_Error
::getMessages($result);
1323 //assign receive date when separate membership payment
1324 //and contribution amount not selected.
1325 if ($form->_amount
== 0) {
1326 $now = date('YmdHis');
1327 $form->_params
['receive_date'] = $now;
1328 $receiveDate = CRM_Utils_Date
::mysqlToIso($now);
1329 $form->set('params', $form->_params
);
1330 $form->assign('receive_date', $receiveDate);
1333 $form->set('membership_trx_id', $result['trxn_id']);
1334 $form->set('membership_amount', $minimumFee);
1336 $form->assign('membership_trx_id', $result['trxn_id']);
1337 $form->assign('membership_amount', $minimumFee);
1339 // we dont need to create the user twice, so lets disable cms_create_account
1340 // irrespective of the value, CRM-2888
1341 $tempParams['cms_create_account'] = 0;
1343 $pending = $form->_params
['is_pay_later'] ?
((CRM_Utils_Array
::value('minimum_fee', $membershipDetails, 0) > 0.0) ?
TRUE : FALSE) : FALSE;
1345 //set this variable as we are not creating pledge for
1346 //separate membership payment contribution.
1347 //so for differentiating membership contributon from
1348 //main contribution.
1349 $form->_params
['separate_membership_payment'] = 1;
1350 $contribution[2] = CRM_Contribute_Form_Contribution_Confirm
::processContribution($form,
1361 $index = CRM_Utils_Array
::value('is_separate_payment', $memBlockDetails) ?
2 : 1;
1363 if (!CRM_Utils_Array
::value($index, $errors)) {
1364 if (isset($membershipParams['onbehalf']) &&
1365 CRM_Utils_Array
::value('member_campaign_id', $membershipParams['onbehalf'])) {
1366 $form->_params
['campaign_id'] = $membershipParams['onbehalf']['member_campaign_id'];
1368 if (is_array($membershipTypeID)) {
1369 $typesTerms = CRM_Utils_Array
::value('types_terms', $membershipParams, array());
1370 $createdMemberships = array();
1372 foreach ($membershipTypeID as $memType) {
1373 $numTerms = CRM_Utils_Array
::value($memType, $typesTerms, 1);
1374 $membership = self
::renewMembership($contactID, $memType,
1375 $isTest, $form, NULL,
1376 CRM_Utils_Array
::value('cms_contactID', $membershipParams),
1377 $customFieldsFormatted, CRM_Utils_Array
::value($memType, $typesTerms, 1)
1380 $createdMemberships[$memType] = $membership;
1381 if (isset($contribution[$index])) {
1382 //insert payment record
1383 $dao = new CRM_Member_DAO_MembershipPayment();
1384 $dao->membership_id
= $membership->id
;
1385 $dao->contribution_id
= $contribution[$index]->id
;
1386 //Fixed for avoiding duplicate entry error when user goes
1387 //back and forward during payment mode is notify
1388 if (!$dao->find(TRUE)) {
1389 CRM_Utils_Hook
::pre('create', 'MembershipPayment', NULL, $dao);
1391 CRM_Utils_Hook
::post('create', 'MembershipPayment', $dao->id
, $dao);
1395 if ($form->_priceSetId
&& !empty($form->_useForMember
) && !empty($form->_lineItem
)) {
1396 foreach ($form->_lineItem
[$form->_priceSetId
] as & $priceFieldOp) {
1397 if (CRM_Utils_Array
::value('membership_type_id', $priceFieldOp) &&
1398 isset($createdMemberships[$priceFieldOp['membership_type_id']])
1400 $membershipOb = $createdMemberships[$priceFieldOp['membership_type_id']];
1401 $priceFieldOp['start_date'] = $membershipOb->start_date ? CRM_Utils_Date
::customFormat($membershipOb->start_date
, '%d%f %b, %Y') : '-';
1402 $priceFieldOp['end_date'] = $membershipOb->end_date ? CRM_Utils_Date
::customFormat($membershipOb->end_date
, '%d%f %b, %Y') : '-';
1405 $priceFieldOp['start_date'] = $priceFieldOp['end_date'] = 'N/A';
1408 $form->_values
['lineItem'] = $form->_lineItem
;
1409 $form->assign('lineItem', $form->_lineItem
);
1413 $membership = self
::renewMembership($contactID, $membershipTypeID,
1414 $isTest, $form, NULL,
1415 CRM_Utils_Array
::value('cms_contactID', $membershipParams),
1416 $customFieldsFormatted, CRM_Utils_Array
::value('types_terms', $membershipParams, 1)
1418 if (isset($contribution[$index])) {
1419 //insert payment record
1420 $dao = new CRM_Member_DAO_MembershipPayment();
1421 $dao->membership_id
= $membership->id
;
1422 $dao->contribution_id
= $contribution[$index]->id
;
1423 //Fixed for avoiding duplicate entry error when user goes
1424 //back and forward during payment mode is notify
1425 if (!$dao->find(TRUE)) {
1426 CRM_Utils_Hook
::pre('create', 'MembershipPayment', NULL, $dao);
1428 CRM_Utils_Hook
::post('create', 'MembershipPayment', $dao->id
, $dao);
1434 if (!empty($errors)) {
1435 foreach ($errors as $error) {
1436 if (is_string($error)) {
1437 $message[] = $error;
1440 $message = ts('Payment Processor Error message') . ': ' . implode('<br/>', $message);
1441 // Redirect the form in case of error
1442 // @todo this redirect in the BAO layer is really bad & should be moved to the form layer
1443 // however since we have no idea how (if) this is triggered we can't safely move / remove it
1444 $errorParams = array(
1445 'legacy_redirect_path' => 'civicrm/contribute/transact',
1446 'legacy_redirect_query' => "_qf_Main_display=true&qfKey={$form->_params['qfKey']}",
1448 throw new CRM_Core_Exception($message, 0, $errorParams);
1452 CRM_Core_BAO_CustomValueTable
::postProcess($form->_params
,
1453 CRM_Core_DAO
::$_nullArray,
1454 'civicrm_membership',
1459 $form->_params
['membershipID'] = $membership->id
;
1460 if ($form->_contributeMode
== 'notify') {
1461 if ($form->_values
['is_monetary'] && $form->_amount
> 0.0 && !$form->_params
['is_pay_later']) {
1462 // call postprocess hook before leaving
1463 $form->postProcessHook();
1464 // this does not return
1465 $payment = CRM_Core_Payment
::singleton($form->_mode
, $form->_paymentProcessor
, $form);
1466 $payment->doTransferCheckout($form->_params
, 'contribute');
1470 $form->_values
['membership_id'] = $membership->id
;
1471 if (isset($contribution[$index]->id
)) {
1472 $form->_values
['contribution_id'] = $contribution[$index]->id
;
1475 // Do not send an email if Recurring transaction is done via Direct Mode
1476 // Email will we sent when the IPN is received.
1477 if (CRM_Utils_Array
::value('is_recur', $form->_params
) && $form->_contributeMode
== 'direct') {
1481 //finally send an email receipt
1482 CRM_Contribute_BAO_ContributionPage
::sendMail($contactID,
1490 * @todo - this form method needs to have the interaction with the form layer removed from it
1491 * as a BAO function. Note that the api now supports membership renewals & it is not clear this function does anything
1492 * not done by the membership.create api (with a lot less unit tests)
1494 * This method will renew / create the membership depending on
1495 * whether the given contact has a membership or not. And will add
1496 * the modified dates for membership and in the log table.
1498 * @param int $contactID id of the contact
1499 * @param int $membershipTypeID id of the new membership type
1500 * @param boolean $is_test if this is test contribution or live contribution
1501 * @param object $form form object
1502 * @param array $ipnParams array of name value pairs, to be used (for e.g source) when $form not present
1503 * @param int $modifiedID individual contact id in case of On Behalf signup (CRM-4027 )
1504 * @param int $numRenewTerms how many membership terms are being added to end date (default is 1)
1506 * @return object $membership object of membership
1512 static function renewMembership(
1517 $changeToday = NULL,
1519 $customFieldsFormatted = NULL,
1522 $statusFormat = '%Y-%m-%d';
1526 //get all active statuses of membership.
1527 $allStatus = CRM_Member_PseudoConstant
::membershipStatus();
1529 $membershipTypeDetails = CRM_Member_BAO_MembershipType
::getMembershipTypeDetails($membershipTypeID);
1531 // check is it pending. - CRM-4555
1533 //@todo this is a BAO function & should not inspect the form - the form should do this
1534 // & pass required params to the BAO
1535 if (CRM_Utils_Array
::value('minimum_fee', $membershipTypeDetails) > 0.0) {
1536 if (((isset($form->_contributeMode
) && $form->_contributeMode
== 'notify') ||
1537 CRM_Utils_Array
::value('is_pay_later', $form->_params
) ||
1538 (CRM_Utils_Array
::value('is_recur', $form->_params
)
1539 && $form->_contributeMode
== 'direct'
1542 (($form->_values
['is_monetary'] && $form->_amount
> 0.0) ||
1543 CRM_Utils_Array
::value('separate_membership_payment', $form->_params
) ||
1544 CRM_Utils_Array
::value('record_contribution', $form->_params
)
1551 //decide status here, if needed.
1552 $updateStatusId = NULL;
1554 // CRM-7297 - allow membership type to be be changed during renewal so long as the parent org of new membershipType
1555 // is the same as the parent org of an existing membership of the contact
1556 $currentMembership = CRM_Member_BAO_Membership
::getContactMembership($contactID, $membershipTypeID,
1557 $is_test, $form->_membershipId
, TRUE
1559 if ($currentMembership) {
1560 $activityType = 'Membership Renewal';
1561 $form->set('renewal_mode', TRUE);
1563 // Do NOT do anything.
1564 //1. membership with status : PENDING/CANCELLED (CRM-2395)
1565 //2. Paylater/IPN renew. CRM-4556.
1566 if ($pending ||
in_array($currentMembership['status_id'], array(array_search('Pending', $allStatus),
1567 array_search('Cancelled', $allStatus),
1569 $membership = new CRM_Member_DAO_Membership();
1570 $membership->id
= $currentMembership['id'];
1571 $membership->find(TRUE);
1573 // CRM-8141 create a membership_log entry so that we will know the membership_type_id to change to when payment completed
1575 // note that we are logging the requested new membership_type_id that may be different than current membership_type_id
1576 // it will be used when payment is received to update the membership_type_id to what was paid for
1578 'membership_id' => $membership->id
,
1579 'status_id' => $membership->status_id
,
1580 'start_date' => CRM_Utils_Date
::customFormat(
1581 $membership->start_date
,
1584 'end_date' => CRM_Utils_Date
::customFormat(
1585 $membership->end_date
,
1588 'modified_date' => CRM_Utils_Date
::customFormat(
1592 'membership_type_id' => $membershipTypeID,
1593 'max_related' => $membershipTypeDetails['max_related'],
1595 $session = CRM_Core_Session
::singleton();
1596 // If we have an authenticated session, set modified_id to that user's contact_id, else set to membership.contact_id
1597 if ($session->get('userID')) {
1598 $logParams['modified_id'] = $session->get('userID');
1601 $logParams['modified_id'] = $membership->contact_id
;
1603 CRM_Member_BAO_MembershipLog
::add($logParams, CRM_Core_DAO
::$_nullArray);
1605 if (CRM_Utils_Array
::value('contributionRecurID', $form->_params
)) {
1606 CRM_Core_DAO
::setFieldValue('CRM_Member_DAO_Membership', $membership->id
,
1607 'contribution_recur_id', $form->_params
['contributionRecurID']
1614 //we renew expired membership, CRM-6277
1615 if (!$changeToday) {
1616 if ($form->get('renewalDate')) {
1617 $changeToday = $form->get('renewalDate');
1619 elseif (get_class($form) == 'CRM_Contribute_Form_Contribution_Confirm') {
1620 $changeToday = date('YmdHis');
1624 // Check and fix the membership if it is STALE
1625 self
::fixMembershipStatusBeforeRenew($currentMembership, $changeToday);
1627 // Now Renew the membership
1628 if (!$currentMembership['is_current_member']) {
1629 // membership is not CURRENT
1631 // CRM-7297 Membership Upsell - calculate dates based on new membership type
1632 $dates = CRM_Member_BAO_MembershipType
::getRenewalDatesForMembershipType($currentMembership['id'],
1638 $currentMembership['join_date'] = CRM_Utils_Date
::customFormat($currentMembership['join_date'], $format);
1639 $currentMembership['start_date'] = CRM_Utils_Array
::value('start_date', $dates);
1640 $currentMembership['end_date'] = CRM_Utils_Array
::value('end_date', $dates);
1641 $currentMembership['is_test'] = $is_test;
1643 if (CRM_Utils_Array
::value('membership_source', $form->_params
)) {
1644 $currentMembership['source'] = $form->_params
['membership_source'];
1646 elseif (isset($form->_values
['title']) && !empty($form->_values
['title'])) {
1647 $currentMembership['source'] = ts('Online Contribution:') . ' ' . $form->_values
['title'];
1650 $currentMembership['source'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership',
1651 $currentMembership['id'],
1656 if (CRM_Utils_Array
::value('id', $currentMembership)) {
1657 $ids['membership'] = $currentMembership['id'];
1659 $memParams = $currentMembership;
1660 $memParams['membership_type_id'] = $membershipTypeID;
1662 //set the log start date.
1663 $memParams['log_start_date'] = CRM_Utils_Date
::customFormat($dates['log_start_date'], $format);
1667 // CURRENT Membership
1668 $membership = new CRM_Member_DAO_Membership();
1669 $membership->id
= $currentMembership['id'];
1670 $membership->find(TRUE);
1671 // CRM-7297 Membership Upsell - calculate dates based on new membership type
1672 $dates = CRM_Member_BAO_MembershipType
::getRenewalDatesForMembershipType($membership->id
,
1678 // Insert renewed dates for CURRENT membership
1679 $memParams = array();
1680 $memParams['join_date'] = CRM_Utils_Date
::isoToMysql($membership->join_date
);
1681 $memParams['start_date'] = CRM_Utils_Date
::isoToMysql($membership->start_date
);
1682 $memParams['end_date'] = CRM_Utils_Array
::value('end_date', $dates);
1683 $memParams['membership_type_id'] = $membershipTypeID;
1685 //set the log start date.
1686 $memParams['log_start_date'] = CRM_Utils_Date
::customFormat($dates['log_start_date'], $format);
1687 if (empty($membership->source
)) {
1688 if (CRM_Utils_Array
::value('membership_source', $form->_params
)) {
1689 $memParams['source'] = $form->_params
['membership_source'];
1691 elseif (property_exists($form, '_values') && CRM_Utils_Array
::value('title', $form->_values
)) {
1692 $memParams['source'] = ts('Online Contribution:') . ' ' . $form->_values
['title'];
1695 $memParams['source'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership',
1696 $currentMembership['id'],
1702 if (CRM_Utils_Array
::value('id', $currentMembership)) {
1703 $ids['membership'] = $currentMembership['id'];
1708 $updateStatusId = array_search('Pending', $allStatus);
1714 $activityType = 'Membership Signup';
1716 'contact_id' => $contactID,
1717 'membership_type_id' => $membershipTypeID,
1721 $dates = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($membershipTypeID, NULL, NULL, NULL, $numRenewTerms);
1723 $memParams['join_date'] = CRM_Utils_Array
::value('join_date', $dates);
1724 $memParams['start_date'] = CRM_Utils_Array
::value('start_date', $dates);
1725 $memParams['end_date'] = CRM_Utils_Array
::value('end_date', $dates);
1727 $status = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate(CRM_Utils_Date
::customFormat($dates['start_date'],
1730 CRM_Utils_Date
::customFormat($dates['end_date'],
1733 CRM_Utils_Date
::customFormat($dates['join_date'],
1738 $updateStatusId = CRM_Utils_Array
::value('id', $status);
1741 // if IPN/Pay-Later set status to: PENDING
1742 $updateStatusId = array_search('Pending', $allStatus);
1745 if (CRM_Utils_Array
::value('membership_source', $form->_params
)) {
1746 $memParams['source'] = $form->_params
['membership_source'];
1748 elseif (CRM_Utils_Array
::value('title', $form->_values
)) {
1749 $memParams['source'] = ts('Online Contribution:') . ' ' . $form->_values
['title'];
1751 $memParams['contribution_recur_id'] = CRM_Utils_Array
::value('contributionRecurID', $form->_params
);
1753 $memParams['is_test'] = $is_test;
1754 $memParams['is_pay_later'] = CRM_Utils_Array
::value('is_pay_later', $form->_params
);
1758 //if we decided status here and want to skip status
1759 //calculation in create( ); then need to pass 'skipStatusCal'.
1760 if ($updateStatusId) {
1761 $memParams['status_id'] = $updateStatusId;
1762 $memParams['skipStatusCal'] = TRUE;
1765 //since we are renewing,
1766 //make status override false.
1767 $memParams['is_override'] = FALSE;
1769 //CRM-4027, create log w/ individual contact.
1771 $ids['userId'] = $modifiedID;
1772 $memParams['is_for_organization'] = TRUE;
1775 $ids['userId'] = $contactID;
1778 //inherit campaign from contrib page.
1779 if (isset($form->_values
) && is_array($form->_values
) && !empty($form->_values
)) {
1780 $campaignId = CRM_Utils_Array
::value('campaign_id', $form->_params
);
1781 if (!array_key_exists('campaign_id', $form->_params
)) {
1782 $campaignId = CRM_Utils_Array
::value('campaign_id', $form->_values
);
1784 $memParams['campaign_id'] = $campaignId;
1787 $memParams['custom'] = $customFieldsFormatted;
1788 $membership = self
::create($memParams, $ids, FALSE, $activityType);
1790 // not sure why this statement is here, seems quite odd :( - Lobo: 12/26/2010
1791 // related to: http://forum.civicrm.org/index.php/topic,11416.msg49072.html#msg49072
1792 $membership->find(TRUE);
1793 if (!empty($dates)) {
1794 $form->assign('mem_start_date',
1795 CRM_Utils_Date
::customFormat($dates['start_date'], $format)
1797 $form->assign('mem_end_date',
1798 CRM_Utils_Date
::customFormat($dates['end_date'], $format)
1806 * Method to fix membership status of stale membership
1808 * This method first checks if the membership is stale. If it is,
1809 * then status will be updated based on existing start and end
1810 * dates and log will be added for the status change.
1812 * @param array $currentMembership referance to the array
1813 * containing all values of
1814 * the current membership
1815 * @param array $changeToday array of month, day, year
1816 * values in case today needs
1817 * to be customised, null otherwise
1822 static function fixMembershipStatusBeforeRenew(&$currentMembership, $changeToday) {
1825 $today = CRM_Utils_Date
::processDate($changeToday, NULL, FALSE, 'Y-m-d');
1828 $status = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate(
1829 CRM_Utils_Array
::value('start_date', $currentMembership),
1830 CRM_Utils_Array
::value('end_date', $currentMembership),
1831 CRM_Utils_Array
::value('join_date', $currentMembership),
1836 if (empty($status) ||
1837 empty($status['id'])
1839 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.'));
1842 $currentMembership['today_date'] = $today;
1844 if ($status['id'] !== $currentMembership['status_id']) {
1845 $memberDAO = new CRM_Member_DAO_Membership();
1846 $memberDAO->id
= $currentMembership['id'];
1847 $memberDAO->find(TRUE);
1849 $memberDAO->status_id
= $status['id'];
1850 $memberDAO->join_date
= CRM_Utils_Date
::isoToMysql($memberDAO->join_date
);
1851 $memberDAO->start_date
= CRM_Utils_Date
::isoToMysql($memberDAO->start_date
);
1852 $memberDAO->end_date
= CRM_Utils_Date
::isoToMysql($memberDAO->end_date
);
1854 CRM_Core_DAO
::storeValues($memberDAO, $currentMembership);
1857 $currentMembership['is_current_member'] = CRM_Core_DAO
::getFieldValue(
1858 'CRM_Member_DAO_MembershipStatus',
1859 $currentMembership['status_id'],
1865 'membership_id' => $currentMembership['id'],
1866 'status_id' => $status['id'],
1867 'start_date' => CRM_Utils_Date
::customFormat(
1868 $currentMembership['start_date'],
1871 'end_date' => CRM_Utils_Date
::customFormat(
1872 $currentMembership['end_date'],
1875 'modified_date' => CRM_Utils_Date
::customFormat(
1876 $currentMembership['today_date'],
1879 'membership_type_id' => $currentMembership['membership_type_id'],
1880 'max_related' => $currentMembership['max_related'],
1883 $session = CRM_Core_Session
::singleton();
1884 // If we have an authenticated session, set modified_id to that user's contact_id, else set to membership.contact_id
1885 if ($session->get('userID')) {
1886 $logParams['modified_id'] = $session->get('userID');
1889 $logParams['modified_id'] = $currentMembership['contact_id'];
1891 CRM_Member_BAO_MembershipLog
::add($logParams, CRM_Core_DAO
::$_nullArray);
1896 * Function to get the contribution page id from the membership record
1898 * @param int membershipId membership id
1900 * @return int $contributionPageId contribution page id
1904 static function getContributionPageId($membershipID) {
1906 SELECT c.contribution_page_id as pageID
1907 FROM civicrm_membership_payment mp, civicrm_contribution c
1908 WHERE mp.contribution_id = c.id
1909 AND c.contribution_page_id IS NOT NULL
1910 AND mp.membership_id = " . CRM_Utils_Type
::escape($membershipID, 'Integer')
1911 . " ORDER BY mp.id DESC";
1913 return CRM_Core_DAO
::singleValueQuery($query,
1914 CRM_Core_DAO
::$_nullArray
1919 * Function to updated related memberships
1921 * @param int $ownerMembershipId owner Membership Id
1922 * @param array $params formatted array of key => value..
1925 static function updateRelatedMemberships($ownerMembershipId, $params) {
1926 $membership = new CRM_Member_DAO_Membership();
1927 $membership->owner_membership_id
= $ownerMembershipId;
1928 $membership->find();
1930 while ($membership->fetch()) {
1931 $relatedMembership = new CRM_Member_DAO_Membership();
1932 $relatedMembership->id
= $membership->id
;
1933 $relatedMembership->copyValues($params);
1934 $relatedMembership->save();
1935 $relatedMembership->free();
1938 $membership->free();
1942 * Function to get list of membership fields for profile
1943 * For now we only allow custom membership fields to be in
1946 * @return return the list of membership fields
1950 static function getMembershipFields($mode = NULL) {
1951 $fields = CRM_Member_DAO_Membership
::export();
1954 if (isset($fields['member_campaign_id'])) {
1955 if ($mode == CRM_Export_Form_Select
::MEMBER_EXPORT
) {
1956 $fields['member_campaign'] = array('title' => ts('Campaign Title'));
1959 $fields['member_campaign_id']['title'] = ts('Campaign');
1963 unset($fields['membership_contact_id']);
1964 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Membership'));
1966 $membershipType = CRM_Member_DAO_MembershipType
::export();
1968 $membershipStatus = CRM_Member_DAO_MembershipStatus
::export();
1970 $fields = array_merge($fields, $membershipType, $membershipStatus);
1976 * function to get the sort name of a contact for a particular membership
1978 * @param int $id id of the membership
1980 * @return null|string sort name of the contact if found
1984 static function sortName($id) {
1985 $id = CRM_Utils_Type
::escape($id, 'Integer');
1988 SELECT civicrm_contact.sort_name
1989 FROM civicrm_membership, civicrm_contact
1990 WHERE civicrm_membership.contact_id = civicrm_contact.id
1991 AND civicrm_membership.id = {$id}
1993 return CRM_Core_DAO
::singleValueQuery($query, CRM_Core_DAO
::$_nullArray);
1997 * function to create memberships for related contacts
1998 * takes into account the maximum related memberships
2000 * @param array $params array of key - value pairs
2001 * @param object $membership membership object
2003 * @return null|relatedMembership array of memberships if created
2007 static function createRelatedMemberships(&$params, &$dao) {
2008 static $relatedContactIds = array();
2010 $membership = new CRM_Member_DAO_Membership();
2011 $membership->id
= $dao->id
;
2013 // required since create method doesn't return all the
2014 // parameters in the returned membership object
2015 if (!$membership->find(TRUE)) {
2018 $deceasedStatusId = array_search('Deceased', CRM_Member_PseudoConstant
::membershipStatus());
2019 // FIXME : While updating/ renewing the
2020 // membership, if the relationship is PAST then
2021 // the membership of the related contact must be
2023 // For that, getting Membership Status for which
2024 // is_current_member is 0. It works for the
2025 // generated data as there is only one membership
2026 // status having is_current_member = 0.
2027 // But this wont work exactly if there will be
2028 // more than one status having is_current_member = 0.
2029 $membershipStatus = new CRM_Member_DAO_MembershipStatus();
2030 $membershipStatus->is_current_member
= 0;
2031 if ($membershipStatus->find(TRUE)) {
2032 $expiredStatusId = $membershipStatus->id
;
2034 $expiredStatusId = array_search('Expired', CRM_Member_PseudoConstant
::membershipStatus());
2037 $allRelatedContacts = array();
2038 $relatedContacts = array();
2039 if (!is_a($membership, 'CRM_Core_Error')) {
2040 $allRelatedContacts = CRM_Member_BAO_Membership
::checkMembershipRelationship($membership->id
,
2041 $membership->contact_id
,
2042 CRM_Utils_Array
::value('action', $params)
2046 // check for loops. CRM-4213
2047 // remove repeated related contacts, which already inherited membership.
2048 $relatedContactIds[$membership->contact_id
] = TRUE;
2049 foreach ($allRelatedContacts as $cid => $status) {
2050 if (!CRM_Utils_Array
::value($cid, $relatedContactIds)) {
2051 $relatedContactIds[$cid] = TRUE;
2053 //don't create membership again for owner contact.
2054 $nestedRelationship = FALSE;
2055 if ($membership->owner_membership_id
) {
2056 $nestedRelMembership = new CRM_Member_DAO_Membership();
2057 $nestedRelMembership->id
= $membership->owner_membership_id
;
2058 $nestedRelMembership->contact_id
= $cid;
2059 $nestedRelationship = $nestedRelMembership->find(TRUE);
2060 $nestedRelMembership->free();
2062 if (!$nestedRelationship) {
2063 $relatedContacts[$cid] = $status;
2068 //lets cleanup related membership if any.
2069 if (empty($relatedContacts)) {
2070 self
::deleteRelatedMemberships($membership->id
);
2073 // Edit the params array
2074 unset($params['id']);
2075 // Reminder should be sent only to the direct membership
2076 unset($params['reminder_date']);
2077 // unset the custom value ids
2078 if (is_array(CRM_Utils_Array
::value('custom', $params))) {
2079 foreach ($params['custom'] as $k => $v) {
2080 unset($params['custom'][$k]['id']);
2083 if (!isset($params['membership_type_id'])) {
2084 $params['membership_type_id'] = $membership->membership_type_id
;
2087 // max_related should be set in the parent membership
2088 unset($params['max_related']);
2089 // Number of inherited memberships available - NULL is interpreted as unlimited, '0' as none
2090 $available = ($membership->max_related
== NULL ? PHP_INT_MAX
: $membership->max_related
);
2091 $queue = array(); // will be used to queue potential memberships to be created
2093 foreach ($relatedContacts as $contactId => $relationshipStatus) {
2094 //use existing membership record.
2095 $relMembership = new CRM_Member_DAO_Membership();
2096 $relMembership->contact_id
= $contactId;
2097 $relMembership->owner_membership_id
= $membership->id
;
2098 $relMemIds = array();
2099 if ($relMembership->find(TRUE)) {
2100 $params['id'] = $relMemIds['membership'] = $relMembership->id
;
2102 $params['contact_id'] = $contactId;
2103 $params['owner_membership_id'] = $membership->id
;
2105 // set status_id as it might have been changed for
2106 // past relationship
2107 $params['status_id'] = $membership->status_id
;
2109 if ($deceasedStatusId &&
2110 CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $contactId, 'is_deceased')
2112 $params['status_id'] = $deceasedStatusId;
2114 elseif ((CRM_Utils_Array
::value('action', $params) & CRM_Core_Action
::UPDATE
) &&
2115 ($relationshipStatus == CRM_Contact_BAO_Relationship
::PAST
)
2117 $params['status_id'] = $expiredStatusId;
2120 //don't calculate status again in create( );
2121 $params['skipStatusCal'] = TRUE;
2123 //do create activity if we changed status.
2124 if ($params['status_id'] != $relMembership->status_id
) {
2125 $params['createActivity'] = TRUE;
2128 // we should not created contribution record for related contacts, CRM-3371
2129 unset($params['contribution_status_id']);
2131 if (($params['status_id'] == $deceasedStatusId) ||
($params['status_id'] == $expiredStatusId)) {
2132 // related membership is not active so does not count towards maximum
2133 CRM_Member_BAO_Membership
::create($params, $relMemIds);
2135 // related membership already exists, so this is just an update
2136 if (isset($params['id'])) {
2137 if ($available > 0) {
2138 CRM_Member_BAO_Membership
::create($params, $relMemIds);
2140 } else { // we have run out of inherited memberships, so delete extras
2141 self
::deleteMembership($params['id']);
2143 // we need to first check if there will remain inherited memberships, so queue it up
2149 // now go over the queue and create any available related memberships
2151 while (($available > 0) && ($params = each($queue))) {
2152 CRM_Member_BAO_Membership
::create($params['value'], $relMemIds);
2159 * Delete the record that are associated with this Membership Payment
2161 * @param int $membershipId membsership id.
2163 * @return boolean true if deleted false otherwise
2166 static function deleteMembershipPayment($membershipId) {
2168 $membesrshipPayment = new CRM_Member_DAO_MembershipPayment();
2169 $membesrshipPayment->membership_id
= $membershipId;
2170 $membesrshipPayment->find();
2172 while ($membesrshipPayment->fetch()) {
2173 CRM_Contribute_BAO_Contribution
::deleteContribution($membesrshipPayment->contribution_id
);
2174 CRM_Utils_Hook
::pre('delete', 'MembershipPayment', $membesrshipPayment->id
, $membesrshipPayment);
2175 $membesrshipPayment->delete();
2176 CRM_Utils_Hook
::post('delete', 'MembershipPayment', $membesrshipPayment->id
, $membesrshipPayment);
2178 return $membesrshipPayment;
2181 static function &buildMembershipTypeValues(&$form, $membershipTypeID = NULL) {
2182 $whereClause = " WHERE domain_id = ". CRM_Core_Config
::domainID();
2184 if (is_array($membershipTypeID)) {
2185 $allIDs = implode(',', $membershipTypeID);
2186 $whereClause .= " AND id IN ( $allIDs )";
2188 elseif (is_numeric($membershipTypeID) &&
2189 $membershipTypeID > 0
2191 $whereClause .= " AND id = $membershipTypeID";
2196 FROM civicrm_membership_type
2199 $dao = CRM_Core_DAO
::executeQuery($query);
2201 $membershipTypeValues = array();
2202 $membershipTypeFields = array(
2203 'id', 'minimum_fee', 'name', 'is_active',
2204 'description', 'financial_type_id', 'auto_renew','member_of_contact_id',
2205 'relationship_type_id', 'relationship_direction', 'max_related',
2208 while ($dao->fetch()) {
2209 $membershipTypeValues[$dao->id
] = array();
2210 foreach ($membershipTypeFields as $mtField) {
2211 $membershipTypeValues[$dao->id
][$mtField] = $dao->$mtField;
2216 CRM_Utils_Hook
::membershipTypeValues($form, $membershipTypeValues);
2218 if (is_numeric($membershipTypeID) &&
2219 $membershipTypeID > 0
2221 return $membershipTypeValues[$membershipTypeID];
2224 return $membershipTypeValues;
2229 * Function to get membership record count for a Contact
2231 * @param int $contactId Contact ID
2232 * @param boolean $activeOnly
2234 * @return int count of membership records
2238 static function getContactMembershipCount($contactID, $activeOnly = FALSE) {
2239 $select = "SELECT count(*) FROM civicrm_membership ";
2240 $where = "WHERE civicrm_membership.contact_id = {$contactID} AND civicrm_membership.is_test = 0 ";
2242 // CRM-6627, all status below 3 (active, pending, grace) are considered active
2244 $select .= " INNER JOIN civicrm_membership_status ON civicrm_membership.status_id = civicrm_membership_status.id ";
2245 $where .= " and civicrm_membership_status.is_current_member = 1";
2248 $query = $select . $where;
2249 return CRM_Core_DAO
::singleValueQuery($query);
2253 * Function to check whether payment processor supports
2254 * cancellation of membership subscription
2256 * @param int $mid membership id
2262 static function isCancelSubscriptionSupported($mid, $isNotCancelled = TRUE) {
2263 $cacheKeyString = "$mid";
2264 $cacheKeyString .= $isNotCancelled ?
'_1' : '_0';
2266 static $supportsCancel = array();
2268 if (!array_key_exists($cacheKeyString, $supportsCancel)) {
2269 $supportsCancel[$cacheKeyString] = FALSE;
2270 $isCancelled = FALSE;
2272 if ($isNotCancelled) {
2273 $isCancelled = self
::isSubscriptionCancelled($mid);
2276 $paymentObject = CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($mid, 'membership', 'obj');
2277 if (!empty($paymentObject)) {
2278 $supportsCancel[$cacheKeyString] = $paymentObject->isSupported('cancelSubscription') && !$isCancelled;
2281 return $supportsCancel[$cacheKeyString];
2285 * Function to check whether subscription is already cancelled
2287 * @param int $mid membership id
2289 * @return string $status contribution status
2293 static function isSubscriptionCancelled($mid) {
2295 SELECT cr.contribution_status_id
2296 FROM civicrm_contribution_recur cr
2297 LEFT JOIN civicrm_membership mem ON ( cr.id = mem.contribution_recur_id )
2298 WHERE mem.id = %1 LIMIT 1";
2299 $params = array(1 => array($mid, 'Integer'));
2300 $statusId = CRM_Core_DAO
::singleValueQuery($sql, $params);
2301 $status = CRM_Contribute_PseudoConstant
::contributionStatus($statusId);
2302 if ($status == 'Cancelled') {
2309 * Function to get membership joins for a specified membership
2310 * type. Specifically, retrieves a count of still current memberships whose
2311 * join_date and start_date are within a specified date range. Dates match
2312 * the pattern "yyyy-mm-dd".
2314 * @param int $membershipTypeId membership type id
2315 * @param int $startDate date on which to start counting
2316 * @param int $endDate date on which to end counting
2317 * @param bool $isTest if true, membership is for a test site
2319 * @return returns the number of members of type $membershipTypeId
2320 * whose join_date is between $startDate and $endDate and
2321 * whose start_date is between $startDate and $endDate
2323 static function getMembershipJoins($membershipTypeId, $startDate, $endDate, $isTest = 0) {
2324 $testClause = 'membership.is_test = 1';
2326 $testClause = '( membership.is_test IS NULL OR membership.is_test = 0 )';
2328 if (!self
::$_signupActType) {
2329 self
::_getActTypes();
2332 if (!self
::$_signupActType) {
2337 SELECT COUNT(DISTINCT membership.id) as member_count
2338 FROM civicrm_membership membership
2339 INNER JOIN civicrm_activity activity ON (activity.source_record_id = membership.id AND activity.activity_type_id = %1)
2340 INNER JOIN civicrm_membership_status status ON ( membership.status_id = status.id AND status.is_current_member = 1 )
2341 INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND contact.is_deleted = 0 )
2342 WHERE membership.membership_type_id = %2
2343 AND activity.activity_date_time >= '$startDate' AND activity.activity_date_time <= '$endDate 23:59:59'
2347 1 => array(self
::$_signupActType, 'Integer'),
2348 2 => array($membershipTypeId, 'Integer'),
2351 $memberCount = CRM_Core_DAO
::singleValueQuery($query, $params);
2353 return (int)$memberCount;
2357 * Function to get membership renewals for a specified membership
2358 * type. Specifically, retrieves a count of still current memberships
2359 * whose join_date is before and start_date is within a specified date
2360 * range. Dates match the pattern "yyyy-mm-dd".
2362 * @param int $membershipTypeId membership type id
2363 * @param int $startDate date on which to start counting
2364 * @param int $endDate date on which to end counting
2365 * @param bool $isTest if true, membership is for a test site
2367 * @return returns the number of members of type $membershipTypeId
2368 * whose join_date is before $startDate and
2369 * whose start_date is between $startDate and $endDate
2371 static function getMembershipRenewals($membershipTypeId, $startDate, $endDate, $isTest = 0) {
2372 $testClause = 'membership.is_test = 1';
2374 $testClause = '( membership.is_test IS NULL OR membership.is_test = 0 )';
2376 if (!self
::$_renewalActType) {
2377 self
::_getActTypes();
2380 if (!self
::$_renewalActType) {
2385 SELECT COUNT(DISTINCT membership.id) as member_count
2386 FROM civicrm_membership membership
2387 INNER JOIN civicrm_activity activity ON (activity.source_record_id = membership.id AND activity.activity_type_id = %1)
2388 INNER JOIN civicrm_membership_status status ON ( membership.status_id = status.id AND status.is_current_member = 1 )
2389 INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND contact.is_deleted = 0 )
2390 WHERE membership.membership_type_id = %2
2391 AND activity.activity_date_time >= '$startDate' AND activity.activity_date_time <= '$endDate 23:59:59'
2395 1 => array(self
::$_renewalActType, 'Integer'),
2396 2 => array($membershipTypeId, 'Integer'),
2398 $memberCount = CRM_Core_DAO
::singleValueQuery($query, $params);
2400 return (int)$memberCount;
2404 * Function to process price set and line items.
2410 function processPriceSet($membershipId, $lineItem) {
2411 //FIXME : need to move this too
2412 if (!$membershipId ||
!is_array($lineItem)
2413 || CRM_Utils_system
::isNull($lineItem)
2418 foreach ($lineItem as $priceSetId => $values) {
2422 foreach ($values as $line) {
2423 $line['entity_table'] = 'civicrm_membership';
2424 $line['entity_id'] = $membershipId;
2425 CRM_Price_BAO_LineItem
::create($line);
2431 * retrieve the contribution record for the associated Membership id
2433 * @param int $membershipId membsership id.
2435 * @return contribution id
2438 static function getMembershipContributionId($membershipId) {
2440 $membesrshipPayment = new CRM_Member_DAO_MembershipPayment();
2441 $membesrshipPayment->membership_id
= $membershipId;
2442 if ($membesrshipPayment->find(TRUE)) {
2443 return $membesrshipPayment->contribution_id
;
2449 * The function checks and updates the status of all membership records for a given domain using the
2450 * calc_membership_status and update_contact_membership APIs.
2453 * Sending renewal reminders has been migrated from this job to the Scheduled Reminders function as of 4.3.
2455 * @return array $result
2458 static function updateAllMembershipStatus() {
2459 require_once 'api/api.php';
2461 //get all active statuses of membership, CRM-3984
2462 $allStatus = CRM_Member_PseudoConstant
::membershipStatus();
2463 $statusLabels = CRM_Member_PseudoConstant
::membershipStatus(NULL, NULL, 'label');
2464 $allTypes = CRM_Member_PseudoConstant
::membershipType();
2465 $contribStatus = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
2467 // get only memberships with active membership types
2469 SELECT civicrm_membership.id as membership_id,
2470 civicrm_membership.is_override as is_override,
2471 civicrm_membership.membership_type_id as membership_type_id,
2472 civicrm_membership.status_id as status_id,
2473 civicrm_membership.join_date as join_date,
2474 civicrm_membership.start_date as start_date,
2475 civicrm_membership.end_date as end_date,
2476 civicrm_membership.source as source,
2477 civicrm_contact.id as contact_id,
2478 civicrm_contact.is_deceased as is_deceased,
2479 civicrm_membership.owner_membership_id as owner_membership_id,
2480 civicrm_membership.contribution_recur_id as recur_id
2481 FROM civicrm_membership
2482 INNER JOIN civicrm_contact ON ( civicrm_membership.contact_id = civicrm_contact.id )
2483 INNER JOIN civicrm_membership_type ON
2484 (civicrm_membership.membership_type_id = civicrm_membership_type.id AND civicrm_membership_type.is_active = 1)
2485 WHERE civicrm_membership.is_test = 0";
2488 $dao = CRM_Core_DAO
::executeQuery($query, $params);
2490 $today = date('Y-m-d');
2494 $smarty = CRM_Core_Smarty
::singleton();
2496 while ($dao->fetch()) {
2500 // Put common parameters into array for easy access
2501 $memberParams = array(
2502 'id' => $dao->membership_id
,
2503 'status_id' => $dao->status_id
,
2504 'contact_id' => $dao->contact_id
,
2505 'membership_type_id' => $dao->membership_type_id
,
2506 'membership_type' => $allTypes[$dao->membership_type_id
],
2507 'join_date' => $dao->join_date
,
2508 'start_date' => $dao->start_date
,
2509 'end_date' => $dao->end_date
,
2510 'source' => $dao->source
,
2511 'skipStatusCal' => TRUE,
2512 'skipRecentView' => TRUE,
2515 $smarty->assign_by_ref('memberParams', $memberParams);
2517 //update membership record to Deceased if contact is deceased
2518 if ($dao->is_deceased
) {
2519 // check for 'Deceased' membership status, CRM-5636
2520 $deceaseStatusId = array_search('Deceased', $allStatus);
2521 if (!$deceaseStatusId) {
2522 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'))));
2525 //process only when status change.
2526 if ($dao->status_id
!= $deceaseStatusId) {
2527 //take all params that need to save.
2528 $deceasedMembership = $memberParams;
2529 $deceasedMembership['status_id'] = $deceaseStatusId;
2530 $deceasedMembership['createActivity'] = TRUE;
2531 $deceasedMembership['version'] = 3;
2533 //since there is change in status.
2534 $statusChange = array('status_id' => $deceaseStatusId);
2535 $smarty->append_by_ref('memberParams', $statusChange, TRUE);
2537 $deceasedMembership['contact_id'],
2538 $deceasedMembership['membership_type_id'],
2539 $deceasedMembership['membership_type'],
2540 $deceasedMembership['join_date'],
2541 $deceasedMembership['start_date'],
2542 $deceasedMembership['end_date'],
2543 $deceasedMembership['source']
2546 //process membership record.
2547 civicrm_api('membership', 'create', $deceasedMembership);
2552 //we fetch related, since we need to check for deceased
2553 //now further processing is handle w/ main membership record.
2554 if ($dao->owner_membership_id
) {
2558 //update membership records where status is NOT - Pending OR Cancelled.
2559 //as well as membership is not override.
2560 //skipping Expired membership records -> reduced extra processing( kiran )
2561 if (!$dao->is_override
&&
2562 !in_array($dao->status_id
, array(array_search('Pending', $allStatus),
2563 array_search('Cancelled', $allStatus),
2564 array_search('Expired', $allStatus),
2568 // CRM-7248: added excludeIsAdmin param to the following fn call to prevent moving to admin statuses
2569 //get the membership status as per id.
2570 $newStatus = civicrm_api('membership_status', 'calc',
2572 'membership_id' => $dao->membership_id
, 'version' => 3, 'ignore_admin_only'=> FALSE), TRUE
2574 $statusId = CRM_Utils_Array
::value('id', $newStatus);
2576 //process only when status change.
2578 $statusId != $dao->status_id
2580 //take all params that need to save.
2581 $memParams = $memberParams;
2582 $memParams['status_id'] = $statusId;
2583 $memParams['createActivity'] = TRUE;
2584 $memParams['version'] = 3;
2586 // Unset columns which should remain unchanged from their current saved
2587 // values. This avoids race condition in which these values may have
2588 // been changed by other processes.
2590 $memParams['contact_id'],
2591 $memParams['membership_type_id'],
2592 $memParams['membership_type'],
2593 $memParams['join_date'],
2594 $memParams['start_date'],
2595 $memParams['end_date'],
2596 $memParams['source']
2598 //since there is change in status.
2599 $statusChange = array('status_id' => $statusId);
2600 $smarty->append_by_ref('memberParams', $statusChange, TRUE);
2602 //process member record.
2603 civicrm_api('membership', 'create', $memParams);
2607 // CRM_Core_Error::debug( 'fEnd', count( $GLOBALS['_DB_DATAOBJECT']['RESULTS'] ) );
2609 $result['is_error'] = 0;
2610 $result['messages'] = ts('Processed %1 membership records. Updated %2 records.', array(1 => $processCount, 2 => $updateCount));
2614 /** The function returns the membershiptypes for a particular contact
2615 * who has lifetime membership without end date.
2617 * @param array $contactMembershipType array of allMembershipTypes Key - value pairs
2621 static function getAllContactMembership($contactID, $isTest = FALSE, $onlyLifeTime = FALSE) {
2622 $contactMembershipType = array();
2624 return $contactMembershipType;
2627 $dao = new CRM_Member_DAO_Membership();
2628 $dao->contact_id
= $contactID;
2629 $pendingStatusId = array_search('Pending', CRM_Member_PseudoConstant
::membershipStatus());
2630 $dao->whereAdd("status_id != $pendingStatusId");
2633 $dao->is_test
= $isTest;
2636 $dao->whereAdd('is_test IS NULL OR is_test = 0');
2639 if ($onlyLifeTime) {
2640 $dao->whereAdd('end_date IS NULL');
2644 while ($dao->fetch()) {
2645 $membership = array();
2646 CRM_Core_DAO
::storeValues($dao, $membership);
2647 $contactMembershipType[$dao->membership_type_id
] = $membership;
2649 return $contactMembershipType;
2653 * Function to record contribution record associated with membership
2655 * @param array $params array of submitted params
2656 * @param array $ids (param in process of being removed - try to use params) array of ids
2661 static function recordMembershipContribution( &$params, $ids = array()) {
2662 $membershipId = $params['membership_id'];
2663 $contributionParams = array();
2664 $config = CRM_Core_Config
::singleton();
2665 $contributionParams['currency'] = $config->defaultCurrency
;
2666 $contributionParams['receipt_date'] = (CRM_Utils_Array
::value('receipt_date', $params)) ?
$params['receipt_date'] : 'null';
2667 $contributionParams['source'] = CRM_Utils_Array
::value('contribution_source', $params);
2668 $contributionParams['soft_credit'] = CRM_Utils_Array
::value('soft_credit', $params);
2669 $contributionParams['non_deductible_amount'] = 'null';
2670 $recordContribution = array(
2671 'contact_id', 'total_amount', 'receive_date', 'financial_type_id',
2672 'payment_instrument_id', 'trxn_id', 'invoice_id', 'is_test',
2673 'honor_contact_id', 'honor_type_id',
2674 'contribution_status_id', 'check_number', 'campaign_id', 'is_pay_later',
2676 foreach ($recordContribution as $f) {
2677 $contributionParams[$f] = CRM_Utils_Array
::value($f, $params);
2680 // make entry in batch entity batch table
2681 if (CRM_Utils_Array
::value('batch_id', $params)) {
2682 $contributionParams['batch_id'] = $params['batch_id'];
2685 if ( CRM_Utils_Array
::value('contribution_contact_id', $params) ) {
2686 // deal with possibility of a different person paying for contribution
2687 $contributionParams['contact_id'] = $params['contribution_contact_id'];
2690 if (CRM_Utils_Array
::value('processPriceSet', $params) &&
2691 !empty($params['lineItems'])
2693 $contributionParams['line_item'] = CRM_Utils_Array
::value('lineItems', $params, NULL);
2696 $contribution = CRM_Contribute_BAO_Contribution
::create($contributionParams, $ids);
2698 // store contribution id
2699 $params['contribution_id'] = $contribution->id
;
2702 //insert payment record for this membership
2703 if (!CRM_Utils_Array
::value('contribution', $ids) ||
2704 CRM_Utils_Array
::value('is_recur', $params)
2706 $mpDAO = new CRM_Member_DAO_MembershipPayment();
2707 $mpDAO->membership_id
= $membershipId;
2708 $mpDAO->contribution_id
= $contribution->id
;
2709 if (CRM_Utils_Array
::value('is_recur', $params)) {
2713 CRM_Utils_Hook
::pre('create', 'MembershipPayment', NULL, $mpDAO);
2715 CRM_Utils_Hook
::post('create', 'MembershipPayment', $mpDAO->id
, $mpDAO);
2717 return $contribution;
2721 * Function to record line items for default membership
2725 * @param $membershipType array with membership type and organization
2727 * @param$ priceSetId priceset id
2731 static function createLineItems(&$qf, $membershipType, &$priceSetId) {
2732 $qf->_priceSetId
= $priceSetId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', 'default_membership_type_amount', 'id', 'name');
2734 $qf->_priceSet
= $priceSets = current(CRM_Price_BAO_PriceSet
::getSetDetail($priceSetId));
2736 $editedFieldParams = array(
2737 'price_set_id' => $priceSetId,
2738 'name' => $membershipType[0],
2740 $editedResults = array();
2741 CRM_Price_BAO_PriceField
::retrieve($editedFieldParams, $editedResults);
2743 if (!empty($editedResults)) {
2744 unset($qf->_priceSet
['fields']);
2745 $qf->_priceSet
['fields'][$editedResults['id']] = $priceSets['fields'][$editedResults['id']];
2746 unset($qf->_priceSet
['fields'][$editedResults['id']]['options']);
2747 $fid = $editedResults['id'];
2748 $editedFieldParams = array(
2749 'price_field_id' => $editedResults['id'],
2750 'membership_type_id' => $membershipType[1],
2752 $editedResults = array();
2753 CRM_Price_BAO_PriceFieldValue
::retrieve($editedFieldParams, $editedResults);
2754 $qf->_priceSet
['fields'][$fid]['options'][$editedResults['id']] = $priceSets['fields'][$fid]['options'][$editedResults['id']];
2755 if (CRM_Utils_Array
::value('total_amount', $qf->_params
)) {
2756 $qf->_priceSet
['fields'][$fid]['options'][$editedResults['id']]['amount'] = $qf->_params
['total_amount'];
2760 $fieldID = key($qf->_priceSet
['fields']);
2761 $qf->_params
['price_' . $fieldID] = CRM_Utils_Array
::value('id', $editedResults);
2764 static function _getActTypes() {
2765 $activityTypes = CRM_Core_PseudoConstant
::activityType(TRUE, FALSE, FALSE, 'name');
2766 self
::$_renewalActType = CRM_Utils_Array
::key('Membership Renewal', $activityTypes);
2767 self
::$_signupActType = CRM_Utils_Array
::key('Membership Signup', $activityTypes);