CRM/Core/Form/RecurringEntity.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   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  * This class generates form components for processing Event
  38  *
  39  */
  40 class CRM_Core_Form_RecurringEntity {
  41   /**
  42    *  Current entity id
  43    */
  44   protected static $_entityId = NULL;
  45
  46   static function buildQuickForm(&$form) {
  47     //$attributes_schedule = CRM_Core_DAO::getAttribute('CRM_Core_DAO_ActionMapping');
  48     self::$_entityId = CRM_Utils_Array::value('id', $_GET);
  49     $form->assign('currentEntityId', self::$_entityId);
  50
  51     $form->_freqUnits = array('hour' => 'hour') + CRM_Core_OptionGroup::values('recur_frequency_units');
  52     foreach ($form->_freqUnits as $val => $label) {
  53       if($label == "day"){
  54           $label = "dai";
  55       }
  56       $freqUnitsDisplay[$val] = ts('%1ly', array(1 => $label));
  57     }
  58    // echo "<pre>";print_r($freqUnitsDisplay);
  59     $dayOfTheWeek = array('monday'   => 'Monday',
  60                           'tuesday'   => 'Tuesday',
  61                           'wednesday' => 'Wednesday',
  62                           'thursday'  => 'Thursday',
  63                           'friday'    => 'Friday',
  64                           'saturday'  => 'Saturday',
  65                           'sunday'    => 'Sunday'
  66                          );
  67     $form->add('select', 'repetition_frequency_unit', ts('Repeats:'), $freqUnitsDisplay, TRUE);
  68     $numericOptions = CRM_Core_SelectValues::getNumericOptions(1, 30);
  69     $form->add('select', 'repetition_frequency_interval', ts('Repeats every:'), $numericOptions, TRUE, array('style' => 'width:55px;'));
  70     $form->addDateTime('repetition_start_date', ts('Repetition Start Date'), FALSE, array('formatType' => 'activityDateTime'));
  71     foreach($dayOfTheWeek as $key => $val){
  72         $startActionCondition[] = $form->createElement('checkbox', $key, NULL, substr($val."&nbsp;", 0, 3));
  73     }
  74     $form->addGroup($startActionCondition, 'start_action_condition', ts('Repeats on'));
  75     $roptionTypes = array('1' => ts('day of the month'),
  76         '2' => ts('day of the week'),
  77       );
  78     $form->addRadio('repeats_by', ts("Repeats By:"), $roptionTypes, array(), NULL);
  79     $getMonths = CRM_Core_SelectValues::getNumericOptions(1, 31);
  80     $form->add('select', 'limit_to', '', $getMonths, FALSE, array('style' => 'width:55px;'));
  81     $dayOfTheWeekNo = array('first'  => 'First',
  82                             'second'=> 'Second',
  83                             'third' => 'Third',
  84                             'fourth'=> 'Fourth',
  85                             'last'  => 'Last'
  86                          );
  87     $form->add('select', 'entity_status_1', ts(''), $dayOfTheWeekNo);
  88     $form->add('select', 'entity_status_2', ts(''), $dayOfTheWeek);
  89     $eoptionTypes = array('1' => ts('After'),
  90         '2' => ts('On'),
  91       );
  92     $form->addRadio('ends', ts("Ends:"), $eoptionTypes, array(), NULL, TRUE);
  93     $form->add('text', 'start_action_offset', ts(''), array('maxlength' => 2));
  94     $form->addFormRule(array('CRM_Core_Form_RecurringEntity', 'formRule'));
  95     $form->addDate('repeat_absolute_date', ts('On'), FALSE, array('formatType' => 'mailing'));
  96     $form->addDate('exclude_date', ts('Exclude Date(s)'), FALSE);
  97     $select = $form->add('select', 'exclude_date_list', ts(''), $form->_excludeDateInfo, FALSE, array('style' => 'width:150px;', 'size' => 4));
  98     $select->setMultiple(TRUE);
  99     $form->addElement('button','add_to_exclude_list','>>','onClick="addToExcludeList(document.getElementById(\'exclude_date\').value);"');
 100     $form->addElement('button','remove_from_exclude_list', '<<', 'onClick="removeFromExcludeList(\'exclude_date_list\')"');
 101     $form->addElement('hidden', 'isChangeInRepeatConfiguration', '', array('id' => 'isChangeInRepeatConfiguration'));
 102     $form->addElement('hidden', 'copyExcludeDates', '', array('id' => 'copyExcludeDates'));
 103     $form->addButtons(array(
 104         array(
 105           'type' => 'submit',
 106           'name' => ts('Save'),
 107           'isDefault' => TRUE,
 108         ),
 109         array(
 110           'type' => 'cancel',
 111           'name' => ts('Cancel')
 112         ),
 113       )
 114     );
 115   }
 116
 117   /**
 118    * global validation rules for the form
 119    *
 120    * @param array $fields posted values of the form
 121    *
 122    * @return array list of errors to be posted back to the form
 123    * @static
 124    * @access public
 125    */
 126   static function formRule($values) {
 127     $errors = array();
 128     $dayOfTheWeek = array(monday,tuesday,wednesday,thursday,friday,saturday,sunday);
 129
 130     //Repeats
 131     if(!CRM_Utils_Array::value('repetition_frequency_unit', $values)){
 132       $errors['repetition_frequency_unit'] = ts('This is a required field');
 133     }
 134     //Repeats every
 135     if(!CRM_Utils_Array::value('repetition_frequency_interval', $values)){
 136       $errors['repetition_frequency_interval'] = ts('This is a required field');
 137     }
 138     //Ends
 139     if(CRM_Utils_Array::value('ends', $values)){
 140       if($values['ends'] == 1){
 141         if ($values['start_action_offset'] == "") {
 142           $errors['start_action_offset'] = ts('This is a required field');
 143         }else if($values['start_action_offset'] > 30){
 144           $errors['start_action_offset'] = ts('Occurrences should be less than or equal to 30');
 145         }
 146       }
 147       if($values['ends'] == 2){
 148         if ($values['repeat_absolute_date'] != "") {
 149           $today = date("Y-m-d H:i:s");
 150           $today = CRM_Utils_Date::processDate($today);
 151           $end = CRM_Utils_Date::processDate($values['repeat_absolute_date']);
 152           if (($end <= $today) && ($end != 0)) {
 153             $errors['repeat_absolute_date'] = ts('End date should be after today\'s date');
 154           }
 155         }else{
 156           $errors['repeat_absolute_date'] = ts('This is a required field');
 157         }
 158       }
 159     }else{
 160       $errors['ends'] = ts('This is a required field');
 161     }
 162
 163     //Repeats BY
 164     if(CRM_Utils_Array::value('repeats_by', $values)){
 165       if($values['repeats_by'] == 1){
 166         if($values['limit_to'] != ""){
 167           if($values['limit_to'] < 1 && $values['limit_to'] > 31){
 168             $errors['limit_to'] = ts('Invalid day of the month');
 169           }
 170         }else{
 171           $errors['limit_to'] = ts('Invalid day of the month');
 172         }
 173       }
 174       if($values['repeats_by'] == 2){
 175         if($values['entity_status_1'] != "" ) {
 176           $dayOfTheWeekNo = array(first, second, third, fourth, last);
 177           if(!in_array($values['entity_status_1'], $dayOfTheWeekNo)){
 178              $errors['entity_status_1'] = ts('Invalid option');
 179           }
 180         }else{
 181           $errors['entity_status_1'] = ts('Invalid option');
 182         }
 183         if($values['entity_status_2'] != "" ) {
 184           if(!in_array($values['entity_status_2'], $dayOfTheWeek)){
 185              $errors['entity_status_2'] = ts('Invalid day name');
 186           }
 187         }else{
 188           $errors['entity_status_2'] = ts('Invalid day name');
 189         }
 190       }
 191     }
 192     return $errors;
 193   }
 194
 195   /**
 196    * Function to process the form
 197    *
 198    * @access public
 199    *
 200    * @return None
 201    */
 202   static function postProcess($params=array(), $type) {
 203     if(!empty($type)){
 204       $params['used_for'] = $type;
 205     }
 206
 207     //Save post params to the schedule reminder table
 208     $dbParams = CRM_Core_BAO_RecurringEntity::mapFormValuesToDB($params);
 209
 210     //Delete repeat configuration and rebuild
 211     if(CRM_Utils_Array::value('id', $params)){
 212       CRM_Core_BAO_ActionSchedule::del($params['id']);
 213       unset($params['id']);
 214     }
 215     $actionScheduleObj = CRM_Core_BAO_ActionSchedule::add($dbParams);
 216
 217     //exclude dates
 218     $excludeDateList = array();
 219     if(CRM_Utils_Array::value('copyExcludeDates', $params) && CRM_Utils_Array::value('parent_event_id', $params)){
 220       //Since we get comma separated values lets get them in array
 221       $exclude_date_list = array();
 222       $exclude_date_list = explode(",", $params['copyExcludeDates']);
 223
 224       //Check if there exists any values for this option group
 225       $optionGroupIdExists = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup',
 226           'event_repeat_exclude_dates_'.$params['parent_event_id'],
 227           'id',
 228           'name'
 229         );
 230       if($optionGroupIdExists){
 231         CRM_Core_BAO_OptionGroup::del($optionGroupIdExists);
 232       }
 233       $optionGroupParams =
 234           array(
 235             'name'        => 'event_repeat_exclude_dates_'.$params['parent_event_id'],
 236             'title'       => 'Event Recursion',
 237             'is_reserved' => 0,
 238             'is_active'   => 1
 239           );
 240       $opGroup = CRM_Core_BAO_OptionGroup::add($optionGroupParams);
 241       if($opGroup->id){
 242         $oldWeight= 0;
 243         $fieldValues = array('option_group_id' => $opGroup->id);
 244         foreach($exclude_date_list as $val){
 245           $optionGroupValue =
 246               array(
 247                 'option_group_id' =>  $opGroup->id,
 248                 'label'           =>  CRM_Utils_Date::processDate($val),
 249                 'value'           =>  CRM_Utils_Date::processDate($val),
 250                 'name'            =>  $opGroup->name,
 251                 'description'     =>  'Used for event recursion',
 252                 'weight'          =>  CRM_Utils_Weight::updateOtherWeights('CRM_Core_DAO_OptionValue', $oldWeight, CRM_Utils_Array::value('weight', $params), $fieldValues),
 253                 'is_active'       =>  1
 254               );
 255           $excludeDateList[] = $optionGroupValue['value'];
 256           CRM_Core_BAO_OptionValue::add($optionGroupValue);
 257         }
 258       }
 259     }
 260
 261     //Delete relations if any from recurring entity tables before inserting new relations for this entity id
 262     if($params['event_id']){
 263       $getRelatedEntities = CRM_Core_BAO_RecurringEntity::getEntitiesFor($params['event_id'], 'civicrm_event', TRUE);
 264       $participantDetails = CRM_Event_Form_ManageEvent_Repeat::getParticipantCountforEvent($getRelatedEntities);
 265       //Check if participants exists for events
 266       foreach ($getRelatedEntities as $key => $value) {
 267         if(!CRM_Utils_Array::value($value['id'], $participantDetails['countByID']) && $value['id'] != $params['event_id']){
 268           CRM_Event_BAO_Event::del($value['id']);
 269         }
 270       }
 271       CRM_Core_BAO_RecurringEntity::delEntityRelations($params['event_id'], 'civicrm_event');
 272     }
 273
 274     $recursion = new CRM_Core_BAO_RecurringEntity();
 275     $recursion->dateColumns  = array('start_date');
 276     $recursion->scheduleId   = $actionScheduleObj->id;
 277
 278     if (!empty($excludeDateList)) {
 279       $recursion->excludeDates = $excludeDateList;
 280       $recursion->excludeDateRangeColumns = array('start_date', 'end_date');
 281     }
 282
 283     if ($params['parent_event_end_date']) {
 284       $interval = $recursion->getInterval($params['parent_event_start_date'], $params['parent_event_end_date']);
 285       $recursion->intervalDateColumns = array('end_date' => $interval);
 286     }
 287
 288     $recursion->entity_id = $params['event_id'];
 289     $recursion->entity_table = 'civicrm_event';
 290     $recursion->linkedEntities = array(
 291       array(
 292         'table'         => 'civicrm_price_set_entity',
 293         'findCriteria'  => array(
 294           'entity_id'    => $recursion->entity_id,
 295           'entity_table' => 'civicrm_event'
 296         ),
 297         'linkedColumns' => array('entity_id'),
 298         'isRecurringEntityRecord' => FALSE,
 299       ),
 300       array(
 301         'table'         => 'civicrm_uf_join',
 302         'findCriteria'  => array(
 303           'entity_id'    => $recursion->entity_id,
 304           'entity_table' => 'civicrm_event'
 305         ),
 306         'linkedColumns' => array('entity_id'),
 307         'isRecurringEntityRecord' => FALSE,
 308       ),
 309       array(
 310         'table'         => 'civicrm_tell_friend',
 311         'findCriteria'  => array(
 312           'entity_id'    => $recursion->entity_id,
 313           'entity_table' => 'civicrm_event'
 314         ),
 315         'linkedColumns' => array('entity_id'),
 316         'isRecurringEntityRecord' => TRUE,
 317       ),
 318       array(
 319         'table'         => 'civicrm_pcp_block',
 320         'findCriteria'  => array(
 321           'entity_id'    => $recursion->entity_id,
 322           'entity_table' => 'civicrm_event'
 323         ),
 324         'linkedColumns' => array('entity_id'),
 325         'isRecurringEntityRecord' => TRUE,
 326       ),
 327     );
 328
 329     $recurResult = $recursion->generate();
 330
 331     $status = ts('Repeat Configuration has been saved');
 332     CRM_Core_Session::setStatus($status, ts('Saved'), 'success');
 333   }
 334   //end of function
 335
 336   /**
 337    * Return a descriptive name for the page, used in wizard header
 338    *
 339    * @return string
 340    * @access public
 341    */
 342   public function getTitle() {
 343     return ts('Repeat Event');
 344   }
 345
 346 }