CRM/Event/Selector/Search.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class is used to retrieve and display a range of
  38  * contacts that match the given criteria (specifically for
  39  * results of advanced search options.
  40  *
  41  */
  42 class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Core_Selector_API {
  43
  44   /**
  45    * This defines two actions- View and Edit.
  46    *
  47    * @var array
  48    * @static
  49    */
  50   static $_links = NULL;
  51
  52   /**
  53    * We use desc to remind us what that column is, name is used in the tpl
  54    *
  55    * @var array
  56    * @static
  57    */
  58   static $_columnHeaders;
  59
  60   /**
  61    * Properties of contact we're interested in displaying
  62    * @var array
  63    * @static
  64    */
  65   static $_properties = array(
  66     'contact_id',
  67     'contact_type',
  68     'sort_name',
  69     'event_id',
  70     'participant_status_id',
  71     'event_title',
  72     'participant_fee_level',
  73     'participant_id',
  74     'event_start_date',
  75     'event_end_date',
  76     'event_type_id',
  77     'modified_date',
  78     'participant_is_test',
  79     'participant_role_id',
  80     'participant_register_date',
  81     'participant_fee_amount',
  82     'participant_fee_currency',
  83     'participant_status',
  84     'participant_role',
  85     'participant_campaign_id',
  86   );
  87
  88   /**
  89    * Are we restricting ourselves to a single contact
  90    *
  91    * @var boolean
  92    */
  93   protected $_single = FALSE;
  94
  95   /**
  96    * Are we restricting ourselves to a single contact
  97    *
  98    * @var boolean
  99    */
 100   protected $_limit = NULL;
 101
 102   /**
 103    * What context are we being invoked from
 104    *
 105    * @var string
 106    */
 107   protected $_context = NULL;
 108
 109   /**
 110    * What component context are we being invoked from
 111    *
 112    * @var string
 113    */
 114   protected $_compContext = NULL;
 115
 116   /**
 117    * QueryParams is the array returned by exportValues called on
 118    * the HTML_QuickForm_Controller for that page.
 119    *
 120    * @var array
 121    */
 122   public $_queryParams;
 123
 124   /**
 125    * Represent the type of selector
 126    *
 127    * @var int
 128    */
 129   protected $_action;
 130
 131   /**
 132    * The additional clause that we restrict the search with
 133    *
 134    * @var string
 135    */
 136   protected $_eventClause = NULL;
 137
 138   /**
 139    * The query object
 140    *
 141    * @var string
 142    */
 143   protected $_query;
 144
 145   /**
 146    * Class constructor
 147    *
 148    * @param array $queryParams
 149    *   Array of parameters for query.
 150    * @param \const|int $action - action of search basic or advanced.
 151    * @param string $eventClause
 152    *   If the caller wants to further restrict the search (used in participations).
 153    * @param bool $single
 154    *   Are we dealing only with one contact?.
 155    * @param int $limit
 156    *   How many participations do we want returned.
 157    *
 158    * @param string $context
 159    * @param null $compContext
 160    *
 161    * @return \CRM_Event_Selector_Search
 162    * @access public
 163    */
 164   function __construct(
 165     &$queryParams,
 166     $action = CRM_Core_Action::NONE,
 167     $eventClause = NULL,
 168     $single = FALSE,
 169     $limit = NULL,
 170     $context = 'search',
 171     $compContext = NULL
 172   ) {
 173     // submitted form values
 174     $this->_queryParams = &$queryParams;
 175
 176     $this->_single = $single;
 177     $this->_limit = $limit;
 178     $this->_context = $context;
 179     $this->_compContext = $compContext;
 180
 181     $this->_eventClause = $eventClause;
 182
 183     // type of selector
 184     $this->_action = $action;
 185
 186     $this->_query = new CRM_Contact_BAO_Query($this->_queryParams,
 187       CRM_Event_BAO_Query::defaultReturnProperties(CRM_Contact_BAO_Query::MODE_EVENT,
 188         FALSE
 189       ),
 190       NULL, FALSE, FALSE,
 191       CRM_Contact_BAO_Query::MODE_EVENT
 192     );
 193     $this->_query->_distinctComponentClause = " civicrm_participant.id";
 194     $this->_query->_groupByComponentClause = " GROUP BY civicrm_participant.id ";
 195   }
 196
 197   /**
 198    * Can be used to alter the number of participation returned from a buildForm hook
 199    *
 200    * @param int $limit
 201    *   How many participations do we want returned.
 202    */
 203   public function setLimit($limit) {
 204     $this->_limit = $limit;
 205   }
 206
 207   /**
 208    * This method returns the links that are given for each search row.
 209    * currently the links added for each row are
 210    *
 211    * - View
 212    * - Edit
 213    *
 214    * @param null $qfKey
 215    * @param null $context
 216    * @param null $compContext
 217    *
 218    * @return array
 219    */
 220   public static function &links($qfKey = NULL, $context = NULL, $compContext = NULL) {
 221     $extraParams = NULL;
 222     if ($compContext) {
 223       $extraParams .= "&compContext={$compContext}";
 224     }
 225     elseif ($context == 'search') {
 226       $extraParams .= '&compContext=participant';
 227     }
 228
 229     if ($qfKey) {
 230       $extraParams .= "&key={$qfKey}";
 231     }
 232
 233     if (!(self::$_links)) {
 234       self::$_links = array(
 235         CRM_Core_Action::VIEW => array(
 236           'name' => ts('View'),
 237           'url' => 'civicrm/contact/view/participant',
 238           'qs' => 'reset=1&id=%%id%%&cid=%%cid%%&action=view&context=%%cxt%%&selectedChild=event' . $extraParams,
 239           'title' => ts('View Participation'),
 240         ),
 241         CRM_Core_Action::UPDATE => array(
 242           'name' => ts('Edit'),
 243           'url' => 'civicrm/contact/view/participant',
 244           'qs' => 'reset=1&action=update&id=%%id%%&cid=%%cid%%&context=%%cxt%%' . $extraParams,
 245           'title' => ts('Edit Participation'),
 246         ),
 247         CRM_Core_Action::DELETE => array(
 248           'name' => ts('Delete'),
 249           'url' => 'civicrm/contact/view/participant',
 250           'qs' => 'reset=1&action=delete&id=%%id%%&cid=%%cid%%&context=%%cxt%%' . $extraParams,
 251           'title' => ts('Delete Participation'),
 252         ),
 253       );
 254     }
 255     return self::$_links;
 256   }
 257
 258   /**
 259    * Getter for array of the parameters required for creating pager.
 260    *
 261    * @param $action
 262    * @param array $params
 263    */
 264   public function getPagerParams($action, &$params) {
 265     $params['status'] = ts('Event') . ' %%StatusMessage%%';
 266     $params['csvString'] = NULL;
 267     if ($this->_limit) {
 268       $params['rowCount'] = $this->_limit;
 269     }
 270     else {
 271       $params['rowCount'] = CRM_Utils_Pager::ROWCOUNT;
 272     }
 273
 274     $params['buttonTop'] = 'PagerTopButton';
 275     $params['buttonBottom'] = 'PagerBottomButton';
 276   }
 277
 278   /**
 279    * Returns total number of rows for the query.
 280    *
 281    * @param
 282    *
 283    * @return int
 284    *   Total number of rows
 285    */
 286   public function getTotalCount($action) {
 287     return $this->_query->searchQuery(0, 0, NULL,
 288       TRUE, FALSE,
 289       FALSE, FALSE,
 290       FALSE,
 291       $this->_eventClause
 292     );
 293   }
 294
 295   /**
 296    * Returns all the rows in the given offset and rowCount
 297    *
 298    * @param string $action
 299    *   The action being performed.
 300    * @param int $offset
 301    *   The row number to start from.
 302    * @param int $rowCount
 303    *   The number of rows to return.
 304    * @param string $sort
 305    *   The sql string that describes the sort order.
 306    * @param string $output
 307    *   What should the result set include (web/email/csv).
 308    *
 309    * @return array
 310    *   rows in the given offset and rowCount
 311    */
 312   public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
 313     $result = $this->_query->searchQuery($offset, $rowCount, $sort,
 314       FALSE, FALSE,
 315       FALSE, FALSE,
 316       FALSE,
 317       $this->_eventClause
 318     );
 319     // process the result of the query
 320     $rows = array();
 321
 322     //lets handle view, edit and delete separately. CRM-4418
 323     $permissions = array(CRM_Core_Permission::VIEW);
 324     if (CRM_Core_Permission::check('edit event participants')) {
 325       $permissions[] = CRM_Core_Permission::EDIT;
 326     }
 327     if (CRM_Core_Permission::check('delete in CiviEvent')) {
 328       $permissions[] = CRM_Core_Permission::DELETE;
 329     }
 330     $mask = CRM_Core_Action::mask($permissions);
 331
 332     $statusTypes = CRM_Event_PseudoConstant::participantStatus();
 333     $statusClasses = CRM_Event_PseudoConstant::participantStatusClass();
 334     $participantRoles = CRM_Event_PseudoConstant::participantRole();
 335     $sep = CRM_Core_DAO::VALUE_SEPARATOR;
 336
 337     //get all campaigns.
 338     $allCampaigns = CRM_Campaign_BAO_Campaign::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
 339
 340     while ($result->fetch()) {
 341       $row = array();
 342       // the columns we are interested in
 343       foreach (self::$_properties as $property) {
 344         if (isset($result->$property)) {
 345           $row[$property] = $result->$property;
 346         }
 347       }
 348
 349       //carry campaign on selectors.
 350       $row['campaign'] = CRM_Utils_Array::value($result->participant_campaign_id, $allCampaigns);
 351       $row['campaign_id'] = $result->participant_campaign_id;
 352
 353       // gross hack to show extra information for pending status
 354       $statusClass = NULL;
 355       if ((isset($row['participant_status_id'])) &&
 356         ($statusId = array_search($row['participant_status_id'], $statusTypes))
 357       ) {
 358         $statusClass = $statusClasses[$statusId];
 359       }
 360
 361       $row['showConfirmUrl'] = ($statusClass == 'Pending') ? TRUE : FALSE;
 362
 363       if (!empty($row['participant_is_test'])) {
 364         $row['participant_status'] .= ' (' . ts('test') . ')';
 365       }
 366
 367       $row['checkbox'] = CRM_Core_Form::CB_PREFIX . $result->participant_id;
 368       $links = self::links($this->_key, $this->_context, $this->_compContext);
 369
 370       if ($statusTypes[$row['participant_status_id']] == 'Partially paid') {
 371         $links[CRM_Core_Action::ADD] = array(
 372           'name' => ts('Record Payment'),
 373           'url' => 'civicrm/payment',
 374           'qs' => 'reset=1&id=%%id%%&cid=%%cid%%&action=add&component=event',
 375           'title' => ts('Record Payment'),
 376         );
 377       }
 378
 379       if ($statusTypes[$row['participant_status_id']] == 'Pending refund') {
 380         $links[CRM_Core_Action::ADD] = array(
 381           'name' => ts('Record Refund'),
 382           'url' => 'civicrm/payment',
 383           'qs' => 'reset=1&id=%%id%%&cid=%%cid%%&action=add&component=event',
 384           'title' => ts('Record Refund'),
 385         );
 386       }
 387
 388       $row['action'] = CRM_Core_Action::formLink($links,
 389         $mask,
 390         array(
 391           'id' => $result->participant_id,
 392           'cid' => $result->contact_id,
 393           'cxt' => $this->_context,
 394         ),
 395         ts('more'),
 396         FALSE,
 397         'participant.selector.row',
 398         'Participant',
 399         $result->participant_id
 400       );
 401
 402       $row['contact_type'] = CRM_Contact_BAO_Contact_Utils::getImage($result->contact_sub_type ? $result->contact_sub_type : $result->contact_type, FALSE, $result->contact_id
 403       );
 404
 405       $row['paid'] = CRM_Event_BAO_Event::isMonetary($row['event_id']);
 406
 407       if (!empty($row['participant_fee_level'])) {
 408         CRM_Event_BAO_Participant::fixEventLevel($row['participant_fee_level']);
 409       }
 410
 411       if (CRM_Event_BAO_Event::usesPriceSet($row['event_id'])) {
 412         // add line item details if applicable
 413         $lineItems[$row['participant_id']] = CRM_Price_BAO_LineItem::getLineItems($row['participant_id']);
 414       }
 415
 416       if (!empty($row['participant_role_id'])) {
 417         $viewRoles = array();
 418         foreach (explode($sep, $row['participant_role_id']) as $k => $v) {
 419           $viewRoles[] = $participantRoles[$v];
 420         }
 421         $row['participant_role_id'] = implode(', ', $viewRoles);
 422       }
 423       $rows[] = $row;
 424     }
 425     CRM_Core_Selector_Controller::$_template->assign_by_ref('lineItems', $lineItems);
 426
 427     return $rows;
 428   }
 429
 430   /**
 431    * @inheritDoc
 432    */
 433   public function getQILL() {
 434     return $this->_query->qill();
 435   }
 436
 437   /**
 438    * Returns the column headers as an array of tuples:
 439    * (name, sortName (key to the sort array))
 440    *
 441    * @param string $action
 442    *   The action being performed.
 443    * @param string $output
 444    *   What should the result set include (web/email/csv).
 445    *
 446    * @return array
 447    *   the column headers that need to be displayed
 448    */
 449   public function &getColumnHeaders($action = NULL, $output = NULL) {
 450     if (!isset(self::$_columnHeaders)) {
 451       self::$_columnHeaders = array(
 452         array(
 453           'name' => ts('Event'),
 454           'sort' => 'event_title',
 455           'direction' => CRM_Utils_Sort::DONTCARE,
 456         ),
 457         array(
 458           'name' => ts('Fee Level'),
 459           'sort' => 'participant_fee_level',
 460           'direction' => CRM_Utils_Sort::DONTCARE,
 461         ),
 462         array(
 463           'name' => ts('Amount'),
 464           'sort' => 'participant_fee_amount',
 465           'direction' => CRM_Utils_Sort::DONTCARE,
 466         ),
 467         array(
 468           'name' => ts('Registered'),
 469           'sort' => 'participant_register_date',
 470           'direction' => CRM_Utils_Sort::DESCENDING,
 471         ),
 472         array(
 473           'name' => ts('Event Date(s)'),
 474           'sort' => 'event_start_date',
 475           'direction' => CRM_Utils_Sort::DESCENDING,
 476         ),
 477         array(
 478           'name' => ts('Status'),
 479           'sort' => 'participant_status',
 480           'direction' => CRM_Utils_Sort::DONTCARE,
 481         ),
 482         array(
 483           'name' => ts('Role'),
 484           'sort' => 'participant_role_id',
 485           'direction' => CRM_Utils_Sort::DONTCARE,
 486         ),
 487         array('desc' => ts('Actions')),
 488       );
 489
 490       if (!$this->_single) {
 491         $pre = array(
 492           array('desc' => ts('Contact Type')),
 493           array(
 494             'name' => ts('Participant'),
 495             'sort' => 'sort_name',
 496             'direction' => CRM_Utils_Sort::DONTCARE,
 497           ),
 498         );
 499         self::$_columnHeaders = array_merge($pre, self::$_columnHeaders);
 500       }
 501     }
 502     return self::$_columnHeaders;
 503   }
 504
 505   /**
 506    * @return mixed
 507    */
 508   public function alphabetQuery() {
 509     return $this->_query->searchQuery(NULL, NULL, NULL, FALSE, FALSE, TRUE);
 510   }
 511
 512   /**
 513    * @return string
 514    */
 515   public function &getQuery() {
 516     return $this->_query;
 517   }
 518
 519   /**
 520    * Name of export file.
 521    *
 522    * @param string $output
 523    *   Type of output.
 524    *
 525    * @return string
 526    *   name of the file
 527    */
 528   public function getExportFileName($output = 'csv') {
 529     return ts('CiviCRM Event Search');
 530   }
 531 }