CRM/Event/Page/EventInfo.php

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