3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
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
161 function __construct(
163 $action = CRM_Core_Action
::NONE
,
170 // submitted form values
171 $this->_queryParams
= &$queryParams;
173 $this->_single
= $single;
174 $this->_limit
= $limit;
175 $this->_context
= $context;
176 $this->_compContext
= $compContext;
178 $this->_eventClause
= $eventClause;
181 $this->_action
= $action;
183 $this->_query
= new CRM_Contact_BAO_Query($this->_queryParams
,
184 CRM_Event_BAO_Query
::defaultReturnProperties(CRM_Contact_BAO_Query
::MODE_EVENT
,
188 CRM_Contact_BAO_Query
::MODE_EVENT
190 $this->_query
->_distinctComponentClause
= " civicrm_participant.id";
191 $this->_query
->_groupByComponentClause
= " GROUP BY civicrm_participant.id ";
195 * Can be used to alter the number of participation returned from a buildForm hook
198 * How many participations do we want returned.
200 public function setLimit($limit) {
201 $this->_limit
= $limit;
205 * This method returns the links that are given for each search row.
206 * currently the links added for each row are
212 * @param null $context
213 * @param null $compContext
217 public static function &links($qfKey = NULL, $context = NULL, $compContext = NULL) {
220 $extraParams .= "&compContext={$compContext}";
222 elseif ($context == 'search') {
223 $extraParams .= '&compContext=participant';
227 $extraParams .= "&key={$qfKey}";
230 if (!(self
::$_links)) {
231 self
::$_links = array(
232 CRM_Core_Action
::VIEW
=> array(
233 'name' => ts('View'),
234 'url' => 'civicrm/contact/view/participant',
235 'qs' => 'reset=1&id=%%id%%&cid=%%cid%%&action=view&context=%%cxt%%&selectedChild=event' . $extraParams,
236 'title' => ts('View Participation'),
238 CRM_Core_Action
::UPDATE
=> array(
239 'name' => ts('Edit'),
240 'url' => 'civicrm/contact/view/participant',
241 'qs' => 'reset=1&action=update&id=%%id%%&cid=%%cid%%&context=%%cxt%%' . $extraParams,
242 'title' => ts('Edit Participation'),
244 CRM_Core_Action
::DELETE
=> array(
245 'name' => ts('Delete'),
246 'url' => 'civicrm/contact/view/participant',
247 'qs' => 'reset=1&action=delete&id=%%id%%&cid=%%cid%%&context=%%cxt%%' . $extraParams,
248 'title' => ts('Delete Participation'),
252 return self
::$_links;
256 * Getter for array of the parameters required for creating pager.
259 * @param array $params
261 public function getPagerParams($action, &$params) {
262 $params['status'] = ts('Event') . ' %%StatusMessage%%';
263 $params['csvString'] = NULL;
265 $params['rowCount'] = $this->_limit
;
268 $params['rowCount'] = CRM_Utils_Pager
::ROWCOUNT
;
271 $params['buttonTop'] = 'PagerTopButton';
272 $params['buttonBottom'] = 'PagerBottomButton';
276 * Returns total number of rows for the query.
281 * Total number of rows
283 public function getTotalCount($action) {
284 return $this->_query
->searchQuery(0, 0, NULL,
293 * Returns all the rows in the given offset and rowCount
295 * @param string $action
296 * The action being performed.
298 * The row number to start from.
299 * @param int $rowCount
300 * The number of rows to return.
301 * @param string $sort
302 * The sql string that describes the sort order.
303 * @param string $output
304 * What should the result set include (web/email/csv).
307 * rows in the given offset and rowCount
309 public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
310 $result = $this->_query
->searchQuery($offset, $rowCount, $sort,
316 // process the result of the query
319 //lets handle view, edit and delete separately. CRM-4418
320 $permissions = array(CRM_Core_Permission
::VIEW
);
321 if (CRM_Core_Permission
::check('edit event participants')) {
322 $permissions[] = CRM_Core_Permission
::EDIT
;
324 if (CRM_Core_Permission
::check('delete in CiviEvent')) {
325 $permissions[] = CRM_Core_Permission
::DELETE
;
327 $mask = CRM_Core_Action
::mask($permissions);
329 $statusTypes = CRM_Event_PseudoConstant
::participantStatus();
330 $statusClasses = CRM_Event_PseudoConstant
::participantStatusClass();
331 $participantRoles = CRM_Event_PseudoConstant
::participantRole();
332 $sep = CRM_Core_DAO
::VALUE_SEPARATOR
;
335 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
337 while ($result->fetch()) {
339 // the columns we are interested in
340 foreach (self
::$_properties as $property) {
341 if (isset($result->$property)) {
342 $row[$property] = $result->$property;
346 //carry campaign on selectors.
347 $row['campaign'] = CRM_Utils_Array
::value($result->participant_campaign_id
, $allCampaigns);
348 $row['campaign_id'] = $result->participant_campaign_id
;
350 // gross hack to show extra information for pending status
352 if ((isset($row['participant_status_id'])) &&
353 ($statusId = array_search($row['participant_status_id'], $statusTypes))
355 $statusClass = $statusClasses[$statusId];
358 $row['showConfirmUrl'] = ($statusClass == 'Pending') ?
TRUE : FALSE;
360 if (!empty($row['participant_is_test'])) {
361 $row['participant_status'] .= ' (' . ts('test') . ')';
364 $row['checkbox'] = CRM_Core_Form
::CB_PREFIX
. $result->participant_id
;
365 $links = self
::links($this->_key
, $this->_context
, $this->_compContext
);
367 if ($statusTypes[$row['participant_status_id']] == 'Partially paid') {
368 $links[CRM_Core_Action
::ADD
] = array(
369 'name' => ts('Record Payment'),
370 'url' => 'civicrm/payment',
371 'qs' => 'reset=1&id=%%id%%&cid=%%cid%%&action=add&component=event',
372 'title' => ts('Record Payment'),
376 if ($statusTypes[$row['participant_status_id']] == 'Pending refund') {
377 $links[CRM_Core_Action
::ADD
] = array(
378 'name' => ts('Record Refund'),
379 'url' => 'civicrm/payment',
380 'qs' => 'reset=1&id=%%id%%&cid=%%cid%%&action=add&component=event',
381 'title' => ts('Record Refund'),
385 $row['action'] = CRM_Core_Action
::formLink($links,
388 'id' => $result->participant_id
,
389 'cid' => $result->contact_id
,
390 'cxt' => $this->_context
,
394 'participant.selector.row',
396 $result->participant_id
399 $row['contact_type'] = CRM_Contact_BAO_Contact_Utils
::getImage($result->contact_sub_type ?
$result->contact_sub_type
: $result->contact_type
, FALSE, $result->contact_id
402 $row['paid'] = CRM_Event_BAO_Event
::isMonetary($row['event_id']);
404 if (!empty($row['participant_fee_level'])) {
405 CRM_Event_BAO_Participant
::fixEventLevel($row['participant_fee_level']);
408 if (CRM_Event_BAO_Event
::usesPriceSet($row['event_id'])) {
409 // add line item details if applicable
410 $lineItems[$row['participant_id']] = CRM_Price_BAO_LineItem
::getLineItems($row['participant_id']);
413 if (!empty($row['participant_role_id'])) {
414 $viewRoles = array();
415 foreach (explode($sep, $row['participant_role_id']) as $k => $v) {
416 $viewRoles[] = $participantRoles[$v];
418 $row['participant_role_id'] = implode(', ', $viewRoles);
422 CRM_Core_Selector_Controller
::$_template->assign_by_ref('lineItems', $lineItems);
430 public function getQILL() {
431 return $this->_query
->qill();
435 * Returns the column headers as an array of tuples:
436 * (name, sortName (key to the sort array))
438 * @param string $action
439 * The action being performed.
440 * @param string $output
441 * What should the result set include (web/email/csv).
444 * the column headers that need to be displayed
446 public function &getColumnHeaders($action = NULL, $output = NULL) {
447 if (!isset(self
::$_columnHeaders)) {
448 self
::$_columnHeaders = array(
450 'name' => ts('Event'),
451 'sort' => 'event_title',
452 'direction' => CRM_Utils_Sort
::DONTCARE
,
455 'name' => ts('Fee Level'),
456 'sort' => 'participant_fee_level',
457 'direction' => CRM_Utils_Sort
::DONTCARE
,
460 'name' => ts('Amount'),
461 'sort' => 'participant_fee_amount',
462 'direction' => CRM_Utils_Sort
::DONTCARE
,
465 'name' => ts('Registered'),
466 'sort' => 'participant_register_date',
467 'direction' => CRM_Utils_Sort
::DESCENDING
,
470 'name' => ts('Event Date(s)'),
471 'sort' => 'event_start_date',
472 'direction' => CRM_Utils_Sort
::DESCENDING
,
475 'name' => ts('Status'),
476 'sort' => 'participant_status',
477 'direction' => CRM_Utils_Sort
::DONTCARE
,
480 'name' => ts('Role'),
481 'sort' => 'participant_role_id',
482 'direction' => CRM_Utils_Sort
::DONTCARE
,
484 array('desc' => ts('Actions')),
487 if (!$this->_single
) {
489 array('desc' => ts('Contact Type')),
491 'name' => ts('Participant'),
492 'sort' => 'sort_name',
493 'direction' => CRM_Utils_Sort
::DONTCARE
,
496 self
::$_columnHeaders = array_merge($pre, self
::$_columnHeaders);
499 return self
::$_columnHeaders;
505 public function alphabetQuery() {
506 return $this->_query
->searchQuery(NULL, NULL, NULL, FALSE, FALSE, TRUE);
512 public function &getQuery() {
513 return $this->_query
;
517 * Name of export file.
519 * @param string $output
525 public function getExportFileName($output = 'csv') {
526 return ts('CiviCRM Event Search');