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
21 * Page for displaying list of events
23 class CRM_Event_Page_ManageEvent
extends CRM_Core_Page
{
26 * The action links that we need to display for the browse screen.
30 public static $_actionLinks = NULL;
33 * The event links to display for the browse screen.
36 public static $_eventLinks = NULL;
38 public static $_links = NULL;
40 public static $_tabLinks = NULL;
42 protected $_pager = NULL;
44 protected $_sortByCharacter;
46 protected $_isTemplate = FALSE;
52 * (reference) of action links
54 public function &links() {
55 if (!(self
::$_actionLinks)) {
56 // helper variable for nicer formatting
57 $copyExtra = ts('Are you sure you want to make a copy of this Event?');
58 $deleteExtra = ts('Are you sure you want to delete this Event?');
60 self
::$_actionLinks = [
61 CRM_Core_Action
::DISABLE
=> [
62 'name' => ts('Disable'),
63 'ref' => 'crm-enable-disable',
64 'title' => ts('Disable Event'),
66 CRM_Core_Action
::ENABLE
=> [
67 'name' => ts('Enable'),
68 'ref' => 'crm-enable-disable',
69 'title' => ts('Enable Event'),
71 CRM_Core_Action
::DELETE
=> [
72 'name' => ts('Delete'),
73 'url' => CRM_Utils_System
::currentPath(),
74 'qs' => 'action=delete&id=%%id%%',
75 'extra' => 'onclick = "return confirm(\'' . $deleteExtra . '\');"',
76 'title' => ts('Delete Event'),
78 CRM_Core_Action
::COPY
=> [
80 'url' => CRM_Utils_System
::currentPath(),
81 'qs' => 'reset=1&action=copy&id=%%id%%',
82 'extra' => 'onclick = "return confirm(\'' . $copyExtra . '\');"',
83 'title' => ts('Copy Event'),
87 return self
::$_actionLinks;
90 public function eventLinks() {
91 if (!(self
::$_eventLinks)) {
92 self
::$_eventLinks = [
93 'register_participant' => [
94 'name' => ts('Register Participant'),
95 'title' => ts('Register Participant'),
96 'url' => 'civicrm/participant/add',
97 'qs' => 'reset=1&action=add&context=standalone&eid=%%id%%',
100 'name' => ts('Event Info'),
101 'title' => ts('Event Info'),
102 'url' => 'civicrm/event/info',
103 'qs' => 'reset=1&id=%%id%%',
106 'online_registration_test' => [
107 'name' => ts('Registration (Test-drive)'),
108 'title' => ts('Online Registration (Test-drive)'),
109 'url' => 'civicrm/event/register',
110 'qs' => 'reset=1&action=preview&id=%%id%%',
113 'online_registration_live' => [
114 'name' => ts('Registration (Live)'),
115 'title' => ts('Online Registration (Live)'),
116 'url' => 'civicrm/event/register',
117 'qs' => 'reset=1&id=%%id%%',
122 return self
::$_eventLinks;
126 * Get tab Links for events.
131 * (reference) of tab links
133 public static function &tabs($enableCart) {
134 $cacheKey = $enableCart ?
1 : 0;
135 if (!(self
::$_tabLinks)) {
136 self
::$_tabLinks = [];
138 if (!isset(self
::$_tabLinks[$cacheKey])) {
139 self
::$_tabLinks[$cacheKey]['settings']
141 'title' => ts('Info and Settings'),
142 'url' => 'civicrm/event/manage/settings',
145 self
::$_tabLinks[$cacheKey]['location']
147 'title' => ts('Location'),
148 'url' => 'civicrm/event/manage/location',
149 'field' => 'loc_block_id',
152 self
::$_tabLinks[$cacheKey]['fee']
154 'title' => ts('Fees'),
155 'url' => 'civicrm/event/manage/fee',
156 'field' => 'is_monetary',
158 self
::$_tabLinks[$cacheKey]['registration']
160 'title' => ts('Online Registration'),
161 'url' => 'civicrm/event/manage/registration',
162 'field' => 'is_online_registration',
165 // @fixme I don't understand the event permissions check here - can we just get rid of it?
166 $permissions = CRM_Event_BAO_Event
::getAllPermissions();
167 if (CRM_Core_Permission
::check('administer CiviCRM') ||
!empty($permissions[CRM_Core_Permission
::EDIT
])) {
168 self
::$_tabLinks[$cacheKey]['reminder']
170 'title' => ts('Schedule Reminders'),
171 'url' => 'civicrm/event/manage/reminder',
172 'field' => 'reminder',
175 self
::$_tabLinks[$cacheKey]['conference']
177 'title' => ts('Conference Slots'),
178 'url' => 'civicrm/event/manage/conference',
179 'field' => 'slot_label_id',
181 self
::$_tabLinks[$cacheKey]['friend']
183 'title' => ts('Tell a Friend'),
184 'url' => 'civicrm/event/manage/friend',
187 self
::$_tabLinks[$cacheKey]['pcp']
189 'title' => ts('Personal Campaign Pages'),
190 'url' => 'civicrm/event/manage/pcp',
191 'field' => 'is_pcp_enabled',
193 self
::$_tabLinks[$cacheKey]['repeat']
195 'title' => ts('Repeat'),
196 'url' => 'civicrm/event/manage/repeat',
197 'field' => 'is_repeating_event',
202 unset(self
::$_tabLinks[$cacheKey]['conference']);
205 CRM_Utils_Hook
::tabset('civicrm/event/manage', self
::$_tabLinks[$cacheKey], []);
206 return self
::$_tabLinks[$cacheKey];
212 * This method is called after the page is created. It checks for the
213 * type of action and executes that action.
214 * Finally it calls the parent's run method.
218 public function run() {
219 // get the requested action
220 $action = CRM_Utils_Request
::retrieve('action', 'String',
221 // default to 'browse'
222 $this, FALSE, 'browse'
225 // assign vars to templates
226 $this->assign('action', $action);
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 // check if we're in shopping cart mode for events
344 $enableCart = Civi
::settings()->get('enable_cart');
345 $this->assign('eventCartEnabled', $enableCart);
346 $mapping = CRM_Utils_Array
::first(CRM_Core_BAO_ActionSchedule
::getMappings([
347 'id' => CRM_Event_ActionMapping
::EVENT_NAME_MAPPING_ID
,
349 $eventType = CRM_Core_OptionGroup
::values('event_type');
350 while ($dao->fetch()) {
351 if (in_array($dao->id
, $permittedEventsByAction[CRM_Core_Permission
::VIEW
])) {
352 $manageEvent[$dao->id
] = [];
353 $repeat = CRM_Core_BAO_RecurringEntity
::getPositionAndCount($dao->id
, 'civicrm_event');
354 $manageEvent[$dao->id
]['repeat'] = '';
356 $manageEvent[$dao->id
]['repeat'] = ts('Repeating (%1 of %2)', [1 => $repeat[0], 2 => $repeat[1]]);
358 CRM_Core_DAO
::storeValues($dao, $manageEvent[$dao->id
]);
360 // form all action links
361 $action = array_sum(array_keys($this->links()));
363 if ($dao->is_active
) {
364 $action -= CRM_Core_Action
::ENABLE
;
367 $action -= CRM_Core_Action
::DISABLE
;
370 if (!in_array($dao->id
, $permittedEventsByAction[CRM_Core_Permission
::DELETE
])) {
371 $action -= CRM_Core_Action
::DELETE
;
373 if (!in_array($dao->id
, $permittedEventsByAction[CRM_Core_Permission
::EDIT
])) {
374 $action -= CRM_Core_Action
::UPDATE
;
377 $eventLinks = self
::eventLinks();
378 if (!CRM_Core_Permission
::check('edit event participants')) {
379 unset($eventLinks['register_participant']);
382 $manageEvent[$dao->id
]['eventlinks'] = CRM_Core_Action
::formLink($eventLinks,
387 'event.manage.eventlinks',
391 $manageEvent[$dao->id
]['action'] = CRM_Core_Action
::formLink(self
::links(),
402 'entity_id' => $dao->id
,
403 'entity_table' => 'civicrm_event',
407 $defaults['location'] = CRM_Core_BAO_Location
::getValues($params, TRUE);
409 $manageEvent[$dao->id
]['friend'] = CRM_Friend_BAO_Friend
::getValues($params);
411 if (isset($defaults['location']['address'][1]['city'])) {
412 $manageEvent[$dao->id
]['city'] = $defaults['location']['address'][1]['city'];
414 if (isset($defaults['location']['address'][1]['state_province_id'])) {
415 $manageEvent[$dao->id
]['state_province'] = CRM_Core_PseudoConstant
::stateProvince($defaults['location']['address'][1]['state_province_id']);
418 //show campaigns on selector.
419 $manageEvent[$dao->id
]['campaign'] = CRM_Utils_Array
::value($dao->campaign_id
, $allCampaigns);
420 $manageEvent[$dao->id
]['reminder'] = CRM_Core_BAO_ActionSchedule
::isConfigured($dao->id
, $mapping->getId());
421 $manageEvent[$dao->id
]['is_pcp_enabled'] = CRM_Utils_Array
::value($dao->id
, $eventPCPS);
422 $manageEvent[$dao->id
]['event_type'] = CRM_Utils_Array
::value($manageEvent[$dao->id
]['event_type_id'], $eventType);
423 $manageEvent[$dao->id
]['is_repeating_event'] = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_RecurringEntity', $dao->id
, 'parent_id', 'entity_id');
424 // allow hooks to set 'field' value which allows configuration pop-up to show a tab as enabled/disabled
425 CRM_Utils_Hook
::tabset('civicrm/event/manage/rows', $manageEvent, ['event_id' => $dao->id
]);
429 $manageEvent['tab'] = self
::tabs($enableCart);
430 $this->assign('rows', $manageEvent);
432 $statusTypes = CRM_Event_PseudoConstant
::participantStatus(NULL, 'is_counted = 1', 'label');
433 $statusTypesPending = CRM_Event_PseudoConstant
::participantStatus(NULL, 'is_counted = 0', 'label');
434 $findParticipants['statusCounted'] = implode(', ', array_values($statusTypes));
435 $findParticipants['statusNotCounted'] = implode(', ', array_values($statusTypesPending));
436 $this->assign('findParticipants', $findParticipants);
440 * make a copy of a Event, including
441 * all the fields in the event wizard
444 * @throws \CRM_Core_Exception
446 public function copy() {
447 $id = CRM_Utils_Request
::retrieve('id', 'Positive', $this, TRUE, 0, 'GET');
449 $urlString = 'civicrm/event/manage';
450 $copyEvent = CRM_Event_BAO_Event
::copy($id);
451 $urlParams = 'reset=1';
452 // Redirect to Copied Event Configuration
453 if ($copyEvent->id
) {
454 $urlString = 'civicrm/event/manage/settings';
455 $urlParams .= '&action=update&id=' . $copyEvent->id
;
458 return CRM_Utils_System
::redirect(CRM_Utils_System
::url($urlString, $urlParams));
461 public function search() {
462 if (isset($this->_action
) & (CRM_Core_Action
::ADD |
463 CRM_Core_Action
::UPDATE |
464 CRM_Core_Action
::DELETE
470 $form = new CRM_Core_Controller_Simple('CRM_Event_Form_SearchEvent', ts('Search Events'), CRM_Core_Action
::ADD
);
471 $form->setEmbedded(TRUE);
472 $form->setParent($this);
478 * @param array $params
479 * @param bool $sortBy
484 public function whereClause(&$params, $sortBy = TRUE, $force) {
487 $title = $this->get('title');
488 $createdId = $this->get('cid');
491 $clauses[] = "(created_id = {$createdId})";
495 $clauses[] = "title LIKE %1";
496 if (strpos($title, '%') !== FALSE) {
497 $params[1] = [trim($title), 'String', FALSE];
500 $params[1] = [trim($title), 'String', TRUE];
504 $value = $this->get('event_type_id');
506 if (is_array($value)) {
507 $type = implode(',', $value);
509 $clauses[] = "event_type_id IN (%2)";
510 $params[2] = [$type, 'String'];
513 $eventsByDates = $this->get('eventsByDates');
514 if ($this->_searchResult
) {
515 if ($eventsByDates) {
517 $from = $this->get('start_date');
518 if (!CRM_Utils_System
::isNull($from)) {
519 $clauses[] = '( end_date >= %3 OR end_date IS NULL )';
520 $params[3] = [$from, 'String'];
523 $to = $this->get('end_date');
524 if (!CRM_Utils_System
::isNull($to)) {
525 $clauses[] = '( start_date <= %4 OR start_date IS NULL )';
526 $params[4] = [$to, 'String'];
530 $curDate = date('YmdHis');
531 $clauses[] = "(end_date >= {$curDate} OR end_date IS NULL)";
535 $curDate = date('YmdHis');
536 $clauses[] = "(end_date >= {$curDate} OR end_date IS NULL)";
540 $this->_sortByCharacter
!== NULL
542 $clauses[] = "title LIKE '" . strtolower(CRM_Core_DAO
::escapeWildCardString($this->_sortByCharacter
)) . "%'";
545 $campaignIds = $this->get('campaign_id');
546 if (!CRM_Utils_System
::isNull($campaignIds)) {
547 if (!is_array($campaignIds)) {
548 $campaignIds = [$campaignIds];
550 $clauses[] = '( campaign_id IN ( ' . implode(' , ', array_values($campaignIds)) . ' ) )';
553 // don't do a the below assignment when doing a
556 if (count($clauses) > 1 ||
$eventsByDates) {
557 $this->assign('isSearch', 1);
560 $this->assign('isSearch', 0);
564 return !empty($clauses) ?
implode(' AND ', $clauses) : '(1)';
568 * @param $whereClause
569 * @param array $whereParams
571 public function pager($whereClause, $whereParams) {
573 $params['status'] = ts('Event %%StatusMessage%%');
574 $params['csvString'] = NULL;
575 $params['buttonTop'] = 'PagerTopButton';
576 $params['buttonBottom'] = 'PagerBottomButton';
577 $params['rowCount'] = $this->get(CRM_Utils_Pager
::PAGE_ROWCOUNT
);
578 if (!$params['rowCount']) {
579 $params['rowCount'] = CRM_Utils_Pager
::ROWCOUNT
;
587 $params['total'] = CRM_Core_DAO
::singleValueQuery($query, $whereParams);
589 $this->_pager
= new CRM_Utils_Pager($params);
590 $this->assign_by_ref('pager', $this->_pager
);
594 * @param $whereClause
595 * @param array $whereParams
597 public function pagerAtoZ($whereClause, $whereParams) {
600 SELECT DISTINCT UPPER(LEFT(title, 1)) as sort_name
603 ORDER BY UPPER(LEFT(title, 1))
605 $dao = CRM_Core_DAO
::executeQuery($query, $whereParams);
607 $aToZBar = CRM_Utils_PagerAToZ
::getAToZBar($dao, $this->_sortByCharacter
, TRUE);
608 $this->assign('aToZ', $aToZBar);