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
35 class CRM_Member_Page_Tab
extends CRM_Core_Page
{
38 * The action links that we need to display for the browse screen.
42 static $_links = NULL;
43 static $_membershipTypesLinks = NULL;
45 public $_permission = NULL;
46 public $_contactId = NULL;
49 * called when action is browse.
51 public function browse() {
52 $links = self
::links('all', $this->_isPaymentProcessor
, $this->_accessContribution
);
53 CRM_Financial_BAO_FinancialType
::getAvailableMembershipTypes($membershipTypes);
54 $addWhere = "membership_type_id IN (0)";
55 if (!empty($membershipTypes)) {
56 $addWhere = "membership_type_id IN (" . implode(',', array_keys($membershipTypes)) . ")";
59 $membership = array();
60 $dao = new CRM_Member_DAO_Membership();
61 $dao->contact_id
= $this->_contactId
;
62 $dao->whereAdd($addWhere);
65 //CRM--4418, check for view, edit, delete
66 $permissions = array(CRM_Core_Permission
::VIEW
);
67 if (CRM_Core_Permission
::check('edit memberships')) {
68 $permissions[] = CRM_Core_Permission
::EDIT
;
70 if (CRM_Core_Permission
::check('delete in CiviMember')) {
71 $permissions[] = CRM_Core_Permission
::DELETE
;
73 $mask = CRM_Core_Action
::mask($permissions);
75 // get deceased status id
76 $allStatus = CRM_Member_PseudoConstant
::membershipStatus();
77 $deceasedStatusId = array_search('Deceased', $allStatus);
80 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
82 //checks membership of contact itself
83 while ($dao->fetch()) {
84 $membership[$dao->id
] = array();
85 CRM_Core_DAO
::storeValues($dao, $membership[$dao->id
]);
88 $membership[$dao->id
]['campaign'] = CRM_Utils_Array
::value($dao->campaign_id
, $allCampaigns);
90 //get the membership status and type values.
91 $statusANDType = CRM_Member_BAO_Membership
::getStatusANDTypeValues($dao->id
);
92 foreach (array('status', 'membership_type') as $fld) {
93 $membership[$dao->id
][$fld] = CRM_Utils_Array
::value($fld, $statusANDType[$dao->id
]);
95 if (!empty($statusANDType[$dao->id
]['is_current_member'])) {
96 $membership[$dao->id
]['active'] = TRUE;
98 if (empty($dao->owner_membership_id
)) {
99 // unset renew and followup link for deceased membership
100 $currentMask = $mask;
101 if ($dao->status_id
== $deceasedStatusId) {
102 $currentMask = $currentMask & ~CRM_Core_Action
::RENEW
& ~CRM_Core_Action
::FOLLOWUP
;
105 $isUpdateBilling = FALSE;
106 // It would be better to determine if there is a recurring contribution &
107 // is so get the entity for the recurring contribution (& skip if not).
108 $paymentObject = CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity(
109 $membership[$dao->id
]['membership_id'], 'membership', 'obj');
110 if (!empty($paymentObject)) {
111 $isUpdateBilling = $paymentObject->supports('updateSubscriptionBillingInfo');
114 // @todo - get this working with syntax style $paymentObject->supports(array
115 //('CancelSubscriptionSupported'));
116 $isCancelSupported = CRM_Member_BAO_Membership
::isCancelSubscriptionSupported(
117 $membership[$dao->id
]['membership_id']);
118 $links = self
::links('all',
124 self
::getPermissionedLinks($dao->membership_type_id
, $links);
125 $membership[$dao->id
]['action'] = CRM_Core_Action
::formLink($links,
129 'cid' => $this->_contactId
,
133 'membership.tab.row',
139 $links = self
::links('view');
140 self
::getPermissionedLinks($dao->membership_type_id
, $links);
141 $membership[$dao->id
]['action'] = CRM_Core_Action
::formLink($links,
145 'cid' => $this->_contactId
,
149 'membership.tab.row',
155 // Display Auto-renew status on page (0=disabled, 1=enabled, 2=enabled, but error
156 if (!empty($membership[$dao->id
]['contribution_recur_id'])) {
157 if (CRM_Member_BAO_Membership
::isSubscriptionCancelled($membership[$dao->id
]['membership_id'])) {
158 $membership[$dao->id
]['auto_renew'] = 2;
161 $membership[$dao->id
]['auto_renew'] = 1;
165 $membership[$dao->id
]['auto_renew'] = 0;
168 // if relevant--membership is active and type allows inheritance--count related memberships
169 if (CRM_Utils_Array
::value('is_current_member', $statusANDType[$dao->id
])
170 && CRM_Utils_Array
::value('relationship_type_id', $statusANDType[$dao->id
])
171 && empty($dao->owner_membership_id
)
173 // not an related membership
176 FROM civicrm_membership m
177 LEFT JOIN civicrm_membership_status ms ON ms.id = m.status_id
178 LEFT JOIN civicrm_contact ct ON ct.id = m.contact_id
179 WHERE m.owner_membership_id = {$dao->id} AND m.is_test = 0 AND ms.is_current_member = 1 AND ct.is_deleted = 0";
180 $num_related = CRM_Core_DAO
::singleValueQuery($query);
181 $max_related = CRM_Utils_Array
::value('max_related', $membership[$dao->id
]);
182 $membership[$dao->id
]['related_count'] = ($max_related == '' ?
ts('%1 created', array(1 => $num_related)) : ts('%1 out of %2', array(
188 $membership[$dao->id
]['related_count'] = ts('N/A');
192 //Below code gives list of all Membership Types associated
193 //with an Organization(CRM-2016)
194 $membershipTypesResult = civicrm_api3('MembershipType', 'get', array(
195 'member_of_contact_id' => $this->_contactId
,
200 $membershipTypes = CRM_Utils_Array
::value('values', $membershipTypesResult, NULL);
202 foreach ($membershipTypes as $key => $value) {
203 $membershipTypes[$key]['action'] = CRM_Core_Action
::formLink(self
::membershipTypeslinks(),
206 'id' => $value['id'],
207 'cid' => $this->_contactId
,
211 'membershipType.organization.action',
217 $activeMembers = CRM_Member_BAO_Membership
::activeMembers($membership);
218 $inActiveMembers = CRM_Member_BAO_Membership
::activeMembers($membership, 'inactive');
219 $this->assign('activeMembers', $activeMembers);
220 $this->assign('inActiveMembers', $inActiveMembers);
221 $this->assign('membershipTypes', $membershipTypes);
223 if ($this->_contactId
) {
224 $displayName = CRM_Contact_BAO_Contact
::displayName($this->_contactId
);
225 $this->assign('displayName', $displayName);
226 $this->ajaxResponse
['tabCount'] = CRM_Contact_BAO_Contact
::getCountComponent('membership', $this->_contactId
);
227 // Refresh other tabs with related data
228 $this->ajaxResponse
['updateTabs'] = array(
229 '#tab_activity' => CRM_Contact_BAO_Contact
::getCountComponent('activity', $this->_contactId
),
230 '#tab_rel' => CRM_Contact_BAO_Contact
::getCountComponent('rel', $this->_contactId
),
232 if (CRM_Core_Permission
::access('CiviContribute')) {
233 $this->ajaxResponse
['updateTabs']['#tab_contribute'] = CRM_Contact_BAO_Contact
::getCountComponent('contribution', $this->_contactId
);
239 * called when action is view.
243 public function view() {
244 $controller = new CRM_Core_Controller_Simple(
245 'CRM_Member_Form_MembershipView',
246 ts('View Membership'),
249 $controller->setEmbedded(TRUE);
250 $controller->set('id', $this->_id
);
251 $controller->set('cid', $this->_contactId
);
253 return $controller->run();
257 * called when action is update or new.
261 public function edit() {
262 // set https for offline cc transaction
263 $mode = CRM_Utils_Request
::retrieve('mode', 'Alphanumeric', $this);
264 if ($mode == 'test' ||
$mode == 'live') {
265 CRM_Utils_System
::redirectToSSL();
268 // build associated contributions ( note: this is called to show associated contributions in edit mode )
269 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
270 $this->assign('accessContribution', FALSE);
271 if (CRM_Core_Permission
::access('CiviContribute')) {
272 $this->assign('accessContribution', TRUE);
273 CRM_Member_Page_Tab
::associatedContribution($this->_contactId
, $this->_id
);
275 //show associated soft credit when contribution payment is paid by different person in edit mode
276 if ($this->_id
&& $this->_contactId
) {
277 $filter = " AND cc.id IN (SELECT contribution_id FROM civicrm_membership_payment WHERE membership_id = {$this->_id})";
278 $softCreditList = CRM_Contribute_BAO_ContributionSoft
::getSoftContributionList($this->_contactId
, $filter);
279 if (!empty($softCreditList)) {
280 $this->assign('softCredit', TRUE);
281 $this->assign('softCreditRows', $softCreditList);
287 if ($this->_action
& CRM_Core_Action
::RENEW
) {
288 $path = 'CRM_Member_Form_MembershipRenewal';
289 $title = ts('Renew Membership');
292 $path = 'CRM_Member_Form_Membership';
293 $title = ts('Create Membership');
296 $controller = new CRM_Core_Controller_Simple($path, $title, $this->_action
);
297 $controller->setEmbedded(TRUE);
298 $controller->set('BAOName', $this->getBAOName());
299 $controller->set('id', $this->_id
);
300 $controller->set('cid', $this->_contactId
);
301 return $controller->run();
304 public function preProcess() {
305 $context = CRM_Utils_Request
::retrieve('context', 'Alphanumeric', $this);
306 $this->_action
= CRM_Utils_Request
::retrieve('action', 'String', $this, FALSE, 'browse');
307 $this->_id
= CRM_Utils_Request
::retrieve('id', 'Positive', $this);
309 if ($context == 'standalone') {
310 $this->_action
= CRM_Core_Action
::ADD
;
313 $this->_contactId
= CRM_Utils_Request
::retrieve('cid', 'Positive', $this, TRUE);
314 $this->assign('contactId', $this->_contactId
);
316 // check logged in url permission
317 CRM_Contact_Page_View
::checkUserPermission($this);
320 $this->assign('action', $this->_action
);
322 if ($this->_permission
== CRM_Core_Permission
::EDIT
&& !CRM_Core_Permission
::check('edit memberships')) {
323 // demote to view since user does not have edit membership rights
324 $this->_permission
= CRM_Core_Permission
::VIEW
;
325 $this->assign('permission', 'view');
330 * the main function that is called when the page loads, it decides the which action has to be taken for the page.
334 public function run() {
337 // check if we can process credit card membership
338 $newCredit = CRM_Core_Config
::isEnabledBackOfficeCreditCardPayments();
339 $this->assign('newCredit', $newCredit);
342 $this->_isPaymentProcessor
= TRUE;
345 $this->_isPaymentProcessor
= FALSE;
348 // Only show credit card membership signup if user has CiviContribute permission
349 if (CRM_Core_Permission
::access('CiviContribute')) {
350 $this->_accessContribution
= TRUE;
351 $this->assign('accessContribution', TRUE);
353 //show associated soft credit when contribution payment is paid by different person
354 if ($this->_id
&& $this->_contactId
) {
355 $filter = " AND cc.id IN (SELECT contribution_id FROM civicrm_membership_payment WHERE membership_id = {$this->_id})";
356 $softCreditList = CRM_Contribute_BAO_ContributionSoft
::getSoftContributionList($this->_contactId
, $filter);
357 if (!empty($softCreditList)) {
358 $this->assign('softCredit', TRUE);
359 $this->assign('softCreditRows', $softCreditList);
364 $this->_accessContribution
= FALSE;
365 $this->assign('accessContribution', FALSE);
366 $this->assign('softCredit', FALSE);
369 if ($this->_action
& CRM_Core_Action
::VIEW
) {
372 elseif ($this->_action
& (CRM_Core_Action
::UPDATE | CRM_Core_Action
::ADD | CRM_Core_Action
::DELETE | CRM_Core_Action
::RENEW
)) {
373 self
::setContext($this);
377 self
::setContext($this);
381 return parent
::run();
385 * @param CRM_Core_Form $form
386 * @param int $contactId
388 public static function setContext(&$form, $contactId = NULL) {
389 $context = CRM_Utils_Request
::retrieve('context', 'Alphanumeric', $form, FALSE, 'search');
391 $qfKey = CRM_Utils_Request
::retrieve('key', 'String', $form);
393 $searchContext = CRM_Utils_Request
::retrieve('searchContext', 'String', $form);
396 if (!CRM_Utils_Rule
::qfKey($qfKey)) {
401 $contactId = $form->_contactId
;
406 $url = CRM_Utils_System
::url('civicrm/member', 'reset=1');
410 $url = CRM_Utils_System
::url('civicrm/contact/view', "reset=1&force=1&cid={$contactId}&selectedChild=member");
414 $urlParams = 'force=1';
416 $urlParams .= "&qfKey=$qfKey";
418 $form->assign('searchKey', $qfKey);
420 if ($searchContext) {
421 $url = CRM_Utils_System
::url("civicrm/$searchContext/search", $urlParams);
424 $url = CRM_Utils_System
::url('civicrm/member/search', $urlParams);
429 $url = CRM_Utils_System
::url('civicrm/dashboard', 'reset=1');
433 $url = CRM_Utils_System
::url('civicrm/contact/view',
434 "reset=1&force=1&cid={$contactId}&selectedChild=activity"
439 $url = CRM_Utils_System
::url('civicrm/dashboard', 'reset=1');
443 $action = CRM_Utils_Request
::retrieve('action', 'String', $form);
445 $urlParams = 'force=1';
446 $urlString = 'civicrm/contact/search/custom';
447 if ($action == CRM_Core_Action
::UPDATE
) {
448 if ($form->_contactId
) {
449 $urlParams .= '&cid=' . $form->_contactId
;
452 $urlParams .= '&context=fulltext&action=view';
453 $urlString = 'civicrm/contact/view/membership';
456 $urlParams .= "$keyName=$qfKey";
458 $form->assign('searchKey', $qfKey);
459 $url = CRM_Utils_System
::url($urlString, $urlParams);
465 $cid = '&cid=' . $contactId;
467 $url = CRM_Utils_System
::url('civicrm/member/search', 'force=1' . $cid);
471 $session = CRM_Core_Session
::singleton();
472 $session->pushUserContext($url);
478 * @param string $status
479 * @param null $isPaymentProcessor
480 * @param null $accessContribution
481 * @param bool $isCancelSupported
482 * @param bool $isUpdateBilling
485 * (reference) of action links
487 public static function &links(
489 $isPaymentProcessor = NULL,
490 $accessContribution = NULL,
491 $isCancelSupported = FALSE,
492 $isUpdateBilling = FALSE
494 if (!CRM_Utils_Array
::value('view', self
::$_links)) {
495 self
::$_links['view'] = array(
496 CRM_Core_Action
::VIEW
=> array(
497 'name' => ts('View'),
498 'url' => 'civicrm/contact/view/membership',
499 'qs' => 'action=view&reset=1&cid=%%cid%%&id=%%id%%&context=membership&selectedChild=member',
500 'title' => ts('View Membership'),
505 if (!CRM_Utils_Array
::value('all', self
::$_links)) {
507 CRM_Core_Action
::UPDATE
=> array(
508 'name' => ts('Edit'),
509 'url' => 'civicrm/contact/view/membership',
510 'qs' => 'action=update&reset=1&cid=%%cid%%&id=%%id%%&context=membership&selectedChild=member',
511 'title' => ts('Edit Membership'),
513 CRM_Core_Action
::RENEW
=> array(
514 'name' => ts('Renew'),
515 'url' => 'civicrm/contact/view/membership',
516 'qs' => 'action=renew&reset=1&cid=%%cid%%&id=%%id%%&context=membership&selectedChild=member',
517 'title' => ts('Renew Membership'),
519 CRM_Core_Action
::FOLLOWUP
=> array(
520 'name' => ts('Renew-Credit Card'),
521 'url' => 'civicrm/contact/view/membership',
522 'qs' => 'action=renew&reset=1&cid=%%cid%%&id=%%id%%&context=membership&selectedChild=member&mode=live',
523 'title' => ts('Renew Membership Using Credit Card'),
525 CRM_Core_Action
::DELETE
=> array(
526 'name' => ts('Delete'),
527 'url' => 'civicrm/contact/view/membership',
528 'qs' => 'action=delete&reset=1&cid=%%cid%%&id=%%id%%&context=membership&selectedChild=member',
529 'title' => ts('Delete Membership'),
532 if (!$isPaymentProcessor ||
!$accessContribution) {
533 //unset the renew with credit card when payment
534 //processor is not available or user is not permitted to create contributions
535 unset($extraLinks[CRM_Core_Action
::FOLLOWUP
]);
537 self
::$_links['all'] = self
::$_links['view'] +
$extraLinks;
540 if ($isCancelSupported) {
541 $cancelMessage = ts('WARNING: If you cancel the recurring contribution associated with this membership, the membership will no longer be renewed automatically. However, the current membership status will not be affected.');
542 self
::$_links['all'][CRM_Core_Action
::DISABLE
] = array(
543 'name' => ts('Cancel Auto-renewal'),
544 'url' => 'civicrm/contribute/unsubscribe',
545 'qs' => 'reset=1&cid=%%cid%%&mid=%%id%%&context=membership&selectedChild=member',
546 'title' => ts('Cancel Auto Renew Subscription'),
547 'extra' => 'onclick = "if (confirm(\'' . $cancelMessage . '\') ) { return true; else return false;}"',
550 elseif (isset(self
::$_links['all'][CRM_Core_Action
::DISABLE
])) {
551 unset(self
::$_links['all'][CRM_Core_Action
::DISABLE
]);
554 if ($isUpdateBilling) {
555 self
::$_links['all'][CRM_Core_Action
::MAP
] = array(
556 'name' => ts('Change Billing Details'),
557 'url' => 'civicrm/contribute/updatebilling',
558 'qs' => 'reset=1&cid=%%cid%%&mid=%%id%%&context=membership&selectedChild=member',
559 'title' => ts('Change Billing Details'),
562 elseif (isset(self
::$_links['all'][CRM_Core_Action
::MAP
])) {
563 unset(self
::$_links['all'][CRM_Core_Action
::MAP
]);
565 return self
::$_links[$status];
569 * Define action links for membership types of related organization.
572 * self::$_membershipTypesLinks array of action links
574 public static function &membershipTypesLinks() {
575 if (!self
::$_membershipTypesLinks) {
576 self
::$_membershipTypesLinks = array(
577 CRM_Core_Action
::VIEW
=> array(
578 'name' => ts('Members'),
579 'url' => 'civicrm/member/search/',
580 'qs' => 'reset=1&force=1&type=%%id%%',
581 'title' => ts('Search'),
583 CRM_Core_Action
::UPDATE
=> array(
584 'name' => ts('Edit'),
585 'url' => 'civicrm/admin/member/membershipType',
586 'qs' => 'action=update&id=%%id%%&reset=1',
587 'title' => ts('Edit Membership Type'),
591 return self
::$_membershipTypesLinks;
595 * used for the to show the associated.
596 * contribution for the membership
598 * @param int $contactId
599 * @param int $membershipId
601 public static function associatedContribution($contactId = NULL, $membershipId = NULL) {
602 $controller = new CRM_Core_Controller_Simple(
603 'CRM_Contribute_Form_Search',
608 $controller->setEmbedded(TRUE);
609 $controller->reset();
610 $controller->set('force', 1);
611 $controller->set('cid', $contactId);
612 $controller->set('memberId', $membershipId);
613 $controller->set('context', 'contribution');
614 $controller->process();
624 public function getBAOName() {
625 return 'CRM_Member_BAO_Membership';
629 * Get a list of links based on permissioned FTs.
631 * @param int $memTypeID
634 * (reference ) action links
636 public static function getPermissionedLinks($memTypeID, &$links) {
637 if (!CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()) {
640 $finTypeId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $memTypeID, 'financial_type_id');
641 $finType = CRM_Contribute_PseudoConstant
::financialType($finTypeId);
642 if (!CRM_Core_Permission
::check('edit contributions of type ' . $finType)) {
643 unset($links[CRM_Core_Action
::UPDATE
]);
644 unset($links[CRM_Core_Action
::RENEW
]);
645 unset($links[CRM_Core_Action
::FOLLOWUP
]);
647 if (!CRM_Core_Permission
::check('delete contributions of type ' . $finType)) {
648 unset($links[CRM_Core_Action
::DELETE
]);