CRM/Member/Page/Tab.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2013
  32  * $Id$
  33  *
  34  */
  35 class CRM_Member_Page_Tab extends CRM_Core_Page {
  36
  37   /**
  38    * The action links that we need to display for the browse screen
  39    *
  40    * @var array
  41    * @static
  42    */
  43   static $_links = NULL;
  44   static $_membershipTypesLinks = NULL;
  45
  46   public $_permission = NULL;
  47   public $_contactId = NULL;
  48
  49   /**
  50    * This function is called when action is browse
  51    *
  52    * return null
  53    * @access public
  54    */
  55   function browse() {
  56     $links = self::links('all', $this->_isPaymentProcessor, $this->_accessContribution);
  57
  58     $membership = array();
  59     $dao = new CRM_Member_DAO_Membership();
  60     $dao->contact_id = $this->_contactId;
  61     $dao->is_test = 0;
  62     //$dao->orderBy('name');
  63     $dao->find();
  64
  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;
  69     }
  70     if (CRM_Core_Permission::check('delete in CiviMember')) {
  71       $permissions[] = CRM_Core_Permission::DELETE;
  72     }
  73     $mask = CRM_Core_Action::mask($permissions);
  74
  75     // get deceased status id
  76     $allStatus = CRM_Member_PseudoConstant::membershipStatus();
  77     $deceasedStatusId = array_search('Deceased', $allStatus);
  78
  79     //get all campaigns.
  80     $allCampaigns = CRM_Campaign_BAO_Campaign::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
  81
  82     //checks membership of contact itself
  83     while ($dao->fetch()) {
  84       $membership[$dao->id] = array();
  85       CRM_Core_DAO::storeValues($dao, $membership[$dao->id]);
  86
  87       //carry campaign.
  88       $membership[$dao->id]['campaign'] = CRM_Utils_Array::value($dao->campaign_id, $allCampaigns);
  89
  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]);
  94       }
  95       if (CRM_Utils_Array::value('is_current_member', $statusANDType[$dao->id])) {
  96         $membership[$dao->id]['active'] = TRUE;
  97       }
  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;
 103         }
 104
 105         $isUpdateBilling = FALSE;
 106         $paymentObject = CRM_Financial_BAO_PaymentProcessor::getProcessorForEntity(
 107           $membership[$dao->id]['membership_id'], 'membership', 'obj');
 108         if (!empty($paymentObject)) {
 109           $isUpdateBilling = $paymentObject->isSupported('updateSubscriptionBillingInfo');
 110         }
 111
 112         $isCancelSupported = CRM_Member_BAO_Membership::isCancelSubscriptionSupported(
 113           $membership[$dao->id]['membership_id']);
 114
 115         $membership[$dao->id]['action'] = CRM_Core_Action::formLink(self::links('all',
 116             NULL,
 117             NULL,
 118             $isCancelSupported,
 119             $isUpdateBilling
 120           ),
 121           $currentMask,
 122           array(
 123             'id' => $dao->id,
 124             'cid' => $this->_contactId,
 125           ),
 126           ts('more'),
 127           FALSE,
 128           'membership.tab.row',
 129           'Membership',
 130           $dao->id
 131         );
 132       }
 133       else {
 134         $membership[$dao->id]['action'] = CRM_Core_Action::formLink(self::links('view'),
 135           $mask,
 136           array(
 137             'id' => $dao->id,
 138             'cid' => $this->_contactId,
 139           ),
 140           ts('more'),
 141           FALSE,
 142           'membership.tab.row',
 143           'Membership',
 144           $dao->id
 145         );
 146       }
 147
 148       //does membership have auto renew CRM-7137.
 149       if (CRM_Utils_Array::value('contribution_recur_id', $membership[$dao->id]) &&
 150         !CRM_Member_BAO_Membership::isSubscriptionCancelled($membership[$dao->id]['membership_id'])
 151       ) {
 152         $membership[$dao->id]['auto_renew'] = 1;
 153       }
 154       else {
 155         $membership[$dao->id]['auto_renew'] = 0;
 156       }
 157
 158       // if relevant, count related memberships
 159       if (CRM_Utils_Array::value('is_current_member', $statusANDType[$dao->id]) // membership is active
 160         && CRM_Utils_Array::value('relationship_type_id', $statusANDType[$dao->id]) // membership type allows inheritance
 161         && empty($dao->owner_membership_id)
 162       ) { // not an related membership
 163         $query = "
 164  SELECT COUNT(m.id)
 165    FROM civicrm_membership m
 166      LEFT JOIN civicrm_membership_status ms ON ms.id = m.status_id
 167      LEFT JOIN civicrm_contact ct ON ct.id = m.contact_id
 168   WHERE m.owner_membership_id = {$dao->id} AND m.is_test = 0 AND ms.is_current_member = 1 AND ct.is_deleted = 0";
 169         $num_related = CRM_Core_DAO::singleValueQuery($query);
 170         $max_related = CRM_Utils_Array::value('max_related', $membership[$dao->id]);
 171         $membership[$dao->id]['related_count'] = ($max_related == '' ?
 172           ts('%1 created', array(1 => $num_related)) :
 173           ts('%1 out of %2', array(1 => $num_related, 2 => $max_related))
 174         );
 175       }
 176       else {
 177         $membership[$dao->id]['related_count'] = ts('N/A');
 178       }
 179     }
 180
 181     //Below code gives list of all Membership Types associated
 182     //with an Organization(CRM-2016)
 183     $membershipTypes = CRM_Member_BAO_MembershipType::getMembershipTypesByOrg($this->_contactId);
 184     foreach ($membershipTypes as $key => $value) {
 185       $membershipTypes[$key]['action'] = CRM_Core_Action::formLink(self::membershipTypeslinks(),
 186         $mask,
 187         array(
 188           'id' => $value['id'],
 189           'cid' => $this->_contactId,
 190         ),
 191         ts('more'),
 192         FALSE,
 193         'membershipType.organization.action',
 194         'MembershipType',
 195         $value['id']
 196       );
 197     }
 198
 199     $activeMembers = CRM_Member_BAO_Membership::activeMembers($membership);
 200     $inActiveMembers = CRM_Member_BAO_Membership::activeMembers($membership, 'inactive');
 201     $this->assign('activeMembers', $activeMembers);
 202     $this->assign('inActiveMembers', $inActiveMembers);
 203     $this->assign('membershipTypes', $membershipTypes);
 204
 205     if ($this->_contactId) {
 206       $displayName = CRM_Contact_BAO_Contact::displayName($this->_contactId);
 207       $this->assign('displayName', $displayName);
 208     }
 209   }
 210
 211   /**
 212    * This function is called when action is view
 213    *
 214    * return null
 215    * @access public
 216    */
 217   function view() {
 218     $controller = new CRM_Core_Controller_Simple(
 219       'CRM_Member_Form_MembershipView',
 220       ts('View Membership'),
 221       $this->_action
 222     );
 223     $controller->setEmbedded(TRUE);
 224     $controller->set('id', $this->_id);
 225     $controller->set('cid', $this->_contactId);
 226
 227     return $controller->run();
 228   }
 229
 230   /**
 231    * This function is called when action is update or new
 232    *
 233    * return null
 234    * @access public
 235    */
 236   function edit() {
 237     // set https for offline cc transaction
 238     $mode = CRM_Utils_Request::retrieve('mode', 'String', $this);
 239     if ($mode == 'test' || $mode == 'live') {
 240       CRM_Utils_System::redirectToSSL();
 241     }
 242
 243     // build associated contributions ( note: this is called to show associated contributions in edit mode )
 244     if ($this->_action & CRM_Core_Action::UPDATE) {
 245       $this->assign('accessContribution', FALSE);
 246       if (CRM_Core_Permission::access('CiviContribute')) {
 247         $this->assign('accessContribution', TRUE);
 248         CRM_Member_Page_Tab::associatedContribution($this->_contactId, $this->_id);
 249       }
 250     }
 251
 252     if ($this->_action & CRM_Core_Action::RENEW) {
 253       $path = 'CRM_Member_Form_MembershipRenewal';
 254       $title = ts('Renew Membership');
 255     }
 256     else {
 257       $path = 'CRM_Member_Form_Membership';
 258       $title = ts('Create Membership');
 259     }
 260
 261     $controller = new CRM_Core_Controller_Simple($path, $title, $this->_action);
 262     $controller->setEmbedded(TRUE);
 263     $controller->set('BAOName', $this->getBAOName());
 264     $controller->set('id', $this->_id);
 265     $controller->set('cid', $this->_contactId);
 266     return $controller->run();
 267   }
 268
 269   function preProcess() {
 270     $context = CRM_Utils_Request::retrieve('context', 'String', $this);
 271     $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'browse');
 272     $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this);
 273
 274     if ($context == 'standalone') {
 275       $this->_action = CRM_Core_Action::ADD;
 276     }
 277     else {
 278       $this->_contactId = CRM_Utils_Request::retrieve('cid', 'Positive', $this, TRUE);
 279       $this->assign('contactId', $this->_contactId);
 280
 281       // check logged in url permission
 282       CRM_Contact_Page_View::checkUserPermission($this);
 283
 284       // set page title
 285       CRM_Contact_Page_View::setTitle($this->_contactId);
 286     }
 287
 288     $this->assign('action', $this->_action);
 289
 290     if ($this->_permission == CRM_Core_Permission::EDIT && !CRM_Core_Permission::check('edit memberships')) {
 291       // demote to view since user does not have edit membership rights
 292       $this->_permission = CRM_Core_Permission::VIEW;
 293       $this->assign('permission', 'view');
 294     }
 295   }
 296
 297   /**
 298    * This function is the main function that is called when the page loads, it decides the which action has to be taken for the page.
 299    *
 300    * return null
 301    * @access public
 302    */
 303   function run() {
 304     $this->preProcess();
 305
 306     // check if we can process credit card membership
 307     $newCredit = CRM_Core_Payment::allowBackofficeCreditCard($this);
 308     if ($newCredit) {
 309       $this->_isPaymentProcessor = TRUE;
 310     }
 311     else {
 312       $this->_isPaymentProcessor = FALSE;
 313     }
 314
 315     // Only show credit card membership signup if user has CiviContribute permission
 316     if (CRM_Core_Permission::access('CiviContribute')) {
 317       $this->_accessContribution = TRUE;
 318       $this->assign('accessContribution', TRUE);
 319     }
 320     else {
 321       $this->_accessContribution = FALSE;
 322       $this->assign('accessContribution', FALSE);
 323     }
 324
 325     if ($this->_action & CRM_Core_Action::VIEW) {
 326       $this->view();
 327     }
 328     elseif ($this->_action & (CRM_Core_Action::UPDATE | CRM_Core_Action::ADD | CRM_Core_Action::DELETE
 329         | CRM_Core_Action::RENEW)) {
 330       self::setContext($this);
 331       $this->edit();
 332     }
 333     else {
 334       self::setContext($this);
 335       $this->browse();
 336     }
 337
 338     return parent::run();
 339   }
 340
 341   public static function setContext(&$form, $contactId = NULL) {
 342     $context = CRM_Utils_Request::retrieve('context', 'String', $form, FALSE, 'search' );
 343
 344     $qfKey = CRM_Utils_Request::retrieve('key', 'String', $form);
 345     //validate the qfKey
 346     if (!CRM_Utils_Rule::qfKey($qfKey)) {
 347       $qfKey = NULL;
 348     }
 349
 350     if (!$contactId) {
 351       $contactId = $form->_contactId;
 352     }
 353
 354     switch ($context) {
 355       case 'dashboard':
 356         $url = CRM_Utils_System::url('civicrm/member', 'reset=1');
 357         break;
 358
 359       case 'membership':
 360         $url = CRM_Utils_System::url('civicrm/contact/view', "reset=1&force=1&cid={$contactId}&selectedChild=member");
 361         break;
 362
 363       case 'search':
 364         $urlParams = 'force=1';
 365         if ($qfKey) {
 366           $urlParams .= "&qfKey=$qfKey";
 367         }
 368         $form->assign('searchKey', $qfKey);
 369
 370         $url = CRM_Utils_System::url('civicrm/member/search', $urlParams);
 371         break;
 372
 373       case 'home':
 374         $url = CRM_Utils_System::url('civicrm/dashboard', 'reset=1');
 375         break;
 376
 377       case 'activity':
 378         $url = CRM_Utils_System::url('civicrm/contact/view',
 379           "reset=1&force=1&cid={$contactId}&selectedChild=activity"
 380         );
 381         break;
 382
 383       case 'standalone':
 384         $url = CRM_Utils_System::url('civicrm/dashboard', 'reset=1');
 385         break;
 386
 387       case 'fulltext':
 388         $action = CRM_Utils_Request::retrieve('action', 'String', $form);
 389         $keyName = '&qfKey';
 390         $urlParams = 'force=1';
 391         $urlString = 'civicrm/contact/search/custom';
 392         if ($action == CRM_Core_Action::UPDATE) {
 393           if ($form->_contactId) {
 394             $urlParams .= '&cid=' . $this->_contactId;
 395           }
 396           $keyName = '&key';
 397           $urlParams .= '&context=fulltext&action=view';
 398           $urlString = 'civicrm/contact/view/membership';
 399         }
 400         if ($qfKey) {
 401           $urlParams .= "$keyName=$qfKey";
 402         }
 403         $form->assign('searchKey', $qfKey);
 404         $url = CRM_Utils_System::url($urlString, $urlParams);
 405         break;
 406
 407       default:
 408         $cid = NULL;
 409         if ($contactId) {
 410           $cid = '&cid=' . $contactId;
 411         }
 412         $url = CRM_Utils_System::url('civicrm/member/search', 'force=1' . $cid);
 413         break;
 414     }
 415
 416     $session = CRM_Core_Session::singleton();
 417     $session->pushUserContext($url);
 418   }
 419
 420   /**
 421    * Get action links
 422    *
 423    * @return array (reference) of action links
 424    * @static
 425    */
 426   static function &links($status = 'all',
 427                          $isPaymentProcessor = NULL,
 428                          $accessContribution = NULL,
 429                          $isCancelSupported = FALSE,
 430                          $isUpdateBilling = FALSE
 431   ) {
 432     if (!CRM_Utils_Array::value('view', self::$_links)) {
 433       self::$_links['view'] = array(
 434         CRM_Core_Action::VIEW => array(
 435           'name' => ts('View'),
 436           'url' => 'civicrm/contact/view/membership',
 437           'qs' => 'action=view&reset=1&cid=%%cid%%&id=%%id%%&context=membership&selectedChild=member',
 438           'title' => ts('View Membership'),
 439         ),
 440       );
 441     }
 442
 443     if (!CRM_Utils_Array::value('all', self::$_links)) {
 444       $extraLinks = array(
 445         CRM_Core_Action::UPDATE => array(
 446           'name' => ts('Edit'),
 447           'url' => 'civicrm/contact/view/membership',
 448           'qs' => 'action=update&reset=1&cid=%%cid%%&id=%%id%%&context=membership&selectedChild=member',
 449           'title' => ts('Edit Membership'),
 450         ),
 451         CRM_Core_Action::RENEW => array(
 452           'name' => ts('Renew'),
 453           'url' => 'civicrm/contact/view/membership',
 454           'qs' => 'action=renew&reset=1&cid=%%cid%%&id=%%id%%&context=membership&selectedChild=member',
 455           'title' => ts('Renew Membership'),
 456         ),
 457         CRM_Core_Action::FOLLOWUP => array(
 458           'name' => ts('Renew-Credit Card'),
 459           'url' => 'civicrm/contact/view/membership',
 460           'qs' => 'action=renew&reset=1&cid=%%cid%%&id=%%id%%&context=membership&selectedChild=member&mode=live',
 461           'title' => ts('Renew Membership Using Credit Card'),
 462         ),
 463         CRM_Core_Action::DELETE => array(
 464           'name' => ts('Delete'),
 465           'url' => 'civicrm/contact/view/membership',
 466           'qs' => 'action=delete&reset=1&cid=%%cid%%&id=%%id%%&context=membership&selectedChild=member',
 467           'title' => ts('Delete Membership'),
 468         ),
 469       );
 470       if (!$isPaymentProcessor || !$accessContribution) {
 471         //unset the renew with credit card when payment
 472         //processor is not available or user is not permitted to create contributions
 473         unset($extraLinks[CRM_Core_Action::FOLLOWUP]);
 474       }
 475       self::$_links['all'] = self::$_links['view'] + $extraLinks;
 476     }
 477
 478
 479     if ($isCancelSupported) {
 480       $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.');
 481       self::$_links['all'][CRM_Core_Action::DISABLE] = array(
 482         'name' => ts('Cancel Auto-renewal'),
 483         'url' => 'civicrm/contribute/unsubscribe',
 484         'qs' => 'reset=1&cid=%%cid%%&mid=%%id%%&context=membership&selectedChild=member',
 485         'title' => ts('Cancel Auto Renew Subscription'),
 486         'extra' => 'onclick = "if (confirm(\'' . $cancelMessage . '\') ) {  return true; else return false;}"',
 487       );
 488     }
 489     elseif (isset(self::$_links['all'][CRM_Core_Action::DISABLE])) {
 490       unset(self::$_links['all'][CRM_Core_Action::DISABLE]);
 491     }
 492
 493     if ($isUpdateBilling) {
 494       self::$_links['all'][CRM_Core_Action::MAP] = array(
 495         'name' => ts('Change Billing Details'),
 496         'url' => 'civicrm/contribute/updatebilling',
 497         'qs' => 'reset=1&cid=%%cid%%&mid=%%id%%&context=membership&selectedChild=member',
 498         'title' => ts('Change Billing Details'),
 499       );
 500     }
 501     elseif (isset(self::$_links['all'][CRM_Core_Action::MAP])) {
 502       unset(self::$_links['all'][CRM_Core_Action::MAP]);
 503     }
 504     return self::$_links[$status];
 505   }
 506
 507   /**
 508    * Function to define action links for membership types of related organization
 509    *
 510    * @return array self::$_membershipTypesLinks array of action links
 511    * @access public
 512    */
 513   static function &membershipTypesLinks() {
 514     if (!self::$_membershipTypesLinks) {
 515       self::$_membershipTypesLinks = array(
 516         CRM_Core_Action::VIEW => array(
 517           'name' => ts('Members'),
 518           'url' => 'civicrm/member/search/',
 519           'qs' => 'reset=1&force=1&type=%%id%%',
 520           'title' => ts('Search'),
 521         ),
 522         CRM_Core_Action::UPDATE => array(
 523           'name' => ts('Edit'),
 524           'url' => 'civicrm/admin/member/membershipType',
 525           'qs' => 'action=update&id=%%id%%&reset=1',
 526           'title' => ts('Edit Membership Type'),
 527         ),
 528       );
 529     }
 530     return self::$_membershipTypesLinks;
 531   }
 532
 533   /**
 534    * This function is used for the to show the associated
 535    * contribution for the membership
 536    * @form array $form (ref.) an assoc array of name/value pairs
 537    * return null
 538    * @access public
 539    */
 540   public static function associatedContribution($contactId = NULL, $membershipId = NULL) {
 541     $controller = new CRM_Core_Controller_Simple(
 542       'CRM_Contribute_Form_Search',
 543       ts('Contributions'),
 544       NULL,
 545       FALSE, FALSE, TRUE
 546     );
 547     $controller->setEmbedded(TRUE);
 548     $controller->reset();
 549     $controller->set('force', 1);
 550     $controller->set('cid', $contactId);
 551     $controller->set('memberId', $membershipId);
 552     $controller->set('context', 'contribution');
 553     $controller->process();
 554     $controller->run();
 555   }
 556
 557   /**
 558    * Get BAO Name
 559    *
 560    * @return string Classname of BAO.
 561    */
 562   function getBAOName() {
 563     return 'CRM_Member_BAO_Membership';
 564   }
 565 }
 566