3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
32 * @copyright CiviCRM LLC (c) 2004-2018
36 * This class generates form components for processing Entity.
38 class CRM_Core_Form_RecurringEntity
{
42 protected static $_entityId = NULL;
45 * Schedule Reminder ID
47 protected static $_scheduleReminderID = NULL;
50 * Schedule Reminder data
52 protected static $_scheduleReminderDetails = array();
57 protected static $_parentEntityId = NULL;
60 * Exclude date information
62 public static $_excludeDateInfo = array();
67 public static $_entityTable;
70 * Checks current entityID has parent
72 public static $_hasParent = FALSE;
77 public static function preProcess($entityTable) {
78 self
::$_entityId = (int) CRM_Utils_Request
::retrieve('id', 'Positive');
79 self
::$_entityTable = $entityTable;
81 if (self
::$_entityId && $entityTable) {
82 $checkParentExistsForThisId = CRM_Core_BAO_RecurringEntity
::getParentFor(self
::$_entityId, $entityTable);
83 if ($checkParentExistsForThisId) {
84 self
::$_hasParent = TRUE;
85 self
::$_parentEntityId = $checkParentExistsForThisId;
86 self
::$_scheduleReminderDetails = CRM_Core_BAO_RecurringEntity
::getReminderDetailsByEntityId($checkParentExistsForThisId, $entityTable);
89 self
::$_parentEntityId = self
::$_entityId;
90 self
::$_scheduleReminderDetails = CRM_Core_BAO_RecurringEntity
::getReminderDetailsByEntityId(self
::$_entityId, $entityTable);
92 if (property_exists(self
::$_scheduleReminderDetails, 'id')) {
93 self
::$_scheduleReminderID = self
::$_scheduleReminderDetails->id
;
96 CRM_Core_OptionValue
::getValues(array('name' => $entityTable . '_repeat_exclude_dates_' . self
::$_parentEntityId), $optionValue);
97 $excludeOptionValues = array();
98 if (!empty($optionValue)) {
99 foreach ($optionValue as $key => $val) {
100 $excludeOptionValues[$val['value']] = substr(CRM_Utils_Date
::mysqlToIso($val['value']), 0, 10);
102 self
::$_excludeDateInfo = $excludeOptionValues;
106 $entityType = CRM_Core_DAO_AllCoreTables
::getBriefName(CRM_Core_DAO_AllCoreTables
::getClassForTable($entityTable));
107 $tpl = CRM_Core_Smarty
::singleton();
108 $tpl->assign('recurringEntityType', ts($entityType));
109 $tpl->assign('currentEntityId', self
::$_entityId);
110 $tpl->assign('entityTable', self
::$_entityTable);
111 $tpl->assign('scheduleReminderId', self
::$_scheduleReminderID);
112 $tpl->assign('hasParent', self
::$_hasParent);
116 * Set default values for the form. For edit/view mode
117 * the default values are retrieved from the database
122 public static function setDefaultValues() {
123 // Defaults for new entity
125 'repetition_frequency_unit' => 'week',
128 // Default for existing entity
129 if (self
::$_scheduleReminderID) {
130 $defaults['repetition_frequency_unit'] = self
::$_scheduleReminderDetails->repetition_frequency_unit
;
131 $defaults['repetition_frequency_interval'] = self
::$_scheduleReminderDetails->repetition_frequency_interval
;
132 $defaults['start_action_condition'] = array_flip(explode(",", self
::$_scheduleReminderDetails->start_action_condition
));
133 foreach ($defaults['start_action_condition'] as $key => $val) {
135 $defaults['start_action_condition'][$key] = $val;
137 $defaults['start_action_offset'] = self
::$_scheduleReminderDetails->start_action_offset
;
138 if (self
::$_scheduleReminderDetails->start_action_offset
) {
139 $defaults['ends'] = 1;
141 $defaults['repeat_absolute_date'] = self
::$_scheduleReminderDetails->absolute_date
;
142 if (self
::$_scheduleReminderDetails->absolute_date
) {
143 $defaults['ends'] = 2;
145 $defaults['limit_to'] = self
::$_scheduleReminderDetails->limit_to
;
146 if (self
::$_scheduleReminderDetails->limit_to
) {
147 $defaults['repeats_by'] = 1;
149 if (self
::$_scheduleReminderDetails->entity_status
) {
150 $explodeStartActionCondition = explode(" ", self
::$_scheduleReminderDetails->entity_status
);
151 $defaults['entity_status_1'] = $explodeStartActionCondition[0];
152 $defaults['entity_status_2'] = $explodeStartActionCondition[1];
154 if (self
::$_scheduleReminderDetails->entity_status
) {
155 $defaults['repeats_by'] = 2;
157 if (self
::$_excludeDateInfo) {
158 $defaults['exclude_date_list'] = implode(',', self
::$_excludeDateInfo);
167 * @param CRM_Core_Form $form
169 public static function buildQuickForm(&$form) {
170 // FIXME: this is using the following as keys rather than the standard numeric keys returned by CRM_Utils_Date
171 $dayOfTheWeek = array();
181 foreach (CRM_Utils_Date
::getAbbrWeekdayNames() as $k => $label) {
182 $dayOfTheWeek[$dayKeys[$k]] = $label;
184 $form->add('select', 'repetition_frequency_unit', ts('Repeats every'), CRM_Core_SelectValues
::getRecurringFrequencyUnits(), FALSE, array('class' => 'required'));
185 $numericOptions = CRM_Core_SelectValues
::getNumericOptions(1, 30);
186 $form->add('select', 'repetition_frequency_interval', NULL, $numericOptions, FALSE, array('class' => 'required'));
187 $form->add('datepicker', 'repetition_start_date', ts('Start Date'), array(), FALSE, array('time' => TRUE));
188 foreach ($dayOfTheWeek as $key => $val) {
189 $startActionCondition[] = $form->createElement('checkbox', $key, NULL, $val);
191 $form->addGroup($startActionCondition, 'start_action_condition', ts('Repeats on'));
192 $roptionTypes = array(
193 '1' => ts('day of the month'),
194 '2' => ts('day of the week'),
196 $form->addRadio('repeats_by', ts("Repeats on"), $roptionTypes, array('required' => TRUE), NULL);
197 $form->add('select', 'limit_to', '', CRM_Core_SelectValues
::getNumericOptions(1, 31));
198 $dayOfTheWeekNo = array(
199 'first' => ts('First'),
200 'second' => ts('Second'),
201 'third' => ts('Third'),
202 'fourth' => ts('Fourth'),
203 'last' => ts('Last'),
205 $form->add('select', 'entity_status_1', '', $dayOfTheWeekNo);
206 $form->add('select', 'entity_status_2', '', $dayOfTheWeek);
207 $eoptionTypes = array(
211 $form->addRadio('ends', ts("Ends"), $eoptionTypes, array('class' => 'required'), NULL);
212 // Offset options gets key=>val pairs like 1=>2 because the BAO wants to know the number of
213 // children while it makes more sense to the user to see the total number including the parent.
214 $offsetOptions = range(1, 30);
215 unset($offsetOptions[0]);
216 $form->add('select', 'start_action_offset', NULL, $offsetOptions, FALSE);
217 $form->addFormRule(array('CRM_Core_Form_RecurringEntity', 'formRule'));
218 $form->add('datepicker', 'repeat_absolute_date', ts('On'), array(), FALSE, array('time' => FALSE));
219 $form->add('text', 'exclude_date_list', ts('Exclude Dates'), array('class' => 'twenty'));
220 $form->addElement('hidden', 'allowRepeatConfigToSubmit', '', array('id' => 'allowRepeatConfigToSubmit'));
221 $form->addButtons(array(
224 'name' => ts('Save'),
229 'name' => ts('Cancel'),
233 // For client-side pluralization
234 $form->assign('recurringFrequencyOptions', array(
235 'single' => CRM_Utils_Array
::makeNonAssociative(CRM_Core_SelectValues
::getRecurringFrequencyUnits()),
236 'plural' => CRM_Utils_Array
::makeNonAssociative(CRM_Core_SelectValues
::getRecurringFrequencyUnits(2)),
241 * Global validation rules for the form.
243 * @param array $values
244 * Posted values of the form.
247 * list of errors to be posted back to the form
249 public static function formRule($values) {
251 //Process this function only when you get this variable
252 if ($values['allowRepeatConfigToSubmit'] == 1) {
253 $dayOfTheWeek = array('monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday', 'sunday');
255 if (empty($values['repetition_frequency_unit'])) {
256 $errors['repetition_frequency_unit'] = ts('This is a required field');
259 if (empty($values['repetition_frequency_interval'])) {
260 $errors['repetition_frequency_interval'] = ts('This is a required field');
263 if (!empty($values['ends'])) {
264 if ($values['ends'] == 1) {
265 if (empty($values['start_action_offset'])) {
266 $errors['start_action_offset'] = ts('This is a required field');
268 elseif ($values['start_action_offset'] > 30) {
269 $errors['start_action_offset'] = ts('Occurrences should be less than or equal to 30');
272 if ($values['ends'] == 2) {
273 if (!empty($values['repeat_absolute_date'])) {
274 $entityStartDate = CRM_Utils_Date
::processDate($values['repetition_start_date']);
275 $end = CRM_Utils_Date
::processDate($values['repeat_absolute_date']);
276 if (($end < $entityStartDate) && ($end != 0)) {
277 $errors['repeat_absolute_date'] = ts('End date should be after current entity\'s start date');
281 $errors['repeat_absolute_date'] = ts('This is a required field');
286 $errors['ends'] = ts('This is a required field');
290 if (!empty($values['repeats_by'])) {
291 if ($values['repeats_by'] == 1) {
292 if (!empty($values['limit_to'])) {
293 if ($values['limit_to'] < 1 && $values['limit_to'] > 31) {
294 $errors['limit_to'] = ts('Invalid day of the month');
298 $errors['limit_to'] = ts('Invalid day of the month');
301 if ($values['repeats_by'] == 2) {
302 if (!empty($values['entity_status_1'])) {
303 $dayOfTheWeekNo = array('first', 'second', 'third', 'fourth', 'last');
304 if (!in_array($values['entity_status_1'], $dayOfTheWeekNo)) {
305 $errors['entity_status_1'] = ts('Invalid option');
309 $errors['entity_status_1'] = ts('Invalid option');
311 if (!empty($values['entity_status_2'])) {
312 if (!in_array($values['entity_status_2'], $dayOfTheWeek)) {
313 $errors['entity_status_2'] = ts('Invalid day name');
317 $errors['entity_status_2'] = ts('Invalid day name');
326 * Process the form submission.
328 * @param array $params
329 * @param string $type
330 * @param array $linkedEntities
332 * @throws \CiviCRM_API3_Exception
334 public static function postProcess($params = array(), $type, $linkedEntities = array()) {
335 // Check entity_id not present in params take it from class variable
336 if (empty($params['entity_id'])) {
337 $params['entity_id'] = self
::$_entityId;
339 //Process this function only when you get this variable
340 if ($params['allowRepeatConfigToSubmit'] == 1) {
341 if (!empty($params['entity_table']) && !empty($params['entity_id']) && $type) {
342 $params['used_for'] = $type;
343 if (empty($params['parent_entity_id'])) {
344 $params['parent_entity_id'] = self
::$_parentEntityId;
346 if (!empty($params['schedule_reminder_id'])) {
347 $params['id'] = $params['schedule_reminder_id'];
350 $params['id'] = self
::$_scheduleReminderID;
353 //Save post params to the schedule reminder table
354 $recurobj = new CRM_Core_BAO_RecurringEntity();
355 $dbParams = $recurobj->mapFormValuesToDB($params);
357 //Delete repeat configuration and rebuild
358 if (!empty($params['id'])) {
359 CRM_Core_BAO_ActionSchedule
::del($params['id']);
360 unset($params['id']);
362 $actionScheduleObj = CRM_Core_BAO_ActionSchedule
::add($dbParams);
365 $excludeDateList = array();
366 if (CRM_Utils_Array
::value('exclude_date_list', $params) && CRM_Utils_Array
::value('parent_entity_id', $params) && $actionScheduleObj->entity_value
) {
367 //Since we get comma separated values lets get them in array
368 $excludeDates = explode(",", $params['exclude_date_list']);
370 //Check if there exists any values for this option group
371 $optionGroupIdExists = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup',
372 $type . '_repeat_exclude_dates_' . $params['parent_entity_id'],
376 if ($optionGroupIdExists) {
377 CRM_Core_BAO_OptionGroup
::del($optionGroupIdExists);
379 $optionGroupParams = array(
380 'name' => $type . '_repeat_exclude_dates_' . $actionScheduleObj->entity_value
,
381 'title' => $type . ' recursion',
385 $opGroup = CRM_Core_BAO_OptionGroup
::add($optionGroupParams);
388 $fieldValues = array('option_group_id' => $opGroup->id
);
389 foreach ($excludeDates as $val) {
390 $optionGroupValue = array(
391 'option_group_id' => $opGroup->id
,
392 'label' => CRM_Utils_Date
::processDate($val),
393 'value' => CRM_Utils_Date
::processDate($val),
394 'name' => $opGroup->name
,
395 'description' => 'Used for recurring ' . $type,
396 'weight' => CRM_Utils_Weight
::updateOtherWeights('CRM_Core_DAO_OptionValue', $oldWeight, CRM_Utils_Array
::value('weight', $params), $fieldValues),
399 $excludeDateList[] = $optionGroupValue['value'];
400 CRM_Core_BAO_OptionValue
::create($optionGroupValue);
406 $apiEntityType = explode("_", $type);
407 if (!empty($apiEntityType[1])) {
408 $apiType = $apiEntityType[1];
410 //Delete relations if any from recurring entity tables before inserting new relations for this entity id
411 if ($params['entity_id']) {
412 //If entity has any pre delete function, consider that first
413 if (CRM_Utils_Array
::value('pre_delete_func', CRM_Core_BAO_RecurringEntity
::$_recurringEntityHelper[$params['entity_table']]) &&
414 CRM_Utils_Array
::value('helper_class', CRM_Core_BAO_RecurringEntity
::$_recurringEntityHelper[$params['entity_table']])
416 $preDeleteResult = call_user_func_array(CRM_Core_BAO_RecurringEntity
::$_recurringEntityHelper[$params['entity_table']]['pre_delete_func'], array($params['entity_id']));
417 if (!empty($preDeleteResult)) {
418 call_user_func(array(CRM_Core_BAO_RecurringEntity
::$_recurringEntityHelper[$params['entity_table']]['helper_class'], $preDeleteResult));
421 //Ready to execute delete on entities if it has delete function set
422 if (CRM_Utils_Array
::value('delete_func', CRM_Core_BAO_RecurringEntity
::$_recurringEntityHelper[$params['entity_table']]) &&
423 CRM_Utils_Array
::value('helper_class', CRM_Core_BAO_RecurringEntity
::$_recurringEntityHelper[$params['entity_table']])
425 //Check if pre delete function has some ids to be deleted
426 if (!empty(CRM_Core_BAO_RecurringEntity
::$_entitiesToBeDeleted)) {
427 foreach (CRM_Core_BAO_RecurringEntity
::$_entitiesToBeDeleted as $eid) {
428 $result = civicrm_api3(
429 ucfirst(strtolower($apiType)),
430 CRM_Core_BAO_RecurringEntity
::$_recurringEntityHelper[$params['entity_table']]['delete_func'],
436 if ($result['error']) {
437 CRM_Core_Error
::statusBounce('Error creating recurring list');
442 $getRelatedEntities = CRM_Core_BAO_RecurringEntity
::getEntitiesFor($params['entity_id'], $params['entity_table'], FALSE);
443 foreach ($getRelatedEntities as $key => $value) {
444 $result = civicrm_api3(
445 ucfirst(strtolower($apiType)),
446 CRM_Core_BAO_RecurringEntity
::$_recurringEntityHelper[$params['entity_table']]['delete_func'],
449 'id' => $value['id'],
452 if ($result['error']) {
453 CRM_Core_Error
::statusBounce('Error creating recurring list');
459 // find all entities from the recurring set. At this point we 'll get entities which were not deleted
460 // for e.g due to participants being present. We need to delete them from recurring tables anyway.
461 $pRepeatingEntities = CRM_Core_BAO_RecurringEntity
::getEntitiesFor($params['entity_id'], $params['entity_table']);
462 foreach ($pRepeatingEntities as $val) {
463 CRM_Core_BAO_RecurringEntity
::delEntity($val['id'], $val['table'], TRUE);
467 $recursion = new CRM_Core_BAO_RecurringEntity();
468 $recursion->dateColumns
= $params['dateColumns'];
469 $recursion->scheduleId
= $actionScheduleObj->id
;
471 if (!empty($excludeDateList)) {
472 $recursion->excludeDates
= $excludeDateList;
473 $recursion->excludeDateRangeColumns
= $params['excludeDateRangeColumns'];
475 if (!empty($params['intervalDateColumns'])) {
476 $recursion->intervalDateColumns
= $params['intervalDateColumns'];
478 $recursion->entity_id
= $params['entity_id'];
479 $recursion->entity_table
= $params['entity_table'];
480 if (!empty($linkedEntities)) {
481 $recursion->linkedEntities
= $linkedEntities;
484 $recursion->generate();
486 $status = ts('Repeat Configuration has been saved');
487 CRM_Core_Session
::setStatus($status, ts('Saved'), 'success');
493 * Return a descriptive name for the page, used in wizard header
497 public function getTitle() {
498 return ts('Repeat Entity');