3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
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 static $_importableFields = NULL;
42 static $_renewalActType = NULL;
44 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;
99 if (empty($membership->contact_id
) ||
empty($membership->status_id
)) {
100 // this means we are in renewal mode and are just updating the membership
101 // record or this is an API update call and all fields are not present in the update record
102 // however the hooks don't care and want all data CRM-7784
103 $tempMembership = new CRM_Member_DAO_Membership();
104 $tempMembership->id
= $membership->id
;
105 $tempMembership->find(TRUE);
106 $membership = $tempMembership;
109 //get the log start date.
110 //it is set during renewal of membership.
111 $logStartDate = CRM_Utils_Array
::value('log_start_date', $params);
112 $logStartDate = ($logStartDate) ? CRM_Utils_Date
::isoToMysql($logStartDate) : CRM_Utils_Date
::isoToMysql($membership->start_date
);
113 $values = self
::getStatusANDTypeValues($membership->id
);
115 $membershipLog = array(
116 'membership_id' => $membership->id
,
117 'status_id' => $membership->status_id
,
118 'start_date' => $logStartDate,
119 'end_date' => CRM_Utils_Date
::isoToMysql($membership->end_date
),
120 'modified_date' => date('Ymd'),
121 'membership_type_id' => $values[$membership->id
]['membership_type_id'],
122 'max_related' => $membership->max_related
,
125 $session = CRM_Core_Session
::singleton();
126 // If we have an authenticated session, set modified_id to that user's contact_id, else set to membership.contact_id
127 if ($session->get('userID')) {
128 $membershipLog['modified_id'] = $session->get('userID');
130 elseif (!empty($ids['userId'])) {
131 $membershipLog['modified_id'] = $ids['userId'];
134 $membershipLog['modified_id'] = $membership->contact_id
;
137 CRM_Member_BAO_MembershipLog
::add($membershipLog, CRM_Core_DAO
::$_nullArray);
139 // reset the group contact cache since smart groups might be affected due to this
140 CRM_Contact_BAO_GroupContactCache
::remove();
143 if ($membership->status_id
!= $oldStatus) {
144 $allStatus = CRM_Member_BAO_Membership
::buildOptions('status_id', 'get');
145 $activityParam = array(
146 'subject' => "Status changed from {$allStatus[$oldStatus]} to {$allStatus[$membership->status_id]}",
147 'source_contact_id' => $membershipLog['modified_id'],
148 'target_contact_id' => $membership->contact_id
,
149 'source_record_id' => $membership->id
,
150 'activity_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Change Membership Status'),
153 'activity_date_time' => date('Y-m-d H:i:s'),
155 civicrm_api3('activity', 'create', $activityParam);
157 if (isset($membership->membership_type_id
) && $membership->membership_type_id
!= $oldType) {
158 $membershipTypes = CRM_Member_BAO_Membership
::buildOptions('membership_type_id', 'get');
159 $activityParam = array(
160 'subject' => "Type changed from {$membershipTypes[$oldType]} to {$membershipTypes[$membership->membership_type_id]}",
161 'source_contact_id' => $membershipLog['modified_id'],
162 'target_contact_id' => $membership->contact_id
,
163 'source_record_id' => $membership->id
,
164 'activity_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Change Membership Type'),
167 'activity_date_time' => date('Y-m-d H:i:s'),
169 civicrm_api3('activity', 'create', $activityParam);
171 CRM_Utils_Hook
::post('edit', 'Membership', $membership->id
, $membership);
174 CRM_Utils_Hook
::post('create', 'Membership', $membership->id
, $membership);
181 * Fetch the object and store the values in the values array.
183 * @param array $params
184 * Input parameters to find object.
185 * @param array $values
186 * Output values of the object.
187 * @param bool $active
188 * Do you want only active memberships to.
190 * @param bool $relatedMemberships
192 * @return CRM_Member_BAO_Membership|null
193 * The found object or null
195 public static function &getValues(&$params, &$values, $active = FALSE, $relatedMemberships = FALSE) {
196 if (empty($params)) {
199 $membership = new CRM_Member_BAO_Membership();
201 $membership->copyValues($params);
203 $memberships = array();
204 while ($membership->fetch()) {
206 (!CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus',
207 $membership->status_id
,
214 CRM_Core_DAO
::storeValues($membership, $values[$membership->id
]);
215 $memberships[$membership->id
] = $membership;
216 if ($relatedMemberships && !empty($membership->owner_membership_id
)) {
217 $values['owner_membership_ids'][] = $membership->owner_membership_id
;
225 * Takes an associative array and creates a membership object.
227 * @param array $params
228 * (reference ) an assoc array of name/value pairs.
230 * The array that holds all the db ids.
231 * @param bool $skipRedirect
232 * @param string $activityType
234 * @throws CRM_Core_Exception
236 * @return CRM_Member_BAO_Membership|CRM_Core_Error
238 public static function create(&$params, &$ids, $skipRedirect = FALSE, $activityType = 'Membership Signup') {
239 // always calculate status if is_override/skipStatusCal is not true.
240 // giving respect to is_override during import. CRM-4012
242 // To skip status calculation we should use 'skipStatusCal'.
243 // eg pay later membership, membership update cron CRM-3984
245 if (empty($params['is_override']) && empty($params['skipStatusCal'])) {
246 $dates = array('start_date', 'end_date', 'join_date');
247 // Declare these out of courtesy as IDEs don't pick up the setting of them below.
248 $start_date = $end_date = $join_date = NULL;
249 foreach ($dates as $date) {
250 $
$date = $params[$date] = CRM_Utils_Date
::processDate(CRM_Utils_Array
::value($date, $params), NULL, TRUE, 'Ymd');
253 //fix for CRM-3570, during import exclude the statuses those having is_admin = 1
254 $excludeIsAdmin = CRM_Utils_Array
::value('exclude_is_admin', $params, FALSE);
256 //CRM-3724 always skip is_admin if is_override != true.
257 if (!$excludeIsAdmin && empty($params['is_override'])) {
258 $excludeIsAdmin = TRUE;
261 $calcStatus = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($start_date, $end_date, $join_date,
262 'today', $excludeIsAdmin, CRM_Utils_Array
::value('membership_type_id', $params), $params
264 if (empty($calcStatus)) {
265 // Redirect the form in case of error
266 // @todo this redirect in the BAO layer is really bad & should be moved to the form layer
267 // however since we have no idea how (if) this is triggered we can't safely move / remove it
268 // NB I tried really hard to trigger this error from backoffice membership form in order to test it
269 // and am convinced form validation is complete on that form WRT this error.
270 $errorParams = array(
271 'message_title' => ts('No valid membership status for given dates.'),
272 'legacy_redirect_path' => 'civicrm/contact/view',
273 'legacy_redirect_query' => "reset=1&force=1&cid={$params['contact_id']}&selectedChild=member",
275 throw new CRM_Core_Exception(ts('The membership cannot be saved because the status cannot be calculated.'), 0, $errorParams);
277 $params['status_id'] = $calcStatus['id'];
280 // data cleanup only: all verifications on number of related memberships are done upstream in:
281 // CRM_Member_BAO_Membership::createRelatedMemberships()
282 // CRM_Contact_BAO_Relationship::relatedMemberships()
283 if (isset($params['owner_membership_id'])) {
284 unset($params['max_related']);
287 // if membership allows related, default max_related to value in membership_type
288 if (!array_key_exists('max_related', $params) && !empty($params['membership_type_id'])) {
289 $membershipType = CRM_Member_BAO_MembershipType
::getMembershipTypeDetails($params['membership_type_id']);
290 if (isset($membershipType['relationship_type_id'])) {
291 $params['max_related'] = CRM_Utils_Array
::value('max_related', $membershipType);
296 $transaction = new CRM_Core_Transaction();
298 $membership = self
::add($params, $ids);
300 if (is_a($membership, 'CRM_Core_Error')) {
301 $transaction->rollback();
305 // add custom field values
306 if (!empty($params['custom']) && is_array($params['custom'])
308 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_membership', $membership->id
);
311 $params['membership_id'] = $membership->id
;
312 if (isset($ids['membership'])) {
313 $ids['contribution'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipPayment',
320 $params['skipLineItem'] = TRUE;
322 //record contribution for this membership
323 if (!empty($params['contribution_status_id']) && empty($params['relate_contribution_id'])) {
324 $memInfo = array_merge($params, array('membership_id' => $membership->id
));
325 $params['contribution'] = self
::recordMembershipContribution($memInfo, $ids);
328 if (!empty($params['lineItems'])) {
329 $params['line_item'] = $params['lineItems'];
332 //do cleanup line items if membership edit the Membership type.
333 if (empty($ids['contribution']) && !empty($ids['membership'])) {
334 CRM_Price_BAO_LineItem
::deleteLineItems($ids['membership'], 'civicrm_membership');
337 if (!empty($params['line_item']) && empty($ids['contribution'])) {
338 CRM_Price_BAO_LineItem
::processPriceSet($membership->id
, $params['line_item'], CRM_Utils_Array
::value('contribution', $params));
341 //insert payment record for this membership
342 if (!empty($params['relate_contribution_id'])) {
343 CRM_Member_BAO_MembershipPayment
::create(array(
344 'membership_id' => $membership->id
,
345 'contribution_id' => $params['relate_contribution_id'],
349 // add activity record only during create mode and renew mode
350 // also add activity if status changed CRM-3984 and CRM-2521
351 if (empty($ids['membership']) ||
352 $activityType == 'Membership Renewal' ||
!empty($params['createActivity'])
354 if (!empty($ids['membership'])) {
356 CRM_Core_DAO
::commonRetrieveAll('CRM_Member_DAO_Membership',
360 array('contact_id', 'membership_type_id', 'source')
363 $membership->contact_id
= $data[$membership->id
]['contact_id'];
364 $membership->membership_type_id
= $data[$membership->id
]['membership_type_id'];
365 $membership->source
= CRM_Utils_Array
::value('source', $data[$membership->id
]);
368 // since we are going to create activity record w/
369 // individual contact as a target in case of on behalf signup,
370 // so get the copy of organization id, CRM-5551
371 $realMembershipContactId = $membership->contact_id
;
373 // create activity source = individual, target = org CRM-4027
374 $targetContactID = NULL;
375 if (!empty($params['is_for_organization'])) {
376 $targetContactID = $membership->contact_id
;
377 $membership->contact_id
= CRM_Utils_Array
::value('userId', $ids);
380 if (empty($membership->contact_id
) && (!empty($membership->owner_membership_id
))) {
381 $membership->contact_id
= $realMembershipContactId;
384 if (!empty($ids['membership']) && $activityType != 'Membership Signup') {
385 CRM_Activity_BAO_Activity
::addActivity($membership, $activityType, $targetContactID);
387 elseif (empty($ids['membership'])) {
388 CRM_Activity_BAO_Activity
::addActivity($membership, $activityType, $targetContactID);
391 // we might created activity record w/ individual
392 // contact as target so update membership object w/
393 // original organization id, CRM-5551
394 $membership->contact_id
= $realMembershipContactId;
397 $transaction->commit();
399 self
::createRelatedMemberships($params, $membership);
401 // do not add to recent items for import, CRM-4399
402 if (empty($params['skipRecentView'])) {
403 $url = CRM_Utils_System
::url('civicrm/contact/view/membership',
404 "action=view&reset=1&id={$membership->id}&cid={$membership->contact_id}&context=home"
406 if (empty($membership->membership_type_id
)) {
407 // ie in an update situation.
408 $membership->find(TRUE);
410 $membershipTypes = CRM_Member_PseudoConstant
::membershipType();
411 $title = CRM_Contact_BAO_Contact
::displayName($membership->contact_id
) . ' - ' . ts('Membership Type:') . ' ' . $membershipTypes[$membership->membership_type_id
];
413 $recentOther = array();
414 if (CRM_Core_Permission
::checkActionPermission('CiviMember', CRM_Core_Action
::UPDATE
)) {
415 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/contact/view/membership',
416 "action=update&reset=1&id={$membership->id}&cid={$membership->contact_id}&context=home"
419 if (CRM_Core_Permission
::checkActionPermission('CiviMember', CRM_Core_Action
::DELETE
)) {
420 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/contact/view/membership',
421 "action=delete&reset=1&id={$membership->id}&cid={$membership->contact_id}&context=home"
425 // add the recently created Membership
426 CRM_Utils_Recent
::add($title,
430 $membership->contact_id
,
440 * Check the membership extended through relationship.
442 * @param int $membershipId
444 * @param int $contactId
450 * array of contact_id of all related contacts.
452 public static function checkMembershipRelationship($membershipId, $contactId, $action = CRM_Core_Action
::ADD
) {
454 $membershipTypeID = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $membershipId, 'membership_type_id');
456 $membershipType = CRM_Member_BAO_MembershipType
::getMembershipTypeDetails($membershipTypeID);
457 $relationships = array();
458 if (isset($membershipType['relationship_type_id'])) {
459 $relationships = CRM_Contact_BAO_Relationship
::getRelationship($contactId,
460 CRM_Contact_BAO_Relationship
::CURRENT
462 if ($action & CRM_Core_Action
::UPDATE
) {
463 $pastRelationships = CRM_Contact_BAO_Relationship
::getRelationship($contactId,
464 CRM_Contact_BAO_Relationship
::PAST
466 $relationships = array_merge($relationships, $pastRelationships);
470 if (!empty($relationships)) {
471 // check for each contact relationships
472 foreach ($relationships as $values) {
473 //get details of the relationship type
474 $relType = array('id' => $values['civicrm_relationship_type_id']);
475 $relValues = array();
476 CRM_Contact_BAO_RelationshipType
::retrieve($relType, $relValues);
477 // Check if contact's relationship type exists in membership type
478 $relTypeDirs = array();
479 $relTypeIds = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $membershipType['relationship_type_id']);
480 $relDirections = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $membershipType['relationship_direction']);
481 $bidirectional = FALSE;
482 foreach ($relTypeIds as $key => $value) {
483 $relTypeDirs[] = $value . '_' . $relDirections[$key];
484 if (in_array($value, $relType) &&
485 $relValues['name_a_b'] == $relValues['name_b_a']
487 $bidirectional = TRUE;
491 $relTypeDir = $values['civicrm_relationship_type_id'] . '_' . $values['rtype'];
492 if ($bidirectional ||
in_array($relTypeDir, $relTypeDirs)) {
493 // $values['status'] is going to have value for
494 // current or past relationships.
495 $contacts[$values['cid']] = $values['status'];
500 // Sort by contact_id ascending
506 * Retrieve DB object based on input parameters.
508 * It also stores all the retrieved values in the default array.
510 * @param array $params
511 * (reference ) an assoc array of name/value pairs.
512 * @param array $defaults
513 * (reference ) an assoc array to hold the name / value pairs.
514 * in a hierarchical manner
516 * @return CRM_Member_BAO_Membership
518 public static function retrieve(&$params, &$defaults) {
519 $membership = new CRM_Member_DAO_Membership();
521 $membership->copyValues($params);
523 if ($membership->find(TRUE)) {
524 CRM_Core_DAO
::storeValues($membership, $defaults);
526 //get the membership status and type values.
527 $statusANDType = self
::getStatusANDTypeValues($membership->id
);
532 $defaults[$fld] = CRM_Utils_Array
::value($fld, $statusANDType[$membership->id
]);
534 if (!empty($statusANDType[$membership->id
]['is_current_member'])) {
535 $defaults['active'] = TRUE;
547 * Get membership status and membership type values.
549 * @param int $membershipId
550 * Membership id of values to return.
553 * Array of key value pairs
555 public static function getStatusANDTypeValues($membershipId) {
557 if (!$membershipId) {
561 SELECT membership.id as id,
562 status.id as status_id,
563 status.label as status,
564 status.is_current_member as is_current_member,
565 type.id as membership_type_id,
566 type.name as membership_type,
567 type.relationship_type_id as relationship_type_id
568 FROM civicrm_membership membership
569 INNER JOIN civicrm_membership_status status ON ( status.id = membership.status_id )
570 INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_type_id )
571 WHERE membership.id = %1';
572 $dao = CRM_Core_DAO
::executeQuery($sql, array(1 => array($membershipId, 'Positive')));
577 'membership_type_id',
579 'relationship_type_id',
581 while ($dao->fetch()) {
582 foreach ($properties as $property) {
583 $values[$dao->id
][$property] = $dao->$property;
593 * Wrapper for most delete calls. Use this unless you JUST want to delete related memberships w/o deleting the parent.
595 * @param int $membershipId
596 * Membership id that needs to be deleted.
599 * Id of deleted Membership on success, false otherwise.
601 public static function del($membershipId) {
602 //delete related first and then delete parent.
603 self
::deleteRelatedMemberships($membershipId);
604 return self
::deleteMembership($membershipId);
610 * @param int $membershipId
611 * Membership id that needs to be deleted.
614 * Id of deleted Membership on success, false otherwise.
616 public static function deleteMembership($membershipId) {
617 // CRM-12147, retrieve membership data before we delete it for hooks
618 $params = array('id' => $membershipId);
619 $memValues = array();
620 $memberships = self
::getValues($params, $memValues);
622 $membership = $memberships[$membershipId];
624 CRM_Utils_Hook
::pre('delete', 'Membership', $membershipId, $memValues);
626 $transaction = new CRM_Core_Transaction();
629 //delete activity record
630 $activityTypes = CRM_Core_PseudoConstant
::activityType(TRUE, FALSE, FALSE, 'name');
633 $deleteActivity = FALSE;
634 $membershipActivities = array(
636 'Membership Renewal',
637 'Change Membership Status',
638 'Change Membership Type',
639 'Membership Renewal Reminder',
641 foreach ($membershipActivities as $membershipActivity) {
642 $activityId = array_search($membershipActivity, $activityTypes);
644 $params['activity_type_id'][] = $activityId;
645 $deleteActivity = TRUE;
648 if ($deleteActivity) {
649 $params['source_record_id'] = $membershipId;
650 CRM_Activity_BAO_Activity
::deleteActivity($params);
652 self
::deleteMembershipPayment($membershipId);
654 $results = $membership->delete();
655 $transaction->commit();
657 CRM_Utils_Hook
::post('delete', 'Membership', $membership->id
, $membership);
659 // delete the recently created Membership
660 $membershipRecent = array(
661 'id' => $membershipId,
662 'type' => 'Membership',
664 CRM_Utils_Recent
::del($membershipRecent);
670 * Delete related memberships.
672 * @param int $ownerMembershipId
673 * @param int $contactId
677 public static function deleteRelatedMemberships($ownerMembershipId, $contactId = NULL) {
678 if (!$ownerMembershipId && !$contactId) {
682 $membership = new CRM_Member_DAO_Membership();
683 $membership->owner_membership_id
= $ownerMembershipId;
686 $membership->contact_id
= $contactId;
690 while ($membership->fetch()) {
691 //delete related first and then delete parent.
692 self
::deleteRelatedMemberships($membership->id
);
693 self
::deleteMembership($membership->id
);
699 * Obtain active/inactive memberships from the list of memberships passed to it.
701 * @param array $memberships
702 * Membership records.
703 * @param string $status
704 * Active or inactive.
707 * array of memberships based on status
709 public static function activeMembers($memberships, $status = 'active') {
711 if ($status == 'active') {
712 foreach ($memberships as $f => $v) {
713 if (!empty($v['active'])) {
719 elseif ($status == 'inactive') {
720 foreach ($memberships as $f => $v) {
721 if (empty($v['active'])) {
731 * Return Membership Block info in Contribution Pages.
734 * Contribution page id.
738 public static function getMembershipBlock($pageID) {
739 $membershipBlock = array();
740 $dao = new CRM_Member_DAO_MembershipBlock();
741 $dao->entity_table
= 'civicrm_contribution_page';
743 $dao->entity_id
= $pageID;
745 if ($dao->find(TRUE)) {
746 CRM_Core_DAO
::storeValues($dao, $membershipBlock);
747 if (!empty($membershipBlock['membership_types'])) {
748 $membershipTypes = unserialize($membershipBlock['membership_types']);
749 if (!is_array($membershipTypes)) {
750 return $membershipBlock;
753 foreach ($membershipTypes as $key => $value) {
754 $membershipBlock['auto_renew'][$key] = $value;
755 $memTypes[$key] = $key;
757 $membershipBlock['membership_types'] = implode(',', $memTypes);
764 return $membershipBlock;
768 * Return a current membership of given contact.
770 * NB: if more than one membership meets criteria, a randomly selected one is returned.
772 * @param int $contactID
774 * @param int $memType
775 * Membership type, null to retrieve all types.
777 * @param int $membershipId
778 * If provided, then determine if it is current.
779 * @param bool $onlySameParentOrg
780 * True if only Memberships with same parent org as the $memType wanted, false otherwise.
784 public static function getContactMembership($contactID, $memType, $isTest, $membershipId = NULL, $onlySameParentOrg = FALSE) {
785 //check for owner membership id, if it exists update that membership instead: CRM-15992
787 $ownerMemberId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership',
789 'owner_membership_id', 'id'
791 if ($ownerMemberId) {
792 $membershipId = $ownerMemberId;
793 $contactID = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership',
800 $dao = new CRM_Member_DAO_Membership();
802 $dao->id
= $membershipId;
804 $dao->contact_id
= $contactID;
805 $dao->membership_type_id
= $memType;
807 //fetch proper membership record.
809 $dao->is_test
= $isTest;
812 $dao->whereAdd('is_test IS NULL OR is_test = 0');
815 //avoid pending membership as current membership: CRM-3027
816 $statusIds[] = array_search('Pending', CRM_Member_PseudoConstant
::membershipStatus());
817 if (!$membershipId) {
819 $statusIds[] = array_search(
821 CRM_Member_PseudoConstant
::membershipStatus(
823 " name = 'Cancelled' ",
830 $dao->whereAdd('status_id NOT IN ( ' . implode(',', $statusIds) . ')');
832 // order by start date to find most recent membership first, CRM-4545
833 $dao->orderBy('start_date DESC');
836 if ($onlySameParentOrg && $memType) {
837 // require the same parent org as the $memType
838 $params = array('id' => $memType);
839 $membershipType = array();
840 if (CRM_Member_BAO_MembershipType
::retrieve($params, $membershipType)) {
841 $memberTypesSameParentOrg = CRM_Member_BAO_MembershipType
::getMembershipTypesByOrg($membershipType['member_of_contact_id']);
842 $memberTypesSameParentOrgList = implode(',', array_keys($memberTypesSameParentOrg));
843 $dao->whereAdd('membership_type_id IN (' . $memberTypesSameParentOrgList . ')');
847 if ($dao->find(TRUE)) {
848 $membership = array();
849 CRM_Core_DAO
::storeValues($dao, $membership);
850 $membership['is_current_member'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus',
851 $membership['status_id'],
852 'is_current_member', 'id'
854 $ownerMemberId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership',
856 'owner_membership_id', 'id'
858 if ($ownerMemberId) {
859 $membership['id'] = $membership['membership_id'] = $ownerMemberId;
860 $membership['membership_contact_id'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership',
869 if ($onlySameParentOrg && $memType) {
870 // see if there is a membership that has same parent as $memType but different parent than $membershipID
871 if ($dao->id
&& CRM_Core_Permission
::check('edit memberships')) {
872 // CRM-10016, This is probably a backend renewal, and make sure we return the same membership thats being renewed.
879 unset($dao->membership_type_id
);
880 if ($dao->find(TRUE)) {
881 $membership = array();
882 CRM_Core_DAO
::storeValues($dao, $membership);
883 $membership['is_current_member'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus',
884 $membership['status_id'],
885 'is_current_member', 'id'
894 * Combine all the importable fields from the lower levels object.
896 * @param string $contactType
898 * @param bool $status
901 * array of importable Fields
903 public static function &importableFields($contactType = 'Individual', $status = TRUE) {
904 if (!self
::$_importableFields) {
905 if (!self
::$_importableFields) {
906 self
::$_importableFields = array();
910 $fields = array('' => array('title' => '- ' . ts('do not import') . ' -'));
913 $fields = array('' => array('title' => '- ' . ts('Membership Fields') . ' -'));
916 $tmpFields = CRM_Member_DAO_Membership
::import();
917 $contactFields = CRM_Contact_BAO_Contact
::importableFields($contactType, NULL);
919 // Using new Dedupe rule.
921 'contact_type' => $contactType,
922 'used' => 'Unsupervised',
924 $fieldsArray = CRM_Dedupe_BAO_Rule
::dedupeRuleFields($ruleParams);
926 $tmpContactField = array();
927 if (is_array($fieldsArray)) {
928 foreach ($fieldsArray as $value) {
929 $customFieldId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField',
934 $value = $customFieldId ?
'custom_' . $customFieldId : $value;
935 $tmpContactField[trim($value)] = CRM_Utils_Array
::value(trim($value), $contactFields);
937 $title = $tmpContactField[trim($value)]['title'] . " " . ts('(match to contact)');
940 $title = $tmpContactField[trim($value)]['title'];
942 $tmpContactField[trim($value)]['title'] = $title;
945 $tmpContactField['external_identifier'] = $contactFields['external_identifier'];
946 $tmpContactField['external_identifier']['title'] = $contactFields['external_identifier']['title'] . " " . ts('(match to contact)');
948 $tmpFields['membership_contact_id']['title'] = $tmpFields['membership_contact_id']['title'] . " " . ts('(match to contact)');;
950 $fields = array_merge($fields, $tmpContactField);
951 $fields = array_merge($fields, $tmpFields);
952 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Membership'));
953 self
::$_importableFields = $fields;
955 return self
::$_importableFields;
959 * Get all exportable fields.
961 * @return array return array of all exportable fields
963 public static function &exportableFields() {
964 $expFieldMembership = CRM_Member_DAO_Membership
::export();
966 $expFieldsMemType = CRM_Member_DAO_MembershipType
::export();
967 $fields = array_merge($expFieldMembership, $expFieldsMemType);
968 $fields = array_merge($fields, $expFieldMembership);
969 $membershipStatus = array(
970 'membership_status' => array(
971 'title' => 'Membership Status',
972 'name' => 'membership_status',
973 'type' => CRM_Utils_Type
::T_STRING
,
974 'where' => 'civicrm_membership_status.name',
977 //CRM-6161 fix for customdata export
978 $fields = array_merge($fields, $membershipStatus, CRM_Core_BAO_CustomField
::getFieldsForImport('Membership'));
983 * Get membership joins/renewals for a specified membership type.
985 * Specifically, retrieves a count of memberships whose "Membership
986 * Signup" or "Membership Renewal" activity falls in the given date range.
987 * Dates match the pattern "yyyy-mm-dd".
989 * @param int $membershipTypeId
990 * Membership type id.
991 * @param int $startDate
992 * Date on which to start counting.
993 * @param int $endDate
994 * Date on which to end counting.
995 * @param bool|int $isTest if true, membership is for a test site
996 * @param bool|int $isOwner if true, only retrieve membership records for owners //LCD
999 * the number of members of type $membershipTypeId whose
1000 * start_date is between $startDate and $endDate
1002 public static function getMembershipStarts($membershipTypeId, $startDate, $endDate, $isTest = 0, $isOwner = 0) {
1004 $testClause = 'membership.is_test = 1';
1006 $testClause = '( membership.is_test IS NULL OR membership.is_test = 0 )';
1009 if (!self
::$_signupActType ||
!self
::$_renewalActType) {
1010 self
::_getActTypes();
1013 if (!self
::$_signupActType ||
!self
::$_renewalActType) {
1018 SELECT COUNT(DISTINCT membership.id) as member_count
1019 FROM civicrm_membership membership
1020 INNER JOIN civicrm_activity activity ON (activity.source_record_id = membership.id AND activity.activity_type_id in (%1, %2))
1021 INNER JOIN civicrm_membership_status status ON ( membership.status_id = status.id AND status.is_current_member = 1 )
1022 INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND contact.is_deleted = 0 )
1023 WHERE membership.membership_type_id = %3
1024 AND activity.activity_date_time >= '$startDate' AND activity.activity_date_time <= '$endDate 23:59:59'
1027 $query .= ($isOwner) ?
' AND owner_membership_id IS NULL' : '';
1030 1 => array(self
::$_signupActType, 'Integer'),
1031 2 => array(self
::$_renewalActType, 'Integer'),
1032 3 => array($membershipTypeId, 'Integer'),
1035 $memberCount = CRM_Core_DAO
::singleValueQuery($query, $params);
1036 return (int) $memberCount;
1040 * Get a count of membership for a specified membership type, optionally for a specified date.
1042 * The date must have the form yyyy-mm-dd.
1044 * If $date is omitted, this function counts as a member anyone whose
1045 * membership status_id indicates they're a current member.
1046 * If $date is given, this function counts as a member anyone who:
1047 * -- Has a start_date before $date and end_date after $date, or
1048 * -- Has a start_date before $date and is currently a member, as indicated
1049 * by the the membership's status_id.
1050 * The second condition takes care of records that have no end_date. These
1051 * are assumed to be lifetime memberships.
1053 * @param int $membershipTypeId
1054 * Membership type id.
1055 * @param string $date
1056 * The date for which to retrieve the count.
1057 * @param bool|int $isTest if true, membership is for a test site
1058 * @param bool|int $isOwner if true, only retrieve membership records for owners //LCD
1061 * the number of members of type $membershipTypeId as of $date.
1063 public static function getMembershipCount($membershipTypeId, $date = NULL, $isTest = 0, $isOwner = 0) {
1064 if (!CRM_Utils_Rule
::date($date)) {
1065 CRM_Core_Error
::fatal(ts('Invalid date "%1" (must have form yyyy-mm-dd).', array(1 => $date)));
1069 1 => array($membershipTypeId, 'Integer'),
1070 2 => array($isTest, 'Boolean'),
1072 $query = "SELECT count(civicrm_membership.id ) as member_count
1073 FROM civicrm_membership left join civicrm_membership_status on ( civicrm_membership.status_id = civicrm_membership_status.id )
1074 WHERE civicrm_membership.membership_type_id = %1
1075 AND civicrm_membership.contact_id NOT IN (SELECT id FROM civicrm_contact WHERE is_deleted = 1)
1076 AND civicrm_membership.is_test = %2";
1078 $query .= " AND civicrm_membership_status.is_current_member = 1";
1081 $query .= " AND civicrm_membership.start_date <= '$date' AND civicrm_membership_status.is_current_member = 1";
1084 $query .= ($isOwner) ?
' AND owner_membership_id IS NULL' : '';
1085 $memberCount = CRM_Core_DAO
::singleValueQuery($query, $params);
1086 return (int) $memberCount;
1090 * Function check the status of the membership before adding membership for a contact.
1092 * @param int $contactId
1097 public static function statusAvailabilty($contactId) {
1098 $membership = new CRM_Member_DAO_MembershipStatus();
1099 $membership->whereAdd('is_active=1');
1100 return $membership->count();
1104 * Process the Memberships.
1106 * @param array $membershipParams
1107 * Array of membership fields.
1108 * @param int $contactID
1110 * @param CRM_Contribute_Form_Contribution_Confirm $form
1111 * Confirmation form object.
1113 * @param array $premiumParams
1114 * @param null $customFieldsFormatted
1115 * @param null $includeFieldTypes
1117 * @param array $membershipDetails
1119 * @param array $membershipTypeIDs
1121 * @param bool $isPaidMembership
1122 * @param array $membershipID
1124 * @param bool $isProcessSeparateMembershipTransaction
1126 * @param int $financialTypeID
1127 * @param array $membershipLineItems
1128 * Line items specific to membership payment that is separate to contribution.
1129 * @param bool $isPayLater
1130 * @param bool $isPending
1132 * @throws \CRM_Core_Exception
1134 public static function postProcessMembership(
1135 $membershipParams, $contactID, &$form, $premiumParams,
1136 $customFieldsFormatted = NULL, $includeFieldTypes = NULL, $membershipDetails, $membershipTypeIDs, $isPaidMembership, $membershipID,
1137 $isProcessSeparateMembershipTransaction, $financialTypeID, $membershipLineItems, $isPayLater, $isPending) {
1138 $result = $membershipContribution = NULL;
1139 $isTest = CRM_Utils_Array
::value('is_test', $membershipParams, FALSE);
1140 $errors = $createdMemberships = $paymentResult = array();
1142 if ($isPaidMembership) {
1143 if ($isProcessSeparateMembershipTransaction) {
1144 // If we have 2 transactions only one can use the invoice id.
1145 $membershipParams['invoiceID'] .= '-2';
1148 $paymentResult = CRM_Contribute_BAO_Contribution_Utils
::processConfirm($form, $membershipParams,
1149 $premiumParams, $contactID,
1156 if (is_a($result[1], 'CRM_Core_Error')) {
1157 $errors[1] = CRM_Core_Error
::getMessages($paymentResult[1]);
1160 if (is_a($paymentResult, 'CRM_Core_Error')) {
1161 $errors[1] = CRM_Core_Error
::getMessages($paymentResult);
1163 elseif (!empty($paymentResult['contribution'])) {
1164 //note that this will be over-written if we are using a separate membership transaction. Otherwise there is only one
1165 $membershipContribution = $paymentResult['contribution'];
1166 // Save the contribution ID so that I can be used in email receipts
1167 // For example, if you need to generate a tax receipt for the donation only.
1168 $form->_values
['contribution_other_id'] = $membershipContribution->id
;
1172 if ($isProcessSeparateMembershipTransaction) {
1174 $form->_lineItem
= $membershipLineItems;
1175 if (empty($form->_params
['auto_renew']) && !empty($membershipParams['is_recur'])) {
1176 unset($membershipParams['is_recur']);
1178 $membershipContribution = self
::processSecondaryFinancialTransaction($contactID, $form, $membershipParams, $isTest, $membershipLineItems, CRM_Utils_Array
::value('minimum_fee', $membershipDetails, 0), CRM_Utils_Array
::value('financial_type_id', $membershipDetails));
1180 catch (CRM_Core_Exception
$e) {
1181 $errors[2] = $e->getMessage();
1182 $membershipContribution = NULL;
1187 if (!empty($membershipContribution) && !is_a($membershipContribution, 'CRM_Core_Error')) {
1188 $membershipContributionID = $membershipContribution->id
;
1191 //@todo - why is this nested so deep? it seems like it could be just set on the calling function on the form layer
1192 if (isset($membershipParams['onbehalf']) && !empty($membershipParams['onbehalf']['member_campaign_id'])) {
1193 $form->_params
['campaign_id'] = $membershipParams['onbehalf']['member_campaign_id'];
1195 //@todo it should no longer be possible for it to get to this point & membership to not be an array
1196 if (is_array($membershipTypeIDs) && !empty($membershipContributionID)) {
1197 $typesTerms = CRM_Utils_Array
::value('types_terms', $membershipParams, array());
1198 foreach ($membershipTypeIDs as $memType) {
1199 $numTerms = CRM_Utils_Array
::value($memType, $typesTerms, 1);
1200 if (!empty($membershipContribution)) {
1201 $pendingStatus = CRM_Core_OptionGroup
::getValue('contribution_status', 'Pending', 'name');
1202 $pending = ($membershipContribution->contribution_status_id
== $pendingStatus) ?
TRUE : FALSE;
1205 $pending = $isPending;
1207 $contributionRecurID = isset($form->_params
['contributionRecurID']) ?
$form->_params
['contributionRecurID'] : NULL;
1209 $membershipSource = NULL;
1210 if (!empty($form->_params
['membership_source'])) {
1211 $membershipSource = $form->_params
['membership_source'];
1213 elseif (isset($form->_values
['title']) && !empty($form->_values
['title'])) {
1214 $membershipSource = ts('Online Contribution:') . ' ' . $form->_values
['title'];
1217 if (isset($form->_params
)) {
1218 $isPayLater = CRM_Utils_Array
::value('is_pay_later', $form->_params
);
1221 if (isset($form->_values
) && is_array($form->_values
) && !empty($form->_values
)) {
1222 $campaignId = CRM_Utils_Array
::value('campaign_id', $form->_params
);
1223 if (!array_key_exists('campaign_id', $form->_params
)) {
1224 $campaignId = CRM_Utils_Array
::value('campaign_id', $form->_values
);
1228 list($membership, $renewalMode, $dates) = self
::renewMembership(
1229 $contactID, $memType, $isTest,
1230 date('YmdHis'), CRM_Utils_Array
::value('cms_contactID', $membershipParams),
1231 $customFieldsFormatted,
1232 $numTerms, $membershipID, $pending,
1233 $contributionRecurID, $membershipSource, $isPayLater, $campaignId
1235 $form->set('renewal_mode', $renewalMode);
1236 if (!empty($dates)) {
1237 $form->assign('mem_start_date',
1238 CRM_Utils_Date
::customFormat($dates['start_date'], '%Y%m%d')
1240 $form->assign('mem_end_date',
1241 CRM_Utils_Date
::customFormat($dates['end_date'], '%Y%m%d')
1245 if (!empty($membershipContribution)) {
1246 // update recurring id for membership record
1247 self
::updateRecurMembership($membership, $membershipContribution);
1248 self
::linkMembershipPayment($membership, $membershipContribution);
1251 if ($form->_priceSetId
&& !empty($form->_useForMember
) && !empty($form->_lineItem
)) {
1252 foreach ($form->_lineItem
[$form->_priceSetId
] as & $priceFieldOp) {
1253 if (!empty($priceFieldOp['membership_type_id']) &&
1254 isset($createdMemberships[$priceFieldOp['membership_type_id']])
1256 $membershipOb = $createdMemberships[$priceFieldOp['membership_type_id']];
1257 $priceFieldOp['start_date'] = $membershipOb->start_date ? CRM_Utils_Date
::customFormat($membershipOb->start_date
, '%B %E%f, %Y') : '-';
1258 $priceFieldOp['end_date'] = $membershipOb->end_date ? CRM_Utils_Date
::customFormat($membershipOb->end_date
, '%B %E%f, %Y') : '-';
1261 $priceFieldOp['start_date'] = $priceFieldOp['end_date'] = 'N/A';
1264 $form->_values
['lineItem'] = $form->_lineItem
;
1265 $form->assign('lineItem', $form->_lineItem
);
1269 if (!empty($errors)) {
1270 $message = self
::compileErrorMessage($errors);
1271 throw new CRM_Core_Exception($message);
1273 $form->_params
['createdMembershipIDs'] = array();
1275 // CRM-7851 - Moved after processing Payment Errors
1276 //@todo - the reasoning for this being here seems a little outdated
1277 foreach ($createdMemberships as $createdMembership) {
1278 CRM_Core_BAO_CustomValueTable
::postProcess(
1280 'civicrm_membership',
1281 $createdMembership->id
,
1284 $form->_params
['createdMembershipIDs'][] = $createdMembership->id
;
1286 if (count($createdMemberships) == 1) {
1287 //presumably this is only relevant for exactly 1 membership
1288 $form->_params
['membershipID'] = $createdMembership->id
;
1291 //CRM-15232: Check if membership is created and on the basis of it use
1292 //membership receipt template to send payment receipt
1293 if (count($createdMemberships)) {
1294 $form->_values
['isMembership'] = TRUE;
1296 if ($form->_contributeMode
== 'notify') {
1297 if ($form->_values
['is_monetary'] && $form->_amount
> 0.0 && !$form->_params
['is_pay_later']) {
1298 // call postProcess hook before leaving
1299 $form->postProcessHook();
1300 // this does not return
1301 $payment = CRM_Core_Payment
::singleton($form->_mode
, $form->_paymentProcessor
, $form);
1302 $payment->doTransferCheckout($form->_params
, 'contribute');
1306 if (isset($membershipContributionID)) {
1307 $form->_values
['contribution_id'] = $membershipContributionID;
1310 // Refer to CRM-16737. Payment processors 'should' return payment_status_id
1311 // to denote the outcome of the transaction.
1313 // In 4.7 trxn_id will no longer denote the outcome & all processor transactions must return an array
1314 // containing payment_status_id.
1315 // In 4.6 support (such as there was) for other ways of denoting payment outcome is retained but the use
1316 // of payment_status_id is strongly encouraged.
1317 if (!empty($form->_params
['is_recur']) && $form->_contributeMode
== 'direct') {
1318 if (!isset($membershipContribution->payment_status_id
) && $membershipContribution->payment_status_id
== 1) {
1320 civicrm_api3('contribution', 'completetransaction', array(
1321 'id' => $paymentResult['contribution']->id
,
1322 'trxn_id' => $paymentResult['contribution']->trxn_id
,
1323 'is_transactional' => FALSE,
1326 catch (CiviCRM_API3_Exception
$e) {
1327 // if for any reason it is already completed this will fail - e.g extensions hacking around core not completing transactions prior to CRM-15296
1328 // so let's be gentle here
1329 CRM_Core_Error
::debug_log_message('contribution ' . $membershipContribution->id
. ' not completed with trxn_id ' . $membershipContribution->trxn_id
. ' and message ' . $e->getMessage());
1332 // Do not send an email if Recurring transaction is done via Direct Mode
1333 // Email will we sent when the IPN is received.
1337 //finally send an email receipt
1338 CRM_Contribute_BAO_ContributionPage
::sendMail($contactID,
1346 * Function for updating a membership record's contribution_recur_id.
1348 * @param CRM_Member_DAO_Membership $membership
1349 * @param \CRM_Contribute_BAO_Contribution|\CRM_Contribute_DAO_Contribution $contribution
1351 static public function updateRecurMembership(CRM_Member_DAO_Membership
$membership, CRM_Contribute_BAO_Contribution
$contribution) {
1353 if (empty($contribution->contribution_recur_id
)) {
1358 1 => array($contribution->contribution_recur_id
, 'Integer'),
1359 2 => array($membership->id
, 'Integer'),
1362 $sql = "UPDATE civicrm_membership SET contribution_recur_id = %1 WHERE id = %2";
1363 CRM_Core_DAO
::executeQuery($sql, $params);
1367 * Method to fix membership status of stale membership.
1369 * This method first checks if the membership is stale. If it is,
1370 * then status will be updated based on existing start and end
1371 * dates and log will be added for the status change.
1373 * @param array $currentMembership
1374 * Reference to the array.
1375 * containing all values of
1376 * the current membership
1377 * @param array $changeToday
1378 * Array of month, day, year.
1379 * values in case today needs
1380 * to be customised, null otherwise
1382 public static function fixMembershipStatusBeforeRenew(&$currentMembership, $changeToday) {
1385 $today = CRM_Utils_Date
::processDate($changeToday, NULL, FALSE, 'Y-m-d');
1388 $status = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate(
1389 CRM_Utils_Array
::value('start_date', $currentMembership),
1390 CRM_Utils_Array
::value('end_date', $currentMembership),
1391 CRM_Utils_Array
::value('join_date', $currentMembership),
1394 $currentMembership['membership_type_id'],
1398 if (empty($status) ||
1399 empty($status['id'])
1401 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.'));
1404 $currentMembership['today_date'] = $today;
1406 if ($status['id'] !== $currentMembership['status_id']) {
1407 $memberDAO = new CRM_Member_DAO_Membership();
1408 $memberDAO->id
= $currentMembership['id'];
1409 $memberDAO->find(TRUE);
1411 $memberDAO->status_id
= $status['id'];
1412 $memberDAO->join_date
= CRM_Utils_Date
::isoToMysql($memberDAO->join_date
);
1413 $memberDAO->start_date
= CRM_Utils_Date
::isoToMysql($memberDAO->start_date
);
1414 $memberDAO->end_date
= CRM_Utils_Date
::isoToMysql($memberDAO->end_date
);
1416 CRM_Core_DAO
::storeValues($memberDAO, $currentMembership);
1419 $currentMembership['is_current_member'] = CRM_Core_DAO
::getFieldValue(
1420 'CRM_Member_DAO_MembershipStatus',
1421 $currentMembership['status_id'],
1427 'membership_id' => $currentMembership['id'],
1428 'status_id' => $status['id'],
1429 'start_date' => CRM_Utils_Date
::customFormat(
1430 $currentMembership['start_date'],
1433 'end_date' => CRM_Utils_Date
::customFormat(
1434 $currentMembership['end_date'],
1437 'modified_date' => CRM_Utils_Date
::customFormat(
1438 $currentMembership['today_date'],
1441 'membership_type_id' => $currentMembership['membership_type_id'],
1442 'max_related' => CRM_Utils_Array
::value('max_related', $currentMembership, 0),
1445 $session = CRM_Core_Session
::singleton();
1446 // If we have an authenticated session, set modified_id to that user's contact_id, else set to membership.contact_id
1447 if ($session->get('userID')) {
1448 $logParams['modified_id'] = $session->get('userID');
1451 $logParams['modified_id'] = $currentMembership['contact_id'];
1453 CRM_Member_BAO_MembershipLog
::add($logParams, CRM_Core_DAO
::$_nullArray);
1458 * Get the contribution page id from the membership record.
1460 * @param int $membershipID
1463 * contribution page id
1465 public static function getContributionPageId($membershipID) {
1467 SELECT c.contribution_page_id as pageID
1468 FROM civicrm_membership_payment mp, civicrm_contribution c
1469 WHERE mp.contribution_id = c.id
1470 AND c.contribution_page_id IS NOT NULL
1471 AND mp.membership_id = " . CRM_Utils_Type
::escape($membershipID, 'Integer')
1472 . " ORDER BY mp.id DESC";
1474 return CRM_Core_DAO
::singleValueQuery($query,
1475 CRM_Core_DAO
::$_nullArray
1480 * Updated related memberships.
1482 * @param int $ownerMembershipId
1483 * Owner Membership Id.
1484 * @param array $params
1485 * Formatted array of key => value.
1487 public static function updateRelatedMemberships($ownerMembershipId, $params) {
1488 $membership = new CRM_Member_DAO_Membership();
1489 $membership->owner_membership_id
= $ownerMembershipId;
1490 $membership->find();
1492 while ($membership->fetch()) {
1493 $relatedMembership = new CRM_Member_DAO_Membership();
1494 $relatedMembership->id
= $membership->id
;
1495 $relatedMembership->copyValues($params);
1496 $relatedMembership->save();
1497 $relatedMembership->free();
1500 $membership->free();
1504 * Get list of membership fields for profile.
1506 * For now we only allow custom membership fields to be in
1510 * FIXME: This param is ignored
1513 * the list of membership fields
1515 public static function getMembershipFields($mode = NULL) {
1516 $fields = CRM_Member_DAO_Membership
::export();
1518 unset($fields['membership_contact_id']);
1519 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Membership'));
1521 $membershipType = CRM_Member_DAO_MembershipType
::export();
1523 $membershipStatus = CRM_Member_DAO_MembershipStatus
::export();
1525 $fields = array_merge($fields, $membershipType, $membershipStatus);
1531 * Get the sort name of a contact for a particular membership.
1534 * Id of the membership.
1536 * @return null|string
1537 * sort name of the contact if found
1539 public static function sortName($id) {
1540 $id = CRM_Utils_Type
::escape($id, 'Integer');
1543 SELECT civicrm_contact.sort_name
1544 FROM civicrm_membership, civicrm_contact
1545 WHERE civicrm_membership.contact_id = civicrm_contact.id
1546 AND civicrm_membership.id = {$id}
1548 return CRM_Core_DAO
::singleValueQuery($query, CRM_Core_DAO
::$_nullArray);
1552 * Create memberships for related contacts, taking into account the maximum related memberships.
1554 * @param array $params
1555 * Array of key - value pairs.
1556 * @param CRM_Core_DAO $dao
1557 * Membership object.
1559 * @param bool $reset
1561 * @return array|null
1562 * Membership details, if created.
1564 * @throws \CRM_Core_Exception
1566 public static function createRelatedMemberships(&$params, &$dao, $reset = FALSE) {
1567 static $relatedContactIds = array();
1569 // not sure why a static var is in use here - we need a way to reset it from the test suite
1570 $relatedContactIds = array();
1574 $membership = new CRM_Member_DAO_Membership();
1575 $membership->id
= $dao->id
;
1577 // required since create method doesn't return all the
1578 // parameters in the returned membership object
1579 if (!$membership->find(TRUE)) {
1582 $deceasedStatusId = array_search('Deceased', CRM_Member_PseudoConstant
::membershipStatus());
1583 // FIXME : While updating/ renewing the
1584 // membership, if the relationship is PAST then
1585 // the membership of the related contact must be
1587 // For that, getting Membership Status for which
1588 // is_current_member is 0. It works for the
1589 // generated data as there is only one membership
1590 // status having is_current_member = 0.
1591 // But this wont work exactly if there will be
1592 // more than one status having is_current_member = 0.
1593 $membershipStatus = new CRM_Member_DAO_MembershipStatus();
1594 $membershipStatus->is_current_member
= 0;
1595 if ($membershipStatus->find(TRUE)) {
1596 $expiredStatusId = $membershipStatus->id
;
1599 $expiredStatusId = array_search('Expired', CRM_Member_PseudoConstant
::membershipStatus());
1602 $allRelatedContacts = array();
1603 $relatedContacts = array();
1604 if (!is_a($membership, 'CRM_Core_Error')) {
1605 $allRelatedContacts = CRM_Member_BAO_Membership
::checkMembershipRelationship($membership->id
,
1606 $membership->contact_id
,
1607 CRM_Utils_Array
::value('action', $params)
1611 // check for loops. CRM-4213
1612 // remove repeated related contacts, which already inherited membership.
1613 $relatedContactIds[$membership->contact_id
] = TRUE;
1614 foreach ($allRelatedContacts as $cid => $status) {
1615 if (empty($relatedContactIds[$cid])) {
1616 $relatedContactIds[$cid] = TRUE;
1618 //don't create membership again for owner contact.
1619 $nestedRelationship = FALSE;
1620 if ($membership->owner_membership_id
) {
1621 $nestedRelMembership = new CRM_Member_DAO_Membership();
1622 $nestedRelMembership->id
= $membership->owner_membership_id
;
1623 $nestedRelMembership->contact_id
= $cid;
1624 $nestedRelationship = $nestedRelMembership->find(TRUE);
1625 $nestedRelMembership->free();
1627 if (!$nestedRelationship) {
1628 $relatedContacts[$cid] = $status;
1633 //lets cleanup related membership if any.
1634 if (empty($relatedContacts)) {
1635 self
::deleteRelatedMemberships($membership->id
);
1638 // Edit the params array
1639 unset($params['id']);
1640 // Reminder should be sent only to the direct membership
1641 unset($params['reminder_date']);
1642 // unset the custom value ids
1643 if (is_array(CRM_Utils_Array
::value('custom', $params))) {
1644 foreach ($params['custom'] as $k => $v) {
1645 unset($params['custom'][$k]['id']);
1648 if (!isset($params['membership_type_id'])) {
1649 $params['membership_type_id'] = $membership->membership_type_id
;
1652 // max_related should be set in the parent membership
1653 unset($params['max_related']);
1654 // Number of inherited memberships available - NULL is interpreted as unlimited, '0' as none
1655 $available = ($membership->max_related
== NULL ? PHP_INT_MAX
: $membership->max_related
);
1656 // will be used to queue potential memberships to be created.
1659 foreach ($relatedContacts as $contactId => $relationshipStatus) {
1660 //use existing membership record.
1661 $relMembership = new CRM_Member_DAO_Membership();
1662 $relMembership->contact_id
= $contactId;
1663 $relMembership->owner_membership_id
= $membership->id
;
1664 $relMemIds = array();
1665 if ($relMembership->find(TRUE)) {
1666 $params['id'] = $relMemIds['membership'] = $relMembership->id
;
1668 $params['contact_id'] = $contactId;
1669 $params['owner_membership_id'] = $membership->id
;
1671 // set status_id as it might have been changed for
1672 // past relationship
1673 $params['status_id'] = $membership->status_id
;
1675 if ($deceasedStatusId &&
1676 CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $contactId, 'is_deceased')
1678 $params['status_id'] = $deceasedStatusId;
1680 elseif ((CRM_Utils_Array
::value('action', $params) & CRM_Core_Action
::UPDATE
) &&
1681 ($relationshipStatus == CRM_Contact_BAO_Relationship
::PAST
)
1683 $params['status_id'] = $expiredStatusId;
1686 //don't calculate status again in create( );
1687 $params['skipStatusCal'] = TRUE;
1689 //do create activity if we changed status.
1690 if ($params['status_id'] != $relMembership->status_id
) {
1691 $params['createActivity'] = TRUE;
1694 // we should not created contribution record for related contacts, CRM-3371
1695 unset($params['contribution_status_id']);
1697 if (($params['status_id'] == $deceasedStatusId) ||
($params['status_id'] == $expiredStatusId)) {
1698 // related membership is not active so does not count towards maximum
1699 CRM_Member_BAO_Membership
::create($params, $relMemIds);
1702 // related membership already exists, so this is just an update
1703 if (isset($params['id'])) {
1704 if ($available > 0) {
1705 CRM_Member_BAO_Membership
::create($params, $relMemIds);
1709 // we have run out of inherited memberships, so delete extras
1710 self
::deleteMembership($params['id']);
1712 // we need to first check if there will remain inherited memberships, so queue it up
1719 // now go over the queue and create any available related memberships
1721 while (($available > 0) && ($params = each($queue))) {
1722 CRM_Member_BAO_Membership
::create($params['value'], $relMemIds);
1729 * Delete the record that are associated with this Membership Payment.
1731 * @param int $membershipId
1734 * $membershipPayment deleted membership payment object
1736 public static function deleteMembershipPayment($membershipId) {
1738 $membershipPayment = new CRM_Member_DAO_MembershipPayment();
1739 $membershipPayment->membership_id
= $membershipId;
1740 $membershipPayment->find();
1742 while ($membershipPayment->fetch()) {
1743 CRM_Contribute_BAO_Contribution
::deleteContribution($membershipPayment->contribution_id
);
1744 CRM_Utils_Hook
::pre('delete', 'MembershipPayment', $membershipPayment->id
, $membershipPayment);
1745 $membershipPayment->delete();
1746 CRM_Utils_Hook
::post('delete', 'MembershipPayment', $membershipPayment->id
, $membershipPayment);
1748 return $membershipPayment;
1752 * Build an array of available membership types.
1754 * @param CRM_Core_Form $form
1755 * @param int $membershipTypeID
1756 * @param bool $activeOnly
1757 * Do we only want active ones?
1758 * (probably this should default to TRUE but as a newly added parameter we are leaving default b
1759 * behaviour unchanged).
1763 public static function buildMembershipTypeValues(&$form, $membershipTypeID = NULL, $activeOnly = FALSE) {
1764 $whereClause = " WHERE domain_id = " . CRM_Core_Config
::domainID();
1767 $whereClause .= " AND is_active = 1 ";
1769 if (is_array($membershipTypeID)) {
1770 $allIDs = implode(',', $membershipTypeID);
1771 $whereClause .= " AND id IN ( $allIDs )";
1773 elseif (is_numeric($membershipTypeID) &&
1774 $membershipTypeID > 0
1776 $whereClause .= " AND id = $membershipTypeID";
1781 FROM civicrm_membership_type
1784 $dao = CRM_Core_DAO
::executeQuery($query);
1786 $membershipTypeValues = array();
1787 $membershipTypeFields = array(
1793 'financial_type_id',
1795 'member_of_contact_id',
1796 'relationship_type_id',
1797 'relationship_direction',
1800 'duration_interval',
1803 while ($dao->fetch()) {
1804 $membershipTypeValues[$dao->id
] = array();
1805 foreach ($membershipTypeFields as $mtField) {
1806 $membershipTypeValues[$dao->id
][$mtField] = $dao->$mtField;
1811 CRM_Utils_Hook
::membershipTypeValues($form, $membershipTypeValues);
1813 if (is_numeric($membershipTypeID) &&
1814 $membershipTypeID > 0
1816 return $membershipTypeValues[$membershipTypeID];
1819 return $membershipTypeValues;
1824 * Get membership record count for a Contact.
1826 * @param int $contactID
1827 * @param bool $activeOnly
1829 * @return null|string
1831 public static function getContactMembershipCount($contactID, $activeOnly = FALSE) {
1832 $select = "SELECT count(*) FROM civicrm_membership ";
1833 $where = "WHERE civicrm_membership.contact_id = {$contactID} AND civicrm_membership.is_test = 0 ";
1835 // CRM-6627, all status below 3 (active, pending, grace) are considered active
1837 $select .= " INNER JOIN civicrm_membership_status ON civicrm_membership.status_id = civicrm_membership_status.id ";
1838 $where .= " and civicrm_membership_status.is_current_member = 1";
1841 $query = $select . $where;
1842 return CRM_Core_DAO
::singleValueQuery($query);
1846 * Check whether payment processor supports cancellation of membership subscription.
1851 * @param bool $isNotCancelled
1855 public static function isCancelSubscriptionSupported($mid, $isNotCancelled = TRUE) {
1856 $cacheKeyString = "$mid";
1857 $cacheKeyString .= $isNotCancelled ?
'_1' : '_0';
1859 static $supportsCancel = array();
1861 if (!array_key_exists($cacheKeyString, $supportsCancel)) {
1862 $supportsCancel[$cacheKeyString] = FALSE;
1863 $isCancelled = FALSE;
1865 if ($isNotCancelled) {
1866 $isCancelled = self
::isSubscriptionCancelled($mid);
1869 $paymentObject = CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($mid, 'membership', 'obj');
1870 if (!empty($paymentObject)) {
1871 $supportsCancel[$cacheKeyString] = $paymentObject->isSupported('cancelSubscription') && !$isCancelled;
1874 return $supportsCancel[$cacheKeyString];
1878 * Check whether subscription is already cancelled.
1884 * contribution status
1886 public static function isSubscriptionCancelled($mid) {
1888 SELECT cr.contribution_status_id
1889 FROM civicrm_contribution_recur cr
1890 LEFT JOIN civicrm_membership mem ON ( cr.id = mem.contribution_recur_id )
1891 WHERE mem.id = %1 LIMIT 1";
1892 $params = array(1 => array($mid, 'Integer'));
1893 $statusId = CRM_Core_DAO
::singleValueQuery($sql, $params);
1894 $status = CRM_Contribute_PseudoConstant
::contributionStatus($statusId, 'name');
1895 if ($status == 'Cancelled') {
1902 * Get membership joins for a specified membership type.
1904 * Specifically, retrieves a count of still current memberships whose
1905 * join_date and start_date are within a specified date range. Dates match
1906 * the pattern "yyyy-mm-dd".
1908 * @param int $membershipTypeId
1909 * Membership type id.
1910 * @param int $startDate
1911 * Date on which to start counting.
1912 * @param int $endDate
1913 * Date on which to end counting.
1914 * @param bool|int $isTest if true, membership is for a test site
1917 * the number of members of type $membershipTypeId
1918 * whose join_date is between $startDate and $endDate and
1919 * whose start_date is between $startDate and $endDate
1921 public static function getMembershipJoins($membershipTypeId, $startDate, $endDate, $isTest = 0) {
1922 $testClause = 'membership.is_test = 1';
1924 $testClause = '( membership.is_test IS NULL OR membership.is_test = 0 )';
1926 if (!self
::$_signupActType) {
1927 self
::_getActTypes();
1930 if (!self
::$_signupActType) {
1935 SELECT COUNT(DISTINCT membership.id) as member_count
1936 FROM civicrm_membership membership
1937 INNER JOIN civicrm_activity activity ON (activity.source_record_id = membership.id AND activity.activity_type_id = %1)
1938 INNER JOIN civicrm_membership_status status ON ( membership.status_id = status.id AND status.is_current_member = 1 )
1939 INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND contact.is_deleted = 0 )
1940 WHERE membership.membership_type_id = %2
1941 AND activity.activity_date_time >= '$startDate' AND activity.activity_date_time <= '$endDate 23:59:59'
1945 1 => array(self
::$_signupActType, 'Integer'),
1946 2 => array($membershipTypeId, 'Integer'),
1949 $memberCount = CRM_Core_DAO
::singleValueQuery($query, $params);
1951 return (int) $memberCount;
1955 * Get membership renewals for a specified membership type.
1957 * Specifically, retrieves a count of still current memberships
1958 * whose join_date is before and start_date is within a specified date
1959 * range. Dates match the pattern "yyyy-mm-dd".
1961 * @param int $membershipTypeId
1962 * Membership type id.
1963 * @param int $startDate
1964 * Date on which to start counting.
1965 * @param int $endDate
1966 * Date on which to end counting.
1967 * @param bool|int $isTest if true, membership is for a test site
1970 * returns the number of members of type $membershipTypeId
1971 * whose join_date is before $startDate and
1972 * whose start_date is between $startDate and $endDate
1974 public static function getMembershipRenewals($membershipTypeId, $startDate, $endDate, $isTest = 0) {
1975 $testClause = 'membership.is_test = 1';
1977 $testClause = '( membership.is_test IS NULL OR membership.is_test = 0 )';
1979 if (!self
::$_renewalActType) {
1980 self
::_getActTypes();
1983 if (!self
::$_renewalActType) {
1988 SELECT COUNT(DISTINCT membership.id) as member_count
1989 FROM civicrm_membership membership
1990 INNER JOIN civicrm_activity activity ON (activity.source_record_id = membership.id AND activity.activity_type_id = %1)
1991 INNER JOIN civicrm_membership_status status ON ( membership.status_id = status.id AND status.is_current_member = 1 )
1992 INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND contact.is_deleted = 0 )
1993 WHERE membership.membership_type_id = %2
1994 AND activity.activity_date_time >= '$startDate' AND activity.activity_date_time <= '$endDate 23:59:59'
1998 1 => array(self
::$_renewalActType, 'Integer'),
1999 2 => array($membershipTypeId, 'Integer'),
2001 $memberCount = CRM_Core_DAO
::singleValueQuery($query, $params);
2003 return (int) $memberCount;
2007 * Where a second separate financial transaction is supported we will process it here.
2009 * @param int $contactID
2010 * @param CRM_Contribute_Form_Contribution_Confirm $form
2011 * @param array $tempParams
2012 * @param bool $isTest
2013 * @param array $lineItems
2014 * @param $minimumFee
2015 * @param int $financialTypeID
2017 * @throws CRM_Core_Exception
2019 * @return CRM_Contribute_BAO_Contribution
2021 public static function processSecondaryFinancialTransaction($contactID, &$form, $tempParams, $isTest, $lineItems, $minimumFee, $financialTypeID) {
2022 $financialType = new CRM_Financial_DAO_FinancialType();
2023 $financialType->id
= $financialTypeID;
2024 $financialType->find(TRUE);
2025 $tempParams['amount'] = $minimumFee;
2026 $tempParams['invoiceID'] = md5(uniqid(rand(), TRUE));
2029 if ($form->_values
['is_monetary'] && !$form->_params
['is_pay_later'] && $minimumFee > 0.0) {
2030 $payment = CRM_Core_Payment
::singleton($form->_mode
, $form->_paymentProcessor
, $form);
2032 if ($form->_contributeMode
== 'express') {
2033 $result = $payment->doExpressCheckout($tempParams);
2034 if (is_a($result, 'CRM_Core_Error')) {
2035 throw new CRM_Core_Exception(CRM_Core_Error
::getMessages($result));
2039 $result = $payment->doPayment($tempParams, 'contribute');
2043 //assign receive date when separate membership payment
2044 //and contribution amount not selected.
2045 if ($form->_amount
== 0) {
2046 $now = date('YmdHis');
2047 $form->_params
['receive_date'] = $now;
2048 $receiveDate = CRM_Utils_Date
::mysqlToIso($now);
2049 $form->set('params', $form->_params
);
2050 $form->assign('receive_date', $receiveDate);
2053 $form->set('membership_trx_id', $result['trxn_id']);
2054 $form->set('membership_amount', $minimumFee);
2056 $form->assign('membership_trx_id', $result['trxn_id']);
2057 $form->assign('membership_amount', $minimumFee);
2059 // we don't need to create the user twice, so lets disable cms_create_account
2060 // irrespective of the value, CRM-2888
2061 $tempParams['cms_create_account'] = 0;
2063 //CRM-16165, scenarios are
2064 // 1) If contribution is_pay_later and if contribution amount is > 0.0 we set pending = TRUE, vice-versa FALSE
2065 // 2) If not pay later but auto-renewal membership is chosen then pending = TRUE as it later triggers
2066 // pending recurring contribution, vice-versa FALSE
2067 $pending = $form->_params
['is_pay_later'] ?
(($minimumFee > 0.0) ?
TRUE : FALSE) : (!empty($form->_params
['auto_renew']) ?
TRUE : FALSE);
2069 //set this variable as we are not creating pledge for
2070 //separate membership payment contribution.
2071 //so for differentiating membership contribution from
2072 //main contribution.
2073 $form->_params
['separate_membership_payment'] = 1;
2074 $membershipContribution = CRM_Contribute_Form_Contribution_Confirm
::processFormContribution($form,
2085 return $membershipContribution;
2089 * Create linkages between membership & contribution - note this is the wrong place for this code but this is a
2090 * refactoring step. This should be BAO functionality
2091 * @param $membership
2092 * @param $membershipContribution
2094 public static function linkMembershipPayment($membership, $membershipContribution) {
2095 CRM_Member_BAO_MembershipPayment
::create(array(
2096 'membership_id' => $membership->id
,
2097 'contribution_id' => $membershipContribution->id
,
2102 * Turn array of errors into message string.
2104 * @param array $errors
2108 public static function compileErrorMessage($errors) {
2109 foreach ($errors as $error) {
2110 if (is_string($error)) {
2111 $message[] = $error;
2114 return ts('Payment Processor Error message') . ': ' . implode('<br/>', $message);
2118 * @param int $contactID
2119 * @param int $membershipTypeID
2120 * @param bool $is_test
2121 * @param $changeToday
2122 * @param int $modifiedID
2123 * @param $customFieldsFormatted
2124 * @param $numRenewTerms
2125 * @param int $membershipID
2127 * @param int $contributionRecurID
2128 * @param $membershipSource
2129 * @param $isPayLater
2130 * @param int $campaignId
2132 * @throws CRM_Core_Exception
2135 public static function renewMembership($contactID, $membershipTypeID, $is_test, $changeToday, $modifiedID, $customFieldsFormatted, $numRenewTerms, $membershipID, $pending, $contributionRecurID, $membershipSource, $isPayLater, $campaignId) {
2136 $renewalMode = $updateStatusId = FALSE;
2137 $allStatus = CRM_Member_PseudoConstant
::membershipStatus();
2139 $statusFormat = '%Y-%m-%d';
2140 $membershipTypeDetails = CRM_Member_BAO_MembershipType
::getMembershipTypeDetails($membershipTypeID);
2142 // CRM-7297 - allow membership type to be be changed during renewal so long as the parent org of new membershipType
2143 // is the same as the parent org of an existing membership of the contact
2144 $currentMembership = CRM_Member_BAO_Membership
::getContactMembership($contactID, $membershipTypeID,
2145 $is_test, $membershipID, TRUE
2147 if ($currentMembership) {
2148 $activityType = 'Membership Renewal';
2149 $renewalMode = TRUE;
2151 // Do NOT do anything.
2152 //1. membership with status : PENDING/CANCELLED (CRM-2395)
2153 //2. Paylater/IPN renew. CRM-4556.
2154 if ($pending ||
in_array($currentMembership['status_id'], array(
2155 array_search('Pending', $allStatus),
2157 array_search('Cancelled', CRM_Member_PseudoConstant
::membershipStatus(NULL, " name = 'Cancelled' ", 'name', FALSE, TRUE)),
2160 $membership = new CRM_Member_DAO_Membership();
2161 $membership->id
= $currentMembership['id'];
2162 $membership->find(TRUE);
2164 // CRM-8141 create a membership_log entry so that we will know the membership_type_id to change to when payment completed
2166 // note that we are logging the requested new membership_type_id that may be different than current membership_type_id
2167 // it will be used when payment is received to update the membership_type_id to what was paid for
2169 'membership_id' => $membership->id
,
2170 'status_id' => $membership->status_id
,
2171 'start_date' => CRM_Utils_Date
::customFormat(
2172 $membership->start_date
,
2175 'end_date' => CRM_Utils_Date
::customFormat(
2176 $membership->end_date
,
2179 'modified_date' => CRM_Utils_Date
::customFormat(
2183 'membership_type_id' => $membershipTypeID,
2184 'max_related' => !empty($membershipTypeDetails['max_related']) ?
$membershipTypeDetails['max_related'] : NULL,
2186 $session = CRM_Core_Session
::singleton();
2187 // If we have an authenticated session, set modified_id to that user's contact_id, else set to membership.contact_id
2188 if ($session->get('userID')) {
2189 $logParams['modified_id'] = $session->get('userID');
2192 $logParams['modified_id'] = $membership->contact_id
;
2194 CRM_Member_BAO_MembershipLog
::add($logParams);
2196 if (!empty($contributionRecurID)) {
2197 CRM_Core_DAO
::setFieldValue('CRM_Member_DAO_Membership', $membership->id
,
2198 'contribution_recur_id', $contributionRecurID
2202 return array($membership, $renewalMode, $dates);
2205 // Check and fix the membership if it is STALE
2206 self
::fixMembershipStatusBeforeRenew($currentMembership, $changeToday);
2208 // Now Renew the membership
2209 if (!$currentMembership['is_current_member']) {
2210 // membership is not CURRENT
2212 // CRM-7297 Membership Upsell - calculate dates based on new membership type
2213 $dates = CRM_Member_BAO_MembershipType
::getRenewalDatesForMembershipType($currentMembership['id'],
2219 $currentMembership['join_date'] = CRM_Utils_Date
::customFormat($currentMembership['join_date'], $format);
2220 $currentMembership['start_date'] = CRM_Utils_Array
::value('start_date', $dates);
2221 $currentMembership['end_date'] = CRM_Utils_Array
::value('end_date', $dates);
2222 $currentMembership['is_test'] = $is_test;
2224 if (!empty($membershipSource)) {
2225 $currentMembership['source'] = $membershipSource;
2228 $currentMembership['source'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership',
2229 $currentMembership['id'],
2234 if (!empty($currentMembership['id'])) {
2235 $ids['membership'] = $currentMembership['id'];
2237 $memParams = $currentMembership;
2238 $memParams['membership_type_id'] = $membershipTypeID;
2240 //set the log start date.
2241 $memParams['log_start_date'] = CRM_Utils_Date
::customFormat($dates['log_start_date'], $format);
2245 // CURRENT Membership
2246 $membership = new CRM_Member_DAO_Membership();
2247 $membership->id
= $currentMembership['id'];
2248 $membership->find(TRUE);
2249 // CRM-7297 Membership Upsell - calculate dates based on new membership type
2250 $dates = CRM_Member_BAO_MembershipType
::getRenewalDatesForMembershipType($membership->id
,
2256 // Insert renewed dates for CURRENT membership
2257 $memParams = array();
2258 $memParams['join_date'] = CRM_Utils_Date
::isoToMysql($membership->join_date
);
2259 $memParams['start_date'] = CRM_Utils_Date
::isoToMysql($membership->start_date
);
2260 $memParams['end_date'] = CRM_Utils_Array
::value('end_date', $dates);
2261 $memParams['membership_type_id'] = $membershipTypeID;
2263 //set the log start date.
2264 $memParams['log_start_date'] = CRM_Utils_Date
::customFormat($dates['log_start_date'], $format);
2265 if (empty($membership->source
)) {
2266 if (!empty($membershipSource)) {
2267 $memParams['source'] = $membershipSource;
2270 $memParams['source'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership',
2271 $currentMembership['id'],
2277 if (!empty($currentMembership['id'])) {
2278 $ids['membership'] = $currentMembership['id'];
2283 $updateStatusId = array_search('Pending', $allStatus);
2289 $activityType = 'Membership Signup';
2291 'contact_id' => $contactID,
2292 'membership_type_id' => $membershipTypeID,
2296 $dates = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($membershipTypeID, NULL, NULL, NULL, $numRenewTerms);
2298 $memParams['join_date'] = CRM_Utils_Array
::value('join_date', $dates);
2299 $memParams['start_date'] = CRM_Utils_Array
::value('start_date', $dates);
2300 $memParams['end_date'] = CRM_Utils_Array
::value('end_date', $dates);
2302 $status = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate(CRM_Utils_Date
::customFormat($dates['start_date'],
2305 CRM_Utils_Date
::customFormat($dates['end_date'],
2308 CRM_Utils_Date
::customFormat($dates['join_date'],
2316 $updateStatusId = CRM_Utils_Array
::value('id', $status);
2319 // if IPN/Pay-Later set status to: PENDING
2320 $updateStatusId = array_search('Pending', $allStatus);
2323 if (!empty($membershipSource)) {
2324 $memParams['source'] = $membershipSource;
2326 $memParams['contribution_recur_id'] = $contributionRecurID;
2328 $memParams['is_test'] = $is_test;
2329 $memParams['is_pay_later'] = $isPayLater;
2333 //if we decided status here and want to skip status
2334 //calculation in create( ); then need to pass 'skipStatusCal'.
2335 if ($updateStatusId) {
2336 $memParams['status_id'] = $updateStatusId;
2337 $memParams['skipStatusCal'] = TRUE;
2340 //since we are renewing,
2341 //make status override false.
2342 $memParams['is_override'] = FALSE;
2344 //CRM-4027, create log w/ individual contact.
2346 $ids['userId'] = $modifiedID;
2347 $memParams['is_for_organization'] = TRUE;
2350 $ids['userId'] = $contactID;
2353 //inherit campaign from contrib page.
2354 if (isset($campaignId)) {
2355 $memParams['campaign_id'] = $campaignId;
2358 $memParams['custom'] = $customFieldsFormatted;
2359 $membership = self
::create($memParams, $ids, FALSE, $activityType);
2361 // not sure why this statement is here, seems quite odd :( - Lobo: 12/26/2010
2362 // related to: http://forum.civicrm.org/index.php/topic,11416.msg49072.html#msg49072
2363 $membership->find(TRUE);
2365 return array($membership, $renewalMode, $dates);
2369 * Process price set and line items.
2371 * @param int $membershipId
2372 * @param array $lineItem
2374 public function processPriceSet($membershipId, $lineItem) {
2375 //FIXME : need to move this too
2376 if (!$membershipId ||
!is_array($lineItem)
2377 || CRM_Utils_System
::isNull($lineItem)
2382 foreach ($lineItem as $priceSetId => $values) {
2386 foreach ($values as $line) {
2387 $line['entity_table'] = 'civicrm_membership';
2388 $line['entity_id'] = $membershipId;
2389 CRM_Price_BAO_LineItem
::create($line);
2395 * Retrieve the contribution id for the associated Membership id.
2396 * @todo we should get this off the line item
2398 * @param int $membershipId
2404 public static function getMembershipContributionId($membershipId) {
2406 $membershipPayment = new CRM_Member_DAO_MembershipPayment();
2407 $membershipPayment->membership_id
= $membershipId;
2408 if ($membershipPayment->find(TRUE)) {
2409 return $membershipPayment->contribution_id
;
2415 * The function checks and updates the status of all membership records for a given domain using the
2416 * calc_membership_status and update_contact_membership APIs.
2419 * Sending renewal reminders has been migrated from this job to the Scheduled Reminders function as of 4.3.
2423 public static function updateAllMembershipStatus() {
2425 //get all active statuses of membership, CRM-3984
2426 $allStatus = CRM_Member_PseudoConstant
::membershipStatus();
2427 $statusLabels = CRM_Member_PseudoConstant
::membershipStatus(NULL, NULL, 'label');
2428 $allTypes = CRM_Member_PseudoConstant
::membershipType();
2430 // get only memberships with active membership types
2432 SELECT civicrm_membership.id as membership_id,
2433 civicrm_membership.is_override as is_override,
2434 civicrm_membership.membership_type_id as membership_type_id,
2435 civicrm_membership.status_id as status_id,
2436 civicrm_membership.join_date as join_date,
2437 civicrm_membership.start_date as start_date,
2438 civicrm_membership.end_date as end_date,
2439 civicrm_membership.source as source,
2440 civicrm_contact.id as contact_id,
2441 civicrm_contact.is_deceased as is_deceased,
2442 civicrm_membership.owner_membership_id as owner_membership_id,
2443 civicrm_membership.contribution_recur_id as recur_id
2444 FROM civicrm_membership
2445 INNER JOIN civicrm_contact ON ( civicrm_membership.contact_id = civicrm_contact.id )
2446 INNER JOIN civicrm_membership_type ON
2447 (civicrm_membership.membership_type_id = civicrm_membership_type.id AND civicrm_membership_type.is_active = 1)
2448 WHERE civicrm_membership.is_test = 0";
2451 $dao = CRM_Core_DAO
::executeQuery($query, $params);
2456 $smarty = CRM_Core_Smarty
::singleton();
2458 while ($dao->fetch()) {
2462 // Put common parameters into array for easy access
2463 $memberParams = array(
2464 'id' => $dao->membership_id
,
2465 'status_id' => $dao->status_id
,
2466 'contact_id' => $dao->contact_id
,
2467 'membership_type_id' => $dao->membership_type_id
,
2468 'membership_type' => $allTypes[$dao->membership_type_id
],
2469 'join_date' => $dao->join_date
,
2470 'start_date' => $dao->start_date
,
2471 'end_date' => $dao->end_date
,
2472 'source' => $dao->source
,
2473 'skipStatusCal' => TRUE,
2474 'skipRecentView' => TRUE,
2477 $smarty->assign_by_ref('memberParams', $memberParams);
2479 //update membership record to Deceased if contact is deceased
2480 if ($dao->is_deceased
) {
2481 // check for 'Deceased' membership status, CRM-5636
2482 $deceaseStatusId = array_search('Deceased', $allStatus);
2483 if (!$deceaseStatusId) {
2484 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'))));
2487 //process only when status change.
2488 if ($dao->status_id
!= $deceaseStatusId) {
2489 //take all params that need to save.
2490 $deceasedMembership = $memberParams;
2491 $deceasedMembership['status_id'] = $deceaseStatusId;
2492 $deceasedMembership['createActivity'] = TRUE;
2493 $deceasedMembership['version'] = 3;
2495 //since there is change in status.
2496 $statusChange = array('status_id' => $deceaseStatusId);
2497 $smarty->append_by_ref('memberParams', $statusChange, TRUE);
2499 $deceasedMembership['contact_id'],
2500 $deceasedMembership['membership_type_id'],
2501 $deceasedMembership['membership_type'],
2502 $deceasedMembership['join_date'],
2503 $deceasedMembership['start_date'],
2504 $deceasedMembership['end_date'],
2505 $deceasedMembership['source']
2508 //process membership record.
2509 civicrm_api('membership', 'create', $deceasedMembership);
2514 //we fetch related, since we need to check for deceased
2515 //now further processing is handle w/ main membership record.
2516 if ($dao->owner_membership_id
) {
2520 //update membership records where status is NOT - Pending OR Cancelled.
2521 //as well as membership is not override.
2522 //skipping Expired membership records -> reduced extra processing( kiran )
2523 if (!$dao->is_override
&&
2524 !in_array($dao->status_id
, array(
2525 array_search('Pending', $allStatus),
2529 CRM_Member_PseudoConstant
::membershipStatus(NULL, " name = 'Cancelled' ", 'name', FALSE, TRUE)
2531 array_search('Expired', $allStatus),
2535 // CRM-7248: added excludeIsAdmin param to the following fn call to prevent moving to admin statuses
2536 //get the membership status as per id.
2537 $newStatus = civicrm_api('membership_status', 'calc',
2539 'membership_id' => $dao->membership_id
,
2541 'ignore_admin_only' => FALSE,
2544 $statusId = CRM_Utils_Array
::value('id', $newStatus);
2546 //process only when status change.
2548 $statusId != $dao->status_id
2550 //take all params that need to save.
2551 $memParams = $memberParams;
2552 $memParams['status_id'] = $statusId;
2553 $memParams['createActivity'] = TRUE;
2554 $memParams['version'] = 3;
2556 // Unset columns which should remain unchanged from their current saved
2557 // values. This avoids race condition in which these values may have
2558 // been changed by other processes.
2560 $memParams['contact_id'],
2561 $memParams['membership_type_id'],
2562 $memParams['membership_type'],
2563 $memParams['join_date'],
2564 $memParams['start_date'],
2565 $memParams['end_date'],
2566 $memParams['source']
2568 //since there is change in status.
2569 $statusChange = array('status_id' => $statusId);
2570 $smarty->append_by_ref('memberParams', $statusChange, TRUE);
2572 //process member record.
2573 civicrm_api('membership', 'create', $memParams);
2578 $result['is_error'] = 0;
2579 $result['messages'] = ts('Processed %1 membership records. Updated %2 records.', array(
2587 * Returns the membership types for a particular contact
2588 * who has lifetime membership without end date.
2590 * @param int $contactID
2591 * @param bool $isTest
2592 * @param bool $onlyLifeTime
2596 public static function getAllContactMembership($contactID, $isTest = FALSE, $onlyLifeTime = FALSE) {
2597 $contactMembershipType = array();
2599 return $contactMembershipType;
2602 $dao = new CRM_Member_DAO_Membership();
2603 $dao->contact_id
= $contactID;
2604 $pendingStatusId = array_search('Pending', CRM_Member_PseudoConstant
::membershipStatus());
2605 $dao->whereAdd("status_id != $pendingStatusId");
2608 $dao->is_test
= $isTest;
2611 $dao->whereAdd('is_test IS NULL OR is_test = 0');
2614 if ($onlyLifeTime) {
2615 $dao->whereAdd('end_date IS NULL');
2619 while ($dao->fetch()) {
2620 $membership = array();
2621 CRM_Core_DAO
::storeValues($dao, $membership);
2622 $contactMembershipType[$dao->membership_type_id
] = $membership;
2624 return $contactMembershipType;
2628 * Record contribution record associated with membership.
2630 * @param array $params
2631 * Array of submitted params.
2633 * (param in process of being removed - try to use params) array of ids.
2635 * @return CRM_Contribute_BAO_Contribution
2637 public static function recordMembershipContribution(&$params, $ids = array()) {
2638 $membershipId = $params['membership_id'];
2639 $contributionParams = array();
2640 $config = CRM_Core_Config
::singleton();
2641 $contributionParams['currency'] = $config->defaultCurrency
;
2642 $contributionParams['receipt_date'] = (CRM_Utils_Array
::value('receipt_date', $params)) ?
$params['receipt_date'] : 'null';
2643 $contributionParams['source'] = CRM_Utils_Array
::value('contribution_source', $params);
2644 $contributionParams['non_deductible_amount'] = 'null';
2645 $contributionParams['payment_processor'] = CRM_Utils_Array
::value('payment_processor_id', $params);
2646 $contributionSoftParams = CRM_Utils_Array
::value('soft_credit', $params);
2647 $recordContribution = array(
2651 'financial_type_id',
2652 'payment_instrument_id',
2656 'contribution_status_id',
2664 foreach ($recordContribution as $f) {
2665 $contributionParams[$f] = CRM_Utils_Array
::value($f, $params);
2668 // make entry in batch entity batch table
2669 if (!empty($params['batch_id'])) {
2670 $contributionParams['batch_id'] = $params['batch_id'];
2673 if (!empty($params['contribution_contact_id'])) {
2674 // deal with possibility of a different person paying for contribution
2675 $contributionParams['contact_id'] = $params['contribution_contact_id'];
2678 if (!empty($params['processPriceSet']) &&
2679 !empty($params['lineItems'])
2681 $contributionParams['line_item'] = CRM_Utils_Array
::value('lineItems', $params, NULL);
2684 $contribution = CRM_Contribute_BAO_Contribution
::create($contributionParams, $ids);
2686 //CRM-13981, create new soft-credit record as to record payment from different person for this membership
2687 if (!empty($contributionSoftParams)) {
2688 if (!empty($params['batch_id'])) {
2689 foreach ($contributionSoftParams as $contributionSoft) {
2690 $contributionSoft['contribution_id'] = $contribution->id
;
2691 $contributionSoft['currency'] = $contribution->currency
;
2692 CRM_Contribute_BAO_ContributionSoft
::add($contributionSoft);
2696 $contributionSoftParams['contribution_id'] = $contribution->id
;
2697 $contributionSoftParams['currency'] = $contribution->currency
;
2698 $contributionSoftParams['amount'] = $contribution->total_amount
;
2699 CRM_Contribute_BAO_ContributionSoft
::add($contributionSoftParams);
2703 // store contribution id
2704 $params['contribution_id'] = $contribution->id
;
2706 //insert payment record for this membership
2707 if (empty($ids['contribution']) ||
!empty($params['is_recur'])) {
2708 CRM_Member_BAO_MembershipPayment
::create(array(
2709 'membership_id' => $membershipId,
2710 'contribution_id' => $contribution->id
,
2713 return $contribution;
2717 * Record line items for default membership.
2719 * @param CRM_Core_Form $qf
2720 * @param array $membershipType
2721 * Array with membership type and organization.
2723 * @return int $priceSetId
2725 public static function createLineItems(&$qf, $membershipType) {
2726 $qf->_priceSetId
= $priceSetId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', 'default_membership_type_amount', 'id', 'name');
2727 $qf->_priceSet
= $priceSets = current(CRM_Price_BAO_PriceSet
::getSetDetail($priceSetId));
2729 // The name of the price field corresponds to the membership_type organization contact.
2730 $editedFieldParams = array(
2731 'price_set_id' => $priceSetId,
2732 'name' => $membershipType[0],
2734 $editedResults = array();
2735 CRM_Price_BAO_PriceField
::retrieve($editedFieldParams, $editedResults);
2737 if (!empty($editedResults)) {
2738 unset($qf->_priceSet
['fields']);
2739 $qf->_priceSet
['fields'][$editedResults['id']] = $priceSets['fields'][$editedResults['id']];
2740 unset($qf->_priceSet
['fields'][$editedResults['id']]['options']);
2741 $fid = $editedResults['id'];
2742 $editedFieldParams = array(
2743 'price_field_id' => $editedResults['id'],
2744 'membership_type_id' => $membershipType[1],
2746 $editedResults = array();
2747 CRM_Price_BAO_PriceFieldValue
::retrieve($editedFieldParams, $editedResults);
2748 $qf->_priceSet
['fields'][$fid]['options'][$editedResults['id']] = $priceSets['fields'][$fid]['options'][$editedResults['id']];
2749 if (!empty($qf->_params
['total_amount'])) {
2750 $qf->_priceSet
['fields'][$fid]['options'][$editedResults['id']]['amount'] = $qf->_params
['total_amount'];
2754 $fieldID = key($qf->_priceSet
['fields']);
2755 $qf->_params
['price_' . $fieldID] = CRM_Utils_Array
::value('id', $editedResults);
2760 * @todo document me - I seem a bit out of date....
2762 public static function _getActTypes() {
2763 $activityTypes = CRM_Core_PseudoConstant
::activityType(TRUE, FALSE, FALSE, 'name');
2764 self
::$_renewalActType = CRM_Utils_Array
::key('Membership Renewal', $activityTypes);
2765 self
::$_signupActType = CRM_Utils_Array
::key('Membership Signup', $activityTypes);
2769 * Get all Cancelled Membership(s) for a contact
2771 * @param int $contactID
2773 * @param bool $isTest
2777 * Array of membership type
2779 public static function getContactsCancelledMembership($contactID, $isTest = FALSE) {
2783 $query = 'SELECT membership_type_id FROM civicrm_membership WHERE contact_id = %1 AND status_id = %2 AND is_test = %3';
2784 $queryParams = array(
2785 1 => array($contactID, 'Integer'),
2790 CRM_Member_PseudoConstant
::membershipStatus(
2792 " name = 'Cancelled' ",
2800 3 => array($isTest, 'Boolean'),
2803 $dao = CRM_Core_DAO
::executeQuery($query, $queryParams);
2804 $cancelledMembershipIds = array();
2805 while ($dao->fetch()) {
2806 $cancelledMembershipIds[] = $dao->membership_type_id
;
2808 return $cancelledMembershipIds;