CRM/Event/Form/ManageEvent/EventInfo.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.3                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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  *
  31  * @package CRM
  32  * @copyright CiviCRM LLC (c) 2004-2013
  33  * $Id$
  34  *
  35  */
  36
  37 /**
  38  * This class generates form components for processing Event
  39  *
  40  */
  41 class CRM_Event_Form_ManageEvent_EventInfo extends CRM_Event_Form_ManageEvent {
  42
  43   /**
  44    * Event type
  45    */
  46   protected $_eventType = NULL;
  47
  48   /**
  49    * Function to set variables up before form is built
  50    *
  51    * @return void
  52    * @access public
  53    */
  54   function preProcess() {
  55     //custom data related code
  56     $this->_cdType = CRM_Utils_Array::value('type', $_GET);
  57     $this->assign('cdType', FALSE);
  58     if ($this->_cdType) {
  59       $this->assign('cdType', TRUE);
  60       return CRM_Custom_Form_CustomData::preProcess($this);
  61     }
  62     parent::preProcess();
  63
  64     if ($this->_id) {
  65       $this->assign('entityID', $this->_id);
  66       $eventType = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Event',
  67         $this->_id,
  68         'event_type_id'
  69       );
  70     }
  71     else {
  72       $eventType = 'null';
  73     }
  74
  75     $showLocation = FALSE;
  76     // when custom data is included in this page
  77     if (CRM_Utils_Array::value('hidden_custom', $_POST)) {
  78       $this->set('type', 'Event');
  79       $this->set('subType', CRM_Utils_Array::value('event_type_id', $_POST));
  80       $this->set('entityId', $this->_id);
  81
  82       CRM_Custom_Form_CustomData::preProcess($this);
  83       CRM_Custom_Form_CustomData::buildQuickForm($this);
  84       CRM_Custom_Form_CustomData::setDefaultValues($this);
  85     }
  86   }
  87
  88   /**
  89    * This function sets the default values for the form. For edit/view mode
  90    * the default values are retrieved from the database
  91    *
  92    * @access public
  93    *
  94    * @return None
  95    */
  96   function setDefaultValues() {
  97     if ($this->_cdType) {
  98       $tempId = (int) CRM_Utils_Request::retrieve('template_id', 'Integer', $this);
  99       // set template custom data as a default for event, CRM-5596
 100       if ($tempId && !$this->_id) {
 101         $defaults = $this->templateCustomDataValues($tempId);
 102       }
 103       else {
 104         $defaults = CRM_Custom_Form_CustomData::setDefaultValues($this);
 105       }
 106
 107       return $defaults;
 108     }
 109     $defaults = parent::setDefaultValues();
 110
 111     // in update mode, we need to set custom data subtype to tpl
 112     if (CRM_Utils_Array::value('event_type_id', $defaults)) {
 113       $this->assign('customDataSubType', $defaults['event_type_id']);
 114     }
 115
 116     $this->_showHide = new CRM_Core_ShowHideBlocks();
 117     // Show waitlist features or event_full_text if max participants set
 118     if (CRM_Utils_Array::value('max_participants', $defaults)) {
 119       $this->_showHide->addShow('id-waitlist');
 120       if (CRM_Utils_Array::value('has_waitlist', $defaults)) {
 121         $this->_showHide->addShow('id-waitlist-text');
 122         $this->_showHide->addHide('id-event_full');
 123       }
 124       else {
 125         $this->_showHide->addHide('id-waitlist-text');
 126         $this->_showHide->addShow('id-event_full');
 127       }
 128     }
 129     else {
 130       $this->_showHide->addHide('id-event_full');
 131       $this->_showHide->addHide('id-waitlist');
 132       $this->_showHide->addHide('id-waitlist-text');
 133     }
 134
 135     $this->_showHide->addToTemplate();
 136     $this->assign('elemType', 'table-row');
 137
 138     $this->assign('description', CRM_Utils_Array::value('description', $defaults));
 139
 140     // Provide suggested text for event full and waitlist messages if they're empty
 141     $defaults['event_full_text'] = CRM_Utils_Array::value('event_full_text', $defaults, ts('This event is currently full.'));
 142
 143     $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.'));
 144     list($defaults['start_date'], $defaults['start_date_time']) = CRM_Utils_Date::setDateDefaults(CRM_Utils_Array::value('start_date', $defaults), 'activityDateTime');
 145
 146     if (CRM_Utils_Array::value('end_date', $defaults)) {
 147       list($defaults['end_date'], $defaults['end_date_time']) = CRM_Utils_Date::setDateDefaults($defaults['end_date'], 'activityDateTime');
 148     }
 149     return $defaults;
 150   }
 151
 152   /**
 153    * Function to build the form
 154    *
 155    * @return None
 156    * @access public
 157    */
 158   public function buildQuickForm() {
 159     if ($this->_cdType) {
 160       return CRM_Custom_Form_CustomData::buildQuickForm($this);
 161     }
 162     //need to assign custom data type and subtype to the template
 163     $this->assign('customDataType', 'Event');
 164     if ($this->_eventType) {
 165       $this->assign('customDataSubType', $this->_eventType);
 166     }
 167     $this->assign('entityId', $this->_id);
 168
 169     $this->_first = TRUE;
 170     $this->applyFilter('__ALL__', 'trim');
 171     $attributes = CRM_Core_DAO::getAttribute('CRM_Event_DAO_Event');
 172
 173     if ($this->_isTemplate) {
 174       $this->add('text', 'template_title', ts('Template Title'), $attributes['template_title'], TRUE);
 175     }
 176
 177     if ($this->_action & CRM_Core_Action::ADD) {
 178       $eventTemplates = CRM_Event_PseudoConstant::eventTemplates();
 179       if (CRM_Utils_System::isNull($eventTemplates) && !$this->_isTemplate) {
 180         $url = CRM_Utils_System::url('civicrm/admin/eventTemplate', array('reset' => 1));
 181         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.', array(1 => $url)), ts('Tip'), 'info');
 182       }
 183       if (!CRM_Utils_System::isNull($eventTemplates)) {
 184         $this->add('select', 'template_id', ts('From Template'), array(
 185           '' => ts('- select -')) + $eventTemplates,
 186           FALSE, array('onchange' => "reloadWindow( this.value );")
 187         );
 188       }
 189     }
 190
 191     // add event title, make required if this is not a template
 192     $this->add('text', 'title', ts('Event Title'), $attributes['event_title'], !$this->_isTemplate);
 193
 194     $event = CRM_Core_OptionGroup::values('event_type');
 195
 196     $this->add('select',
 197       'event_type_id',
 198       ts('Event Type'),
 199       array(
 200         '' => ts('- select -')) + $event,
 201       TRUE,
 202       array('onChange' => "CRM.buildCustomData( 'Event', this.value );")
 203     );
 204
 205     //CRM-7362 --add campaigns.
 206     $campaignId = NULL;
 207     if ($this->_id) {
 208       $campaignId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Event', $this->_id, 'campaign_id');
 209     }
 210     CRM_Campaign_BAO_Campaign::addCampaign($this, $campaignId);
 211
 212     $participantRole = CRM_Core_OptionGroup::values('participant_role');
 213     $this->add('select',
 214       'default_role_id',
 215       ts('Participant Role'),
 216       $participantRole,
 217       TRUE
 218     );
 219
 220     $participantListing = CRM_Core_OptionGroup::values('participant_listing');
 221     $this->add('select',
 222       'participant_listing_id',
 223       ts('Participant Listing'),
 224       array(
 225         '' => ts('Disabled')) + $participantListing,
 226       FALSE
 227     );
 228
 229     $this->add('textarea', 'summary', ts('Event Summary'), $attributes['summary']);
 230     $this->addWysiwyg('description', ts('Complete Description'), $attributes['event_description']);
 231     $this->addElement('checkbox', 'is_public', ts('Public Event?'));
 232     $this->addElement('checkbox', 'is_share', ts('Allow sharing through social media?'));
 233     $this->addElement('checkbox', 'is_map', ts('Include Map to Event Location?'));
 234
 235     $this->addDateTime('start_date', ts('Start Date'), FALSE, array('formatType' => 'activityDateTime'));
 236     $this->addDateTime('end_date', ts('End Date / Time'), FALSE, array('formatType' => 'activityDateTime'));
 237
 238     $this->add('text', 'max_participants', ts('Max Number of Participants'),
 239       array('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;}")
 240     );
 241     $this->addRule('max_participants', ts('Max participants should be a positive number'), 'positiveInteger');
 242
 243     $participantStatuses = CRM_Event_PseudoConstant::participantStatus();
 244     $waitlist = 0;
 245     if (in_array('On waitlist', $participantStatuses) and in_array('Pending from waitlist', $participantStatuses)) {
 246       $this->addElement('checkbox', 'has_waitlist', ts('Offer a Waitlist?'), NULL, array('onclick' => "showHideByValue('has_waitlist','0','id-event_full','table-row','radio',true); showHideByValue('has_waitlist','0','id-waitlist-text','table-row','radio',false);"));
 247       $this->add('textarea', 'waitlist_text', ts('Waitlist Message'), $attributes['waitlist_text']);
 248       $waitlist = 1;
 249     }
 250     $this->assign('waitlist', $waitlist);
 251
 252     $this->add('textarea', 'event_full_text', ts('Message if Event Is Full'), $attributes['event_full_text']);
 253
 254     $this->addElement('checkbox', 'is_active', ts('Is this Event Active?'));
 255
 256     $this->addFormRule(array('CRM_Event_Form_ManageEvent_EventInfo', 'formRule'));
 257
 258     parent::buildQuickForm();
 259   }
 260
 261   /**
 262    * global validation rules for the form
 263    *
 264    * @param array $fields posted values of the form
 265    *
 266    * @return array list of errors to be posted back to the form
 267    * @static
 268    * @access public
 269    */
 270   static function formRule($values) {
 271     $errors = array();
 272
 273     if (!$values['is_template']) {
 274       if (CRM_Utils_System::isNull($values['start_date'])) {
 275         $errors['start_date'] = ts('Start Date and Time are required fields');
 276       }
 277       else {
 278         $start = CRM_Utils_Date::processDate($values['start_date']);
 279         $end = CRM_Utils_Date::processDate($values['end_date']);
 280         if (($end < $start) && ($end != 0)) {
 281           $errors['end_date'] = ts('End date should be after Start date');
 282         }
 283       }
 284     }
 285
 286     //CRM-4286
 287     if (strstr($values['title'], '/')) {
 288       $errors['title'] = ts("Please do not use '/' in Event Title.");
 289     }
 290
 291     return $errors;
 292   }
 293
 294   /**
 295    * Function to process the form
 296    *
 297    * @access public
 298    *
 299    * @return None
 300    */
 301   public function postProcess() {
 302     $params = $this->controller->exportValues($this->_name);
 303
 304     //format params
 305     $params['start_date'] = CRM_Utils_Date::processDate($params['start_date'], $params['start_date_time']);
 306     $params['end_date'] = CRM_Utils_Date::processDate(CRM_Utils_Array::value('end_date', $params),
 307       CRM_Utils_Array::value('end_date_time', $params),
 308       TRUE
 309     );
 310     $params['has_waitlist'] = CRM_Utils_Array::value('has_waitlist', $params, FALSE);
 311     $params['is_map'] = CRM_Utils_Array::value('is_map', $params, FALSE);
 312     $params['is_active'] = CRM_Utils_Array::value('is_active', $params, FALSE);
 313     $params['is_public'] = CRM_Utils_Array::value('is_public', $params, FALSE);
 314     $params['is_share'] = CRM_Utils_Array::value('is_share', $params, FALSE);
 315     $params['default_role_id'] = CRM_Utils_Array::value('default_role_id', $params, FALSE);
 316     $params['id'] = $this->_id;
 317
 318     $customFields = CRM_Core_BAO_CustomField::getFields('Event', FALSE, FALSE,
 319       CRM_Utils_Array::value('event_type_id', $params)
 320     );
 321     $params['custom'] = CRM_Core_BAO_CustomField::postProcess($params,
 322       $customFields,
 323       $this->_id,
 324       'Event'
 325     );
 326
 327     //merge params with defaults from templates
 328     if (CRM_Utils_Array::value('template_id', $params)) {
 329       $params = array_merge(CRM_Event_BAO_Event::getTemplateDefaultValues($params['template_id']), $params);
 330     }
 331
 332     $event = CRM_Event_BAO_Event::create($params);
 333
 334     // now that we have the event’s id, do some more template-based stuff
 335     if (CRM_Utils_Array::value('template_id', $params)) {
 336       CRM_Event_BAO_Event::copy($params['template_id'], $event, TRUE);
 337     }
 338
 339     $this->set('id', $event->id);
 340
 341     if ($this->_action & CRM_Core_Action::ADD) {
 342       $url = 'civicrm/event/manage/location';
 343       $urlParams = "action=update&reset=1&id={$event->id}";
 344       // special case for 'Save and Done' consistency.
 345       if ($this->controller->getButtonName('submit') == '_qf_EventInfo_upload_done') {
 346         $url = 'civicrm/event/manage';
 347         $urlParams = 'reset=1';
 348         CRM_Core_Session::setStatus(ts("'%1' information has been saved.",
 349             array(1 => $this->getTitle())
 350           ), ts('Saved'), 'success');
 351       }
 352
 353       CRM_Utils_System::redirect(CRM_Utils_System::url($url, $urlParams));
 354     }
 355
 356     parent::endPostProcess();
 357   }
 358   //end of function
 359
 360   /**
 361    * Return a descriptive name for the page, used in wizard header
 362    *
 363    * @return string
 364    * @access public
 365    */
 366   public function getTitle() {
 367     return ts('Event Information and Settings');
 368   }
 369
 370   /* Retrieve event template custom data values
 371      * and set as default values for current new event.
 372      *
 373      * @params int $tempId event template id.
 374      *
 375      * @return $defaults an array of custom data defaults.
 376      */
 377
 378   public function templateCustomDataValues($templateId) {
 379     $defaults = array();
 380     if (!$templateId) {
 381       return $defaults;
 382     }
 383
 384     // pull template custom data as a default for event, CRM-5596
 385     $groupTree    = CRM_Core_BAO_CustomGroup::getTree($this->_type, $this, $templateId, NULL, $this->_subType);
 386     $groupTree    = CRM_Core_BAO_CustomGroup::formatGroupTree($groupTree, $this->_groupCount, $this);
 387     $customValues = array();
 388     CRM_Core_BAO_CustomGroup::setDefaults($groupTree, $customValues);
 389     foreach ($customValues as $key => $val) {
 390       if ($fieldKey = CRM_Core_BAO_CustomField::getKeyID($key)) {
 391         $defaults["custom_{$fieldKey}_-1"] = $val;
 392       }
 393     }
 394
 395     return $defaults;
 396   }
 397 }
 398