CRM/Event/Page/EventInfo.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  * Event Info Page - Summary about the event
  20  */
  21 class CRM_Event_Page_EventInfo extends CRM_Core_Page {
  22
  23   /**
  24    * Run the page.
  25    *
  26    * This method is called after the page is created. It checks for the
  27    * type of action and executes that action.
  28    * Finally it calls the parent's run method.
  29    *
  30    * @return void
  31    */
  32   public function run() {
  33     //get the event id.
  34     $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this, TRUE);
  35     $config = CRM_Core_Config::singleton();
  36     // ensure that the user has permission to see this page
  37     if (!CRM_Core_Permission::event(CRM_Core_Permission::VIEW,
  38       $this->_id, 'view event info'
  39     )
  40     ) {
  41       CRM_Utils_System::setUFMessage(ts('You do not have permission to view this event'));
  42       return CRM_Utils_System::permissionDenied();
  43     }
  44
  45     $action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE);
  46     $context = CRM_Utils_Request::retrieve('context', 'Alphanumeric', $this, FALSE, 'register');
  47     $this->assign('context', $context);
  48
  49     $this->assign('iCal', CRM_Event_BAO_Event::getICalLinks($this->_id));
  50
  51     // Sometimes we want to suppress the Event Full msg
  52     $noFullMsg = CRM_Utils_Request::retrieve('noFullMsg', 'String', $this, FALSE, 'false');
  53
  54     // set breadcrumb to append to 2nd layer pages
  55     $breadCrumbPath = CRM_Utils_System::url('civicrm/event/info',
  56       "id={$this->_id}&reset=1"
  57     );
  58
  59     //retrieve event information
  60     $params = ['id' => $this->_id];
  61     CRM_Event_BAO_Event::retrieve($params, $values['event']);
  62
  63     if (!$values['event']['is_active']) {
  64       CRM_Utils_System::setUFMessage(ts('The event you requested is currently unavailable (contact the site administrator for assistance).'));
  65       return CRM_Utils_System::permissionDenied();
  66     }
  67
  68     if (!$values['event']['is_public']) {
  69       CRM_Utils_System::addHTMLHead('<META NAME="ROBOTS" CONTENT="NOINDEX, NOFOLLOW">');
  70     }
  71
  72     if (!empty($values['event']['is_template'])) {
  73       // form is an Event Template
  74       CRM_Core_Error::statusBounce(ts('The page you requested is currently unavailable.'));
  75     }
  76
  77     // Add Event Type to $values in case folks want to display it
  78     $values['event']['event_type'] = CRM_Utils_Array::value($values['event']['event_type_id'], CRM_Event_PseudoConstant::eventType());
  79
  80     $this->assign('isShowLocation', CRM_Utils_Array::value('is_show_location', $values['event']));
  81
  82     // show event fees.
  83     if ($this->_id && !empty($values['event']['is_monetary'])) {
  84       CRM_Contribute_BAO_Contribution_Utils::overrideDefaultCurrency($values['event']);
  85
  86       //CRM-10434
  87       $discountId = CRM_Core_BAO_Discount::findSet($this->_id, 'civicrm_event');
  88       if ($discountId) {
  89         $priceSetId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Discount', $discountId, 'price_set_id');
  90       }
  91       else {
  92         $priceSetId = CRM_Price_BAO_PriceSet::getFor('civicrm_event', $this->_id);
  93       }
  94
  95       // get price set options, - CRM-5209
  96       if ($priceSetId) {
  97         $setDetails = CRM_Price_BAO_PriceSet::getSetDetail($priceSetId, TRUE, TRUE);
  98
  99         $priceSetFields = $setDetails[$priceSetId]['fields'];
 100         if (is_array($priceSetFields)) {
 101           $fieldCnt = 1;
 102           $visibility = CRM_Core_PseudoConstant::visibility('name');
 103
 104           // CRM-14492 Admin price fields should show up on event registration if user has 'administer CiviCRM' permissions
 105           $adminFieldVisible = FALSE;
 106           if (CRM_Core_Permission::check('administer CiviCRM')) {
 107             $adminFieldVisible = TRUE;
 108           }
 109
 110           foreach ($priceSetFields as $fid => $fieldValues) {
 111             if (!is_array($fieldValues['options']) ||
 112               empty($fieldValues['options']) ||
 113               (CRM_Utils_Array::value('visibility_id', $fieldValues) != array_search('public', $visibility) && $adminFieldVisible == FALSE)
 114             ) {
 115               continue;
 116             }
 117
 118             if (count($fieldValues['options']) > 1) {
 119               $values['feeBlock']['value'][$fieldCnt] = '';
 120               $values['feeBlock']['label'][$fieldCnt] = $fieldValues['label'];
 121               $values['feeBlock']['lClass'][$fieldCnt] = 'price_set_option_group-label';
 122               $values['feeBlock']['isDisplayAmount'][$fieldCnt] = $fieldValues['is_display_amounts'] ?? NULL;
 123               $fieldCnt++;
 124               $labelClass = 'price_set_option-label';
 125             }
 126             else {
 127               $labelClass = 'price_set_field-label';
 128             }
 129             // show tax rate with amount
 130             $invoiceSettings = Civi::settings()->get('contribution_invoice_settings');
 131             $taxTerm = Civi::settings()->get('tax_term');
 132             $displayOpt = $invoiceSettings['tax_display_settings'] ?? NULL;
 133
 134             foreach ($fieldValues['options'] as $optionId => $optionVal) {
 135               if (CRM_Utils_Array::value('visibility_id', $optionVal) != array_search('public', $visibility) &&
 136                 $adminFieldVisible == FALSE
 137               ) {
 138                 continue;
 139               }
 140
 141               $values['feeBlock']['isDisplayAmount'][$fieldCnt] = $fieldValues['is_display_amounts'] ?? NULL;
 142               if (Civi::settings()->get('invoicing') && isset($optionVal['tax_amount'])) {
 143                 $values['feeBlock']['value'][$fieldCnt] = CRM_Price_BAO_PriceField::getTaxLabel($optionVal, 'amount', $displayOpt, $taxTerm);
 144                 $values['feeBlock']['tax_amount'][$fieldCnt] = $optionVal['tax_amount'];
 145               }
 146               else {
 147                 $values['feeBlock']['value'][$fieldCnt] = $optionVal['amount'];
 148                 $values['feeBlock']['tax_amount'][$fieldCnt] = 0;
 149               }
 150               $values['feeBlock']['label'][$fieldCnt] = $optionVal['label'];
 151               $values['feeBlock']['lClass'][$fieldCnt] = $labelClass;
 152               $fieldCnt++;
 153             }
 154           }
 155         }
 156         // Tell tpl we have price set fee data and whether it's a quick_config price set
 157         $this->assign('isPriceSet', 1);
 158         $this->assign('isQuickConfig', $setDetails[$priceSetId]['is_quick_config']);
 159       }
 160     }
 161
 162     $params = ['entity_id' => $this->_id, 'entity_table' => 'civicrm_event'];
 163     $values['location'] = CRM_Core_BAO_Location::getValues($params, TRUE);
 164
 165     // fix phone type labels
 166     if (!empty($values['location']['phone'])) {
 167       $phoneTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Phone', 'phone_type_id');
 168       foreach ($values['location']['phone'] as &$val) {
 169         if (!empty($val['phone_type_id'])) {
 170           $val['phone_type_display'] = $phoneTypes[$val['phone_type_id']];
 171         }
 172       }
 173     }
 174
 175     //retrieve custom field information
 176     $groupTree = CRM_Core_BAO_CustomGroup::getTree('Event', NULL, $this->_id, 0, $values['event']['event_type_id'], NULL,
 177       TRUE, NULL, FALSE, CRM_Core_Permission::VIEW, NULL, TRUE);
 178     CRM_Core_BAO_CustomGroup::buildCustomDataView($this, $groupTree, FALSE, NULL, NULL, NULL, $this->_id);
 179     $this->assign('action', CRM_Core_Action::VIEW);
 180     //To show the event location on maps directly on event info page
 181     $locations = CRM_Event_BAO_Event::getMapInfo($this->_id);
 182     if (!empty($locations) && !empty($values['event']['is_map'])) {
 183       $this->assign('locations', $locations);
 184       $this->assign('mapProvider', $config->mapProvider);
 185       $this->assign('mapKey', $config->mapAPIKey);
 186       $sumLat = $sumLng = 0;
 187       $maxLat = $maxLng = -400;
 188       $minLat = $minLng = 400;
 189       foreach ($locations as $location) {
 190         $sumLat += $location['lat'];
 191         $sumLng += $location['lng'];
 192
 193         if ($location['lat'] > $maxLat) {
 194           $maxLat = $location['lat'];
 195         }
 196         if ($location['lat'] < $minLat) {
 197           $minLat = $location['lat'];
 198         }
 199
 200         if ($location['lng'] > $maxLng) {
 201           $maxLng = $location['lng'];
 202         }
 203         if ($location['lng'] < $minLng) {
 204           $minLng = $location['lng'];
 205         }
 206       }
 207
 208       $center = [
 209         'lat' => (float ) $sumLat / count($locations),
 210         'lng' => (float ) $sumLng / count($locations),
 211       ];
 212       $span = [
 213         'lat' => (float ) ($maxLat - $minLat),
 214         'lng' => (float ) ($maxLng - $minLng),
 215       ];
 216       $this->assign_by_ref('center', $center);
 217       $this->assign_by_ref('span', $span);
 218       if ($action == CRM_Core_Action::PREVIEW) {
 219         $mapURL = CRM_Utils_System::url('civicrm/contact/map/event',
 220           "eid={$this->_id}&reset=1&action=preview",
 221           FALSE, NULL, TRUE,
 222           TRUE
 223         );
 224       }
 225       else {
 226         $mapURL = CRM_Utils_System::url('civicrm/contact/map/event',
 227           "eid={$this->_id}&reset=1",
 228           FALSE, NULL, TRUE,
 229           TRUE
 230         );
 231       }
 232
 233       $this->assign('skipLocationType', TRUE);
 234       $this->assign('mapURL', $mapURL);
 235     }
 236
 237     if (CRM_Core_Permission::check('view event participants')) {
 238       $statusTypes = CRM_Event_PseudoConstant::participantStatus(NULL, 'is_counted = 1', 'label');
 239       $statusTypesPending = CRM_Event_PseudoConstant::participantStatus(NULL, 'is_counted = 0', 'label');
 240       $findParticipants['statusCounted'] = implode(', ', array_values($statusTypes));
 241       $findParticipants['statusNotCounted'] = implode(', ', array_values($statusTypesPending));
 242       $this->assign('findParticipants', $findParticipants);
 243     }
 244
 245     $participantListingID = $values['event']['participant_listing_id'] ?? NULL;
 246     if ($participantListingID) {
 247       $participantListingURL = CRM_Utils_System::url('civicrm/event/participant',
 248         "reset=1&id={$this->_id}",
 249         FALSE, NULL, TRUE, TRUE
 250       );
 251       $this->assign('participantListingURL', $participantListingURL);
 252     }
 253
 254     $hasWaitingList = $values['event']['has_waitlist'] ?? NULL;
 255     $eventFullMessage = CRM_Event_BAO_Participant::eventFull($this->_id,
 256       FALSE,
 257       $hasWaitingList
 258     );
 259
 260     $allowRegistration = FALSE;
 261     $isEventOpenForRegistration = CRM_Event_BAO_Event::validRegistrationRequest($values['event'], $this->_id);
 262     if (!empty($values['event']['is_online_registration'])) {
 263       if ($isEventOpenForRegistration == 1) {
 264         // we always generate urls for the front end in joomla
 265         $action_query = $action === CRM_Core_Action::PREVIEW ? "&action=$action" : '';
 266         $url = CRM_Utils_System::url('civicrm/event/register',
 267           "id={$this->_id}&reset=1{$action_query}",
 268           FALSE, NULL, TRUE,
 269           TRUE
 270         );
 271         if (!$eventFullMessage || $hasWaitingList) {
 272           $registerText = ts('Register Now');
 273           if (!empty($values['event']['registration_link_text'])) {
 274             $registerText = $values['event']['registration_link_text'];
 275           }
 276
 277           //Fixed for CRM-4855
 278           $allowRegistration = CRM_Event_BAO_Event::showHideRegistrationLink($values);
 279
 280           $this->assign('registerText', $registerText);
 281           $this->assign('registerURL', $url);
 282         }
 283       }
 284       elseif (CRM_Core_Permission::check('register for events')) {
 285         $this->assign('registerClosed', TRUE);
 286       }
 287     }
 288
 289     $this->assign('allowRegistration', $allowRegistration);
 290
 291     $session = CRM_Core_Session::singleton();
 292     $params = [
 293       'contact_id' => $session->get('userID'),
 294       'event_id' => $values['event']['id'] ?? NULL,
 295       'role_id' => $values['event']['default_role_id'] ?? NULL,
 296     ];
 297
 298     if ($eventFullMessage && ($noFullMsg == 'false') || CRM_Event_BAO_Event::checkRegistration($params)) {
 299       $statusMessage = $eventFullMessage;
 300       if (CRM_Event_BAO_Event::checkRegistration($params)) {
 301         if ($noFullMsg == 'false') {
 302           if ($values['event']['allow_same_participant_emails']) {
 303             $statusMessage = ts('It looks like you are already registered for this event.  You may proceed if you want to create an additional registration.');
 304           }
 305           else {
 306             $registerUrl = CRM_Utils_System::url('civicrm/event/register',
 307               "reset=1&id={$values['event']['id']}&cid=0"
 308             );
 309             $statusMessage = ts("It looks like you are already registered for this event. If you want to change your registration, or you feel that you've gotten this message in error, please contact the site administrator.") . ' ' . ts('You can also <a href="%1">register another participant</a>.', [1 => $registerUrl]);
 310           }
 311         }
 312       }
 313       elseif ($hasWaitingList) {
 314         $statusMessage = $values['event']['waitlist_text'] ?? NULL;
 315         if (!$statusMessage) {
 316           $statusMessage = ts('Event is currently full, but you can register and be a part of waiting list.');
 317         }
 318       }
 319       if ($isEventOpenForRegistration == 1) {
 320         CRM_Core_Session::setStatus($statusMessage);
 321       }
 322     }
 323     // we do not want to display recently viewed items, so turn off
 324     $this->assign('displayRecent', FALSE);
 325
 326     // set page title = event title
 327     CRM_Utils_System::setTitle($values['event']['title']);
 328
 329     $this->assign('event', $values['event']);
 330     if (isset($values['feeBlock'])) {
 331       $this->assign('feeBlock', $values['feeBlock']);
 332     }
 333     $this->assign('location', $values['location']);
 334
 335     if (CRM_Core_Permission::check(['access CiviEvent', 'edit all events'])) {
 336       $this->assign('manageEventLinks', CRM_Event_Page_ManageEvent::tabs());
 337     }
 338
 339     return parent::run();
 340   }
 341
 342   /**
 343    * @return string
 344    */
 345   public function getTemplateFileName() {
 346     if ($this->_id) {
 347       $templateFile = "CRM/Event/Page/{$this->_id}/EventInfo.tpl";
 348       $template = CRM_Core_Page::getTemplate();
 349
 350       if ($template->template_exists($templateFile)) {
 351         return $templateFile;
 352       }
 353     }
 354     return parent::getTemplateFileName();
 355   }
 356
 357 }