CRM/Member/Selector/Search.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2017                                |
   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-2017
  32  */
  33
  34 /**
  35  * This class is used to retrieve and display a range of
  36  * contacts that match the given criteria (specifically for
  37  * results of advanced search options.
  38  */
  39 class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_Core_Selector_API {
  40
  41   /**
  42    * This defines two actions- View and Edit.
  43    *
  44    * @var array
  45    */
  46   static $_links = NULL;
  47
  48   /**
  49    * We use desc to remind us what that column is, name is used in the tpl
  50    *
  51    * @var array
  52    */
  53   static $_columnHeaders;
  54
  55   /**
  56    * Properties of contact we're interested in displaying
  57    * @var array
  58    */
  59   static $_properties = array(
  60     'contact_id',
  61     'membership_id',
  62     'contact_type',
  63     'sort_name',
  64     'membership_type',
  65     'join_date',
  66     'membership_start_date',
  67     'membership_end_date',
  68     'membership_source',
  69     'status_id',
  70     'member_is_test',
  71     'owner_membership_id',
  72     'membership_status',
  73     'member_campaign_id',
  74   );
  75
  76   /**
  77    * Are we restricting ourselves to a single contact
  78    *
  79    * @var boolean
  80    */
  81   protected $_single = FALSE;
  82
  83   /**
  84    * Are we restricting ourselves to a single contact
  85    *
  86    * @var boolean
  87    */
  88   protected $_limit = NULL;
  89
  90   /**
  91    * What context are we being invoked from
  92    *
  93    * @var string
  94    */
  95   protected $_context = NULL;
  96
  97   /**
  98    * QueryParams is the array returned by exportValues called on
  99    * the HTML_QuickForm_Controller for that page.
 100    *
 101    * @var array
 102    */
 103   public $_queryParams;
 104
 105   /**
 106    * Represent the type of selector.
 107    *
 108    * @var int
 109    */
 110   protected $_action;
 111
 112   /**
 113    * The additional clause that we restrict the search with.
 114    *
 115    * @var string
 116    */
 117   protected $_memberClause = NULL;
 118
 119   /**
 120    * The query object.
 121    *
 122    * @var string
 123    */
 124   protected $_query;
 125
 126   /**
 127    * Class constructor.
 128    *
 129    * @param array $queryParams
 130    *   Array of parameters for query.
 131    * @param \const|int $action - action of search basic or advanced.
 132    * @param string $memberClause
 133    *   If the caller wants to further restrict the search (used in memberships).
 134    * @param bool $single
 135    *   Are we dealing only with one contact?.
 136    * @param int $limit
 137    *   How many memberships do we want returned.
 138    *
 139    * @param string $context
 140    *
 141    * @return \CRM_Member_Selector_Search
 142    */
 143   public function __construct(
 144     &$queryParams,
 145     $action = CRM_Core_Action::NONE,
 146     $memberClause = NULL,
 147     $single = FALSE,
 148     $limit = NULL,
 149     $context = 'search'
 150   ) {
 151     // submitted form values
 152     $this->_queryParams = &$queryParams;
 153
 154     $this->_single = $single;
 155     $this->_limit = $limit;
 156     $this->_context = $context;
 157
 158     $this->_memberClause = $memberClause;
 159
 160     // type of selector
 161     $this->_action = $action;
 162
 163     $this->_query = new CRM_Contact_BAO_Query($this->_queryParams,
 164       CRM_Member_BAO_Query::defaultReturnProperties(CRM_Contact_BAO_Query::MODE_MEMBER,
 165         FALSE
 166       ),
 167       NULL, FALSE, FALSE,
 168       CRM_Contact_BAO_Query::MODE_MEMBER
 169     );
 170     $this->_query->_distinctComponentClause = " civicrm_membership.id";
 171     $this->_query->_groupByComponentClause = " GROUP BY civicrm_membership.id ";
 172   }
 173
 174   /**
 175    * This method returns the links that are given for each search row.
 176    *
 177    * Currently the links added for each row are
 178    *
 179    * - View
 180    * - Edit
 181    *
 182    * @param string $status
 183    * @param bool $isPaymentProcessor
 184    * @param null $accessContribution
 185    * @param null $qfKey
 186    * @param null $context
 187    * @param bool $isCancelSupported
 188    *
 189    * @return array
 190    */
 191   public static function &links(
 192     $status = 'all',
 193     $isPaymentProcessor = NULL,
 194     $accessContribution = NULL,
 195     $qfKey = NULL,
 196     $context = NULL,
 197     $isCancelSupported = FALSE
 198   ) {
 199     $extraParams = NULL;
 200     if ($context == 'search') {
 201       $extraParams .= '&compContext=membership';
 202     }
 203     if ($qfKey) {
 204       $extraParams .= "&key={$qfKey}";
 205     }
 206
 207     if (!self::$_links['view']) {
 208       self::$_links['view'] = array(
 209         CRM_Core_Action::VIEW => array(
 210           'name' => ts('View'),
 211           'url' => 'civicrm/contact/view/membership',
 212           'qs' => 'reset=1&id=%%id%%&cid=%%cid%%&action=view&context=%%cxt%%&selectedChild=member' . $extraParams,
 213           'title' => ts('View Membership'),
 214         ),
 215       );
 216     }
 217     if (!isset(self::$_links['all']) || !self::$_links['all']) {
 218       $extraLinks = array(
 219         CRM_Core_Action::UPDATE => array(
 220           'name' => ts('Edit'),
 221           'url' => 'civicrm/contact/view/membership',
 222           'qs' => 'reset=1&action=update&id=%%id%%&cid=%%cid%%&context=%%cxt%%' . $extraParams,
 223           'title' => ts('Edit Membership'),
 224         ),
 225         CRM_Core_Action::DELETE => array(
 226           'name' => ts('Delete'),
 227           'url' => 'civicrm/contact/view/membership',
 228           'qs' => 'reset=1&action=delete&id=%%id%%&cid=%%cid%%&context=%%cxt%%' . $extraParams,
 229           'title' => ts('Delete Membership'),
 230         ),
 231         CRM_Core_Action::RENEW => array(
 232           'name' => ts('Renew'),
 233           'url' => 'civicrm/contact/view/membership',
 234           'qs' => 'reset=1&action=renew&id=%%id%%&cid=%%cid%%&context=%%cxt%%' . $extraParams,
 235           'title' => ts('Renew Membership'),
 236         ),
 237         CRM_Core_Action::FOLLOWUP => array(
 238           'name' => ts('Renew-Credit Card'),
 239           'url' => 'civicrm/contact/view/membership',
 240           'qs' => 'action=renew&reset=1&cid=%%cid%%&id=%%id%%&context=%%cxt%%&mode=live' . $extraParams,
 241           'title' => ts('Renew Membership Using Credit Card'),
 242         ),
 243       );
 244       if (!$isPaymentProcessor || !$accessContribution) {
 245         //unset the renew with credit card when payment
 246         //processor is not available or user not permitted to make contributions
 247         unset($extraLinks[CRM_Core_Action::FOLLOWUP]);
 248       }
 249
 250       self::$_links['all'] = self::$_links['view'] + $extraLinks;
 251     }
 252
 253     if ($isCancelSupported) {
 254       self::$_links['all'][CRM_Core_Action::DISABLE] = array(
 255         'name' => ts('Cancel Auto-renewal'),
 256         'url' => 'civicrm/contribute/unsubscribe',
 257         'qs' => 'reset=1&mid=%%id%%&context=%%cxt%%' . $extraParams,
 258         'title' => 'Cancel Auto Renew Subscription',
 259       );
 260     }
 261     elseif (isset(self::$_links['all'][CRM_Core_Action::DISABLE])) {
 262       unset(self::$_links['all'][CRM_Core_Action::DISABLE]);
 263     }
 264
 265     return self::$_links[$status];
 266   }
 267
 268   /**
 269    * Getter for array of the parameters required for creating pager.
 270    *
 271    * @param int $action
 272    * @param array $params
 273    */
 274   public function getPagerParams($action, &$params) {
 275     $params['status'] = ts('Member') . ' %%StatusMessage%%';
 276     $params['csvString'] = NULL;
 277     if ($this->_limit) {
 278       $params['rowCount'] = $this->_limit;
 279     }
 280     else {
 281       $params['rowCount'] = CRM_Utils_Pager::ROWCOUNT;
 282     }
 283
 284     $params['buttonTop'] = 'PagerTopButton';
 285     $params['buttonBottom'] = 'PagerBottomButton';
 286   }
 287
 288   /**
 289    * Returns total number of rows for the query.
 290    *
 291    * @param int $action
 292    *
 293    * @return int
 294    *   Total number of rows
 295    */
 296   public function getTotalCount($action) {
 297     return $this->_query->searchQuery(0, 0, NULL,
 298       TRUE, FALSE,
 299       FALSE, FALSE,
 300       FALSE,
 301       $this->_memberClause
 302     );
 303   }
 304
 305   /**
 306    * Returns all the rows in the given offset and rowCount.
 307    *
 308    * @param string $action
 309    *   The action being performed.
 310    * @param int $offset
 311    *   The row number to start from.
 312    * @param int $rowCount
 313    *   The number of rows to return.
 314    * @param string $sort
 315    *   The sql string that describes the sort order.
 316    * @param string $output
 317    *   What should the result set include (web/email/csv).
 318    *
 319    * @return int
 320    *   the total number of rows for this action
 321    */
 322   public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
 323     // check if we can process credit card registration
 324     $processors = CRM_Core_PseudoConstant::paymentProcessor(FALSE, FALSE,
 325       "billing_mode IN ( 1, 3 )"
 326     );
 327     if (count($processors) > 0) {
 328       $this->_isPaymentProcessor = TRUE;
 329     }
 330     else {
 331       $this->_isPaymentProcessor = FALSE;
 332     }
 333
 334     // Only show credit card membership signup and renewal if user has CiviContribute permission
 335     if (CRM_Core_Permission::access('CiviContribute')) {
 336       $this->_accessContribution = TRUE;
 337     }
 338     else {
 339       $this->_accessContribution = FALSE;
 340     }
 341
 342     //get all campaigns.
 343     $allCampaigns = CRM_Campaign_BAO_Campaign::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
 344
 345     $result = $this->_query->searchQuery($offset, $rowCount, $sort,
 346       FALSE, FALSE,
 347       FALSE, FALSE,
 348       FALSE,
 349       $this->_memberClause
 350     );
 351
 352     // process the result of the query
 353     $rows = array();
 354
 355     //CRM-4418 check for view, edit, delete
 356     $permissions = array(CRM_Core_Permission::VIEW);
 357     if (CRM_Core_Permission::check('edit memberships')) {
 358       $permissions[] = CRM_Core_Permission::EDIT;
 359     }
 360     if (CRM_Core_Permission::check('delete in CiviMember')) {
 361       $permissions[] = CRM_Core_Permission::DELETE;
 362     }
 363     $mask = CRM_Core_Action::mask($permissions);
 364
 365     while ($result->fetch()) {
 366       $row = array();
 367
 368       // the columns we are interested in
 369       foreach (self::$_properties as $property) {
 370         if (property_exists($result, $property)) {
 371           $row[$property] = $result->$property;
 372         }
 373       }
 374
 375       //carry campaign on selectors.
 376       $row['campaign'] = CRM_Utils_Array::value($result->member_campaign_id, $allCampaigns);
 377       $row['campaign_id'] = $result->member_campaign_id;
 378
 379       if (!empty($row['member_is_test'])) {
 380         $row['membership_type'] = $row['membership_type'] . " (test)";
 381       }
 382
 383       $row['checkbox'] = CRM_Core_Form::CB_PREFIX . $result->membership_id;
 384
 385       if (!isset($result->owner_membership_id)) {
 386         // unset renew and followup link for deceased membership
 387         $currentMask = $mask;
 388         if ($result->membership_status == 'Deceased') {
 389           $currentMask = $currentMask & ~CRM_Core_Action::RENEW & ~CRM_Core_Action::FOLLOWUP;
 390         }
 391
 392         $isCancelSupported = CRM_Member_BAO_Membership::isCancelSubscriptionSupported($row['membership_id']);
 393         $links = self::links('all',
 394           $this->_isPaymentProcessor,
 395           $this->_accessContribution,
 396           $this->_key,
 397           $this->_context,
 398           $isCancelSupported
 399         );
 400
 401         // check permissions
 402         $finTypeId = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $result->membership_type_id, 'financial_type_id');
 403         $finType = CRM_Contribute_PseudoConstant::financialType($finTypeId);
 404         if (CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus()
 405           && !CRM_Core_Permission::check('edit contributions of type ' . $finType)
 406         ) {
 407           unset($links[CRM_Core_Action::UPDATE]);
 408         }
 409         if (CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus() &&
 410           !CRM_Core_Permission::check('delete contributions of type ' . $finType)
 411         ) {
 412           unset($links[CRM_Core_Action::DELETE]);
 413         }
 414         $row['action'] = CRM_Core_Action::formLink($links,
 415           $currentMask,
 416           array(
 417             'id' => $result->membership_id,
 418             'cid' => $result->contact_id,
 419             'cxt' => $this->_context,
 420           ),
 421           ts('Renew') . '...',
 422           FALSE,
 423           'membership.selector.row',
 424           'Membership',
 425           $result->membership_id
 426         );
 427       }
 428       else {
 429         $links = self::links('view');
 430         $row['action'] = CRM_Core_Action::formLink($links, $mask,
 431           array(
 432             'id' => $result->membership_id,
 433             'cid' => $result->contact_id,
 434             'cxt' => $this->_context,
 435           ),
 436           ts('more'),
 437           FALSE,
 438           'membership.selector.row',
 439           'Membership',
 440           $result->membership_id
 441         );
 442       }
 443
 444       //does membership have auto renew CRM-7137.
 445       $autoRenew = FALSE;
 446       if (isset($result->membership_recur_id) && $result->membership_recur_id &&
 447         !CRM_Member_BAO_Membership::isSubscriptionCancelled($row['membership_id'])
 448       ) {
 449         $autoRenew = TRUE;
 450       }
 451       $row['auto_renew'] = $autoRenew;
 452
 453       $row['contact_type'] = CRM_Contact_BAO_Contact_Utils::getImage($result->contact_sub_type ? $result->contact_sub_type : $result->contact_type, FALSE, $result->contact_id
 454       );
 455
 456       $rows[] = $row;
 457     }
 458
 459     return $rows;
 460   }
 461
 462   /**
 463    * @inheritDoc
 464    */
 465   public function getQILL() {
 466     return $this->_query->qill();
 467   }
 468
 469   /**
 470    * Returns the column headers as an array of tuples.
 471    *
 472    * (name, sortName (key to the sort array))
 473    *
 474    * @param string $action
 475    *   The action being performed.
 476    * @param string $output
 477    *   What should the result set include (web/email/csv).
 478    *
 479    * @return array
 480    *   the column headers that need to be displayed
 481    */
 482   public function &getColumnHeaders($action = NULL, $output = NULL) {
 483     if (!isset(self::$_columnHeaders)) {
 484       self::$_columnHeaders = array(
 485         array(
 486           'name' => ts('Type'),
 487           'sort' => 'membership_type',
 488           'direction' => CRM_Utils_Sort::DONTCARE,
 489         ),
 490         array(
 491           'name' => ts('Member Since'),
 492           'sort' => 'join_date',
 493           'direction' => CRM_Utils_Sort::DESCENDING,
 494         ),
 495         array(
 496           'name' => ts('Start Date'),
 497           'sort' => 'membership_start_date',
 498           'direction' => CRM_Utils_Sort::DONTCARE,
 499         ),
 500         array(
 501           'name' => ts('End Date'),
 502           'sort' => 'membership_end_date',
 503           'direction' => CRM_Utils_Sort::DONTCARE,
 504         ),
 505         array(
 506           'name' => ts('Source'),
 507           'sort' => 'membership_source',
 508           'direction' => CRM_Utils_Sort::DONTCARE,
 509         ),
 510         array(
 511           'name' => ts('Status'),
 512           'sort' => 'membership_status',
 513           'direction' => CRM_Utils_Sort::DONTCARE,
 514         ),
 515         array(
 516           'name' => ts('Auto-renew?'),
 517         ),
 518         array('desc' => ts('Actions')),
 519       );
 520
 521       if (!$this->_single) {
 522         $pre = array(
 523           array('desc' => ts('Contact Type')),
 524           array(
 525             'name' => ts('Name'),
 526             'sort' => 'sort_name',
 527             'direction' => CRM_Utils_Sort::DONTCARE,
 528           ),
 529         );
 530         self::$_columnHeaders = array_merge($pre, self::$_columnHeaders);
 531       }
 532     }
 533     return self::$_columnHeaders;
 534   }
 535
 536   /**
 537    * Alphabet query.
 538    *
 539    * @return mixed
 540    */
 541   public function alphabetQuery() {
 542     return $this->_query->searchQuery(NULL, NULL, NULL, FALSE, FALSE, TRUE);
 543   }
 544
 545   /**
 546    * Get query.
 547    *
 548    * @return string
 549    */
 550   public function &getQuery() {
 551     return $this->_query;
 552   }
 553
 554   /**
 555    * Name of export file.
 556    *
 557    * @param string $output
 558    *   Type of output.
 559    *
 560    * @return string
 561    *   name of the file
 562    */
 563   public function getExportFileName($output = 'csv') {
 564     return ts('CiviCRM Member Search');
 565   }
 566
 567 }