3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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-2017
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.
42 class CRM_Event_Selector_Search
extends CRM_Core_Selector_Base
implements CRM_Core_Selector_API
{
45 * This defines two actions- View and Edit.
49 static $_links = NULL;
52 * We use desc to remind us what that column is, name is used in the tpl
56 static $_columnHeaders;
59 * Properties of contact we're interested in displaying
62 static $_properties = array(
67 'participant_status_id',
69 'participant_fee_level',
75 'participant_is_test',
76 'participant_role_id',
77 'participant_register_date',
78 'participant_fee_amount',
79 'participant_fee_currency',
82 'participant_campaign_id',
86 * Are we restricting ourselves to a single contact
90 protected $_single = FALSE;
93 * Are we restricting ourselves to a single contact
97 protected $_limit = NULL;
100 * What context are we being invoked from
104 protected $_context = NULL;
107 * What component context are we being invoked from
111 protected $_compContext = NULL;
114 * QueryParams is the array returned by exportValues called on
115 * the HTML_QuickForm_Controller for that page.
119 public $_queryParams;
122 * Represent the type of selector.
129 * The additional clause that we restrict the search with.
133 protected $_eventClause = NULL;
145 * @param array $queryParams
146 * Array of parameters for query.
147 * @param \const|int $action - action of search basic or advanced.
148 * @param string $eventClause
149 * If the caller wants to further restrict the search (used in participations).
150 * @param bool $single
151 * Are we dealing only with one contact?.
153 * How many participations do we want returned.
155 * @param string $context
156 * @param null $compContext
158 * @return \CRM_Event_Selector_Search
160 public function __construct(
162 $action = CRM_Core_Action
::NONE
,
169 // submitted form values
170 $this->_queryParams
= &$queryParams;
172 $this->_single
= $single;
173 $this->_limit
= $limit;
174 $this->_context
= $context;
175 $this->_compContext
= $compContext;
177 $this->_eventClause
= $eventClause;
180 $this->_action
= $action;
182 $this->_query
= new CRM_Contact_BAO_Query($this->_queryParams
,
183 CRM_Event_BAO_Query
::defaultReturnProperties(CRM_Contact_BAO_Query
::MODE_EVENT
,
187 CRM_Contact_BAO_Query
::MODE_EVENT
189 $this->_query
->_distinctComponentClause
= " civicrm_participant.id";
190 $this->_query
->_groupByComponentClause
= " GROUP BY civicrm_participant.id ";
194 * Can be used to alter the number of participation returned from a buildForm hook.
197 * How many participations do we want returned.
199 public function setLimit($limit) {
200 $this->_limit
= $limit;
204 * This method returns the links that are given for each search row.
205 * currently the links added for each row are
211 * @param null $context
212 * @param null $compContext
216 public static function &links($qfKey = NULL, $context = NULL, $compContext = NULL) {
219 $extraParams .= "&compContext={$compContext}";
221 elseif ($context == 'search') {
222 $extraParams .= '&compContext=participant';
226 $extraParams .= "&key={$qfKey}";
229 if (!(self
::$_links)) {
230 self
::$_links = array(
231 CRM_Core_Action
::VIEW
=> array(
232 'name' => ts('View'),
233 'url' => 'civicrm/contact/view/participant',
234 'qs' => 'reset=1&id=%%id%%&cid=%%cid%%&action=view&context=%%cxt%%&selectedChild=event' . $extraParams,
235 'title' => ts('View Participation'),
237 CRM_Core_Action
::UPDATE
=> array(
238 'name' => ts('Edit'),
239 'url' => 'civicrm/contact/view/participant',
240 'qs' => 'reset=1&action=update&id=%%id%%&cid=%%cid%%&context=%%cxt%%' . $extraParams,
241 'title' => ts('Edit Participation'),
243 CRM_Core_Action
::DELETE
=> array(
244 'name' => ts('Delete'),
245 'url' => 'civicrm/contact/view/participant',
246 'qs' => 'reset=1&action=delete&id=%%id%%&cid=%%cid%%&context=%%cxt%%' . $extraParams,
247 'title' => ts('Delete Participation'),
251 return self
::$_links;
255 * Getter for array of the parameters required for creating pager.
258 * @param array $params
260 public function getPagerParams($action, &$params) {
261 $params['status'] = ts('Event') . ' %%StatusMessage%%';
262 $params['csvString'] = NULL;
264 $params['rowCount'] = $this->_limit
;
267 $params['rowCount'] = CRM_Utils_Pager
::ROWCOUNT
;
270 $params['buttonTop'] = 'PagerTopButton';
271 $params['buttonBottom'] = 'PagerBottomButton';
275 * Returns total number of rows for the query.
280 * Total number of rows
282 public function getTotalCount($action) {
283 return $this->_query
->searchQuery(0, 0, NULL,
292 * Returns all the rows in the given offset and rowCount.
294 * @param string $action
295 * The action being performed.
297 * The row number to start from.
298 * @param int $rowCount
299 * The number of rows to return.
300 * @param string $sort
301 * The sql string that describes the sort order.
302 * @param string $output
303 * What should the result set include (web/email/csv).
306 * rows in the given offset and rowCount
308 public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
309 $result = $this->_query
->searchQuery($offset, $rowCount, $sort,
315 // process the result of the query
318 //lets handle view, edit and delete separately. CRM-4418
319 $permissions = array(CRM_Core_Permission
::VIEW
);
320 if (CRM_Core_Permission
::check('edit event participants')) {
321 $permissions[] = CRM_Core_Permission
::EDIT
;
323 if (CRM_Core_Permission
::check('delete in CiviEvent')) {
324 $permissions[] = CRM_Core_Permission
::DELETE
;
326 $mask = CRM_Core_Action
::mask($permissions);
328 $statusTypes = CRM_Event_PseudoConstant
::participantStatus();
329 $statusClasses = CRM_Event_PseudoConstant
::participantStatusClass();
330 $participantRoles = CRM_Event_PseudoConstant
::participantRole();
331 $sep = CRM_Core_DAO
::VALUE_SEPARATOR
;
334 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
336 while ($result->fetch()) {
338 // the columns we are interested in
339 foreach (self
::$_properties as $property) {
340 if (isset($result->$property)) {
341 $row[$property] = $result->$property;
345 //carry campaign on selectors.
346 $row['campaign'] = CRM_Utils_Array
::value($result->participant_campaign_id
, $allCampaigns);
347 $row['campaign_id'] = $result->participant_campaign_id
;
349 // gross hack to show extra information for pending status
351 if ((isset($row['participant_status_id'])) &&
352 ($statusId = array_search($row['participant_status_id'], $statusTypes))
354 $statusClass = $statusClasses[$statusId];
357 $row['showConfirmUrl'] = ($statusClass == 'Pending') ?
TRUE : FALSE;
359 if (!empty($row['participant_is_test'])) {
360 $row['participant_status'] .= ' (' . ts('test') . ')';
363 $row['checkbox'] = CRM_Core_Form
::CB_PREFIX
. $result->participant_id
;
364 $links = self
::links($this->_key
, $this->_context
, $this->_compContext
);
366 if ($statusTypes[$row['participant_status_id']] == 'Partially paid') {
367 $links[CRM_Core_Action
::ADD
] = array(
368 'name' => ts('Record Payment'),
369 'url' => 'civicrm/payment',
370 'qs' => 'reset=1&id=%%id%%&cid=%%cid%%&action=add&component=event',
371 'title' => ts('Record Payment'),
373 if (CRM_Core_Config
::isEnabledBackOfficeCreditCardPayments()) {
374 $links[CRM_Core_Action
::BASIC
] = array(
375 'name' => ts('Submit Credit Card payment'),
376 'url' => 'civicrm/payment/add',
377 'qs' => 'reset=1&id=%%id%%&cid=%%cid%%&action=add&component=event&mode=live',
378 'title' => ts('Submit Credit Card payment'),
383 if ($statusTypes[$row['participant_status_id']] == 'Pending refund') {
384 $links[CRM_Core_Action
::ADD
] = array(
385 'name' => ts('Record Refund'),
386 'url' => 'civicrm/payment',
387 'qs' => 'reset=1&id=%%id%%&cid=%%cid%%&action=add&component=event',
388 'title' => ts('Record Refund'),
392 $row['action'] = CRM_Core_Action
::formLink($links,
395 'id' => $result->participant_id
,
396 'cid' => $result->contact_id
,
397 'cxt' => $this->_context
,
401 'participant.selector.row',
403 $result->participant_id
406 $row['contact_type'] = CRM_Contact_BAO_Contact_Utils
::getImage($result->contact_sub_type ?
$result->contact_sub_type
: $result->contact_type
, FALSE, $result->contact_id
409 $row['paid'] = CRM_Event_BAO_Event
::isMonetary($row['event_id']);
411 if (!empty($row['participant_fee_level'])) {
412 CRM_Event_BAO_Participant
::fixEventLevel($row['participant_fee_level']);
415 if (CRM_Event_BAO_Event
::usesPriceSet($row['event_id'])) {
416 // add line item details if applicable
417 $lineItems[$row['participant_id']] = CRM_Price_BAO_LineItem
::getLineItems($row['participant_id']);
420 if (!empty($row['participant_role_id'])) {
421 $viewRoles = array();
422 foreach (explode($sep, $row['participant_role_id']) as $k => $v) {
423 $viewRoles[] = $participantRoles[$v];
425 $row['participant_role_id'] = implode(', ', $viewRoles);
429 CRM_Core_Selector_Controller
::$_template->assign_by_ref('lineItems', $lineItems);
437 public function getQILL() {
438 return $this->_query
->qill();
442 * Returns the column headers as an array of tuples:
443 * (name, sortName (key to the sort array))
445 * @param string $action
446 * The action being performed.
447 * @param string $output
448 * What should the result set include (web/email/csv).
451 * the column headers that need to be displayed
453 public function &getColumnHeaders($action = NULL, $output = NULL) {
454 if (!isset(self
::$_columnHeaders)) {
455 self
::$_columnHeaders = array(
457 'name' => ts('Event'),
458 'sort' => 'event_title',
459 'direction' => CRM_Utils_Sort
::DONTCARE
,
462 'name' => ts('Fee Level'),
463 'sort' => 'participant_fee_level',
464 'direction' => CRM_Utils_Sort
::DONTCARE
,
467 'name' => ts('Amount'),
468 'sort' => 'participant_fee_amount',
469 'direction' => CRM_Utils_Sort
::DONTCARE
,
472 'name' => ts('Registered'),
473 'sort' => 'participant_register_date',
474 'direction' => CRM_Utils_Sort
::DESCENDING
,
477 'name' => ts('Event Date(s)'),
478 'sort' => 'event_start_date',
479 'direction' => CRM_Utils_Sort
::DESCENDING
,
482 'name' => ts('Status'),
483 'sort' => 'participant_status',
484 'direction' => CRM_Utils_Sort
::DONTCARE
,
487 'name' => ts('Role'),
488 'sort' => 'participant_role_id',
489 'direction' => CRM_Utils_Sort
::DONTCARE
,
491 array('desc' => ts('Actions')),
494 if (!$this->_single
) {
496 array('desc' => ts('Contact Type')),
498 'name' => ts('Participant'),
499 'sort' => 'sort_name',
500 'direction' => CRM_Utils_Sort
::DONTCARE
,
503 self
::$_columnHeaders = array_merge($pre, self
::$_columnHeaders);
506 return self
::$_columnHeaders;
512 public function alphabetQuery() {
513 return $this->_query
->searchQuery(NULL, NULL, NULL, FALSE, FALSE, TRUE);
519 public function &getQuery() {
520 return $this->_query
;
524 * Name of export file.
526 * @param string $output
532 public function getExportFileName($output = 'csv') {
533 return ts('CiviCRM Event Search');