CRM/Event/Page/ManageEvent.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   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  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17
  18 /**
  19  * Page for displaying list of events
  20  */
  21 class CRM_Event_Page_ManageEvent extends CRM_Core_Page {
  22
  23   /**
  24    * The action links that we need to display for the browse screen.
  25    *
  26    * @var array
  27    */
  28   public static $_actionLinks = NULL;
  29
  30   /**
  31    * The event links to display for the browse screen.
  32    * @var array
  33    */
  34   public static $_eventLinks = NULL;
  35
  36   public static $_links = NULL;
  37
  38   public static $_tabLinks = NULL;
  39
  40   protected $_pager = NULL;
  41
  42   protected $_sortByCharacter;
  43
  44   protected $_isTemplate = FALSE;
  45
  46   /**
  47    * Get action Links.
  48    *
  49    * @return array
  50    *   (reference) of action links
  51    */
  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?');
  56       $deleteExtra = ts('Are you sure you want to delete this Event?');
  57
  58       self::$_actionLinks = [
  59         CRM_Core_Action::DISABLE => [
  60           'name' => ts('Disable'),
  61           'ref' => 'crm-enable-disable',
  62           'title' => ts('Disable Event'),
  63         ],
  64         CRM_Core_Action::ENABLE => [
  65           'name' => ts('Enable'),
  66           'ref' => 'crm-enable-disable',
  67           'title' => ts('Enable Event'),
  68         ],
  69         CRM_Core_Action::DELETE => [
  70           'name' => ts('Delete'),
  71           'url' => CRM_Utils_System::currentPath(),
  72           'qs' => 'action=delete&id=%%id%%',
  73           'extra' => 'onclick = "return confirm(\'' . $deleteExtra . '\');"',
  74           'title' => ts('Delete Event'),
  75         ],
  76         CRM_Core_Action::COPY => [
  77           'name' => ts('Copy'),
  78           'url' => CRM_Utils_System::currentPath(),
  79           'qs' => 'reset=1&action=copy&id=%%id%%',
  80           'extra' => 'onclick = "return confirm(\'' . $copyExtra . '\');"',
  81           'title' => ts('Copy Event'),
  82         ],
  83       ];
  84     }
  85     return self::$_actionLinks;
  86   }
  87
  88   public function eventLinks() {
  89     if (!(self::$_eventLinks)) {
  90       self::$_eventLinks = [
  91         'register_participant' => [
  92           'name' => ts('Register Participant'),
  93           'title' => ts('Register Participant'),
  94           'url' => 'civicrm/participant/add',
  95           'qs' => 'reset=1&action=add&context=standalone&eid=%%id%%',
  96         ],
  97         'event_info' => [
  98           'name' => ts('Event Info'),
  99           'title' => ts('Event Info'),
 100           'url' => 'civicrm/event/info',
 101           'qs' => 'reset=1&id=%%id%%',
 102           'fe' => TRUE,
 103         ],
 104         'online_registration_test' => [
 105           'name' => ts('Registration (Test-drive)'),
 106           'title' => ts('Online Registration (Test-drive)'),
 107           'url' => 'civicrm/event/register',
 108           'qs' => 'reset=1&action=preview&id=%%id%%',
 109           'fe' => TRUE,
 110         ],
 111         'online_registration_live' => [
 112           'name' => ts('Registration (Live)'),
 113           'title' => ts('Online Registration (Live)'),
 114           'url' => 'civicrm/event/register',
 115           'qs' => 'reset=1&id=%%id%%',
 116           'fe' => TRUE,
 117         ],
 118       ];
 119     }
 120     return self::$_eventLinks;
 121   }
 122
 123   /**
 124    * Get tab  Links for events.
 125    *
 126    * @return array
 127    *   (reference) of tab links
 128    * @throws \CiviCRM_API3_Exception
 129    */
 130   public static function &tabs() {
 131     // @todo Move to eventcart extension
 132     // check if we're in shopping cart mode for events
 133     $enableCart = (bool) Civi::settings()->get('enable_cart');
 134
 135     $cacheKey = $enableCart ? 1 : 0;
 136     if (!(self::$_tabLinks)) {
 137       self::$_tabLinks = [];
 138     }
 139     if (!isset(self::$_tabLinks[$cacheKey])) {
 140       self::$_tabLinks[$cacheKey]['settings']
 141         = [
 142           'title' => ts('Info and Settings'),
 143           'url' => 'civicrm/event/manage/settings',
 144           'field' => 'id',
 145         ];
 146       self::$_tabLinks[$cacheKey]['location']
 147         = [
 148           'title' => ts('Location'),
 149           'url' => 'civicrm/event/manage/location',
 150           'field' => 'loc_block_id',
 151         ];
 152
 153       self::$_tabLinks[$cacheKey]['fee']
 154         = [
 155           'title' => ts('Fees'),
 156           'url' => 'civicrm/event/manage/fee',
 157           'field' => 'is_monetary',
 158         ];
 159       self::$_tabLinks[$cacheKey]['registration']
 160         = [
 161           'title' => ts('Online Registration'),
 162           'url' => 'civicrm/event/manage/registration',
 163           'field' => 'is_online_registration',
 164         ];
 165
 166       // @fixme I don't understand the event permissions check here - can we just get rid of it?
 167       $permissions = CRM_Event_BAO_Event::getAllPermissions();
 168       if (CRM_Core_Permission::check('administer CiviCRM data') || !empty($permissions[CRM_Core_Permission::EDIT])) {
 169         self::$_tabLinks[$cacheKey]['reminder']
 170           = [
 171             'title' => ts('Schedule Reminders'),
 172             'url' => 'civicrm/event/manage/reminder',
 173             'field' => 'reminder',
 174           ];
 175       }
 176       self::$_tabLinks[$cacheKey]['conference']
 177         = [
 178           'title' => ts('Conference Slots'),
 179           'url' => 'civicrm/event/manage/conference',
 180           'field' => 'slot_label_id',
 181         ];
 182       self::$_tabLinks[$cacheKey]['friend']
 183         = [
 184           'title' => ts('Tell a Friend'),
 185           'url' => 'civicrm/event/manage/friend',
 186           'field' => 'friend',
 187         ];
 188       self::$_tabLinks[$cacheKey]['pcp']
 189         = [
 190           'title' => ts('Personal Campaign Pages'),
 191           'url' => 'civicrm/event/manage/pcp',
 192           'field' => 'is_pcp_enabled',
 193         ];
 194       self::$_tabLinks[$cacheKey]['repeat']
 195         = [
 196           'title' => ts('Repeat'),
 197           'url' => 'civicrm/event/manage/repeat',
 198           'field' => 'is_repeating_event',
 199         ];
 200     }
 201
 202     if (!$enableCart) {
 203       unset(self::$_tabLinks[$cacheKey]['conference']);
 204     }
 205
 206     CRM_Utils_Hook::tabset('civicrm/event/manage', self::$_tabLinks[$cacheKey], []);
 207     return self::$_tabLinks[$cacheKey];
 208   }
 209
 210   /**
 211    * Run the page.
 212    *
 213    * This method is called after the page is created. It checks for the
 214    * type of action and executes that action.
 215    * Finally it calls the parent's run method.
 216    *
 217    * @return void
 218    */
 219   public function run() {
 220     // get the requested action
 221     $action = CRM_Utils_Request::retrieve('action', 'String',
 222       // default to 'browse'
 223       $this, FALSE, 'browse'
 224     );
 225
 226     // assign vars to templates
 227     $this->assign('action', $action);
 228     $this->assign('iCal', CRM_Event_BAO_Event::getICalLinks());
 229     $id = CRM_Utils_Request::retrieve('id', 'Positive',
 230       $this, FALSE, 0, 'REQUEST'
 231     );
 232
 233     // figure out whether we’re handling an event or an event template
 234     if ($id) {
 235       $this->_isTemplate = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Event', $id, 'is_template');
 236     }
 237     elseif ($action & CRM_Core_Action::ADD) {
 238       $this->_isTemplate = CRM_Utils_Request::retrieve('is_template', 'Boolean', $this);
 239     }
 240
 241     if (!$this->_isTemplate && $id) {
 242       $breadCrumb = [
 243         [
 244           'title' => ts('Manage Events'),
 245           'url' => CRM_Utils_System::url(CRM_Utils_System::currentPath(), 'reset=1'),
 246         ],
 247       ];
 248       CRM_Utils_System::appendBreadCrumb($breadCrumb);
 249     }
 250
 251     // what action to take ?
 252     if ($action & CRM_Core_Action::DELETE) {
 253       $session = CRM_Core_Session::singleton();
 254       $session->pushUserContext(CRM_Utils_System::url(CRM_Utils_System::currentPath(), 'reset=1&action=browse'));
 255       $controller = new CRM_Core_Controller_Simple('CRM_Event_Form_ManageEvent_Delete',
 256         'Delete Event',
 257         $action
 258       );
 259       $controller->set('id', $id);
 260       $controller->process();
 261       return $controller->run();
 262     }
 263     elseif ($action & CRM_Core_Action::COPY) {
 264       $this->copy();
 265     }
 266
 267     // finally browse the custom groups
 268     $this->browse();
 269
 270     // parent run
 271     return parent::run();
 272   }
 273
 274   /**
 275    * Browse all events.
 276    *
 277    * @return void
 278    */
 279   public function browse() {
 280     Civi::resources()->addStyleFile('civicrm', 'css/searchForm.css', 1, 'html-header');
 281
 282     $this->_sortByCharacter = CRM_Utils_Request::retrieve('sortByCharacter',
 283       'String',
 284       $this
 285     );
 286     $createdId = CRM_Utils_Request::retrieve('cid', 'Positive', $this, FALSE, 0);
 287     if (strtolower($this->_sortByCharacter) == 'all' ||
 288       !empty($_POST)
 289     ) {
 290       $this->_sortByCharacter = '';
 291       $this->set('sortByCharacter', '');
 292     }
 293
 294     $this->_force = $this->_searchResult = NULL;
 295
 296     $this->search();
 297
 298     $params = [];
 299     $this->_force = CRM_Utils_Request::retrieve('force', 'Boolean',
 300       $this, FALSE
 301     );
 302     $this->_searchResult = CRM_Utils_Request::retrieve('searchResult', 'Boolean', $this);
 303
 304     $whereClause = $this->whereClause($params, FALSE, $this->_force);
 305
 306     if (CRM_Core_Config::singleton()->includeAlphabeticalPager) {
 307       $this->pagerAToZ($whereClause, $params);
 308     }
 309
 310     $params = [];
 311     $whereClause = $this->whereClause($params, TRUE, $this->_force);
 312     // because is_template != 1 would be to simple
 313     $whereClause .= ' AND (is_template = 0 OR is_template IS NULL)';
 314
 315     $this->pager($whereClause, $params);
 316
 317     list($offset, $rowCount) = $this->_pager->getOffsetAndRowCount();
 318
 319     // get all custom groups sorted by weight
 320     $manageEvent = [];
 321
 322     $query = "
 323   SELECT *
 324     FROM civicrm_event
 325    WHERE $whereClause
 326 ORDER BY start_date desc
 327    LIMIT $offset, $rowCount";
 328
 329     $dao = CRM_Core_DAO::executeQuery($query, $params, TRUE, 'CRM_Event_DAO_Event');
 330     $permittedEventsByAction = CRM_Event_BAO_Event::getAllPermissions();
 331
 332     //get all campaigns.
 333     $allCampaigns = CRM_Campaign_BAO_Campaign::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
 334
 335     // get the list of active event pcps
 336     $eventPCPS = [];
 337
 338     $pcpDao = new CRM_PCP_DAO_PCPBlock();
 339     $pcpDao->entity_table = 'civicrm_event';
 340     $pcpDao->find();
 341
 342     while ($pcpDao->fetch()) {
 343       $eventPCPS[$pcpDao->entity_id] = $pcpDao->entity_id;
 344     }
 345     $mapping = CRM_Utils_Array::first(CRM_Core_BAO_ActionSchedule::getMappings([
 346       'id' => CRM_Event_ActionMapping::EVENT_NAME_MAPPING_ID,
 347     ]));
 348     $eventType = CRM_Core_OptionGroup::values('event_type');
 349     while ($dao->fetch()) {
 350       if (in_array($dao->id, $permittedEventsByAction[CRM_Core_Permission::VIEW])) {
 351         $manageEvent[$dao->id] = [];
 352         $repeat = CRM_Core_BAO_RecurringEntity::getPositionAndCount($dao->id, 'civicrm_event');
 353         $manageEvent[$dao->id]['repeat'] = '';
 354         if ($repeat) {
 355           $manageEvent[$dao->id]['repeat'] = ts('Repeating (%1 of %2)', [1 => $repeat[0], 2 => $repeat[1]]);
 356         }
 357         CRM_Core_DAO::storeValues($dao, $manageEvent[$dao->id]);
 358
 359         // form all action links
 360         $action = array_sum(array_keys($this->links()));
 361
 362         if ($dao->is_active) {
 363           $action -= CRM_Core_Action::ENABLE;
 364         }
 365         else {
 366           $action -= CRM_Core_Action::DISABLE;
 367         }
 368
 369         if (!in_array($dao->id, $permittedEventsByAction[CRM_Core_Permission::DELETE])) {
 370           $action -= CRM_Core_Action::DELETE;
 371         }
 372         if (!in_array($dao->id, $permittedEventsByAction[CRM_Core_Permission::EDIT])) {
 373           $action -= CRM_Core_Action::UPDATE;
 374         }
 375
 376         $eventLinks = self::eventLinks();
 377         if (!CRM_Core_Permission::check('edit event participants')) {
 378           unset($eventLinks['register_participant']);
 379         }
 380
 381         $manageEvent[$dao->id]['eventlinks'] = CRM_Core_Action::formLink($eventLinks,
 382           NULL,
 383           ['id' => $dao->id],
 384           ts('Event Links'),
 385           TRUE,
 386           'event.manage.eventlinks',
 387           'Event',
 388           $dao->id
 389         );
 390         $manageEvent[$dao->id]['action'] = CRM_Core_Action::formLink(self::links(),
 391           $action,
 392           ['id' => $dao->id],
 393           ts('more'),
 394           TRUE,
 395           'event.manage.list',
 396           'Event',
 397           $dao->id
 398         );
 399
 400         $params = [
 401           'entity_id' => $dao->id,
 402           'entity_table' => 'civicrm_event',
 403           'is_active' => 1,
 404         ];
 405
 406         $defaults['location'] = CRM_Core_BAO_Location::getValues($params, TRUE);
 407
 408         $manageEvent[$dao->id]['friend'] = CRM_Friend_BAO_Friend::getValues($params);
 409
 410         if (isset($defaults['location']['address'][1]['city'])) {
 411           $manageEvent[$dao->id]['city'] = $defaults['location']['address'][1]['city'];
 412         }
 413         if (isset($defaults['location']['address'][1]['state_province_id'])) {
 414           $manageEvent[$dao->id]['state_province'] = CRM_Core_PseudoConstant::stateProvince($defaults['location']['address'][1]['state_province_id']);
 415         }
 416
 417         //show campaigns on selector.
 418         $manageEvent[$dao->id]['campaign'] = $allCampaigns[$dao->campaign_id] ?? NULL;
 419         $manageEvent[$dao->id]['reminder'] = CRM_Core_BAO_ActionSchedule::isConfigured($dao->id, $mapping->getId());
 420         $manageEvent[$dao->id]['is_pcp_enabled'] = $eventPCPS[$dao->id] ?? NULL;
 421         $manageEvent[$dao->id]['event_type'] = $eventType[$manageEvent[$dao->id]['event_type_id']] ?? NULL;
 422         $manageEvent[$dao->id]['is_repeating_event'] = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_RecurringEntity', $dao->id, 'parent_id', 'entity_id');
 423         // allow hooks to set 'field' value which allows configuration pop-up to show a tab as enabled/disabled
 424         CRM_Utils_Hook::tabset('civicrm/event/manage/rows', $manageEvent, ['event_id' => $dao->id]);
 425       }
 426     }
 427
 428     $manageEvent['tab'] = self::tabs();
 429     $this->assign('rows', $manageEvent);
 430
 431     $statusTypes = CRM_Event_PseudoConstant::participantStatus(NULL, 'is_counted = 1', 'label');
 432     $statusTypesPending = CRM_Event_PseudoConstant::participantStatus(NULL, 'is_counted = 0', 'label');
 433     $findParticipants['statusCounted'] = implode(', ', array_values($statusTypes));
 434     $findParticipants['statusNotCounted'] = implode(', ', array_values($statusTypesPending));
 435     $this->assign('findParticipants', $findParticipants);
 436   }
 437
 438   /**
 439    * make a copy of a Event, including
 440    * all the fields in the event wizard
 441    *
 442    * @return void
 443    * @throws \CRM_Core_Exception
 444    */
 445   public function copy() {
 446     $id = CRM_Utils_Request::retrieve('id', 'Positive', $this, TRUE, 0, 'GET');
 447
 448     $urlString = 'civicrm/event/manage';
 449     $copyEvent = CRM_Event_BAO_Event::copy($id);
 450     $urlParams = 'reset=1';
 451     // Redirect to Copied Event Configuration
 452     if ($copyEvent->id) {
 453       $urlString = 'civicrm/event/manage/settings';
 454       $urlParams .= '&action=update&id=' . $copyEvent->id;
 455     }
 456
 457     return CRM_Utils_System::redirect(CRM_Utils_System::url($urlString, $urlParams));
 458   }
 459
 460   public function search() {
 461     if (isset($this->_action) & (CRM_Core_Action::ADD |
 462         CRM_Core_Action::UPDATE |
 463         CRM_Core_Action::DELETE
 464       )
 465     ) {
 466       return;
 467     }
 468
 469     $form = new CRM_Core_Controller_Simple('CRM_Event_Form_SearchEvent', ts('Search Events'), CRM_Core_Action::ADD);
 470     $form->setEmbedded(TRUE);
 471     $form->setParent($this);
 472     $form->process();
 473     $form->run();
 474   }
 475
 476   /**
 477    * @param array $params
 478    * @param bool $sortBy
 479    * @param $force
 480    *
 481    * @return string
 482    */
 483   public function whereClause(&$params, $sortBy, $force) {
 484     $values = [];
 485     $clauses = [];
 486     $title = $this->get('title');
 487     $createdId = $this->get('cid');
 488
 489     if ($createdId) {
 490       $clauses[] = "(created_id = {$createdId})";
 491     }
 492
 493     if ($title) {
 494       $clauses[] = "title LIKE %1";
 495       if (strpos($title, '%') !== FALSE) {
 496         $params[1] = [trim($title), 'String', FALSE];
 497       }
 498       else {
 499         $params[1] = [trim($title), 'String', TRUE];
 500       }
 501     }
 502
 503     $value = $this->get('event_type_id');
 504     if ($value) {
 505       if (is_array($value)) {
 506         $type = implode(',', $value);
 507       }
 508       $clauses[] = "event_type_id IN (%2)";
 509       $params[2] = [$type, 'String'];
 510     }
 511
 512     $eventsByDates = $this->get('eventsByDates');
 513     if ($this->_searchResult) {
 514       if ($eventsByDates) {
 515
 516         $from = $this->get('start_date');
 517         if (!CRM_Utils_System::isNull($from)) {
 518           $clauses[] = '( end_date >= %3 OR end_date IS NULL )';
 519           $params[3] = [$from, 'String'];
 520         }
 521
 522         $to = $this->get('end_date');
 523         if (!CRM_Utils_System::isNull($to)) {
 524           $clauses[] = '( start_date <= %4 OR start_date IS NULL )';
 525           $params[4] = [$to, 'String'];
 526         }
 527       }
 528       else {
 529         $curDate = date('YmdHis');
 530         $clauses[] = "(end_date >= {$curDate} OR end_date IS NULL)";
 531       }
 532     }
 533     else {
 534       $curDate = date('YmdHis');
 535       $clauses[] = "(end_date >= {$curDate} OR end_date IS NULL)";
 536     }
 537
 538     if ($sortBy &&
 539       $this->_sortByCharacter !== NULL
 540     ) {
 541       $clauses[] = "title LIKE '" . strtolower(CRM_Core_DAO::escapeWildCardString($this->_sortByCharacter)) . "%'";
 542     }
 543
 544     $campaignIds = $this->get('campaign_id');
 545     if (!CRM_Utils_System::isNull($campaignIds)) {
 546       if (!is_array($campaignIds)) {
 547         $campaignIds = [$campaignIds];
 548       }
 549       $clauses[] = '( campaign_id IN ( ' . implode(' , ', array_values($campaignIds)) . ' ) )';
 550     }
 551
 552     // don't do a the below assignment when doing a
 553     // AtoZ pager clause
 554     if ($sortBy) {
 555       if (count($clauses) > 1 || $eventsByDates) {
 556         $this->assign('isSearch', 1);
 557       }
 558       else {
 559         $this->assign('isSearch', 0);
 560       }
 561     }
 562
 563     return !empty($clauses) ? implode(' AND ', $clauses) : '(1)';
 564   }
 565
 566   /**
 567    * @param $whereClause
 568    * @param array $whereParams
 569    */
 570   public function pager($whereClause, $whereParams) {
 571
 572     $params['status'] = ts('Event %%StatusMessage%%');
 573     $params['csvString'] = NULL;
 574     $params['buttonTop'] = 'PagerTopButton';
 575     $params['buttonBottom'] = 'PagerBottomButton';
 576     $params['rowCount'] = $this->get(CRM_Utils_Pager::PAGE_ROWCOUNT);
 577     if (!$params['rowCount']) {
 578       $params['rowCount'] = Civi::settings()->get('default_pager_size');
 579     }
 580
 581     $query = "
 582 SELECT count(id)
 583   FROM civicrm_event
 584  WHERE $whereClause";
 585
 586     $params['total'] = CRM_Core_DAO::singleValueQuery($query, $whereParams);
 587
 588     $this->_pager = new CRM_Utils_Pager($params);
 589     $this->assign_by_ref('pager', $this->_pager);
 590   }
 591
 592   /**
 593    * @param $whereClause
 594    * @param array $whereParams
 595    */
 596   public function pagerAtoZ($whereClause, $whereParams) {
 597
 598     $query = "
 599    SELECT DISTINCT UPPER(LEFT(title, 1)) as sort_name
 600      FROM civicrm_event
 601     WHERE $whereClause
 602  ORDER BY UPPER(LEFT(title, 1))
 603 ";
 604     $dao = CRM_Core_DAO::executeQuery($query, $whereParams);
 605
 606     $aToZBar = CRM_Utils_PagerAToZ::getAToZBar($dao, $this->_sortByCharacter, TRUE);
 607     $this->assign('aToZ', $aToZBar);
 608   }
 609
 610 }