CRM/Member/Form/MembershipView.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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-2019
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class generates form components for Payment-Instrument
  38  */
  39 class CRM_Member_Form_MembershipView extends CRM_Core_Form {
  40
  41   /**
  42    * The action links that we need to display for the browse screen.
  43    *
  44    * @var array
  45    */
  46   public static $_links = NULL;
  47
  48   /**
  49    * The id of the membership being viewed.
  50    *
  51    * @var int
  52    */
  53   private $membershipID;
  54
  55   /**
  56    * Contact's ID.
  57    *
  58    * @var int
  59    */
  60   private $contactID;
  61
  62   /**
  63    * Add context information at the end of a link.
  64    *
  65    * @return string
  66    *   extra query parameters
  67    */
  68   public function addContext() {
  69     $extra = '';
  70     foreach (['context', 'selectedChild'] as $arg) {
  71       if ($value = CRM_Utils_Request::retrieve($arg, 'String', $this)) {
  72         $extra .= "&{$arg}={$value}";
  73       }
  74     }
  75     return $extra;
  76   }
  77
  78   /**
  79    * Get action Links.
  80    *
  81    * @return array
  82    *   (reference) of action links
  83    */
  84   public function &links() {
  85     if (!(self::$_links)) {
  86       self::$_links = [
  87         CRM_Core_Action::DELETE => [
  88           'name' => ts('Delete'),
  89           'url' => 'civicrm/contact/view/membership',
  90           'qs' => 'action=view&id=%%id%%&cid=%%cid%%&relAction=delete&mid=%%mid%%&reset=1' . $this->addContext(),
  91           'title' => ts('Cancel Related Membership'),
  92         ],
  93         CRM_Core_Action::ADD => [
  94           'name' => ts('Create'),
  95           'url' => 'civicrm/contact/view/membership',
  96           'qs' => 'action=view&id=%%id%%&cid=%%cid%%&relAction=create&rid=%%rid%%&reset=1' . $this->addContext(),
  97           'title' => ts('Create Related Membership'),
  98         ],
  99       ];
 100     }
 101     return self::$_links;
 102   }
 103
 104   /**
 105    * Perform create or delete action on related memberships.
 106    *
 107    * @param string $action
 108    *   Create or delete.
 109    * @param array $owner
 110    *   Primary membership info (membership_id, contact_id, membership_type ...).
 111    */
 112   public function relAction($action, $owner) {
 113     switch ($action) {
 114       case 'delete':
 115         $id = CRM_Utils_Request::retrieve('mid', 'Positive', $this);
 116         $relatedContactId = CRM_Utils_Request::retrieve('cid', 'Positive', $this);
 117         $relatedDisplayName = CRM_Contact_BAO_Contact::displayName($relatedContactId);
 118         CRM_Member_BAO_Membership::del($id);
 119         CRM_Core_Session::setStatus(ts('Related membership for %1 has been deleted.', [1 => $relatedDisplayName]),
 120           ts('Membership Deleted'), 'success');
 121         break;
 122
 123       case 'create':
 124         $params = [
 125           'contact_id' => CRM_Utils_Request::retrieve('rid', 'Positive', $this),
 126           'membership_type_id' => $owner['membership_type_id'],
 127           'owner_membership_id' => $owner['id'],
 128           'join_date' => CRM_Utils_Date::processDate($owner['join_date'], NULL, TRUE, 'Ymd'),
 129           'start_date' => CRM_Utils_Date::processDate($owner['start_date'], NULL, TRUE, 'Ymd'),
 130           'end_date' => CRM_Utils_Date::processDate($owner['end_date'], NULL, TRUE, 'Ymd'),
 131           'source' => ts('Manual Assignment of Related Membership'),
 132           'is_test' => $owner['is_test'],
 133           'campaign_id' => CRM_Utils_Array::value('campaign_id', $owner),
 134           'status_id' => $owner['status_id'],
 135           'skipStatusCal' => TRUE,
 136           'createActivity' => TRUE,
 137         ];
 138         // @todo stop passing $ids here (we are only doing so because of passbyreference)
 139         $ids = [];
 140         CRM_Member_BAO_Membership::create($params, $ids);
 141         $relatedDisplayName = CRM_Contact_BAO_Contact::displayName($params['contact_id']);
 142         CRM_Core_Session::setStatus(ts('Related membership for %1 has been created.', [1 => $relatedDisplayName]),
 143           ts('Membership Added'), 'success');
 144         break;
 145
 146       default:
 147         CRM_Core_Error::fatal(ts("Invalid action specified in URL"));
 148     }
 149
 150     // Redirect back to membership view page for the owner, without the relAction parameters
 151     CRM_Utils_System::redirect(
 152       CRM_Utils_System::url(
 153         'civicrm/contact/view/membership',
 154         "action=view&reset=1&id={$owner['membership_id']}&cid={$owner['contact_id']}" . $this->addContext()
 155       )
 156     );
 157   }
 158
 159   /**
 160    * Set variables up before form is built.
 161    *
 162    * @return void
 163    */
 164   public function preProcess() {
 165     $values = [];
 166     $this->membershipID = CRM_Utils_Request::retrieve('id', 'Positive', $this);
 167     $this->contactID = CRM_Utils_Request::retrieve('cid', 'Positive', $this);
 168
 169     // Make sure context is assigned to template for condition where we come here view civicrm/membership/view
 170     $context = CRM_Utils_Request::retrieve('context', 'Alphanumeric', $this);
 171     $this->assign('context', $context);
 172
 173     if ($this->membershipID) {
 174       $params = ['id' => $this->membershipID];
 175       CRM_Member_BAO_Membership::retrieve($params, $values);
 176       if (CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus()) {
 177         $finTypeId = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $values['membership_type_id'], 'financial_type_id');
 178         $finType = CRM_Contribute_PseudoConstant::financialType($finTypeId);
 179         if (!CRM_Core_Permission::check('view contributions of type ' . $finType)) {
 180           CRM_Core_Error::statusBounce(ts('You do not have permission to access this page.'));
 181         }
 182       }
 183       else {
 184         $this->assign('noACL', TRUE);
 185       }
 186       $membershipType = CRM_Member_BAO_MembershipType::getMembershipTypeDetails($values['membership_type_id']);
 187
 188       // Do the action on related Membership if needed
 189       $relAction = CRM_Utils_Request::retrieve('relAction', 'String', $this);
 190       if ($relAction) {
 191         $this->relAction($relAction, $values);
 192       }
 193
 194       // build associated contributions
 195       $this->assign('accessContribution', FALSE);
 196       if (CRM_Core_Permission::access('CiviContribute')) {
 197         $this->assign('accessContribution', TRUE);
 198         CRM_Member_Page_Tab::associatedContribution($values['contact_id'], $this->membershipID);
 199       }
 200
 201       //Provide information about membership source when it is the result of a relationship (CRM-1901)
 202       $values['owner_membership_id'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership',
 203         $this->membershipID,
 204         'owner_membership_id'
 205       );
 206
 207       if (isset($values['owner_membership_id'])) {
 208         $values['owner_contact_id'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership',
 209           $values['owner_membership_id'],
 210           'contact_id',
 211           'id'
 212         );
 213
 214         $values['owner_display_name'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
 215           $values['owner_contact_id'],
 216           'display_name',
 217           'id'
 218         );
 219
 220         $direction = strrev($membershipType['relationship_direction']);
 221         // To display relationship type in view membership page
 222         $relTypeIds = str_replace(CRM_Core_DAO::VALUE_SEPARATOR, ",", $membershipType['relationship_type_id']);
 223         $sql = "
 224 SELECT relationship_type_id,
 225   CASE
 226   WHEN  contact_id_a = {$values['owner_contact_id']} AND contact_id_b = {$values['contact_id']} THEN 'b_a'
 227   WHEN  contact_id_b = {$values['owner_contact_id']} AND contact_id_a = {$values['contact_id']} THEN 'a_b'
 228 END AS 'relType'
 229   FROM civicrm_relationship
 230  WHERE relationship_type_id IN ($relTypeIds)";
 231         $dao = CRM_Core_DAO::executeQuery($sql);
 232         $values['relationship'] = NULL;
 233         while ($dao->fetch()) {
 234           $typeId = $dao->relationship_type_id;
 235           $direction = $dao->relType;
 236           if ($direction && $typeId) {
 237             if ($values['relationship']) {
 238               $values['relationship'] .= ',';
 239             }
 240             $values['relationship'] .= CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_RelationshipType',
 241               $typeId,
 242               "name_$direction",
 243               'id'
 244             );
 245           }
 246         }
 247       }
 248
 249       $this->assign('has_related', FALSE);
 250       // if membership can be granted, and we are the owner of the membership
 251       if (!empty($membershipType['relationship_type_id']) && empty($values['owner_membership_id'])) {
 252         // display related contacts/membership block
 253         $this->assign('has_related', TRUE);
 254         $this->assign('max_related', CRM_Utils_Array::value('max_related', $values, ts('Unlimited')));
 255         // split the relations in 2 arrays based on direction
 256         $relTypeId = explode(CRM_Core_DAO::VALUE_SEPARATOR, $membershipType['relationship_type_id']);
 257         $relDirection = explode(CRM_Core_DAO::VALUE_SEPARATOR, $membershipType['relationship_direction']);
 258         foreach ($relTypeId as $rid) {
 259           $relTypeDir[substr($relDirection[0], 0, 1)][] = $rid;
 260         }
 261         // build query in 2 parts with a UNION if necessary
 262         // _x and _y are replaced with _a and _b first, then vice-versa
 263         // comment is a qualifier for the relationship - now just job_title
 264         $select = "
 265 SELECT r.id, c.id as cid, c.display_name as name, c.job_title as comment,
 266        rt.name_x_y as relation, r.start_date, r.end_date,
 267        m.id as mid, ms.is_current_member, ms.label as status
 268   FROM civicrm_relationship r
 269   LEFT JOIN civicrm_relationship_type rt ON rt.id = r.relationship_type_id
 270   LEFT JOIN civicrm_contact c ON c.id = r.contact_id_x
 271   LEFT JOIN civicrm_membership m ON (m.owner_membership_id = {$values['id']}
 272   AND m.contact_id = r.contact_id_x AND m.is_test = 0)
 273   LEFT JOIN civicrm_membership_status ms ON ms.id = m.status_id
 274  WHERE r.contact_id_y = {$values['contact_id']} AND r.is_active = 1  AND c.is_deleted = 0";
 275         $query = '';
 276         foreach (['a', 'b'] as $dir) {
 277           if (isset($relTypeDir[$dir])) {
 278             $query .= ($query ? ' UNION ' : '')
 279               . str_replace('_y', '_' . $dir, str_replace('_x', '_' . ($dir == 'a' ? 'b' : 'a'), $select))
 280               . ' AND r.relationship_type_id IN (' . implode(',', $relTypeDir[$dir]) . ')';
 281           }
 282         }
 283         $query .= " ORDER BY is_current_member DESC";
 284         $dao = CRM_Core_DAO::executeQuery($query);
 285         $related = [];
 286         $relatedRemaining = CRM_Utils_Array::value('max_related', $values, PHP_INT_MAX);
 287         $rowElememts = [
 288           'id',
 289           'cid',
 290           'name',
 291           'comment',
 292           'relation',
 293           'mid',
 294           'start_date',
 295           'end_date',
 296           'is_current_member',
 297           'status',
 298         ];
 299
 300         while ($dao->fetch()) {
 301           $row = [];
 302           foreach ($rowElememts as $field) {
 303             $row[$field] = $dao->$field;
 304           }
 305           if ($row['mid'] && ($row['is_current_member'] == 1)) {
 306             $relatedRemaining--;
 307             $row['action'] = CRM_Core_Action::formLink(self::links(), CRM_Core_Action::DELETE,
 308               [
 309                 'id' => CRM_Utils_Request::retrieve('id', 'Positive', $this),
 310                 'cid' => $row['cid'],
 311                 'mid' => $row['mid'],
 312               ],
 313               ts('more'),
 314               FALSE,
 315               'membership.relationship.action',
 316               'Relationship',
 317               CRM_Utils_Request::retrieve('id', 'Positive', $this)
 318             );
 319           }
 320           else {
 321             if ($relatedRemaining > 0) {
 322               $row['action'] = CRM_Core_Action::formLink(self::links(), CRM_Core_Action::ADD,
 323                 [
 324                   'id' => CRM_Utils_Request::retrieve('id', 'Positive', $this),
 325                   'cid' => $row['cid'],
 326                   'rid' => $row['cid'],
 327                 ],
 328                 ts('more'),
 329                 FALSE,
 330                 'membership.relationship.action',
 331                 'Relationship',
 332                 CRM_Utils_Request::retrieve('id', 'Positive', $this)
 333               );
 334             }
 335           }
 336           $related[] = $row;
 337         }
 338         $this->assign('related', $related);
 339         if ($relatedRemaining <= 0) {
 340           $this->assign('related_text', ts('None available'));
 341         }
 342         else {
 343           if ($relatedRemaining < 100000) {
 344             $this->assign('related_text', ts('%1 available', [1 => $relatedRemaining]));
 345           }
 346           else {
 347             $this->assign('related_text', ts('Unlimited', [1 => $relatedRemaining]));
 348           }
 349         }
 350       }
 351
 352       $displayName = CRM_Contact_BAO_Contact::displayName($values['contact_id']);
 353       $this->assign('displayName', $displayName);
 354
 355       // Check if this is default domain contact CRM-10482
 356       if (CRM_Contact_BAO_Contact::checkDomainContact($values['contact_id'])) {
 357         $displayName .= ' (' . ts('default organization') . ')';
 358       }
 359
 360       // omitting contactImage from title for now since the summary overlay css doesn't work outside crm-container
 361       CRM_Utils_System::setTitle(ts('View Membership for') . ' ' . $displayName);
 362
 363       // add viewed membership to recent items list
 364       $recentTitle = $displayName . ' - ' . ts('Membership Type:') . ' ' . $values['membership_type'];
 365       $url = CRM_Utils_System::url('civicrm/contact/view/membership',
 366         "action=view&reset=1&id={$values['id']}&cid={$values['contact_id']}&context=home"
 367       );
 368
 369       $recentOther = [];
 370       if (CRM_Core_Permission::checkActionPermission('CiviMember', CRM_Core_Action::UPDATE)) {
 371         $recentOther['editUrl'] = CRM_Utils_System::url('civicrm/contact/view/membership',
 372           "action=update&reset=1&id={$values['id']}&cid={$values['contact_id']}&context=home"
 373         );
 374       }
 375       if (CRM_Core_Permission::checkActionPermission('CiviMember', CRM_Core_Action::DELETE)) {
 376         $recentOther['deleteUrl'] = CRM_Utils_System::url('civicrm/contact/view/membership',
 377           "action=delete&reset=1&id={$values['id']}&cid={$values['contact_id']}&context=home"
 378         );
 379       }
 380       CRM_Utils_Recent::add($recentTitle,
 381         $url,
 382         $values['id'],
 383         'Membership',
 384         $values['contact_id'],
 385         NULL,
 386         $recentOther
 387       );
 388
 389       CRM_Member_Page_Tab::setContext($this, $values['contact_id']);
 390
 391       $memType = CRM_Core_DAO::getFieldValue("CRM_Member_DAO_Membership", $this->membershipID, "membership_type_id");
 392
 393       $groupTree = CRM_Core_BAO_CustomGroup::getTree('Membership', NULL, $this->membershipID, 0, $memType);
 394       CRM_Core_BAO_CustomGroup::buildCustomDataView($this, $groupTree, FALSE, NULL, NULL, NULL, $this->membershipID);
 395
 396       $isRecur = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $this->membershipID, 'contribution_recur_id');
 397
 398       $autoRenew = $isRecur ? TRUE : FALSE;
 399     }
 400
 401     if (!empty($values['is_test'])) {
 402       $values['membership_type'] = CRM_Core_TestEntity::appendTestText($values['membership_type']);
 403     }
 404
 405     $subscriptionCancelled = CRM_Member_BAO_Membership::isSubscriptionCancelled($this->membershipID);
 406     $values['auto_renew'] = ($autoRenew && !$subscriptionCancelled) ? 'Yes' : 'No';
 407
 408     //do check for campaigns
 409     if ($campaignId = CRM_Utils_Array::value('campaign_id', $values)) {
 410       $campaigns = CRM_Campaign_BAO_Campaign::getCampaigns($campaignId);
 411       $values['campaign'] = $campaigns[$campaignId];
 412     }
 413
 414     $this->assign($values);
 415   }
 416
 417   /**
 418    * Build the form object.
 419    *
 420    * @return void
 421    */
 422   public function buildQuickForm() {
 423     $this->addButtons([
 424       [
 425         'type' => 'cancel',
 426         'name' => ts('Done'),
 427         'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 428         'isDefault' => TRUE,
 429       ],
 430     ]);
 431   }
 432
 433 }