CRM/Event/Form/ManageEvent/EventInfo.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_EventInfo extends CRM_Event_Form_ManageEvent {
  37
  38   /**
  39    * Event type.
  40    * @var int
  41    */
  42   protected $_eventType = NULL;
  43
  44   /**
  45    * Set variables up before form is built.
  46    */
  47   public function preProcess() {
  48     parent::preProcess();
  49     $this->setSelectedChild('settings');
  50
  51     $entityID = $this->_id ?: $this->_templateId;
  52     if ($entityID) {
  53       $this->assign('entityID', $entityID);
  54       $eventType = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Event',
  55         $entityID,
  56         'event_type_id'
  57       );
  58     }
  59     else {
  60       $eventType = 'null';
  61     }
  62
  63     $showLocation = FALSE;
  64     // when custom data is included in this page
  65     if (!empty($_POST['hidden_custom'])) {
  66       $this->set('type', 'Event');
  67       $this->set('subType', CRM_Utils_Array::value('event_type_id', $_POST));
  68       $this->assign('customDataSubType', CRM_Utils_Array::value('event_type_id', $_POST));
  69       $this->set('entityId', $entityID);
  70
  71       CRM_Custom_Form_CustomData::preProcess($this, NULL, $this->_eventType, 1, 'Event', $entityID);
  72       CRM_Custom_Form_CustomData::buildQuickForm($this);
  73       CRM_Custom_Form_CustomData::setDefaultValues($this);
  74     }
  75   }
  76
  77   /**
  78    * Set default values for the form.
  79    *
  80    * For edit/view mode he default values are retrieved from the database.
  81    */
  82   public function setDefaultValues() {
  83     $defaults = parent::setDefaultValues();
  84
  85     // in update mode, we need to set custom data subtype to tpl
  86     if (!empty($defaults['event_type_id'])) {
  87       $this->assign('customDataSubType', $defaults['event_type_id']);
  88     }
  89
  90     $this->_showHide = new CRM_Core_ShowHideBlocks();
  91     // Show waitlist features or event_full_text if max participants set
  92     if (!empty($defaults['max_participants'])) {
  93       $this->_showHide->addShow('id-waitlist');
  94       if (!empty($defaults['has_waitlist'])) {
  95         $this->_showHide->addShow('id-waitlist-text');
  96         $this->_showHide->addHide('id-event_full');
  97       }
  98       else {
  99         $this->_showHide->addHide('id-waitlist-text');
 100         $this->_showHide->addShow('id-event_full');
 101       }
 102     }
 103     else {
 104       $this->_showHide->addHide('id-event_full');
 105       $this->_showHide->addHide('id-waitlist');
 106       $this->_showHide->addHide('id-waitlist-text');
 107     }
 108
 109     $this->_showHide->addToTemplate();
 110     $this->assign('elemType', 'table-row');
 111
 112     $this->assign('description', CRM_Utils_Array::value('description', $defaults));
 113
 114     // Provide suggested text for event full and waitlist messages if they're empty
 115     $defaults['event_full_text'] = CRM_Utils_Array::value('event_full_text', $defaults, ts('This event is currently full.'));
 116
 117     $defaults['waitlist_text'] = CRM_Utils_Array::value('waitlist_text', $defaults, ts('This event is currently full. However you can register now and get added to a waiting list. You will be notified if spaces become available.'));
 118     $defaults['template_id'] = $this->_templateId;
 119     return $defaults;
 120   }
 121
 122   /**
 123    * Build the form object.
 124    */
 125   public function buildQuickForm() {
 126     //need to assign custom data type and subtype to the template
 127     $this->assign('customDataType', 'Event');
 128     if ($this->_eventType) {
 129       $this->assign('customDataSubType', $this->_eventType);
 130     }
 131
 132     $this->_first = TRUE;
 133     $this->applyFilter('__ALL__', 'trim');
 134     $attributes = CRM_Core_DAO::getAttribute('CRM_Event_DAO_Event');
 135
 136     if ($this->_isTemplate) {
 137       $this->add('text', 'template_title', ts('Template Title'), $attributes['template_title'], TRUE);
 138     }
 139
 140     if ($this->_action & CRM_Core_Action::ADD) {
 141       $eventTemplates = CRM_Event_PseudoConstant::eventTemplates();
 142       if (CRM_Utils_System::isNull($eventTemplates) && !$this->_isTemplate) {
 143         $url = CRM_Utils_System::url('civicrm/admin/eventTemplate', ['reset' => 1]);
 144         CRM_Core_Session::setStatus(ts('If you find that you are creating multiple events with similar settings, you may want to use the <a href="%1">Event Templates</a> feature to streamline your workflow.', [1 => $url]), ts('Tip'), 'info');
 145       }
 146       if (!CRM_Utils_System::isNull($eventTemplates)) {
 147         $this->add('select', 'template_id', ts('From Template'), ['' => ts('- select -')] + $eventTemplates, FALSE, ['class' => 'crm-select2 huge']);
 148       }
 149       // Make sure this form redirects properly
 150       $this->preventAjaxSubmit();
 151     }
 152
 153     // add event title, make required if this is not a template
 154     $this->add('text', 'title', ts('Event Title'), $attributes['event_title'], !$this->_isTemplate);
 155
 156     $this->addSelect('event_type_id',
 157       ['onChange' => "CRM.buildCustomData( 'Event', this.value );"],
 158       TRUE
 159     );
 160
 161     //CRM-7362 --add campaigns.
 162     $campaignId = NULL;
 163     if ($this->_id) {
 164       $campaignId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Event', $this->_id, 'campaign_id');
 165     }
 166     CRM_Campaign_BAO_Campaign::addCampaign($this, $campaignId);
 167
 168     $this->addSelect('default_role_id', [], TRUE);
 169
 170     $this->addSelect('participant_listing_id', ['placeholder' => ts('Disabled'), 'option_url' => NULL]);
 171
 172     $this->add('textarea', 'summary', ts('Event Summary'), $attributes['summary']);
 173     $this->add('wysiwyg', 'description', ts('Complete Description'), $attributes['event_description'] + ['preset' => 'civievent']);
 174     $this->addElement('checkbox', 'is_public', ts('Public Event'));
 175     $this->addElement('checkbox', 'is_share', ts('Allow sharing through social media?'));
 176     $this->addElement('checkbox', 'is_map', ts('Include Map to Event Location'));
 177
 178     $this->add('datepicker', 'start_date', ts('Start'), [], !$this->_isTemplate, ['time' => TRUE]);
 179     $this->add('datepicker', 'end_date', ts('End'), [], FALSE, ['time' => TRUE]);
 180
 181     $this->add('number', 'max_participants', ts('Max Number of Participants'),
 182       ['onchange' => "if (this.value != '') {cj('#id-waitlist').show(); showHideByValue('has_waitlist','0','id-waitlist-text','table-row','radio',false); showHideByValue('has_waitlist','0','id-event_full','table-row','radio',true); return;} else {cj('#id-event_full, #id-waitlist, #id-waitlist-text').hide(); return;}"]
 183     );
 184     $this->addRule('max_participants', ts('Max participants should be a positive number'), 'positiveInteger');
 185
 186     $participantStatuses = CRM_Event_PseudoConstant::participantStatus();
 187     $waitlist = 0;
 188     if (in_array('On waitlist', $participantStatuses) and in_array('Pending from waitlist', $participantStatuses)) {
 189       $this->addElement('checkbox', 'has_waitlist', ts('Offer a Waitlist?'), NULL, ['onclick' => "showHideByValue('has_waitlist','0','id-event_full','table-row','radio',true); showHideByValue('has_waitlist','0','id-waitlist-text','table-row','radio',false);"]);
 190       $this->add('textarea', 'waitlist_text', ts('Waitlist Message'), $attributes['waitlist_text']);
 191       $waitlist = 1;
 192     }
 193     $this->assign('waitlist', $waitlist);
 194
 195     $this->add('textarea', 'event_full_text', ts('Message if Event Is Full'), $attributes['event_full_text']);
 196
 197     $this->addElement('checkbox', 'is_active', ts('Is this Event Active?'));
 198
 199     $this->addFormRule(['CRM_Event_Form_ManageEvent_EventInfo', 'formRule']);
 200
 201     parent::buildQuickForm();
 202   }
 203
 204   /**
 205    * Global validation rules for the form.
 206    *
 207    * @param array $values
 208    *
 209    * @return array
 210    *   list of errors to be posted back to the form
 211    */
 212   public static function formRule($values) {
 213     $errors = [];
 214
 215     if (!empty($values['end_date']) && ($values['end_date'] < $values['start_date'])) {
 216       $errors['end_date'] = ts('End date should be after Start date.');
 217     }
 218
 219     //CRM-4286
 220     if (strstr($values['title'], '/')) {
 221       $errors['title'] = ts("Please do not use '/' in Event Title.");
 222     }
 223
 224     return $errors;
 225   }
 226
 227   /**
 228    * Process the form submission.
 229    */
 230   public function postProcess() {
 231     $params = array_merge($this->controller->exportValues($this->_name), $this->_submitValues);
 232
 233     //format params
 234     $params['start_date'] = CRM_Utils_Array::value('start_date', $params);
 235     $params['end_date'] = CRM_Utils_Array::value('end_date', $params);
 236     $params['has_waitlist'] = CRM_Utils_Array::value('has_waitlist', $params, FALSE);
 237     $params['is_map'] = CRM_Utils_Array::value('is_map', $params, FALSE);
 238     $params['is_active'] = CRM_Utils_Array::value('is_active', $params, FALSE);
 239     $params['is_public'] = CRM_Utils_Array::value('is_public', $params, FALSE);
 240     $params['is_share'] = CRM_Utils_Array::value('is_share', $params, FALSE);
 241     $params['default_role_id'] = CRM_Utils_Array::value('default_role_id', $params, FALSE);
 242     $params['id'] = $this->_id;
 243
 244     //merge params with defaults from templates
 245     if (!empty($params['template_id'])) {
 246       $params = array_merge(CRM_Event_BAO_Event::getTemplateDefaultValues($params['template_id']), $params);
 247       foreach ($params as $key => $value) {
 248         $customFieldInfo = CRM_Core_BAO_CustomField::getKeyID($key, TRUE);
 249         if (!empty($customFieldInfo[1])) {
 250           $params[str_replace($customFieldInfo[1], '-' . $customFieldInfo[1], $key)] = $value;
 251           unset($params[$key]);
 252         }
 253       }
 254     }
 255
 256     $params['custom'] = CRM_Core_BAO_CustomField::postProcess($params,
 257       $this->_id,
 258       'Event'
 259     );
 260
 261     // now that we have the event’s id, do some more template-based stuff
 262     if (!empty($params['template_id'])) {
 263       $event = CRM_Event_BAO_Event::copy($params['template_id'], $params);
 264     }
 265     else {
 266       $event = CRM_Event_BAO_Event::create($params);
 267     }
 268
 269     $this->set('id', $event->id);
 270
 271     $this->postProcessHook();
 272
 273     if ($this->_action & CRM_Core_Action::ADD) {
 274       $url = 'civicrm/event/manage/location';
 275       $urlParams = "action=update&reset=1&id={$event->id}";
 276       // special case for 'Save and Done' consistency.
 277       if ($this->controller->getButtonName('submit') == '_qf_EventInfo_upload_done') {
 278         $url = 'civicrm/event/manage';
 279         $urlParams = 'reset=1';
 280         CRM_Core_Session::setStatus(ts("'%1' information has been saved.",
 281           [1 => $this->getTitle()]
 282         ), ts('Saved'), 'success');
 283       }
 284
 285       CRM_Utils_System::redirect(CRM_Utils_System::url($url, $urlParams));
 286     }
 287
 288     parent::endPostProcess();
 289   }
 290
 291   /**
 292    * Return a descriptive name for the page, used in wizard header.
 293    *
 294    * @return string
 295    */
 296   public function getTitle() {
 297     return ts('Event Information and Settings');
 298   }
 299
 300 }