3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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-2019
33 class CRM_Member_BAO_Membership
extends CRM_Member_DAO_Membership
{
36 * Static field for all the membership information that we can potentially import.
40 public static $_importableFields = NULL;
42 public static $_renewalActType = NULL;
44 public static $_signupActType = NULL;
49 public 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
61 * (reference ) an assoc array of name/value pairs.
63 * The array that holds all the db ids.
65 * @return CRM_Member_BAO_Membership
67 public static function add(&$params, $ids = array()) {
68 $oldStatus = $oldType = NULL;
69 $params['id'] = CRM_Utils_Array
::value('id', $params, CRM_Utils_Array
::value('membership', $ids));
71 CRM_Utils_Hook
::pre('edit', 'Membership', $params['id'], $params);
74 CRM_Utils_Hook
::pre('create', 'Membership', NULL, $params);
77 // we do this after the hooks are called in case it has been altered
79 $membershipObj = new CRM_Member_DAO_Membership();
80 $membershipObj->id
= $id;
81 $membershipObj->find();
82 while ($membershipObj->fetch()) {
83 $oldStatus = $membershipObj->status_id
;
84 $oldType = $membershipObj->membership_type_id
;
88 if (array_key_exists('is_override', $params) && !$params['is_override']) {
89 $params['is_override'] = 'null';
92 $membership = new CRM_Member_BAO_Membership();
93 $membership->copyValues($params);
94 $membership->id
= $id;
98 if (empty($membership->contact_id
) ||
empty($membership->status_id
)) {
99 // this means we are in renewal mode and are just updating the membership
100 // record or this is an API update call and all fields are not present in the update record
101 // however the hooks don't care and want all data CRM-7784
102 $tempMembership = new CRM_Member_DAO_Membership();
103 $tempMembership->id
= $membership->id
;
104 $tempMembership->find(TRUE);
105 $membership = $tempMembership;
108 //get the log start date.
109 //it is set during renewal of membership.
110 $logStartDate = CRM_Utils_Array
::value('log_start_date', $params);
111 $logStartDate = ($logStartDate) ? CRM_Utils_Date
::isoToMysql($logStartDate) : CRM_Utils_Date
::isoToMysql($membership->start_date
);
112 $values = self
::getStatusANDTypeValues($membership->id
);
114 $membershipLog = array(
115 'membership_id' => $membership->id
,
116 'status_id' => $membership->status_id
,
117 'start_date' => $logStartDate,
118 'end_date' => CRM_Utils_Date
::isoToMysql($membership->end_date
),
119 'modified_date' => date('Ymd'),
120 'membership_type_id' => $values[$membership->id
]['membership_type_id'],
121 'max_related' => $membership->max_related
,
124 $session = CRM_Core_Session
::singleton();
125 // If we have an authenticated session, set modified_id to that user's contact_id, else set to membership.contact_id
126 if ($session->get('userID')) {
127 $membershipLog['modified_id'] = $session->get('userID');
129 elseif (!empty($ids['userId'])) {
130 $membershipLog['modified_id'] = $ids['userId'];
133 $membershipLog['modified_id'] = $membership->contact_id
;
136 CRM_Member_BAO_MembershipLog
::add($membershipLog);
138 // reset the group contact cache since smart groups might be affected due to this
139 CRM_Contact_BAO_GroupContactCache
::opportunisticCacheFlush();
141 $allStatus = CRM_Member_BAO_Membership
::buildOptions('status_id', 'get');
142 $activityParams = array(
143 'status_id' => CRM_Utils_Array
::value('membership_activity_status', $params, 'Completed'),
145 if (in_array($allStatus[$membership->status_id
], array('Pending', 'Grace'))) {
146 $activityParams['status_id'] = 'Scheduled';
148 $activityParams['status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', $activityParams['status_id']);
150 $targetContactID = $membership->contact_id
;
151 if (!empty($params['is_for_organization'])) {
152 $targetContactID = CRM_Utils_Array
::value('userId', $ids);
155 if ($membership->status_id
!= $oldStatus) {
156 CRM_Activity_BAO_Activity
::addActivity($membership,
157 'Change Membership Status',
160 'subject' => "Status changed from {$allStatus[$oldStatus]} to {$allStatus[$membership->status_id]}",
161 'source_contact_id' => $membershipLog['modified_id'],
162 'priority_id' => 'Normal',
166 if (isset($membership->membership_type_id
) && $membership->membership_type_id
!= $oldType) {
167 $membershipTypes = CRM_Member_BAO_Membership
::buildOptions('membership_type_id', 'get');
168 CRM_Activity_BAO_Activity
::addActivity($membership,
169 'Change Membership Type',
172 'subject' => "Type changed from {$membershipTypes[$oldType]} to {$membershipTypes[$membership->membership_type_id]}",
173 'source_contact_id' => $membershipLog['modified_id'],
174 'priority_id' => 'Normal',
179 foreach (array('Membership Signup', 'Membership Renewal') as $activityType) {
180 $activityParams['id'] = CRM_Utils_Array
::value('id',
181 civicrm_api3('Activity', 'Get',
183 'source_record_id' => $membership->id
,
184 'activity_type_id' => $activityType,
185 'status_id' => 'Scheduled',
189 // 1. Update Schedule Membership Signup/Renwal activity to completed on successful payment of pending membership
190 // 2. OR Create renewal activity scheduled if its membership renewal will be paid later
191 if (!empty($params['membership_activity_status']) && (!empty($activityParams['id']) ||
$activityType == 'Membership Renewal')) {
192 CRM_Activity_BAO_Activity
::addActivity($membership, $activityType, $targetContactID, $activityParams);
197 CRM_Utils_Hook
::post('edit', 'Membership', $membership->id
, $membership);
200 CRM_Activity_BAO_Activity
::addActivity($membership, 'Membership Signup', $targetContactID, $activityParams);
201 CRM_Utils_Hook
::post('create', 'Membership', $membership->id
, $membership);
208 * Fetch the object and store the values in the values array.
210 * @param array $params
211 * Input parameters to find object.
212 * @param array $values
213 * Output values of the object.
214 * @param bool $active
215 * Do you want only active memberships to.
217 * @param bool $relatedMemberships
219 * @return CRM_Member_BAO_Membership|null
220 * The found object or null
222 public static function &getValues(&$params, &$values, $active = FALSE, $relatedMemberships = FALSE) {
223 if (empty($params)) {
226 $membership = new CRM_Member_BAO_Membership();
228 $membership->copyValues($params);
230 $memberships = array();
231 while ($membership->fetch()) {
233 (!CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus',
234 $membership->status_id
,
241 CRM_Core_DAO
::storeValues($membership, $values[$membership->id
]);
242 $memberships[$membership->id
] = $membership;
243 if ($relatedMemberships && !empty($membership->owner_membership_id
)) {
244 $values['owner_membership_ids'][] = $membership->owner_membership_id
;
252 * Takes an associative array and creates a membership object.
254 * @param array $params
255 * (reference ) an assoc array of name/value pairs.
257 * Deprecated parameter The array that holds all the db ids.
258 * @param bool $skipRedirect
260 * @throws CRM_Core_Exception
262 * @return CRM_Member_BAO_Membership|CRM_Core_Error
264 public static function create(&$params, &$ids = [], $skipRedirect = FALSE) {
265 // always calculate status if is_override/skipStatusCal is not true.
266 // giving respect to is_override during import. CRM-4012
268 // To skip status calculation we should use 'skipStatusCal'.
269 // eg pay later membership, membership update cron CRM-3984
271 if (empty($params['is_override']) && empty($params['skipStatusCal'])) {
272 $dates = array('start_date', 'end_date', 'join_date');
273 // Declare these out of courtesy as IDEs don't pick up the setting of them below.
274 $start_date = $end_date = $join_date = NULL;
275 foreach ($dates as $date) {
276 $
$date = $params[$date] = CRM_Utils_Date
::processDate(CRM_Utils_Array
::value($date, $params), NULL, TRUE, 'Ymd');
279 //fix for CRM-3570, during import exclude the statuses those having is_admin = 1
280 $excludeIsAdmin = CRM_Utils_Array
::value('exclude_is_admin', $params, FALSE);
282 //CRM-3724 always skip is_admin if is_override != true.
283 if (!$excludeIsAdmin && empty($params['is_override'])) {
284 $excludeIsAdmin = TRUE;
287 $calcStatus = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($start_date, $end_date, $join_date,
288 'today', $excludeIsAdmin, CRM_Utils_Array
::value('membership_type_id', $params), $params
290 if (empty($calcStatus)) {
291 // Redirect the form in case of error
292 // @todo this redirect in the BAO layer is really bad & should be moved to the form layer
293 // however since we have no idea how (if) this is triggered we can't safely move / remove it
294 // NB I tried really hard to trigger this error from backoffice membership form in order to test it
295 // and am convinced form validation is complete on that form WRT this error.
296 $errorParams = array(
297 'message_title' => ts('No valid membership status for given dates.'),
298 'legacy_redirect_path' => 'civicrm/contact/view',
299 'legacy_redirect_query' => "reset=1&force=1&cid={$params['contact_id']}&selectedChild=member",
301 throw new CRM_Core_Exception(ts(
302 "The membership cannot be saved because the status cannot be calculated for start_date: $start_date end_date $end_date join_date $join_date as at " . date('Y-m-d H:i:s')),
307 $params['status_id'] = $calcStatus['id'];
310 // data cleanup only: all verifications on number of related memberships are done upstream in:
311 // CRM_Member_BAO_Membership::createRelatedMemberships()
312 // CRM_Contact_BAO_Relationship::relatedMemberships()
313 if (!empty($params['owner_membership_id'])) {
314 unset($params['max_related']);
317 // if membership allows related, default max_related to value in membership_type
318 if (!array_key_exists('max_related', $params) && !empty($params['membership_type_id'])) {
319 $membershipType = CRM_Member_BAO_MembershipType
::getMembershipTypeDetails($params['membership_type_id']);
320 if (isset($membershipType['relationship_type_id'])) {
321 $params['max_related'] = CRM_Utils_Array
::value('max_related', $membershipType);
326 $transaction = new CRM_Core_Transaction();
328 // @todo remove $ids from here - $ids['contribution'] is not used or set by add. $ids['userId'] is used. $ids['membership'] is used if $params['id'] is not set
329 $membership = self
::add($params, $ids);
331 if (is_a($membership, 'CRM_Core_Error')) {
332 $transaction->rollback();
336 // add custom field values
337 if (!empty($params['custom']) && is_array($params['custom'])
339 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_membership', $membership->id
);
342 $params['membership_id'] = $membership->id
;
343 // @todo further cleanup required to remove use of $ids['contribution'] from here
344 if (isset($ids['membership'])) {
345 $ids['contribution'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipPayment',
350 // @todo this is a temporary step to removing $ids['contribution'] completely
351 if (empty($params['contribution_id']) && !empty($ids['contribution'])) {
352 $params['contribution_id'] = $ids['contribution'];
356 // This code ensures a line item is created but it is recommended you pass in 'skipLineItem' or 'line_item'
357 if (empty($params['line_item']) && !empty($params['membership_type_id']) && empty($params['skipLineItem'])) {
358 CRM_Price_BAO_LineItem
::getLineItemArray($params, NULL, 'membership', $params['membership_type_id']);
360 $params['skipLineItem'] = TRUE;
362 //record contribution for this membership
363 if (!empty($params['contribution_status_id']) && empty($params['relate_contribution_id'])) {
364 $memInfo = array_merge($params, array('membership_id' => $membership->id
));
365 $params['contribution'] = self
::recordMembershipContribution($memInfo);
368 if (!empty($params['lineItems'])) {
369 $params['line_item'] = $params['lineItems'];
372 // do cleanup line items if membership edit the Membership type.
373 if (empty($ids['contribution']) && !empty($ids['membership'])) {
374 CRM_Price_BAO_LineItem
::deleteLineItems($ids['membership'], 'civicrm_membership');
377 // This could happen if there is no contribution or we are in one of many
378 // weird and wonderful flows. This is scary code. Keep adding tests.
379 if (!empty($params['line_item']) && empty($ids['contribution'])) {
381 foreach ($params['line_item'] as $priceSetId => $lineItems) {
382 foreach ($lineItems as $lineIndex => $lineItem) {
383 $lineMembershipType = CRM_Utils_Array
::value('membership_type_id', $lineItem);
384 if (CRM_Utils_Array
::value('contribution', $params)) {
385 $params['line_item'][$priceSetId][$lineIndex]['contribution_id'] = $params['contribution']->id
;
387 if ($lineMembershipType && $lineMembershipType == CRM_Utils_Array
::value('membership_type_id', $params)) {
388 $params['line_item'][$priceSetId][$lineIndex]['entity_id'] = $membership->id
;
389 $params['line_item'][$priceSetId][$lineIndex]['entity_table'] = 'civicrm_membership';
391 elseif (!$lineMembershipType && CRM_Utils_Array
::value('contribution', $params)) {
392 $params['line_item'][$priceSetId][$lineIndex]['entity_id'] = $params['contribution']->id
;
393 $params['line_item'][$priceSetId][$lineIndex]['entity_table'] = 'civicrm_contribution';
397 CRM_Price_BAO_LineItem
::processPriceSet(
399 $params['line_item'],
400 CRM_Utils_Array
::value('contribution', $params)
404 //insert payment record for this membership
405 if (!empty($params['relate_contribution_id'])) {
406 $membershipPaymentParams = [
407 'membership_id' => $membership->id
,
408 'membership_type_id' => $membership->membership_type_id
,
409 'contribution_id' => $params['relate_contribution_id'],
411 civicrm_api3('MembershipPayment', 'create', $membershipPaymentParams);
414 $transaction->commit();
416 self
::createRelatedMemberships($params, $membership);
418 // do not add to recent items for import, CRM-4399
419 if (empty($params['skipRecentView'])) {
420 $url = CRM_Utils_System
::url('civicrm/contact/view/membership',
421 "action=view&reset=1&id={$membership->id}&cid={$membership->contact_id}&context=home"
423 if (empty($membership->membership_type_id
)) {
424 // ie in an update situation.
425 $membership->find(TRUE);
427 $membershipTypes = CRM_Member_PseudoConstant
::membershipType();
428 $title = CRM_Contact_BAO_Contact
::displayName($membership->contact_id
) . ' - ' . ts('Membership Type:') . ' ' . $membershipTypes[$membership->membership_type_id
];
430 $recentOther = array();
431 if (CRM_Core_Permission
::checkActionPermission('CiviMember', CRM_Core_Action
::UPDATE
)) {
432 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/contact/view/membership',
433 "action=update&reset=1&id={$membership->id}&cid={$membership->contact_id}&context=home"
436 if (CRM_Core_Permission
::checkActionPermission('CiviMember', CRM_Core_Action
::DELETE
)) {
437 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/contact/view/membership',
438 "action=delete&reset=1&id={$membership->id}&cid={$membership->contact_id}&context=home"
442 // add the recently created Membership
443 CRM_Utils_Recent
::add($title,
447 $membership->contact_id
,
457 * Check the membership extended through relationship.
459 * @param int $membershipTypeID
460 * Membership type id.
461 * @param int $contactId
467 * array of contact_id of all related contacts.
469 public static function checkMembershipRelationship($membershipTypeID, $contactId, $action = CRM_Core_Action
::ADD
) {
472 $membershipType = CRM_Member_BAO_MembershipType
::getMembershipTypeDetails($membershipTypeID);
473 $relationships = array();
474 if (isset($membershipType['relationship_type_id'])) {
475 $relationships = CRM_Contact_BAO_Relationship
::getRelationship($contactId,
476 CRM_Contact_BAO_Relationship
::CURRENT
478 if ($action & CRM_Core_Action
::UPDATE
) {
479 $pastRelationships = CRM_Contact_BAO_Relationship
::getRelationship($contactId,
480 CRM_Contact_BAO_Relationship
::PAST
482 $relationships = array_merge($relationships, $pastRelationships);
486 if (!empty($relationships)) {
487 // check for each contact relationships
488 foreach ($relationships as $values) {
489 //get details of the relationship type
490 $relType = array('id' => $values['civicrm_relationship_type_id']);
491 $relValues = array();
492 CRM_Contact_BAO_RelationshipType
::retrieve($relType, $relValues);
493 // Check if contact's relationship type exists in membership type
494 $relTypeDirs = array();
495 $relTypeIds = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $membershipType['relationship_type_id']);
496 $relDirections = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $membershipType['relationship_direction']);
497 $bidirectional = FALSE;
498 foreach ($relTypeIds as $key => $value) {
499 $relTypeDirs[] = $value . '_' . $relDirections[$key];
500 if (in_array($value, $relType) &&
501 $relValues['name_a_b'] == $relValues['name_b_a']
503 $bidirectional = TRUE;
507 $relTypeDir = $values['civicrm_relationship_type_id'] . '_' . $values['rtype'];
508 if ($bidirectional ||
in_array($relTypeDir, $relTypeDirs)) {
509 // $values['status'] is going to have value for
510 // current or past relationships.
511 $contacts[$values['cid']] = $values['status'];
516 // Sort by contact_id ascending
522 * Retrieve DB object based on input parameters.
524 * It also stores all the retrieved values in the default array.
526 * @param array $params
527 * (reference ) an assoc array of name/value pairs.
528 * @param array $defaults
529 * (reference ) an assoc array to hold the name / value pairs.
530 * in a hierarchical manner
532 * @return CRM_Member_BAO_Membership
534 public static function retrieve(&$params, &$defaults) {
535 $membership = new CRM_Member_DAO_Membership();
537 $membership->copyValues($params);
539 if ($membership->find(TRUE)) {
540 CRM_Core_DAO
::storeValues($membership, $defaults);
542 //get the membership status and type values.
543 $statusANDType = self
::getStatusANDTypeValues($membership->id
);
548 $defaults[$fld] = CRM_Utils_Array
::value($fld, $statusANDType[$membership->id
]);
550 if (!empty($statusANDType[$membership->id
]['is_current_member'])) {
551 $defaults['active'] = TRUE;
561 * Get membership status and membership type values.
563 * @param int $membershipId
564 * Membership id of values to return.
567 * Array of key value pairs
569 public static function getStatusANDTypeValues($membershipId) {
571 if (!$membershipId) {
575 SELECT membership.id as id,
576 status.id as status_id,
577 status.label as status,
578 status.is_current_member as is_current_member,
579 type.id as membership_type_id,
580 type.name as membership_type,
581 type.relationship_type_id as relationship_type_id
582 FROM civicrm_membership membership
583 INNER JOIN civicrm_membership_status status ON ( status.id = membership.status_id )
584 INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_type_id )
585 WHERE membership.id = %1';
586 $dao = CRM_Core_DAO
::executeQuery($sql, array(1 => array($membershipId, 'Positive')));
591 'membership_type_id',
593 'relationship_type_id',
595 while ($dao->fetch()) {
596 foreach ($properties as $property) {
597 $values[$dao->id
][$property] = $dao->$property;
607 * Wrapper for most delete calls. Use this unless you JUST want to delete related memberships w/o deleting the parent.
609 * @param int $membershipId
610 * Membership id that needs to be deleted.
611 * @param bool $preserveContrib
614 * Id of deleted Membership on success, false otherwise.
616 public static function del($membershipId, $preserveContrib = FALSE) {
617 //delete related first and then delete parent.
618 self
::deleteRelatedMemberships($membershipId);
619 return self
::deleteMembership($membershipId, $preserveContrib);
625 * @param int $membershipId
626 * Membership id that needs to be deleted.
627 * @param bool $preserveContrib
630 * Id of deleted Membership on success, false otherwise.
632 public static function deleteMembership($membershipId, $preserveContrib = FALSE) {
633 // CRM-12147, retrieve membership data before we delete it for hooks
634 $params = array('id' => $membershipId);
635 $memValues = array();
636 $memberships = self
::getValues($params, $memValues);
638 $membership = $memberships[$membershipId];
640 CRM_Utils_Hook
::pre('delete', 'Membership', $membershipId, $memValues);
642 $transaction = new CRM_Core_Transaction();
645 //delete activity record
646 $activityTypes = CRM_Core_PseudoConstant
::activityType(TRUE, FALSE, FALSE, 'name');
649 $deleteActivity = FALSE;
650 $membershipActivities = array(
652 'Membership Renewal',
653 'Change Membership Status',
654 'Change Membership Type',
655 'Membership Renewal Reminder',
657 foreach ($membershipActivities as $membershipActivity) {
658 $activityId = array_search($membershipActivity, $activityTypes);
660 $params['activity_type_id'][] = $activityId;
661 $deleteActivity = TRUE;
664 if ($deleteActivity) {
665 $params['source_record_id'] = $membershipId;
666 CRM_Activity_BAO_Activity
::deleteActivity($params);
668 self
::deleteMembershipPayment($membershipId, $preserveContrib);
670 $results = $membership->delete();
671 $transaction->commit();
673 CRM_Utils_Hook
::post('delete', 'Membership', $membership->id
, $membership);
675 // delete the recently created Membership
676 $membershipRecent = array(
677 'id' => $membershipId,
678 'type' => 'Membership',
680 CRM_Utils_Recent
::del($membershipRecent);
686 * Delete related memberships.
688 * @param int $ownerMembershipId
689 * @param int $contactId
693 public static function deleteRelatedMemberships($ownerMembershipId, $contactId = NULL) {
694 if (!$ownerMembershipId && !$contactId) {
698 $membership = new CRM_Member_DAO_Membership();
699 $membership->owner_membership_id
= $ownerMembershipId;
702 $membership->contact_id
= $contactId;
706 while ($membership->fetch()) {
707 //delete related first and then delete parent.
708 self
::deleteRelatedMemberships($membership->id
);
709 self
::deleteMembership($membership->id
);
714 * Obtain active/inactive memberships from the list of memberships passed to it.
716 * @param array $memberships
717 * Membership records.
718 * @param string $status
719 * Active or inactive.
722 * array of memberships based on status
724 public static function activeMembers($memberships, $status = 'active') {
726 if ($status == 'active') {
727 foreach ($memberships as $f => $v) {
728 if (!empty($v['active'])) {
734 elseif ($status == 'inactive') {
735 foreach ($memberships as $f => $v) {
736 if (empty($v['active'])) {
746 * Return Membership Block info in Contribution Pages.
749 * Contribution page id.
753 public static function getMembershipBlock($pageID) {
754 $membershipBlock = array();
755 $dao = new CRM_Member_DAO_MembershipBlock();
756 $dao->entity_table
= 'civicrm_contribution_page';
758 $dao->entity_id
= $pageID;
760 if ($dao->find(TRUE)) {
761 CRM_Core_DAO
::storeValues($dao, $membershipBlock);
762 if (!empty($membershipBlock['membership_types'])) {
763 $membershipTypes = unserialize($membershipBlock['membership_types']);
764 if (!is_array($membershipTypes)) {
765 return $membershipBlock;
768 foreach ($membershipTypes as $key => $value) {
769 $membershipBlock['auto_renew'][$key] = $value;
770 $memTypes[$key] = $key;
772 $membershipBlock['membership_types'] = implode(',', $memTypes);
779 return $membershipBlock;
783 * Return a current membership of given contact.
785 * NB: if more than one membership meets criteria, a randomly selected one is returned.
787 * @param int $contactID
789 * @param int $memType
790 * Membership type, null to retrieve all types.
792 * @param int $membershipId
793 * If provided, then determine if it is current.
794 * @param bool $onlySameParentOrg
795 * True if only Memberships with same parent org as the $memType wanted, false otherwise.
799 public static function getContactMembership($contactID, $memType, $isTest, $membershipId = NULL, $onlySameParentOrg = FALSE) {
800 //check for owner membership id, if it exists update that membership instead: CRM-15992
802 $ownerMemberId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership',
804 'owner_membership_id', 'id'
806 if ($ownerMemberId) {
807 $membershipId = $ownerMemberId;
808 $contactID = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership',
815 $dao = new CRM_Member_DAO_Membership();
817 $dao->id
= $membershipId;
819 $dao->contact_id
= $contactID;
820 $dao->membership_type_id
= $memType;
822 //fetch proper membership record.
824 $dao->is_test
= $isTest;
827 $dao->whereAdd('is_test IS NULL OR is_test = 0');
830 //avoid pending membership as current membership: CRM-3027
831 $statusIds = array(array_search('Pending', CRM_Member_PseudoConstant
::membershipStatus()));
832 if (!$membershipId) {
834 $statusIds[] = array_search(
836 CRM_Member_PseudoConstant
::membershipStatus(
838 " name = 'Cancelled' ",
845 $dao->whereAdd('status_id NOT IN ( ' . implode(',', $statusIds) . ')');
847 // order by start date to find most recent membership first, CRM-4545
848 $dao->orderBy('start_date DESC');
851 if ($onlySameParentOrg && $memType) {
852 // require the same parent org as the $memType
853 $params = array('id' => $memType);
854 $membershipType = array();
855 if (CRM_Member_BAO_MembershipType
::retrieve($params, $membershipType)) {
856 $memberTypesSameParentOrg = civicrm_api3('MembershipType', 'get', array(
857 'member_of_contact_id' => $membershipType['member_of_contact_id'],
862 $memberTypesSameParentOrgList = implode(',', array_keys(CRM_Utils_Array
::value('values', $memberTypesSameParentOrg, array())));
863 $dao->whereAdd('membership_type_id IN (' . $memberTypesSameParentOrgList . ')');
867 if ($dao->find(TRUE)) {
868 $membership = array();
869 CRM_Core_DAO
::storeValues($dao, $membership);
870 $membership['is_current_member'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus',
871 $membership['status_id'],
872 'is_current_member', 'id'
874 $ownerMemberId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership',
876 'owner_membership_id', 'id'
878 if ($ownerMemberId) {
879 $membership['id'] = $membership['membership_id'] = $ownerMemberId;
880 $membership['membership_contact_id'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership',
889 if ($onlySameParentOrg && $memType) {
890 // see if there is a membership that has same parent as $memType but different parent than $membershipID
891 if ($dao->id
&& CRM_Core_Permission
::check('edit memberships')) {
892 // CRM-10016, This is probably a backend renewal, and make sure we return the same membership thats being renewed.
899 unset($dao->membership_type_id
);
900 if ($dao->find(TRUE)) {
901 $membership = array();
902 CRM_Core_DAO
::storeValues($dao, $membership);
903 $membership['is_current_member'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus',
904 $membership['status_id'],
905 'is_current_member', 'id'
914 * Combine all the importable fields from the lower levels object.
916 * @param string $contactType
918 * @param bool $status
921 * array of importable Fields
923 public static function &importableFields($contactType = 'Individual', $status = TRUE) {
924 if (!self
::$_importableFields) {
925 if (!self
::$_importableFields) {
926 self
::$_importableFields = array();
930 $fields = array('' => array('title' => '- ' . ts('do not import') . ' -'));
933 $fields = array('' => array('title' => '- ' . ts('Membership Fields') . ' -'));
936 $tmpFields = CRM_Member_DAO_Membership
::import();
937 $contactFields = CRM_Contact_BAO_Contact
::importableFields($contactType, NULL);
939 // Using new Dedupe rule.
941 'contact_type' => $contactType,
942 'used' => 'Unsupervised',
944 $fieldsArray = CRM_Dedupe_BAO_Rule
::dedupeRuleFields($ruleParams);
946 $tmpContactField = array();
947 if (is_array($fieldsArray)) {
948 foreach ($fieldsArray as $value) {
949 $customFieldId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField',
954 $value = $customFieldId ?
'custom_' . $customFieldId : $value;
955 $tmpContactField[trim($value)] = CRM_Utils_Array
::value(trim($value), $contactFields);
957 $title = $tmpContactField[trim($value)]['title'] . " " . ts('(match to contact)');
960 $title = $tmpContactField[trim($value)]['title'];
962 $tmpContactField[trim($value)]['title'] = $title;
965 $tmpContactField['external_identifier'] = $contactFields['external_identifier'];
966 $tmpContactField['external_identifier']['title'] = $contactFields['external_identifier']['title'] . " " . ts('(match to contact)');
968 $tmpFields['membership_contact_id']['title'] = $tmpFields['membership_contact_id']['title'] . " " . ts('(match to contact)');;
970 $fields = array_merge($fields, $tmpContactField);
971 $fields = array_merge($fields, $tmpFields);
972 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Membership'));
973 self
::$_importableFields = $fields;
975 return self
::$_importableFields;
979 * Get all exportable fields.
981 * @return array return array of all exportable fields
983 public static function &exportableFields() {
984 $expFieldMembership = CRM_Member_DAO_Membership
::export();
986 $expFieldsMemType = CRM_Member_DAO_MembershipType
::export();
987 $fields = array_merge($expFieldMembership, $expFieldsMemType);
988 $fields = array_merge($fields, $expFieldMembership);
989 $membershipStatus = array(
990 'membership_status' => array(
991 'title' => ts('Membership Status'),
992 'name' => 'membership_status',
993 'type' => CRM_Utils_Type
::T_STRING
,
994 'where' => 'civicrm_membership_status.name',
997 //CRM-6161 fix for customdata export
998 $fields = array_merge($fields, $membershipStatus, CRM_Core_BAO_CustomField
::getFieldsForImport('Membership'));
1003 * Get membership joins/renewals for a specified membership type.
1005 * Specifically, retrieves a count of memberships whose "Membership
1006 * Signup" or "Membership Renewal" activity falls in the given date range.
1007 * Dates match the pattern "yyyy-mm-dd".
1009 * @param int $membershipTypeId
1010 * Membership type id.
1011 * @param int $startDate
1012 * Date on which to start counting.
1013 * @param int $endDate
1014 * Date on which to end counting.
1015 * @param bool|int $isTest if true, membership is for a test site
1016 * @param bool|int $isOwner if true, only retrieve membership records for owners //LCD
1019 * the number of members of type $membershipTypeId whose
1020 * start_date is between $startDate and $endDate
1022 public static function getMembershipStarts($membershipTypeId, $startDate, $endDate, $isTest = 0, $isOwner = 0) {
1024 $testClause = 'membership.is_test = 1';
1026 $testClause = '( membership.is_test IS NULL OR membership.is_test = 0 )';
1029 if (!self
::$_signupActType ||
!self
::$_renewalActType) {
1030 self
::_getActTypes();
1033 if (!self
::$_signupActType ||
!self
::$_renewalActType) {
1038 SELECT COUNT(DISTINCT membership.id) as member_count
1039 FROM civicrm_membership membership
1040 INNER JOIN civicrm_activity activity ON (activity.source_record_id = membership.id AND activity.activity_type_id in (%1, %2))
1041 INNER JOIN civicrm_membership_status status ON ( membership.status_id = status.id AND status.is_current_member = 1 )
1042 INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND contact.is_deleted = 0 )
1043 WHERE membership.membership_type_id = %3
1044 AND activity.activity_date_time >= '$startDate' AND activity.activity_date_time <= '$endDate 23:59:59'
1047 $query .= ($isOwner) ?
' AND owner_membership_id IS NULL' : '';
1050 1 => array(self
::$_signupActType, 'Integer'),
1051 2 => array(self
::$_renewalActType, 'Integer'),
1052 3 => array($membershipTypeId, 'Integer'),
1055 $memberCount = CRM_Core_DAO
::singleValueQuery($query, $params);
1056 return (int) $memberCount;
1060 * Get a count of membership for a specified membership type, optionally for a specified date.
1062 * The date must have the form yyyy-mm-dd.
1064 * If $date is omitted, this function counts as a member anyone whose
1065 * membership status_id indicates they're a current member.
1066 * If $date is given, this function counts as a member anyone who:
1067 * -- Has a start_date before $date and end_date after $date, or
1068 * -- Has a start_date before $date and is currently a member, as indicated
1069 * by the the membership's status_id.
1070 * The second condition takes care of records that have no end_date. These
1071 * are assumed to be lifetime memberships.
1073 * @param int $membershipTypeId
1074 * Membership type id.
1075 * @param string $date
1076 * The date for which to retrieve the count.
1077 * @param bool|int $isTest if true, membership is for a test site
1078 * @param bool|int $isOwner if true, only retrieve membership records for owners //LCD
1081 * the number of members of type $membershipTypeId as of $date.
1083 public static function getMembershipCount($membershipTypeId, $date = NULL, $isTest = 0, $isOwner = 0) {
1084 if (!CRM_Utils_Rule
::date($date)) {
1085 CRM_Core_Error
::fatal(ts('Invalid date "%1" (must have form yyyy-mm-dd).', array(1 => $date)));
1089 1 => array($membershipTypeId, 'Integer'),
1090 2 => array($isTest, 'Boolean'),
1092 $query = "SELECT count(civicrm_membership.id ) as member_count
1093 FROM civicrm_membership left join civicrm_membership_status on ( civicrm_membership.status_id = civicrm_membership_status.id )
1094 WHERE civicrm_membership.membership_type_id = %1
1095 AND civicrm_membership.contact_id NOT IN (SELECT id FROM civicrm_contact WHERE is_deleted = 1)
1096 AND civicrm_membership.is_test = %2";
1098 $query .= " AND civicrm_membership_status.is_current_member = 1";
1101 $query .= " AND civicrm_membership.start_date <= '$date' AND civicrm_membership_status.is_current_member = 1";
1104 $query .= ($isOwner) ?
' AND owner_membership_id IS NULL' : '';
1105 $memberCount = CRM_Core_DAO
::singleValueQuery($query, $params);
1106 return (int) $memberCount;
1110 * Function check the status of the membership before adding membership for a contact.
1114 public static function statusAvailabilty() {
1115 $membership = new CRM_Member_DAO_MembershipStatus();
1116 $membership->whereAdd('is_active=1');
1117 return $membership->count();
1121 * Function for updating a membership record's contribution_recur_id.
1123 * @param CRM_Member_DAO_Membership $membership
1124 * @param \CRM_Contribute_BAO_Contribution|\CRM_Contribute_DAO_Contribution $contribution
1126 public static function updateRecurMembership(CRM_Member_DAO_Membership
$membership, CRM_Contribute_BAO_Contribution
$contribution) {
1128 if (empty($contribution->contribution_recur_id
)) {
1133 1 => array($contribution->contribution_recur_id
, 'Integer'),
1134 2 => array($membership->id
, 'Integer'),
1137 $sql = "UPDATE civicrm_membership SET contribution_recur_id = %1 WHERE id = %2";
1138 CRM_Core_DAO
::executeQuery($sql, $params);
1142 * Method to fix membership status of stale membership.
1144 * This method first checks if the membership is stale. If it is,
1145 * then status will be updated based on existing start and end
1146 * dates and log will be added for the status change.
1148 * @param array $currentMembership
1149 * Reference to the array.
1150 * containing all values of
1151 * the current membership
1152 * @param string $changeToday
1153 * In case today needs
1154 * to be customised, null otherwise
1156 public static function fixMembershipStatusBeforeRenew(&$currentMembership, $changeToday) {
1159 $today = CRM_Utils_Date
::processDate($changeToday, NULL, FALSE, 'Y-m-d');
1162 $status = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate(
1163 CRM_Utils_Array
::value('start_date', $currentMembership),
1164 CRM_Utils_Array
::value('end_date', $currentMembership),
1165 CRM_Utils_Array
::value('join_date', $currentMembership),
1168 $currentMembership['membership_type_id'],
1172 if (empty($status) ||
empty($status['id'])) {
1173 throw new CRM_Core_Exception(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.'));
1176 $currentMembership['today_date'] = $today;
1178 if ($status['id'] !== $currentMembership['status_id']) {
1179 $oldStatus = $currentMembership['status_id'];
1180 $memberDAO = new CRM_Member_DAO_Membership();
1181 $memberDAO->id
= $currentMembership['id'];
1182 $memberDAO->find(TRUE);
1184 $memberDAO->status_id
= $status['id'];
1185 $memberDAO->join_date
= CRM_Utils_Date
::isoToMysql($memberDAO->join_date
);
1186 $memberDAO->start_date
= CRM_Utils_Date
::isoToMysql($memberDAO->start_date
);
1187 $memberDAO->end_date
= CRM_Utils_Date
::isoToMysql($memberDAO->end_date
);
1189 CRM_Core_DAO
::storeValues($memberDAO, $currentMembership);
1191 $currentMembership['is_current_member'] = CRM_Core_DAO
::getFieldValue(
1192 'CRM_Member_DAO_MembershipStatus',
1193 $currentMembership['status_id'],
1199 'membership_id' => $currentMembership['id'],
1200 'status_id' => $status['id'],
1201 'start_date' => CRM_Utils_Date
::customFormat(
1202 $currentMembership['start_date'],
1205 'end_date' => CRM_Utils_Date
::customFormat(
1206 $currentMembership['end_date'],
1209 'modified_date' => CRM_Utils_Date
::customFormat(
1210 $currentMembership['today_date'],
1213 'membership_type_id' => $currentMembership['membership_type_id'],
1214 'max_related' => CRM_Utils_Array
::value('max_related', $currentMembership, 0),
1217 $session = CRM_Core_Session
::singleton();
1218 // If we have an authenticated session, set modified_id to that user's contact_id, else set to membership.contact_id
1219 if ($session->get('userID')) {
1220 $logParams['modified_id'] = $session->get('userID');
1223 $logParams['modified_id'] = $currentMembership['contact_id'];
1226 //Create activity for status change.
1227 $allStatus = CRM_Member_BAO_Membership
::buildOptions('status_id', 'get');
1228 CRM_Activity_BAO_Activity
::addActivity($memberDAO,
1229 'Change Membership Status',
1232 'subject' => "Status changed from {$allStatus[$oldStatus]} to {$allStatus[$status['id']]}",
1233 'source_contact_id' => $logParams['modified_id'],
1234 'priority_id' => 'Normal',
1238 CRM_Member_BAO_MembershipLog
::add($logParams);
1243 * Get the contribution page id from the membership record.
1245 * @param int $membershipID
1248 * contribution page id
1250 public static function getContributionPageId($membershipID) {
1252 SELECT c.contribution_page_id as pageID
1253 FROM civicrm_membership_payment mp, civicrm_contribution c
1254 WHERE mp.contribution_id = c.id
1255 AND c.contribution_page_id IS NOT NULL
1256 AND mp.membership_id = " . CRM_Utils_Type
::escape($membershipID, 'Integer')
1257 . " ORDER BY mp.id DESC";
1259 return CRM_Core_DAO
::singleValueQuery($query);
1263 * Updated related memberships.
1265 * @param int $ownerMembershipId
1266 * Owner Membership Id.
1267 * @param array $params
1268 * Formatted array of key => value.
1270 public static function updateRelatedMemberships($ownerMembershipId, $params) {
1271 $membership = new CRM_Member_DAO_Membership();
1272 $membership->owner_membership_id
= $ownerMembershipId;
1273 $membership->find();
1275 while ($membership->fetch()) {
1276 $relatedMembership = new CRM_Member_DAO_Membership();
1277 $relatedMembership->id
= $membership->id
;
1278 $relatedMembership->copyValues($params);
1279 $relatedMembership->save();
1285 * Get list of membership fields for profile.
1287 * For now we only allow custom membership fields to be in
1291 * FIXME: This param is ignored
1294 * the list of membership fields
1296 public static function getMembershipFields($mode = NULL) {
1297 $fields = CRM_Member_DAO_Membership
::export();
1299 unset($fields['membership_contact_id']);
1300 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Membership'));
1302 $membershipType = CRM_Member_DAO_MembershipType
::export();
1304 $membershipStatus = CRM_Member_DAO_MembershipStatus
::export();
1306 $fields = array_merge($fields, $membershipType, $membershipStatus);
1312 * Get the sort name of a contact for a particular membership.
1315 * Id of the membership.
1317 * @return null|string
1318 * sort name of the contact if found
1320 public static function sortName($id) {
1321 $id = CRM_Utils_Type
::escape($id, 'Integer');
1324 SELECT civicrm_contact.sort_name
1325 FROM civicrm_membership, civicrm_contact
1326 WHERE civicrm_membership.contact_id = civicrm_contact.id
1327 AND civicrm_membership.id = {$id}
1329 return CRM_Core_DAO
::singleValueQuery($query);
1333 * Create memberships for related contacts, taking into account the maximum related memberships.
1335 * @param array $params
1336 * Array of key - value pairs.
1337 * @param CRM_Core_DAO $dao
1338 * Membership object.
1340 * @param bool $reset
1342 * @return array|null
1343 * Membership details, if created.
1345 * @throws \CRM_Core_Exception
1347 public static function createRelatedMemberships(&$params, &$dao, $reset = FALSE) {
1348 // CRM-4213 check for loops, using static variable to record contacts already processed.
1349 static $relatedContactIds = array();
1351 // We need a way to reset this static variable from the test suite.
1352 // @todo consider replacing with Civi::$statics but note reset now used elsewhere: CRM-17723.
1353 $relatedContactIds = array();
1357 $membership = new CRM_Member_DAO_Membership();
1358 $membership->id
= $dao->id
;
1360 // required since create method doesn't return all the
1361 // parameters in the returned membership object
1362 if (!$membership->find(TRUE)) {
1365 $deceasedStatusId = array_search('Deceased', CRM_Member_PseudoConstant
::membershipStatus());
1366 // FIXME : While updating/ renewing the
1367 // membership, if the relationship is PAST then
1368 // the membership of the related contact must be
1370 // For that, getting Membership Status for which
1371 // is_current_member is 0. It works for the
1372 // generated data as there is only one membership
1373 // status having is_current_member = 0.
1374 // But this wont work exactly if there will be
1375 // more than one status having is_current_member = 0.
1376 $membershipStatus = new CRM_Member_DAO_MembershipStatus();
1377 $membershipStatus->is_current_member
= 0;
1378 if ($membershipStatus->find(TRUE)) {
1379 $expiredStatusId = $membershipStatus->id
;
1382 $expiredStatusId = array_search('Expired', CRM_Member_PseudoConstant
::membershipStatus());
1385 $allRelatedContacts = array();
1386 $relatedContacts = array();
1387 if (!is_a($membership, 'CRM_Core_Error')) {
1388 $allRelatedContacts = CRM_Member_BAO_Membership
::checkMembershipRelationship($membership->membership_type_id
,
1389 $membership->contact_id
,
1390 CRM_Utils_Array
::value('action', $params)
1394 // CRM-4213, CRM-19735 check for loops, using static variable to record contacts already processed.
1395 // Remove repeated related contacts, which already inherited membership of this type.
1396 $relatedContactIds[$membership->contact_id
][$membership->membership_type_id
] = TRUE;
1397 foreach ($allRelatedContacts as $cid => $status) {
1398 if (empty($relatedContactIds[$cid]) ||
empty($relatedContactIds[$cid][$membership->membership_type_id
])) {
1399 $relatedContactIds[$cid][$membership->membership_type_id
] = TRUE;
1401 //don't create membership again for owner contact.
1402 $nestedRelationship = FALSE;
1403 if ($membership->owner_membership_id
) {
1404 $nestedRelMembership = new CRM_Member_DAO_Membership();
1405 $nestedRelMembership->id
= $membership->owner_membership_id
;
1406 $nestedRelMembership->contact_id
= $cid;
1407 $nestedRelationship = $nestedRelMembership->find(TRUE);
1409 if (!$nestedRelationship) {
1410 $relatedContacts[$cid] = $status;
1415 //lets cleanup related membership if any.
1416 if (empty($relatedContacts)) {
1417 self
::deleteRelatedMemberships($membership->id
);
1420 // Edit the params array
1421 unset($params['id']);
1422 // Reminder should be sent only to the direct membership
1423 unset($params['reminder_date']);
1424 // unset the custom value ids
1425 if (is_array(CRM_Utils_Array
::value('custom', $params))) {
1426 foreach ($params['custom'] as $k => $v) {
1427 unset($params['custom'][$k]['id']);
1430 if (!isset($params['membership_type_id'])) {
1431 $params['membership_type_id'] = $membership->membership_type_id
;
1434 // max_related should be set in the parent membership
1435 unset($params['max_related']);
1436 // Number of inherited memberships available - NULL is interpreted as unlimited, '0' as none
1437 $numRelatedAvailable = ($membership->max_related
== NULL ? PHP_INT_MAX
: $membership->max_related
);
1438 // will be used to queue potential memberships to be created.
1441 foreach ($relatedContacts as $contactId => $relationshipStatus) {
1442 //use existing membership record.
1443 $relMembership = new CRM_Member_DAO_Membership();
1444 $relMembership->contact_id
= $contactId;
1445 $relMembership->owner_membership_id
= $membership->id
;
1446 if ($relMembership->find(TRUE)) {
1447 $params['id'] = $relMembership->id
;
1449 $params['contact_id'] = $contactId;
1450 $params['owner_membership_id'] = $membership->id
;
1452 // set status_id as it might have been changed for
1453 // past relationship
1454 $params['status_id'] = $membership->status_id
;
1456 if ($deceasedStatusId &&
1457 CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $contactId, 'is_deceased')
1459 $params['status_id'] = $deceasedStatusId;
1461 elseif ((CRM_Utils_Array
::value('action', $params) & CRM_Core_Action
::UPDATE
) &&
1462 ($relationshipStatus == CRM_Contact_BAO_Relationship
::PAST
)
1464 $params['status_id'] = $expiredStatusId;
1467 //don't calculate status again in create( );
1468 $params['skipStatusCal'] = TRUE;
1470 //do create activity if we changed status.
1471 if ($params['status_id'] != $relMembership->status_id
) {
1472 $params['createActivity'] = TRUE;
1475 //CRM-20707 - include start/end date
1476 $params['start_date'] = $membership->start_date
;
1477 $params['end_date'] = $membership->end_date
;
1479 // we should not created contribution record for related contacts, CRM-3371
1480 unset($params['contribution_status_id']);
1482 //CRM-16857: Do not create multiple line-items for inherited membership through priceset.
1483 unset($params['lineItems']);
1484 unset($params['line_item']);
1486 // CRM-20966: Do not create membership_payment record for inherited membership.
1487 unset($params['relate_contribution_id']);
1490 if (($params['status_id'] == $deceasedStatusId) ||
($params['status_id'] == $expiredStatusId)) {
1491 // related membership is not active so does not count towards maximum
1492 // @todo stop passing empty $ids
1493 CRM_Member_BAO_Membership
::create($params, $ids);
1496 // related membership already exists, so this is just an update
1497 if (isset($params['id'])) {
1498 if ($numRelatedAvailable > 0) {
1499 // @todo stop passing empty $ids
1500 CRM_Member_BAO_Membership
::create($params, $ids);
1501 $numRelatedAvailable--;
1504 // we have run out of inherited memberships, so delete extras
1505 self
::deleteMembership($params['id']);
1507 // we need to first check if there will remain inherited memberships, so queue it up
1514 // now go over the queue and create any available related memberships
1515 foreach ($queue as $params) {
1516 if ($numRelatedAvailable <= 0) {
1519 // @todo stop passing $ids - at this point it may be set by reference from earlier calls to CRM_Member_BAO_Membership::create
1520 CRM_Member_BAO_Membership
::create($params, $ids);
1521 $numRelatedAvailable--;
1527 * Delete the record that are associated with this Membership Payment.
1529 * @param int $membershipId
1530 * @param bool $preserveContrib
1533 * $membershipPayment deleted membership payment object
1535 public static function deleteMembershipPayment($membershipId, $preserveContrib = FALSE) {
1537 $membershipPayment = new CRM_Member_DAO_MembershipPayment();
1538 $membershipPayment->membership_id
= $membershipId;
1539 $membershipPayment->find();
1541 while ($membershipPayment->fetch()) {
1542 if (!$preserveContrib) {
1543 CRM_Contribute_BAO_Contribution
::deleteContribution($membershipPayment->contribution_id
);
1545 CRM_Utils_Hook
::pre('delete', 'MembershipPayment', $membershipPayment->id
, $membershipPayment);
1546 $membershipPayment->delete();
1547 CRM_Utils_Hook
::post('delete', 'MembershipPayment', $membershipPayment->id
, $membershipPayment);
1549 return $membershipPayment;
1553 * Build an array of available membership types.
1555 * @param CRM_Core_Form $form
1556 * @param array $membershipTypeID
1557 * @param bool $activeOnly
1558 * Do we only want active ones?
1559 * (probably this should default to TRUE but as a newly added parameter we are leaving default b
1560 * behaviour unchanged).
1564 public static function buildMembershipTypeValues(&$form, $membershipTypeID = array(), $activeOnly = FALSE) {
1565 $whereClause = " WHERE domain_id = " . CRM_Core_Config
::domainID();
1566 $membershipTypeIDS = (array) $membershipTypeID;
1569 $whereClause .= " AND is_active = 1 ";
1571 if (!empty($membershipTypeIDS)) {
1572 $allIDs = implode(',', $membershipTypeIDS);
1573 $whereClause .= " AND id IN ( $allIDs )";
1575 CRM_Financial_BAO_FinancialType
::getAvailableFinancialTypes($financialTypes, CRM_Core_Action
::ADD
);
1577 if ($financialTypes) {
1578 $whereClause .= " AND financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ")";
1581 $whereClause .= " AND financial_type_id IN (0)";
1586 FROM civicrm_membership_type
1589 $dao = CRM_Core_DAO
::executeQuery($query);
1591 $membershipTypeValues = array();
1592 $membershipTypeFields = array(
1598 'financial_type_id',
1600 'member_of_contact_id',
1601 'relationship_type_id',
1602 'relationship_direction',
1605 'duration_interval',
1608 while ($dao->fetch()) {
1609 $membershipTypeValues[$dao->id
] = array();
1610 foreach ($membershipTypeFields as $mtField) {
1611 $membershipTypeValues[$dao->id
][$mtField] = $dao->$mtField;
1615 CRM_Utils_Hook
::membershipTypeValues($form, $membershipTypeValues);
1617 if (is_numeric($membershipTypeID) &&
1618 $membershipTypeID > 0
1620 return $membershipTypeValues[$membershipTypeID];
1623 return $membershipTypeValues;
1628 * Get membership record count for a Contact.
1630 * @param int $contactID
1631 * @param bool $activeOnly
1633 * @return null|string
1635 public static function getContactMembershipCount($contactID, $activeOnly = FALSE) {
1636 CRM_Financial_BAO_FinancialType
::getAvailableMembershipTypes($membershipTypes);
1637 $addWhere = " AND membership_type_id IN (0)";
1638 if (!empty($membershipTypes)) {
1639 $addWhere = " AND membership_type_id IN (" . implode(',', array_keys($membershipTypes)) . ")";
1641 $select = "SELECT count(*) FROM civicrm_membership ";
1642 $where = "WHERE civicrm_membership.contact_id = {$contactID} AND civicrm_membership.is_test = 0 ";
1644 // CRM-6627, all status below 3 (active, pending, grace) are considered active
1646 $select .= " INNER JOIN civicrm_membership_status ON civicrm_membership.status_id = civicrm_membership_status.id ";
1647 $where .= " and civicrm_membership_status.is_current_member = 1";
1650 $query = $select . $where . $addWhere;
1651 return CRM_Core_DAO
::singleValueQuery($query);
1655 * Check whether payment processor supports cancellation of membership subscription.
1660 * @param bool $isNotCancelled
1664 public static function isCancelSubscriptionSupported($mid, $isNotCancelled = TRUE) {
1665 $cacheKeyString = "$mid";
1666 $cacheKeyString .= $isNotCancelled ?
'_1' : '_0';
1668 static $supportsCancel = array();
1670 if (!array_key_exists($cacheKeyString, $supportsCancel)) {
1671 $supportsCancel[$cacheKeyString] = FALSE;
1672 $isCancelled = FALSE;
1674 if ($isNotCancelled) {
1675 $isCancelled = self
::isSubscriptionCancelled($mid);
1678 $paymentObject = CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($mid, 'membership', 'obj');
1679 if (!empty($paymentObject)) {
1680 $supportsCancel[$cacheKeyString] = $paymentObject->supports('cancelRecurring') && !$isCancelled;
1683 return $supportsCancel[$cacheKeyString];
1687 * Check whether subscription is already cancelled.
1693 * contribution status
1695 public static function isSubscriptionCancelled($mid) {
1697 SELECT cr.contribution_status_id
1698 FROM civicrm_contribution_recur cr
1699 LEFT JOIN civicrm_membership mem ON ( cr.id = mem.contribution_recur_id )
1700 WHERE mem.id = %1 LIMIT 1";
1701 $params = array(1 => array($mid, 'Integer'));
1702 $statusId = CRM_Core_DAO
::singleValueQuery($sql, $params);
1703 $status = CRM_Contribute_PseudoConstant
::contributionStatus($statusId, 'name');
1704 if ($status == 'Cancelled') {
1711 * Get membership joins for a specified membership type.
1713 * Specifically, retrieves a count of still current memberships whose
1714 * join_date and start_date are within a specified date range. Dates match
1715 * the pattern "yyyy-mm-dd".
1717 * @param int $membershipTypeId
1718 * Membership type id.
1719 * @param int $startDate
1720 * Date on which to start counting.
1721 * @param int $endDate
1722 * Date on which to end counting.
1723 * @param bool|int $isTest if true, membership is for a test site
1726 * the number of members of type $membershipTypeId
1727 * whose join_date is between $startDate and $endDate and
1728 * whose start_date is between $startDate and $endDate
1730 public static function getMembershipJoins($membershipTypeId, $startDate, $endDate, $isTest = 0) {
1731 $testClause = 'membership.is_test = 1';
1733 $testClause = '( membership.is_test IS NULL OR membership.is_test = 0 )';
1735 if (!self
::$_signupActType) {
1736 self
::_getActTypes();
1739 if (!self
::$_signupActType) {
1744 SELECT COUNT(DISTINCT membership.id) as member_count
1745 FROM civicrm_membership membership
1746 INNER JOIN civicrm_activity activity ON (activity.source_record_id = membership.id AND activity.activity_type_id = %1)
1747 INNER JOIN civicrm_membership_status status ON ( membership.status_id = status.id AND status.is_current_member = 1 )
1748 INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND contact.is_deleted = 0 )
1749 WHERE membership.membership_type_id = %2
1750 AND activity.activity_date_time >= '$startDate' AND activity.activity_date_time <= '$endDate 23:59:59'
1754 1 => array(self
::$_signupActType, 'Integer'),
1755 2 => array($membershipTypeId, 'Integer'),
1758 $memberCount = CRM_Core_DAO
::singleValueQuery($query, $params);
1760 return (int) $memberCount;
1764 * Get membership renewals for a specified membership type.
1766 * Specifically, retrieves a count of still current memberships
1767 * whose join_date is before and start_date is within a specified date
1768 * range. Dates match the pattern "yyyy-mm-dd".
1770 * @param int $membershipTypeId
1771 * Membership type id.
1772 * @param int $startDate
1773 * Date on which to start counting.
1774 * @param int $endDate
1775 * Date on which to end counting.
1776 * @param bool|int $isTest if true, membership is for a test site
1779 * returns the number of members of type $membershipTypeId
1780 * whose join_date is before $startDate and
1781 * whose start_date is between $startDate and $endDate
1783 public static function getMembershipRenewals($membershipTypeId, $startDate, $endDate, $isTest = 0) {
1784 $testClause = 'membership.is_test = 1';
1786 $testClause = '( membership.is_test IS NULL OR membership.is_test = 0 )';
1788 if (!self
::$_renewalActType) {
1789 self
::_getActTypes();
1792 if (!self
::$_renewalActType) {
1797 SELECT COUNT(DISTINCT membership.id) as member_count
1798 FROM civicrm_membership membership
1799 INNER JOIN civicrm_activity activity ON (activity.source_record_id = membership.id AND activity.activity_type_id = %1)
1800 INNER JOIN civicrm_membership_status status ON ( membership.status_id = status.id AND status.is_current_member = 1 )
1801 INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND contact.is_deleted = 0 )
1802 WHERE membership.membership_type_id = %2
1803 AND activity.activity_date_time >= '$startDate' AND activity.activity_date_time <= '$endDate 23:59:59'
1807 1 => array(self
::$_renewalActType, 'Integer'),
1808 2 => array($membershipTypeId, 'Integer'),
1810 $memberCount = CRM_Core_DAO
::singleValueQuery($query, $params);
1812 return (int) $memberCount;
1816 * @param int $contactID
1817 * @param int $membershipTypeID
1818 * @param bool $is_test
1819 * @param string $changeToday
1820 * @param int $modifiedID
1821 * @param $customFieldsFormatted
1822 * @param $numRenewTerms
1823 * @param int $membershipID
1825 * @param int $contributionRecurID
1826 * @param $membershipSource
1827 * @param $isPayLater
1828 * @param int $campaignId
1829 * @param array $formDates
1830 * @param null|CRM_Contribute_BAO_Contribution $contribution
1831 * @param array $lineItems
1834 * @throws \CRM_Core_Exception
1836 public static function processMembership($contactID, $membershipTypeID, $is_test, $changeToday, $modifiedID, $customFieldsFormatted, $numRenewTerms, $membershipID, $pending, $contributionRecurID, $membershipSource, $isPayLater, $campaignId, $formDates = array(), $contribution = NULL, $lineItems = array()) {
1837 $renewalMode = $updateStatusId = FALSE;
1838 $allStatus = CRM_Member_PseudoConstant
::membershipStatus();
1840 $statusFormat = '%Y-%m-%d';
1841 $membershipTypeDetails = CRM_Member_BAO_MembershipType
::getMembershipTypeDetails($membershipTypeID);
1844 // CRM-7297 - allow membership type to be be changed during renewal so long as the parent org of new membershipType
1845 // is the same as the parent org of an existing membership of the contact
1846 $currentMembership = CRM_Member_BAO_Membership
::getContactMembership($contactID, $membershipTypeID,
1847 $is_test, $membershipID, TRUE
1849 if ($currentMembership) {
1850 $renewalMode = TRUE;
1852 // Do NOT do anything.
1853 //1. membership with status : PENDING/CANCELLED (CRM-2395)
1854 //2. Paylater/IPN renew. CRM-4556.
1855 if ($pending ||
in_array($currentMembership['status_id'], array(
1856 array_search('Pending', $allStatus),
1858 array_search('Cancelled', CRM_Member_PseudoConstant
::membershipStatus(NULL, " name = 'Cancelled' ", 'name', FALSE, TRUE)),
1862 'id' => $currentMembership['id'],
1863 'contribution' => $contribution,
1864 'status_id' => $currentMembership['status_id'],
1865 'start_date' => $currentMembership['start_date'],
1866 'end_date' => $currentMembership['end_date'],
1867 'line_item' => $lineItems,
1868 'join_date' => $currentMembership['join_date'],
1869 'membership_type_id' => $membershipTypeID,
1870 'max_related' => !empty($membershipTypeDetails['max_related']) ?
$membershipTypeDetails['max_related'] : NULL,
1871 'membership_activity_status' => ($pending ||
$isPayLater) ?
'Scheduled' : 'Completed',
1873 if ($contributionRecurID) {
1874 $memParams['contribution_recur_id'] = $contributionRecurID;
1876 // @todo stop passing $ids - it is empty
1877 $membership = self
::create($memParams, $ids, FALSE);
1878 return array($membership, $renewalMode, $dates);
1881 // Check and fix the membership if it is STALE
1882 self
::fixMembershipStatusBeforeRenew($currentMembership, $changeToday);
1884 // Now Renew the membership
1885 if (!$currentMembership['is_current_member']) {
1886 // membership is not CURRENT
1888 // CRM-7297 Membership Upsell - calculate dates based on new membership type
1889 $dates = CRM_Member_BAO_MembershipType
::getRenewalDatesForMembershipType($currentMembership['id'],
1895 $currentMembership['join_date'] = CRM_Utils_Date
::customFormat($currentMembership['join_date'], $format);
1896 foreach (array('start_date', 'end_date') as $dateType) {
1897 $currentMembership[$dateType] = CRM_Utils_Array
::value($dateType, $formDates);
1898 if (empty($currentMembership[$dateType])) {
1899 $currentMembership[$dateType] = CRM_Utils_Array
::value($dateType, $dates);
1902 $currentMembership['is_test'] = $is_test;
1904 if (!empty($membershipSource)) {
1905 $currentMembership['source'] = $membershipSource;
1908 $currentMembership['source'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership',
1909 $currentMembership['id'],
1914 if (!empty($currentMembership['id'])) {
1915 $ids['membership'] = $currentMembership['id'];
1917 $memParams = $currentMembership;
1918 $memParams['membership_type_id'] = $membershipTypeID;
1920 //set the log start date.
1921 $memParams['log_start_date'] = CRM_Utils_Date
::customFormat($dates['log_start_date'], $format);
1925 // CURRENT Membership
1926 $membership = new CRM_Member_DAO_Membership();
1927 $membership->id
= $currentMembership['id'];
1928 $membership->find(TRUE);
1929 // CRM-7297 Membership Upsell - calculate dates based on new membership type
1930 $dates = CRM_Member_BAO_MembershipType
::getRenewalDatesForMembershipType($membership->id
,
1936 // Insert renewed dates for CURRENT membership
1937 $memParams = array();
1938 $memParams['join_date'] = CRM_Utils_Date
::isoToMysql($membership->join_date
);
1939 $memParams['start_date'] = CRM_Utils_Array
::value('start_date', $formDates, CRM_Utils_Date
::isoToMysql($membership->start_date
));
1940 $memParams['end_date'] = CRM_Utils_Array
::value('end_date', $formDates);
1941 if (empty($memParams['end_date'])) {
1942 $memParams['end_date'] = CRM_Utils_Array
::value('end_date', $dates);
1944 $memParams['membership_type_id'] = $membershipTypeID;
1946 //set the log start date.
1947 $memParams['log_start_date'] = CRM_Utils_Date
::customFormat($dates['log_start_date'], $format);
1950 if (!empty($membershipSource)) {
1951 $memParams['source'] = $membershipSource;
1953 elseif (empty($membership->source
)) {
1954 $memParams['source'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership',
1955 $currentMembership['id'],
1960 if (!empty($currentMembership['id'])) {
1961 $ids['membership'] = $currentMembership['id'];
1963 $memParams['membership_activity_status'] = ($pending ||
$isPayLater) ?
'Scheduled' : 'Completed';
1967 $updateStatusId = array_search('Pending', $allStatus);
1973 'contact_id' => $contactID,
1974 'membership_type_id' => $membershipTypeID,
1978 $dates = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($membershipTypeID, NULL, NULL, NULL, $numRenewTerms);
1980 foreach (array('join_date', 'start_date', 'end_date') as $dateType) {
1981 $memParams[$dateType] = CRM_Utils_Array
::value($dateType, $formDates);
1982 if (empty($memParams[$dateType])) {
1983 $memParams[$dateType] = CRM_Utils_Array
::value($dateType, $dates);
1987 $status = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate(CRM_Utils_Date
::customFormat($dates['start_date'],
1990 CRM_Utils_Date
::customFormat($dates['end_date'],
1993 CRM_Utils_Date
::customFormat($dates['join_date'],
2001 $updateStatusId = CRM_Utils_Array
::value('id', $status);
2004 // if IPN/Pay-Later set status to: PENDING
2005 $updateStatusId = array_search('Pending', $allStatus);
2008 if (!empty($membershipSource)) {
2009 $memParams['source'] = $membershipSource;
2011 $memParams['is_test'] = $is_test;
2012 $memParams['is_pay_later'] = $isPayLater;
2014 // Putting this in an IF is precautionary as it seems likely that it would be ignored if empty, but
2015 // perhaps shouldn't be?
2016 if ($contributionRecurID) {
2017 $memParams['contribution_recur_id'] = $contributionRecurID;
2020 //if we decided status here and want to skip status
2021 //calculation in create( ); then need to pass 'skipStatusCal'.
2022 if ($updateStatusId) {
2023 $memParams['status_id'] = $updateStatusId;
2024 $memParams['skipStatusCal'] = TRUE;
2027 //since we are renewing,
2028 //make status override false.
2029 $memParams['is_override'] = FALSE;
2031 //CRM-4027, create log w/ individual contact.
2033 $ids['userId'] = $modifiedID;
2034 $memParams['is_for_organization'] = TRUE;
2037 $ids['userId'] = $contactID;
2040 //inherit campaign from contrib page.
2041 if (isset($campaignId)) {
2042 $memParams['campaign_id'] = $campaignId;
2045 $memParams['contribution'] = $contribution;
2046 $memParams['custom'] = $customFieldsFormatted;
2047 // Load all line items & process all in membership. Don't do in contribution.
2048 // Relevant tests in api_v3_ContributionPageTest.
2049 $memParams['line_item'] = $lineItems;
2050 // @todo stop passing $ids (membership and userId may be set by this point)
2051 $membership = self
::create($memParams, $ids, FALSE);
2053 // not sure why this statement is here, seems quite odd :( - Lobo: 12/26/2010
2054 // related to: http://forum.civicrm.org/index.php/topic,11416.msg49072.html#msg49072
2055 $membership->find(TRUE);
2057 return array($membership, $renewalMode, $dates);
2061 * Get line items representing the default price set.
2063 * @param int $membershipOrg
2064 * @param int $membershipTypeID
2065 * @param float $total_amount
2066 * @param int $priceSetId
2070 public static function setQuickConfigMembershipParameters($membershipOrg, $membershipTypeID, $total_amount, $priceSetId) {
2071 $priceSets = current(CRM_Price_BAO_PriceSet
::getSetDetail($priceSetId));
2073 // The name of the price field corresponds to the membership_type organization contact.
2075 'price_set_id' => $priceSetId,
2076 'name' => $membershipOrg,
2079 CRM_Price_BAO_PriceField
::retrieve($params, $results);
2081 if (!empty($results)) {
2082 $fields[$results['id']] = $priceSets['fields'][$results['id']];
2083 $fid = $results['id'];
2084 $editedFieldParams = array(
2085 'price_field_id' => $results['id'],
2086 'membership_type_id' => $membershipTypeID,
2089 CRM_Price_BAO_PriceFieldValue
::retrieve($editedFieldParams, $results);
2090 $fields[$fid]['options'][$results['id']] = $priceSets['fields'][$fid]['options'][$results['id']];
2091 if (!empty($total_amount)) {
2092 $fields[$fid]['options'][$results['id']]['amount'] = $total_amount;
2096 $fieldID = key($fields);
2097 $returnParams = array(
2098 'price_set_id' => $priceSetId,
2099 'price_sets' => $priceSets,
2100 'fields' => $fields,
2101 'price_fields' => array(
2102 'price_' . $fieldID => CRM_Utils_Array
::value('id', $results),
2105 return $returnParams;
2109 * Update the status of all deceased members to deceased.
2112 * Count of updated contacts.
2114 protected static function updateDeceasedMembersStatuses() {
2117 $deceasedStatusId = CRM_Core_PseudoConstant
::getKey('CRM_Member_BAO_Membership', 'status_id', 'Deceased');
2119 // 'create' context for buildOptions returns only if enabled.
2120 $allStatus = self
::buildOptions('status_id', 'create');
2121 if (array_key_exists($deceasedStatusId, $allStatus) === FALSE) {
2122 // Deceased status is an admin status & is required. We want to fail early if
2123 // it is not present or active.
2124 // We could make the case 'some databases just don't use deceased so we will check
2125 // for the presence of a deceased contact in the DB before rejecting.
2126 if (CRM_Core_DAO
::singleValueQuery('
2127 SELECT count(*) FROM civicrm_contact WHERE is_deceased = 0'
2129 throw new CRM_Core_Exception(
2130 ts("Deceased Membership status is missing or not active. <a href='%1'>Click here to check</a>.",
2131 [1 => CRM_Utils_System
::url('civicrm/admin/member/membershipStatus', 'reset=1')]
2135 $deceasedDAO = CRM_Core_DAO
::executeQuery(
2137 SELECT membership.id as membership_id
2138 FROM civicrm_membership membership
2139 INNER JOIN civicrm_contact ON membership.contact_id = civicrm_contact.id
2140 INNER JOIN civicrm_membership_type ON membership.membership_type_id = civicrm_membership_type.id
2141 AND civicrm_membership_type.is_active = 1
2142 WHERE membership.is_test = 0
2143 AND civicrm_contact.is_deceased = 1
2144 AND membership.status_id <> %1
2146 [1 => [$deceasedStatusId, 'Integer']]
2148 while ($deceasedDAO->fetch()) {
2149 civicrm_api3('membership', 'create', [
2150 'id' => $deceasedDAO->membership_id
,
2151 'status_id' => $deceasedStatusId,
2152 'createActivity' => TRUE,
2153 'skipStatusCal' => TRUE,
2154 'skipRecentView' => TRUE,
2162 * Process price set and line items.
2164 * @param int $membershipId
2165 * @param array $lineItem
2167 public function processPriceSet($membershipId, $lineItem) {
2168 //FIXME : need to move this too
2169 if (!$membershipId ||
!is_array($lineItem)
2170 || CRM_Utils_System
::isNull($lineItem)
2175 foreach ($lineItem as $priceSetId => $values) {
2179 foreach ($values as $line) {
2180 $line['entity_table'] = 'civicrm_membership';
2181 $line['entity_id'] = $membershipId;
2182 CRM_Price_BAO_LineItem
::create($line);
2188 * Retrieve the contribution id for the associated Membership id.
2189 * @todo we should get this off the line item
2191 * @param int $membershipId
2194 * if more than one payment associated with membership id need to be returned.
2199 public static function getMembershipContributionId($membershipId, $all = FALSE) {
2201 $membershipPayment = new CRM_Member_DAO_MembershipPayment();
2202 $membershipPayment->membership_id
= $membershipId;
2203 if ($all && $membershipPayment->find()) {
2204 $contributionIds = array();
2205 while ($membershipPayment->fetch()) {
2206 $contributionIds[] = $membershipPayment->contribution_id
;
2208 return $contributionIds;
2211 if ($membershipPayment->find(TRUE)) {
2212 return $membershipPayment->contribution_id
;
2218 * The function checks and updates the status of all membership records for a given domain using the
2219 * calc_membership_status and update_contact_membership APIs.
2222 * Sending renewal reminders has been migrated from this job to the Scheduled Reminders function as of 4.3.
2226 public static function updateAllMembershipStatus() {
2227 // Tests for this function are in api_v3_JobTest. Please add tests for all updates.
2229 $updateCount = $processCount = self
::updateDeceasedMembersStatuses();
2231 // We want all of the statuses as id => name, even the disabled ones (cf.
2232 // CRM-15475), to identify which are Pending, Deceased, Cancelled, and
2234 $allStatus = CRM_Member_BAO_Membership
::buildOptions('status_id', 'validate');
2235 $allTypes = CRM_Member_PseudoConstant
::membershipType();
2237 // This query retrieves ALL memberships of active types.
2239 SELECT civicrm_membership.id as membership_id,
2240 civicrm_membership.is_override as is_override,
2241 civicrm_membership.status_override_end_date as status_override_end_date,
2242 civicrm_membership.membership_type_id as membership_type_id,
2243 civicrm_membership.status_id as status_id,
2244 civicrm_membership.join_date as join_date,
2245 civicrm_membership.start_date as start_date,
2246 civicrm_membership.end_date as end_date,
2247 civicrm_membership.source as source,
2248 civicrm_contact.id as contact_id,
2249 civicrm_membership.owner_membership_id as owner_membership_id,
2250 civicrm_membership.contribution_recur_id as recur_id
2251 FROM civicrm_membership
2252 INNER JOIN civicrm_contact ON ( civicrm_membership.contact_id = civicrm_contact.id )
2253 INNER JOIN civicrm_membership_type ON
2254 (civicrm_membership.membership_type_id = civicrm_membership_type.id AND civicrm_membership_type.is_active = 1)
2255 WHERE civicrm_membership.is_test = 0
2256 AND civicrm_contact.is_deceased = 0 ";
2258 $deceaseStatusId = array_search('Deceased', $allStatus);
2259 $pendingStatusId = array_search('Pending', $allStatus);
2260 $cancelledStatusId = array_search('Cancelled', $allStatus);
2261 // Expired is not reserved so might not exist. A value of `0` won't break.
2262 $expiredStatusId = array_search('Expired', $allStatus) ?
: 0;
2264 $query = $baseQuery . " AND civicrm_membership.is_override IS NOT NULL AND civicrm_membership.status_override_end_date IS NOT NULL";
2265 $dao1 = CRM_Core_DAO
::executeQuery($query);
2266 while ($dao1->fetch()) {
2267 self
::processOverriddenUntilDateMembership($dao1);
2270 $query = $baseQuery . " AND (civicrm_membership.is_override = 0 OR civicrm_membership.is_override IS NULL)
2271 AND civicrm_membership.status_id NOT IN (%1, %2, %3, %4)
2272 AND civicrm_membership.owner_membership_id IS NULL ";
2274 1 => array($pendingStatusId, 'Integer'),
2275 2 => array($cancelledStatusId, 'Integer'),
2276 3 => array($expiredStatusId, 'Integer'),
2277 4 => array($deceaseStatusId, 'Integer'),
2279 $dao2 = CRM_Core_DAO
::executeQuery($query, $params);
2281 while ($dao2->fetch()) {
2285 // Put common parameters into array for easy access
2286 $memberParams = array(
2287 'id' => $dao2->membership_id
,
2288 'status_id' => $dao2->status_id
,
2289 'contact_id' => $dao2->contact_id
,
2290 'membership_type_id' => $dao2->membership_type_id
,
2291 'membership_type' => $allTypes[$dao2->membership_type_id
],
2292 'join_date' => $dao2->join_date
,
2293 'start_date' => $dao2->start_date
,
2294 'end_date' => $dao2->end_date
,
2295 'source' => $dao2->source
,
2296 'skipStatusCal' => TRUE,
2297 'skipRecentView' => TRUE,
2300 // CRM-7248: added excludeIsAdmin param to the following fn call to prevent moving to admin statuses
2301 //get the membership status as per id.
2302 $newStatus = civicrm_api('membership_status', 'calc',
2304 'membership_id' => $dao2->membership_id
,
2306 'ignore_admin_only' => TRUE,
2309 $statusId = CRM_Utils_Array
::value('id', $newStatus);
2311 //process only when status change.
2313 $statusId != $dao2->status_id
2315 //take all params that need to save.
2316 $memParams = $memberParams;
2317 $memParams['status_id'] = $statusId;
2318 $memParams['createActivity'] = TRUE;
2319 $memParams['version'] = 3;
2321 // Unset columns which should remain unchanged from their current saved
2322 // values. This avoids race condition in which these values may have
2323 // been changed by other processes.
2325 $memParams['contact_id'],
2326 $memParams['membership_type_id'],
2327 $memParams['membership_type'],
2328 $memParams['join_date'],
2329 $memParams['start_date'],
2330 $memParams['end_date'],
2331 $memParams['source']
2333 //since there is change in status.
2335 //process member record.
2336 civicrm_api('membership', 'create', $memParams);
2340 $result['is_error'] = 0;
2341 $result['messages'] = ts('Processed %1 membership records. Updated %2 records.', array(
2349 * Set is_override for the 'overridden until date' membership to
2350 * False and clears the 'until date' field in case the 'until date'
2351 * is equal or after today date.
2353 * @param CRM_Core_DAO $membership
2354 * The membership to be processed
2356 private static function processOverriddenUntilDateMembership($membership) {
2357 $isOverriddenUntilDate = !empty($membership->is_override
) && !empty($membership->status_override_end_date
);
2358 if (!$isOverriddenUntilDate) {
2362 $todayDate = new DateTime();
2363 $todayDate->setTime(0, 0);
2365 $overrideEndDate = new DateTime($membership->status_override_end_date
);
2366 $overrideEndDate->setTime(0, 0);
2368 $datesDifference = $todayDate->diff($overrideEndDate);
2369 $daysDifference = (int) $datesDifference->format('%R%a');
2370 if ($daysDifference <= 0) {
2372 'id' => $membership->membership_id
,
2373 'is_override' => FALSE,
2374 'status_override_end_date' => 'null',
2376 civicrm_api3('membership', 'create', $params);
2381 * Returns the membership types for a particular contact
2382 * who has lifetime membership without end date.
2384 * @param int $contactID
2385 * @param bool $isTest
2386 * @param bool $onlyLifeTime
2390 public static function getAllContactMembership($contactID, $isTest = FALSE, $onlyLifeTime = FALSE) {
2391 $contactMembershipType = array();
2393 return $contactMembershipType;
2396 $dao = new CRM_Member_DAO_Membership();
2397 $dao->contact_id
= $contactID;
2398 $pendingStatusId = array_search('Pending', CRM_Member_PseudoConstant
::membershipStatus());
2399 $dao->whereAdd("status_id != $pendingStatusId");
2402 $dao->is_test
= $isTest;
2405 $dao->whereAdd('is_test IS NULL OR is_test = 0');
2408 if ($onlyLifeTime) {
2409 $dao->whereAdd('end_date IS NULL');
2413 while ($dao->fetch()) {
2414 $membership = array();
2415 CRM_Core_DAO
::storeValues($dao, $membership);
2416 $contactMembershipType[$dao->membership_type_id
] = $membership;
2418 return $contactMembershipType;
2422 * Record contribution record associated with membership.
2424 * @param array $params
2425 * Array of submitted params.
2427 * (@deprecated) array of ids.
2429 * @return CRM_Contribute_BAO_Contribution
2431 public static function recordMembershipContribution(&$params, $ids = array()) {
2433 CRM_Core_Error
::deprecatedFunctionWarning('no $ids array');
2435 $membershipId = $params['membership_id'];
2436 $contributionParams = array();
2437 $config = CRM_Core_Config
::singleton();
2438 $contributionParams['currency'] = $config->defaultCurrency
;
2439 $contributionParams['receipt_date'] = (CRM_Utils_Array
::value('receipt_date', $params)) ?
$params['receipt_date'] : 'null';
2440 $contributionParams['source'] = CRM_Utils_Array
::value('contribution_source', $params);
2441 $contributionParams['non_deductible_amount'] = 'null';
2442 $contributionParams['skipCleanMoney'] = TRUE;
2443 $contributionParams['payment_processor'] = CRM_Utils_Array
::value('payment_processor_id', $params);
2444 $contributionSoftParams = CRM_Utils_Array
::value('soft_credit', $params);
2445 $recordContribution = array(
2450 'financial_type_id',
2451 'payment_instrument_id',
2455 'contribution_status_id',
2462 'contribution_recur_id',
2466 foreach ($recordContribution as $f) {
2467 $contributionParams[$f] = CRM_Utils_Array
::value($f, $params);
2470 if (!empty($params['contribution_id'])) {
2471 $contributionParams['id'] = $params['contribution_id'];
2473 // make entry in batch entity batch table
2474 if (!empty($params['batch_id'])) {
2475 $contributionParams['batch_id'] = $params['batch_id'];
2478 if (!empty($params['contribution_contact_id'])) {
2479 // deal with possibility of a different person paying for contribution
2480 $contributionParams['contact_id'] = $params['contribution_contact_id'];
2483 if (!empty($params['processPriceSet']) &&
2484 !empty($params['lineItems'])
2486 $contributionParams['line_item'] = CRM_Utils_Array
::value('lineItems', $params, NULL);
2489 $contribution = CRM_Contribute_BAO_Contribution
::create($contributionParams);
2491 //CRM-13981, create new soft-credit record as to record payment from different person for this membership
2492 if (!empty($contributionSoftParams)) {
2493 if (!empty($params['batch_id'])) {
2494 foreach ($contributionSoftParams as $contributionSoft) {
2495 $contributionSoft['contribution_id'] = $contribution->id
;
2496 $contributionSoft['currency'] = $contribution->currency
;
2497 CRM_Contribute_BAO_ContributionSoft
::add($contributionSoft);
2501 $contributionSoftParams['contribution_id'] = $contribution->id
;
2502 $contributionSoftParams['currency'] = $contribution->currency
;
2503 $contributionSoftParams['amount'] = $contribution->total_amount
;
2504 CRM_Contribute_BAO_ContributionSoft
::add($contributionSoftParams);
2508 // store contribution id
2509 $params['contribution_id'] = $contribution->id
;
2511 //insert payment record for this membership
2512 if (empty($ids['contribution']) ||
!empty($params['is_recur'])) {
2513 civicrm_api3('MembershipPayment', 'create', [
2514 'membership_id' => $membershipId,
2515 'contribution_id' => $contribution->id
,
2519 return $contribution;
2523 * @todo document me - I seem a bit out of date....
2525 public static function _getActTypes() {
2526 $activityTypes = CRM_Core_PseudoConstant
::activityType(TRUE, FALSE, FALSE, 'name');
2527 self
::$_renewalActType = CRM_Utils_Array
::key('Membership Renewal', $activityTypes);
2528 self
::$_signupActType = CRM_Utils_Array
::key('Membership Signup', $activityTypes);
2532 * Get all Cancelled Membership(s) for a contact
2534 * @param int $contactID
2536 * @param bool $isTest
2540 * Array of membership type
2542 public static function getContactsCancelledMembership($contactID, $isTest = FALSE) {
2546 $query = 'SELECT membership_type_id FROM civicrm_membership WHERE contact_id = %1 AND status_id = %2 AND is_test = %3';
2547 $queryParams = array(
2548 1 => array($contactID, 'Integer'),
2553 CRM_Member_PseudoConstant
::membershipStatus(
2555 " name = 'Cancelled' ",
2563 3 => array($isTest, 'Boolean'),
2566 $dao = CRM_Core_DAO
::executeQuery($query, $queryParams);
2567 $cancelledMembershipIds = array();
2568 while ($dao->fetch()) {
2569 $cancelledMembershipIds[] = $dao->membership_type_id
;
2571 return $cancelledMembershipIds;
2575 * Merges the memberships from otherContactID to mainContactID.
2577 * General idea is to merge memberships in regards to their type. We
2578 * move the other contact’s contributions to the main contact’s
2579 * membership which has the same type (if any) and then we update
2580 * membership to avoid loosing `join_date`, `end_date`, and
2581 * `status_id`. In this function, we don’t touch the contributions
2582 * directly (CRM_Dedupe_Merger::moveContactBelongings() takes care
2585 * This function adds new SQL queries to the $sqlQueries parameter.
2587 * @param int $mainContactID
2588 * Contact id of main contact record.
2589 * @param int $otherContactID
2590 * Contact id of record which is going to merge.
2591 * @param array $sqlQueries
2592 * (reference) array of SQL queries to be executed.
2593 * @param array $tables
2594 * List of tables that have to be merged.
2595 * @param array $tableOperations
2596 * Special options/params for some tables to be merged.
2598 * @see CRM_Dedupe_Merger::cpTables()
2600 public static function mergeMemberships($mainContactID, $otherContactID, &$sqlQueries, $tables, $tableOperations) {
2602 * If the user requests not to merge memberships but to add them,
2603 * just attribute the `civicrm_membership` to the
2604 * `$mainContactID`. We have to do this here since the general
2605 * merge process is bypassed by this function.
2607 if (array_key_exists("civicrm_membership", $tableOperations) && $tableOperations['civicrm_membership']['add']) {
2608 $sqlQueries[] = "UPDATE IGNORE civicrm_membership SET contact_id = $mainContactID WHERE contact_id = $otherContactID";
2613 * Retrieve all memberships that belongs to each contacts and
2614 * keep track of each membership type.
2616 $mainContactMemberships = array();
2617 $otherContactMemberships = array();
2619 $sql = "SELECT id, membership_type_id FROM civicrm_membership membership WHERE contact_id = %1";
2620 $dao = CRM_Core_DAO
::executeQuery($sql, array(1 => array($mainContactID, "Integer")));
2621 while ($dao->fetch()) {
2622 $mainContactMemberships[$dao->id
] = $dao->membership_type_id
;
2625 $dao = CRM_Core_DAO
::executeQuery($sql, array(1 => array($otherContactID, "Integer")));
2626 while ($dao->fetch()) {
2627 $otherContactMemberships[$dao->id
] = $dao->membership_type_id
;
2631 * For each membership, move related contributions to the main
2632 * contact’s membership (by updating `membership_payments`). Then,
2633 * update membership’s `join_date` (if the other membership’s
2634 * join_date is older) and `end_date` (if the other membership’s
2635 * `end_date` is newer) and `status_id` (if the newly calculated
2636 * status is different).
2638 * FIXME: what should we do if we have multiple memberships with
2639 * the same type (currently we only take the first one)?
2642 foreach ($otherContactMemberships as $otherMembershipId => $otherMembershipTypeId) {
2643 if ($newMembershipId = array_search($otherMembershipTypeId, $mainContactMemberships)) {
2646 * Move other membership’s contributions to the main one only
2647 * if user requested to merge contributions.
2649 if (!empty($tables) && in_array('civicrm_contribution', $tables)) {
2650 $newSql[] = "UPDATE civicrm_membership_payment SET membership_id=$newMembershipId WHERE membership_id=$otherMembershipId";
2653 $sql = "SELECT * FROM civicrm_membership membership WHERE id = %1";
2655 $newMembership = CRM_Member_DAO_Membership
::findById($newMembershipId);
2656 $otherMembership = CRM_Member_DAO_Membership
::findById($otherMembershipId);
2659 if (new DateTime($otherMembership->join_date
) < new DateTime($newMembership->join_date
)) {
2660 $updates["join_date"] = $otherMembership->join_date
;
2663 if (new DateTime($otherMembership->end_date
) > new DateTime($newMembership->end_date
)) {
2664 $updates["end_date"] = $otherMembership->end_date
;
2667 if (count($updates)) {
2672 $status = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate(
2673 isset($updates["start_date"]) ?
$updates["start_date"] : $newMembership->start_date
,
2674 isset($updates["end_date"]) ?
$updates["end_date"] : $newMembership->end_date
,
2675 isset($updates["join_date"]) ?
$updates["join_date"] : $newMembership->join_date
,
2682 if (!empty($status['id']) and $status['id'] != $newMembership->status_id
) {
2683 $updates['status_id'] = $status['id'];
2687 foreach ($updates as $k => $v) {
2688 $updates_sql[] = "$k = '{$v}'";
2691 $newSql[] = sprintf("UPDATE civicrm_membership SET %s WHERE id=%s", implode(", ", $updates_sql), $newMembershipId);
2692 $newSql[] = sprintf("DELETE FROM civicrm_membership WHERE id=%s", $otherMembershipId);
2698 $sqlQueries = array_merge($sqlQueries, $newSql);