3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 * Page for displaying list of events
21 class CRM_Event_Page_ManageEvent
extends CRM_Core_Page
{
24 * The action links that we need to display for the browse screen.
28 public static $_actionLinks = NULL;
31 * The event links to display for the browse screen.
34 public static $_eventLinks = NULL;
36 public static $_links = NULL;
38 public static $_tabLinks = NULL;
40 protected $_pager = NULL;
42 protected $_sortByCharacter;
44 protected $_isTemplate = FALSE;
50 * (reference) of action links
52 public function &links() {
53 if (!(self
::$_actionLinks)) {
54 // helper variable for nicer formatting
55 $copyExtra = ts('Are you sure you want to make a copy of this Event?');
57 self
::$_actionLinks = [
58 CRM_Core_Action
::DISABLE
=> [
59 'name' => ts('Disable'),
60 'ref' => 'crm-enable-disable',
61 'title' => ts('Disable Event'),
63 CRM_Core_Action
::ENABLE
=> [
64 'name' => ts('Enable'),
65 'ref' => 'crm-enable-disable',
66 'title' => ts('Enable Event'),
68 CRM_Core_Action
::DELETE
=> [
69 'name' => ts('Delete'),
70 'url' => CRM_Utils_System
::currentPath(),
71 'qs' => 'action=delete&id=%%id%%',
72 'title' => ts('Delete Event'),
74 CRM_Core_Action
::COPY
=> [
76 'url' => CRM_Utils_System
::currentPath(),
77 'qs' => 'reset=1&action=copy&id=%%id%%',
78 'extra' => 'onclick = "return confirm(\'' . $copyExtra . '\');"',
79 'title' => ts('Copy Event'),
83 return self
::$_actionLinks;
86 public function eventLinks() {
87 if (!(self
::$_eventLinks)) {
88 self
::$_eventLinks = [
89 'register_participant' => [
90 'name' => ts('Register Participant'),
91 'title' => ts('Register Participant'),
92 'url' => 'civicrm/participant/add',
93 'qs' => 'reset=1&action=add&context=standalone&eid=%%id%%',
96 'name' => ts('Event Info'),
97 'title' => ts('Event Info'),
98 'url' => 'civicrm/event/info',
99 'qs' => 'reset=1&id=%%id%%',
102 'online_registration_test' => [
103 'name' => ts('Registration (Test-drive)'),
104 'title' => ts('Online Registration (Test-drive)'),
105 'url' => 'civicrm/event/register',
106 'qs' => 'reset=1&action=preview&id=%%id%%',
109 'online_registration_live' => [
110 'name' => ts('Registration (Live)'),
111 'title' => ts('Online Registration (Live)'),
112 'url' => 'civicrm/event/register',
113 'qs' => 'reset=1&id=%%id%%',
118 return self
::$_eventLinks;
122 * Get tab Links for events.
125 * (reference) of tab links
126 * @throws \CiviCRM_API3_Exception
128 public static function &tabs() {
129 // @todo Move to eventcart extension
130 // check if we're in shopping cart mode for events
131 $enableCart = (bool) Civi
::settings()->get('enable_cart');
133 $cacheKey = $enableCart ?
1 : 0;
134 if (!(self
::$_tabLinks)) {
135 self
::$_tabLinks = [];
137 if (!isset(self
::$_tabLinks[$cacheKey])) {
138 self
::$_tabLinks[$cacheKey]['settings']
140 'title' => ts('Info and Settings'),
141 'url' => 'civicrm/event/manage/settings',
144 self
::$_tabLinks[$cacheKey]['location']
146 'title' => ts('Location'),
147 'url' => 'civicrm/event/manage/location',
148 'field' => 'loc_block_id',
151 self
::$_tabLinks[$cacheKey]['fee']
153 'title' => ts('Fees'),
154 'url' => 'civicrm/event/manage/fee',
155 'field' => 'is_monetary',
157 self
::$_tabLinks[$cacheKey]['registration']
159 'title' => ts('Online Registration'),
160 'url' => 'civicrm/event/manage/registration',
161 'field' => 'is_online_registration',
164 // @fixme I don't understand the event permissions check here - can we just get rid of it?
165 $permissions = CRM_Event_BAO_Event
::getAllPermissions();
166 if (CRM_Core_Permission
::check('administer CiviCRM data') ||
!empty($permissions[CRM_Core_Permission
::EDIT
])) {
167 self
::$_tabLinks[$cacheKey]['reminder']
169 'title' => ts('Schedule Reminders'),
170 'url' => 'civicrm/event/manage/reminder',
171 'field' => 'reminder',
174 self
::$_tabLinks[$cacheKey]['conference']
176 'title' => ts('Conference Slots'),
177 'url' => 'civicrm/event/manage/conference',
178 'field' => 'slot_label_id',
180 self
::$_tabLinks[$cacheKey]['friend']
182 'title' => ts('Tell a Friend'),
183 'url' => 'civicrm/event/manage/friend',
186 self
::$_tabLinks[$cacheKey]['pcp']
188 'title' => ts('Personal Campaign Pages'),
189 'url' => 'civicrm/event/manage/pcp',
190 'field' => 'is_pcp_enabled',
192 self
::$_tabLinks[$cacheKey]['repeat']
194 'title' => ts('Repeat'),
195 'url' => 'civicrm/event/manage/repeat',
196 'field' => 'is_repeating_event',
201 unset(self
::$_tabLinks[$cacheKey]['conference']);
204 CRM_Utils_Hook
::tabset('civicrm/event/manage', self
::$_tabLinks[$cacheKey], []);
205 return self
::$_tabLinks[$cacheKey];
211 * This method is called after the page is created. It checks for the
212 * type of action and executes that action.
213 * Finally it calls the parent's run method.
217 public function run() {
218 // get the requested action
219 $action = CRM_Utils_Request
::retrieve('action', 'String',
220 // default to 'browse'
221 $this, FALSE, 'browse'
224 // assign vars to templates
225 $this->assign('action', $action);
226 $this->assign('iCal', CRM_Event_BAO_Event
::getICalLinks());
227 $id = CRM_Utils_Request
::retrieve('id', 'Positive',
228 $this, FALSE, 0, 'REQUEST'
231 // figure out whether we’re handling an event or an event template
233 $this->_isTemplate
= CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event', $id, 'is_template');
235 elseif ($action & CRM_Core_Action
::ADD
) {
236 $this->_isTemplate
= CRM_Utils_Request
::retrieve('is_template', 'Boolean', $this);
239 if (!$this->_isTemplate
&& $id) {
242 'title' => ts('Manage Events'),
243 'url' => CRM_Utils_System
::url(CRM_Utils_System
::currentPath(), 'reset=1'),
246 CRM_Utils_System
::appendBreadCrumb($breadCrumb);
249 // what action to take ?
250 if ($action & CRM_Core_Action
::DELETE
) {
251 $session = CRM_Core_Session
::singleton();
252 $session->pushUserContext(CRM_Utils_System
::url(CRM_Utils_System
::currentPath(), 'reset=1&action=browse'));
253 $controller = new CRM_Core_Controller_Simple('CRM_Event_Form_ManageEvent_Delete',
257 $controller->set('id', $id);
258 $controller->process();
259 return $controller->run();
261 elseif ($action & CRM_Core_Action
::COPY
) {
265 // finally browse the custom groups
269 return parent
::run();
277 public function browse() {
278 Civi
::resources()->addStyleFile('civicrm', 'css/searchForm.css', 1, 'html-header');
280 $this->_sortByCharacter
= CRM_Utils_Request
::retrieve('sortByCharacter',
284 $createdId = CRM_Utils_Request
::retrieve('cid', 'Positive', $this, FALSE, 0);
285 if (strtolower($this->_sortByCharacter
) == 'all' ||
288 $this->_sortByCharacter
= '';
289 $this->set('sortByCharacter', '');
292 $this->_force
= $this->_searchResult
= NULL;
297 $this->_force
= CRM_Utils_Request
::retrieve('force', 'Boolean',
300 $this->_searchResult
= CRM_Utils_Request
::retrieve('searchResult', 'Boolean', $this);
302 $whereClause = $this->whereClause($params, FALSE, $this->_force
);
304 if (CRM_Core_Config
::singleton()->includeAlphabeticalPager
) {
305 $this->pagerAToZ($whereClause, $params);
309 $whereClause = $this->whereClause($params, TRUE, $this->_force
);
310 // because is_template != 1 would be to simple
311 $whereClause .= ' AND (is_template = 0 OR is_template IS NULL)';
313 $this->pager($whereClause, $params);
315 list($offset, $rowCount) = $this->_pager
->getOffsetAndRowCount();
317 // get all custom groups sorted by weight
324 ORDER BY start_date desc
325 LIMIT $offset, $rowCount";
327 $dao = CRM_Core_DAO
::executeQuery($query, $params, TRUE, 'CRM_Event_DAO_Event');
328 $permittedEventsByAction = CRM_Event_BAO_Event
::getAllPermissions();
331 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
333 // get the list of active event pcps
336 $pcpDao = new CRM_PCP_DAO_PCPBlock();
337 $pcpDao->entity_table
= 'civicrm_event';
340 while ($pcpDao->fetch()) {
341 $eventPCPS[$pcpDao->entity_id
] = $pcpDao->entity_id
;
343 $mapping = CRM_Utils_Array
::first(CRM_Core_BAO_ActionSchedule
::getMappings([
344 'id' => CRM_Event_ActionMapping
::EVENT_NAME_MAPPING_ID
,
346 $eventType = CRM_Core_OptionGroup
::values('event_type');
347 while ($dao->fetch()) {
348 if (in_array($dao->id
, $permittedEventsByAction[CRM_Core_Permission
::VIEW
])) {
349 $manageEvent[$dao->id
] = [
350 // Set defaults to prevent smarty e-notices, will be overwritten if populated.
352 'state_province' => '',
354 'loc_block_id' => '',
355 'participant_listing_id' => '',
357 $repeat = CRM_Core_BAO_RecurringEntity
::getPositionAndCount($dao->id
, 'civicrm_event');
358 $manageEvent[$dao->id
]['repeat'] = '';
360 $manageEvent[$dao->id
]['repeat'] = ts('Repeating (%1 of %2)', [1 => $repeat[0], 2 => $repeat[1]]);
362 CRM_Core_DAO
::storeValues($dao, $manageEvent[$dao->id
]);
364 // form all action links
365 $action = array_sum(array_keys($this->links()));
367 if ($dao->is_active
) {
368 $action -= CRM_Core_Action
::ENABLE
;
371 $action -= CRM_Core_Action
::DISABLE
;
374 if (!in_array($dao->id
, $permittedEventsByAction[CRM_Core_Permission
::DELETE
])) {
375 $action -= CRM_Core_Action
::DELETE
;
377 if (!in_array($dao->id
, $permittedEventsByAction[CRM_Core_Permission
::EDIT
])) {
378 $action -= CRM_Core_Action
::UPDATE
;
381 $eventLinks = self
::eventLinks();
382 if (!CRM_Core_Permission
::check('edit event participants')) {
383 unset($eventLinks['register_participant']);
386 $manageEvent[$dao->id
]['eventlinks'] = CRM_Core_Action
::formLink($eventLinks,
391 'event.manage.eventlinks',
395 $manageEvent[$dao->id
]['action'] = CRM_Core_Action
::formLink(self
::links(),
406 'entity_id' => $dao->id
,
407 'entity_table' => 'civicrm_event',
411 $defaults['location'] = CRM_Core_BAO_Location
::getValues($params, TRUE);
413 $manageEvent[$dao->id
]['friend'] = CRM_Friend_BAO_Friend
::getValues($params);
415 if (isset($defaults['location']['address'][1]['city'])) {
416 $manageEvent[$dao->id
]['city'] = $defaults['location']['address'][1]['city'];
418 if (isset($defaults['location']['address'][1]['state_province_id'])) {
419 $manageEvent[$dao->id
]['state_province'] = CRM_Core_PseudoConstant
::stateProvince($defaults['location']['address'][1]['state_province_id']);
422 //show campaigns on selector.
423 $manageEvent[$dao->id
]['campaign'] = $allCampaigns[$dao->campaign_id
] ??
NULL;
424 $manageEvent[$dao->id
]['reminder'] = CRM_Core_BAO_ActionSchedule
::isConfigured($dao->id
, $mapping->getId());
425 $manageEvent[$dao->id
]['is_pcp_enabled'] = $eventPCPS[$dao->id
] ??
NULL;
426 $manageEvent[$dao->id
]['event_type'] = $eventType[$manageEvent[$dao->id
]['event_type_id']] ??
NULL;
427 $manageEvent[$dao->id
]['is_repeating_event'] = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_RecurringEntity', $dao->id
, 'parent_id', 'entity_id');
428 // allow hooks to set 'field' value which allows configuration pop-up to show a tab as enabled/disabled
429 CRM_Utils_Hook
::tabset('civicrm/event/manage/rows', $manageEvent, ['event_id' => $dao->id
]);
433 $manageEvent['tab'] = self
::tabs();
434 $this->assign('rows', $manageEvent);
436 $statusTypes = CRM_Event_PseudoConstant
::participantStatus(NULL, 'is_counted = 1', 'label');
437 $statusTypesPending = CRM_Event_PseudoConstant
::participantStatus(NULL, 'is_counted = 0', 'label');
438 $findParticipants['statusCounted'] = implode(', ', array_values($statusTypes));
439 $findParticipants['statusNotCounted'] = implode(', ', array_values($statusTypesPending));
440 $this->assign('findParticipants', $findParticipants);
444 * make a copy of a Event, including
445 * all the fields in the event wizard
448 * @throws \CRM_Core_Exception
450 public function copy() {
451 $id = CRM_Utils_Request
::retrieve('id', 'Positive', $this, TRUE, 0, 'GET');
453 $urlString = 'civicrm/event/manage';
454 $copyEvent = CRM_Event_BAO_Event
::copy($id);
455 $urlParams = 'reset=1';
456 // Redirect to Copied Event Configuration
457 if ($copyEvent->id
) {
458 $urlString = 'civicrm/event/manage/settings';
459 $urlParams .= '&action=update&id=' . $copyEvent->id
;
462 return CRM_Utils_System
::redirect(CRM_Utils_System
::url($urlString, $urlParams));
465 public function search() {
466 if (isset($this->_action
) & (CRM_Core_Action
::ADD |
467 CRM_Core_Action
::UPDATE |
468 CRM_Core_Action
::DELETE
474 $form = new CRM_Core_Controller_Simple('CRM_Event_Form_SearchEvent', ts('Search Events'), CRM_Core_Action
::ADD
);
475 $form->setEmbedded(TRUE);
476 $form->setParent($this);
482 * @param array $params
483 * @param bool $sortBy
488 public function whereClause(&$params, $sortBy, $force) {
491 $title = $this->get('title');
492 $createdId = $this->get('cid');
495 $clauses[] = "(created_id = {$createdId})";
499 $clauses[] = "title LIKE %1";
500 if (strpos($title, '%') !== FALSE) {
501 $params[1] = [trim($title), 'String', FALSE];
504 $params[1] = [trim($title), 'String', TRUE];
508 $value = $this->get('event_type_id');
510 if (is_array($value)) {
511 $type = implode(',', $value);
513 $clauses[] = "event_type_id IN (%2)";
514 $params[2] = [$type, 'String'];
517 $eventsByDates = $this->get('eventsByDates');
518 if ($this->_searchResult
) {
519 if ($eventsByDates) {
521 $from = $this->get('start_date');
522 if (!CRM_Utils_System
::isNull($from)) {
523 $clauses[] = '( end_date >= %3 OR end_date IS NULL )';
524 $params[3] = [$from, 'String'];
527 $to = $this->get('end_date');
528 if (!CRM_Utils_System
::isNull($to)) {
529 $clauses[] = '( start_date <= %4 OR start_date IS NULL )';
530 $params[4] = [$to, 'String'];
534 $curDate = date('YmdHis');
535 $clauses[] = "(end_date >= {$curDate} OR end_date IS NULL)";
539 $curDate = date('YmdHis');
540 $clauses[] = "(end_date >= {$curDate} OR end_date IS NULL)";
544 $this->_sortByCharacter
!== NULL
546 $clauses[] = "title LIKE '" . strtolower(CRM_Core_DAO
::escapeWildCardString($this->_sortByCharacter
)) . "%'";
549 $campaignIds = $this->get('campaign_id');
550 if (!CRM_Utils_System
::isNull($campaignIds)) {
551 if (!is_array($campaignIds)) {
552 $campaignIds = [$campaignIds];
554 $clauses[] = '( campaign_id IN ( ' . implode(' , ', array_values($campaignIds)) . ' ) )';
557 // don't do a the below assignment when doing a
560 if (count($clauses) > 1 ||
$eventsByDates) {
561 $this->assign('isSearch', 1);
564 $this->assign('isSearch', 0);
568 return !empty($clauses) ?
implode(' AND ', $clauses) : '(1)';
572 * @param $whereClause
573 * @param array $whereParams
575 public function pager($whereClause, $whereParams) {
577 $params['status'] = ts('Event %%StatusMessage%%');
578 $params['csvString'] = NULL;
579 $params['buttonTop'] = 'PagerTopButton';
580 $params['buttonBottom'] = 'PagerBottomButton';
581 $params['rowCount'] = $this->get(CRM_Utils_Pager
::PAGE_ROWCOUNT
);
582 if (!$params['rowCount']) {
583 $params['rowCount'] = Civi
::settings()->get('default_pager_size');
591 $params['total'] = CRM_Core_DAO
::singleValueQuery($query, $whereParams);
593 $this->_pager
= new CRM_Utils_Pager($params);
594 $this->assign_by_ref('pager', $this->_pager
);
598 * @param $whereClause
599 * @param array $whereParams
601 public function pagerAtoZ($whereClause, $whereParams) {
604 SELECT DISTINCT UPPER(LEFT(title, 1)) as sort_name
607 ORDER BY UPPER(LEFT(title, 1))
609 $dao = CRM_Core_DAO
::executeQuery($query, $whereParams);
611 $aToZBar = CRM_Utils_PagerAToZ
::getAToZBar($dao, $this->_sortByCharacter
, TRUE);
612 $this->assign('aToZ', $aToZBar);