CRM/Event/Form/ManageEvent.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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  * @package CRM
  30  * @copyright CiviCRM LLC (c) 2004-2019
  31  */
  32
  33 /**
  34  * This class generates form components for processing Event.
  35  */
  36 class CRM_Event_Form_ManageEvent extends CRM_Core_Form {
  37
  38   /**
  39    * The id of the event we are processing.
  40    *
  41    * @var int
  42    */
  43   public $_id;
  44
  45   /**
  46    * Is this the first page?
  47    *
  48    * @var bool
  49    */
  50   protected $_first = FALSE;
  51
  52   /**
  53    * Are we in single form mode or wizard mode?
  54    *
  55    * @var bool
  56    */
  57   protected $_single;
  58
  59   public $_action;
  60
  61   /**
  62    * Are we actually managing an event template?
  63    * @var bool
  64    */
  65   protected $_isTemplate = FALSE;
  66
  67   /**
  68    * Pre-populate fields based on this template event_id.
  69    *
  70    * @var int
  71    */
  72   protected $_templateId;
  73
  74   protected $_cancelURL = NULL;
  75
  76   /**
  77    * The campaign id of the existing event, we use this to know if we need to update
  78    * the participant records
  79    * @var int
  80    */
  81   protected $_campaignID = NULL;
  82
  83   /**
  84    * Check if repeating event.
  85    * @var bool
  86    */
  87   public $_isRepeatingEvent;
  88
  89   /**
  90    * Explicitly declare the entity api name.
  91    */
  92   public function getDefaultEntity() {
  93     return 'Event';
  94   }
  95
  96   /**
  97    * Explicitly declare the form context.
  98    */
  99   public function getDefaultContext() {
 100     return 'create';
 101   }
 102
 103   /**
 104    * Set the active tab
 105    *
 106    * @param string $default
 107    *
 108    * @throws \CRM_Core_Exception
 109    */
 110   public function setSelectedChild($default = NULL) {
 111     $selectedChild = CRM_Utils_Request::retrieve('selectedChild', 'Alphanumeric', $this, FALSE, $default);
 112     if (!empty($selectedChild)) {
 113       $this->set('selectedChild', $selectedChild);
 114       $this->assign('selectedChild', $selectedChild);
 115     }
 116   }
 117
 118   /**
 119    * Set variables up before form is built.
 120    */
 121   public function preProcess() {
 122     $config = CRM_Core_Config::singleton();
 123     if (in_array('CiviEvent', $config->enableComponents)) {
 124       $this->assign('CiviEvent', TRUE);
 125     }
 126     CRM_Core_Form_RecurringEntity::preProcess('civicrm_event');
 127
 128     $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'add', 'REQUEST');
 129
 130     $this->assign('action', $this->_action);
 131
 132     $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this, FALSE, NULL, 'GET');
 133     if ($this->_id) {
 134       $this->_isRepeatingEvent = CRM_Core_BAO_RecurringEntity::getParentFor($this->_id, 'civicrm_event');
 135       $this->assign('eventId', $this->_id);
 136       if (!empty($this->_addBlockName) && empty($this->_addProfileBottom) && empty($this->_addProfileBottomAdd)) {
 137         $this->add('hidden', 'id', $this->_id);
 138       }
 139       $this->_single = TRUE;
 140
 141       $params = ['id' => $this->_id];
 142       CRM_Event_BAO_Event::retrieve($params, $eventInfo);
 143
 144       // its an update mode, do a permission check
 145       if (!CRM_Event_BAO_Event::checkPermission($this->_id, CRM_Core_Permission::EDIT)) {
 146         CRM_Core_Error::fatal(ts('You do not have permission to access this page.'));
 147       }
 148
 149       $participantListingID = CRM_Utils_Array::value('participant_listing_id', $eventInfo);
 150       //CRM_Core_DAO::getFieldValue( 'CRM_Event_DAO_Event', $this->_id, 'participant_listing_id' );
 151       if ($participantListingID) {
 152         $participantListingURL = CRM_Utils_System::url('civicrm/event/participant',
 153           "reset=1&id={$this->_id}",
 154           TRUE, NULL, TRUE, TRUE
 155         );
 156         $this->assign('participantListingURL', $participantListingURL);
 157       }
 158
 159       $this->assign('isOnlineRegistration', CRM_Utils_Array::value('is_online_registration', $eventInfo));
 160
 161       $this->assign('id', $this->_id);
 162     }
 163
 164     // figure out whether we’re handling an event or an event template
 165     if ($this->_id) {
 166       $this->_isTemplate = CRM_Utils_Array::value('is_template', $eventInfo);
 167     }
 168     elseif ($this->_action & CRM_Core_Action::ADD) {
 169       $this->_isTemplate = CRM_Utils_Request::retrieve('is_template', 'Boolean', $this);
 170     }
 171
 172     $this->assign('isTemplate', $this->_isTemplate);
 173
 174     // Set "Manage Event" Title
 175     $title = NULL;
 176     if ($this->_id) {
 177       if ($this->_isTemplate) {
 178         $title = ts('Edit Event Template') . ' - ' . CRM_Utils_Array::value('template_title', $eventInfo);
 179       }
 180       else {
 181         $configureText = $this->_isRepeatingEvent ? ts('Configure Repeating Event') : ts('Configure Event');
 182         $title = $configureText . ' - ' . CRM_Utils_Array::value('title', $eventInfo);
 183       }
 184     }
 185     elseif ($this->_action & CRM_Core_Action::ADD) {
 186       $title = $this->_isTemplate ? ts('New Event Template') : ts('New Event');
 187     }
 188     $this->setTitle($title);
 189
 190     if (CRM_Core_Permission::check('view event participants') &&
 191       CRM_Core_Permission::check('view all contacts')
 192     ) {
 193       $statusTypes = CRM_Event_PseudoConstant::participantStatus(NULL, 'is_counted = 1', 'label');
 194       $statusTypesPending = CRM_Event_PseudoConstant::participantStatus(NULL, 'is_counted = 0', 'label');
 195       $findParticipants['statusCounted'] = implode(', ', array_values($statusTypes));
 196       $findParticipants['statusNotCounted'] = implode(', ', array_values($statusTypesPending));
 197       $this->assign('findParticipants', $findParticipants);
 198     }
 199
 200     $this->_templateId = (int) CRM_Utils_Request::retrieve('template_id', 'Integer', $this);
 201
 202     //Is a repeating event
 203     if ($this->_isRepeatingEvent) {
 204       $isRepeatingEntity = TRUE;
 205       $this->assign('isRepeatingEntity', $isRepeatingEntity);
 206     }
 207
 208     // CRM-16776 - show edit/copy/create buttons for Profiles if user has required permission.
 209     $ufGroups = CRM_Core_PseudoConstant::get('CRM_Core_DAO_UFField', 'uf_group_id');
 210     $ufCreate = CRM_ACL_API::group(CRM_Core_Permission::CREATE, NULL, 'civicrm_uf_group', $ufGroups);
 211     $ufEdit = CRM_ACL_API::group(CRM_Core_Permission::EDIT, NULL, 'civicrm_uf_group', $ufGroups);
 212     $checkPermission = [
 213       [
 214         'administer CiviCRM',
 215         'manage event profiles',
 216       ],
 217     ];
 218     if (CRM_Core_Permission::check($checkPermission) || !empty($ufCreate) || !empty($ufEdit)) {
 219       $this->assign('perm', TRUE);
 220     }
 221
 222     // also set up tabs
 223     CRM_Event_Form_ManageEvent_TabHeader::build($this);
 224
 225     // Set Done button URL and breadcrumb. Templates go back to Manage Templates,
 226     // otherwise go to Manage Event for new event or ManageEventEdit if event if exists.
 227     $breadCrumb = [];
 228     if (!$this->_isTemplate) {
 229       if ($this->_id) {
 230         $this->_doneUrl = CRM_Utils_System::url(CRM_Utils_System::currentPath(),
 231           "action=update&reset=1&id={$this->_id}"
 232         );
 233       }
 234       else {
 235         $this->_doneUrl = CRM_Utils_System::url('civicrm/event/manage',
 236           'reset=1'
 237         );
 238         $breadCrumb = [
 239           [
 240             'title' => ts('Manage Events'),
 241             'url' => $this->_doneUrl,
 242           ],
 243         ];
 244       }
 245     }
 246     else {
 247       $this->_doneUrl = CRM_Utils_System::url('civicrm/admin/eventTemplate', 'reset=1');
 248       $breadCrumb = [
 249         [
 250           'title' => ts('Manage Event Templates'),
 251           'url' => $this->_doneUrl,
 252         ],
 253       ];
 254     }
 255     CRM_Utils_System::appendBreadCrumb($breadCrumb);
 256   }
 257
 258   /**
 259    * Set default values for the form.
 260    *
 261    * For edit/view mode the default values are retrieved from the database.
 262    */
 263   public function setDefaultValues() {
 264     $defaults = [];
 265     if (isset($this->_id)) {
 266       $params = ['id' => $this->_id];
 267       CRM_Event_BAO_Event::retrieve($params, $defaults);
 268
 269       $this->_campaignID = CRM_Utils_Array::value('campaign_id', $defaults);
 270     }
 271     elseif ($this->_templateId) {
 272       $params = ['id' => $this->_templateId];
 273       CRM_Event_BAO_Event::retrieve($params, $defaults);
 274       $defaults['is_template'] = $this->_isTemplate;
 275       $defaults['template_id'] = $defaults['id'];
 276       unset($defaults['id']);
 277       unset($defaults['start_date']);
 278       unset($defaults['end_date']);
 279     }
 280     else {
 281       $defaults['is_active'] = 1;
 282       $defaults['style'] = 'Inline';
 283     }
 284
 285     return $defaults;
 286   }
 287
 288   /**
 289    * Build the form object.
 290    */
 291   public function buildQuickForm() {
 292     $session = CRM_Core_Session::singleton();
 293
 294     $this->_cancelURL = CRM_Utils_Array::value('cancelURL', $_POST);
 295
 296     if (!$this->_cancelURL) {
 297       if ($this->_isTemplate) {
 298         $this->_cancelURL = CRM_Utils_System::url('civicrm/admin/eventTemplate',
 299           'reset=1'
 300         );
 301       }
 302       else {
 303         $this->_cancelURL = CRM_Utils_System::url('civicrm/event/manage',
 304           'reset=1'
 305         );
 306       }
 307     }
 308
 309     if ($this->_cancelURL) {
 310       $this->addElement('hidden', 'cancelURL', $this->_cancelURL);
 311     }
 312
 313     if ($this->_single) {
 314       $buttons = [
 315         [
 316           'type' => 'upload',
 317           'name' => ts('Save'),
 318           'isDefault' => TRUE,
 319         ],
 320         [
 321           'type' => 'upload',
 322           'name' => ts('Save and Done'),
 323           'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 324           'subName' => 'done',
 325         ],
 326         [
 327           'type' => 'cancel',
 328           'name' => ts('Cancel'),
 329         ],
 330       ];
 331       $this->addButtons($buttons);
 332     }
 333     else {
 334       $buttons = [];
 335       if (!$this->_first) {
 336         $buttons[] = [
 337           'type' => 'back',
 338           'name' => ts('Previous'),
 339           'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 340         ];
 341       }
 342       $buttons[] = [
 343         'type' => 'upload',
 344         'name' => ts('Continue'),
 345         'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 346         'isDefault' => TRUE,
 347       ];
 348       $buttons[] = [
 349         'type' => 'cancel',
 350         'name' => ts('Cancel'),
 351       ];
 352
 353       $this->addButtons($buttons);
 354     }
 355     $session->replaceUserContext($this->_cancelURL);
 356     $this->add('hidden', 'is_template', $this->_isTemplate);
 357   }
 358
 359   public function endPostProcess() {
 360     // make submit buttons keep the current working tab opened.
 361     if ($this->_action & CRM_Core_Action::UPDATE) {
 362       $className = CRM_Utils_String::getClassName($this->_name);
 363
 364       // hack for special cases.
 365       switch ($className) {
 366         case 'Event':
 367           $attributes = $this->getVar('_attributes');
 368           $subPage = CRM_Utils_Request::retrieveComponent($attributes);
 369           break;
 370
 371         case 'EventInfo':
 372           $subPage = 'settings';
 373           break;
 374
 375         case 'ScheduleReminders':
 376           $subPage = 'reminder';
 377           break;
 378
 379         default:
 380           $subPage = strtolower($className);
 381           break;
 382       }
 383
 384       CRM_Core_Session::setStatus(ts("'%1' information has been saved.",
 385         [1 => CRM_Utils_Array::value('title', CRM_Utils_Array::value($subPage, $this->get('tabHeader')), $className)]
 386       ), $this->getTitle(), 'success');
 387
 388       $config = CRM_Core_Config::singleton();
 389       if (in_array('CiviCampaign', $config->enableComponents)) {
 390         $values = $this->controller->exportValues($this->_name);
 391         $newCampaignID = CRM_Utils_Array::value('campaign_id', $values);
 392         $eventID = CRM_Utils_Array::value('id', $values);
 393         if ($eventID && $this->_campaignID != $newCampaignID) {
 394           CRM_Event_BAO_Event::updateParticipantCampaignID($eventID, $newCampaignID);
 395         }
 396       }
 397       $this->postProcessHook();
 398       if ($this->controller->getButtonName('submit') == "_qf_{$className}_upload_done") {
 399         if ($this->_isTemplate) {
 400           CRM_Core_Session::singleton()
 401             ->pushUserContext(CRM_Utils_System::url('civicrm/admin/eventTemplate', 'reset=1'));
 402         }
 403         else {
 404           CRM_Core_Session::singleton()->pushUserContext(CRM_Utils_System::url('civicrm/event/manage', 'reset=1'));
 405         }
 406       }
 407       else {
 408         CRM_Core_Session::singleton()->pushUserContext(CRM_Utils_System::url("civicrm/event/manage/{$subPage}",
 409           "action=update&reset=1&id={$this->_id}"
 410         ));
 411       }
 412     }
 413   }
 414
 415   /**
 416    * @return string
 417    */
 418   public function getTemplateFileName() {
 419     if ($this->controller->getPrint() || $this->getVar('_id') <= 0 || $this->_action & CRM_Core_Action::DELETE) {
 420       return parent::getTemplateFileName();
 421     }
 422     else {
 423       // hack lets suppress the form rendering for now
 424       self::$_template->assign('isForm', FALSE);
 425       return 'CRM/Event/Form/ManageEvent/Tab.tpl';
 426     }
 427   }
 428
 429   /**
 430    * Pre-load libraries required by Online Registration Profile fields
 431    */
 432   public static function addProfileEditScripts() {
 433     CRM_UF_Page_ProfileEditor::registerProfileScripts();
 434     CRM_UF_Page_ProfileEditor::registerSchemas(['IndividualModel', 'ParticipantModel']);
 435   }
 436
 437 }