Projet

Général

Profil

Paste
Télécharger (24,9 ko) Statistiques
| Branche: | Révision:

root / drupal7 / sites / all / modules / date / date_repeat_field / date_repeat_field.module @ 74f6bef0

1
<?php
2

    
3
/**
4
 * @file
5
 * Creates the option of Repeating date fields and manages Date fields that use the Date Repeat API.
6
 *
7
 * The Repeating functionality is pretty tightly intermingled with other code,
8
 * so the process of pulling it out into this module will happen gradually.
9
 *
10
 * The current implementation adds a repeat form to the date field so the user
11
 * can select the repeat rules. That selection is built into an RRULE
12
 * which is stored in the zero position of the field values. During widget
13
 * validation, the rule is parsed to see what dates it will create,
14
 * and multiple values are added to the field, one for each repeat date.
15
 * That update only happens when the rule, the start date, or the end date
16
 * change, no need to waste processing cycles for other changes to the node
17
 * values.
18
 *
19
 * Lots of possible TODOs, the biggest one is figuring out the best
20
 * way to handle dates with no UNTIL date since we can't add an infinite
21
 * number of values to the field. For now, we require the UNTIL date.
22
 */
23

    
24
/**
25
 * Implements hook_theme().
26
 */
27
function date_repeat_field_theme() {
28
  $themes = array(
29
    'date_repeat_display' => array(
30
      'variables' => array(
31
        'field' => NULL,
32
        'item' => NULL,
33
        'entity_type' => NULL,
34
        'entity' => NULL,
35
        'dates' => NULL
36
      ),
37
      'function' => 'theme_date_repeat_display',
38
    ),
39
  );
40

    
41
  return $themes;
42
}
43

    
44
/**
45
 * Theme the human-readable description for a Date Repeat rule.
46
 *
47
 * TODO -
48
 * add in ways to store the description in the date so it isn't regenerated
49
 * over and over and find a way to allow description to be shown or hidden.
50
 */
51
function theme_date_repeat_display($vars) {
52
  $field = $vars['field'];
53
  $item = $vars['item'];
54
  $entity = !empty($vars['node']) ? $vars['node'] : NULL;
55
  $output = '';
56
  if (!empty($item['rrule'])) {
57
    $output = date_repeat_rrule_description($item['rrule']);
58
    $output = '<div class="date-repeat-rule">' . $output . '</div>';
59
  }
60
  return $output;
61
}
62

    
63
/**
64
 * Implements hook_menu().
65
 *
66
 * Add menu tabs to display pages with details about repeating date values.
67
 */
68
function date_repeat_field_menu() {
69
  $items = array();
70

    
71
  $values = date_repeat_field_bundles();
72
  foreach ($values as $entity_type => $bundles) {
73
    if (module_exists('field_collection') && $entity_type == 'field_collection_item') {
74
      foreach ($bundles as $bundle => $fields) {
75
        $field = field_info_field($bundle);
76
        if ($field['type'] == 'field_collection') {
77
          $path = field_collection_field_get_path($field);
78
          $count = count(explode('/', $path));
79
          $items[$path . '/%field_collection_item/repeats'] = array(
80
           'title' => 'Repeats',
81
           'page callback' => 'date_repeat_field_page',
82
           'page arguments' => array($entity_type, $count),
83
           'access callback' => 'date_repeat_field_show',
84
           'access arguments' => array($entity_type, $count),
85
           'type' => MENU_LOCAL_TASK,
86
           'context' => MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE,
87
          );
88
        }
89
      }
90
    }
91
    else {
92
      $path = $entity_type . '/%' . $entity_type;
93
      $items[$path . '/repeats'] = array(
94
       'title' => 'Repeats',
95
       'page callback' => 'date_repeat_field_page',
96
       'page arguments' => array($entity_type, 1),
97
       'access callback' => 'date_repeat_field_show',
98
       'access arguments' => array($entity_type, 1),
99
       'type' => MENU_LOCAL_TASK,
100
       'context' => MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE,
101
      );
102
    }
103
  }
104
  return $items;
105
}
106

    
107
/**
108
 * Implements hook_permission().
109
 */
110
function date_repeat_field_permission() {
111
  return array('view date repeats' => array(
112
    'title' => t('View Repeating Dates'),
113
    'description' => t('Allow user to see a page with all the times a date repeats.'),
114
  ));
115
}
116

    
117
/**
118
 * See if the user can access repeat date info for this field.
119
 */
120
function date_repeat_field_show($entity_type = 'node', $entity = NULL) {
121
  $bundle = date_get_entity_bundle($entity_type, $entity);
122
  foreach (field_info_fields() as $field_name => $field) {
123
    if (in_array($field['type'], array('date', 'datestamp', 'datetime'))
124
        && array_key_exists($entity_type, $field['bundles'])
125
        && in_array($bundle, $field['bundles'][$entity_type])
126
        && date_is_repeat_field($field)) {
127
      return user_access('view date repeats');
128
    }
129
  }
130
  return FALSE;
131
}
132

    
133
/**
134
 * A page to list all values for a repeating date.
135
 */
136
function date_repeat_field_page($entity_type = 'node', $entity = NULL) {
137
  $bundle = date_get_entity_bundle($entity_type, $entity);
138
  $info = entity_get_info($entity_type);
139
  $key = $info['entity keys']['id'];
140
  drupal_set_title(t('Repeats'));
141
  $entity->date_repeat_show_all = TRUE;
142
  $entity->content = array();
143
  $output = '';
144
  foreach (field_info_fields() as $field_name => $field) {
145
    if (in_array($field['type'], array('date', 'datestamp', 'datetime')) && date_is_repeat_field($field)) {
146
      foreach ($field['bundles'] as $field_entity_type => $bundles) {
147
        foreach ($bundles as $field_bundle) {
148
          if ($entity_type == $field_entity_type && $bundle == $field_bundle) {
149
            $data = field_view_field($entity_type, $entity, $field_name);
150
            $output .= drupal_render($data);
151
          }
152
        }
153
      }
154
    }
155
  }
156
  return $output;
157
}
158

    
159
/**
160
 * Return an array of all entity types and bundles that have repeating date fields.
161
 */
162
function date_repeat_field_bundles() {
163
  $values = array();
164
  foreach (field_info_fields() as $field_name => $field) {
165
    if (in_array($field['type'], array('date', 'datestamp', 'datetime')) && $field['settings']['repeat']) {
166
      foreach ($field['bundles'] as $entity_type => $bundles) {
167
        foreach ($bundles as $bundle) {
168
          $values[$entity_type][$bundle][] = $field_name;
169
        }
170
      }
171
    }
172
  }
173
  return $values;
174
}
175

    
176
function date_is_repeat_field($field, $instance = NULL) {
177
  if (is_string($field)) {
178
    $field = field_info_field($field);
179
  }
180

    
181
  if (!isset($field['settings']['repeat'])) {
182
    return FALSE;
183
  }
184

    
185
  $value = $field['settings']['repeat'];
186

    
187
  // This might be either a field form or a real field.
188
  if (is_array($value)) {
189
    return $value['#value'];
190
  }
191
  else {
192
    return $value;
193
  }
194
}
195

    
196
/*
197
 * Implements hook_date_field_insert_alter().
198
 */
199
function date_repeat_field_date_field_insert_alter(&$items, $context) {
200

    
201
  $entity = $context['entity'];
202
  $field = $context['field'];
203
  $instance = $context['instance'];
204
  $langcode = $context['langcode'];
205

    
206
  // If an RRULE with a frequency of NONE made it this far, unset it.
207
  if (!empty($items[0]['rrule']) && strpos($items[0]['rrule'], 'FREQ=NONE')) {
208
    $items[0]['rrule'] = NULL;
209
  }
210

    
211
  // We can't use hook_devel_generate() because we need custom handling for
212
  // repeating date fields. So we wait until the entity is inserted, then
213
  // intervene here to fix it.
214
  if (!empty($entity->devel_generate) && !empty($field['settings']['repeat'])) {
215
    module_load_include('inc', 'date_repeat_field', 'date_repeat_field.devel_generate');
216
    date_repeat_field_date_field_insert($items, $context);
217
  }
218
}
219

    
220
/*
221
 * Implements hook_date_field_update_alter().
222
 */
223
function date_repeat_field_date_field_update_alter(&$items, $context) {
224

    
225
  // If an RRULE with a frequency of NONE made it this far, unset it.
226
  if (!empty($items[0]['rrule']) && strpos($items[0]['rrule'], 'FREQ=NONE')) {
227
    $items[0]['rrule'] = NULL;
228
  }
229

    
230
  // If you have a repeating date field on a user and don't check the box to repeat it,
231
  // we end up with $items[0]['rrule'] = array('additions' => '', 'exceptions' => ''));
232
  // This will clean it up by getting rid of those bogus values.
233
  // @TODO Figure out where that's coming from. It doesn't happen on nodes.
234
  if (!empty($items[0]['rrule']) && is_array($items[0]['rrule'])) {
235
    $items[0]['rrule'] = NULL;
236
  }
237
}
238

    
239
/**
240
 * Implements hook_field_widget_form_alter().
241
 */
242
function date_repeat_field_field_widget_form_alter(&$element, &$form_state, $context) {
243

    
244
  $field = $context['field'];
245
  $instance = $context['instance'];
246
  $items = $context['items'];
247
  $delta = $context['delta'];
248

    
249
  if (in_array($field['type'], array('date', 'datetime', 'datestamp'))) {
250
    if (!empty($field['settings']['repeat'])) {
251
      $element['#element_validate'][] = 'date_repeat_field_widget_validate';
252
      $element['show_repeat_settings'] = array(
253
        '#type' => 'checkbox',
254
        '#title' => t('Repeat'),
255
        '#weight' => $instance['widget']['weight'] + .3,
256
        '#prefix' => '<div class="date-clear">',
257
        '#suffix' => '</div>',
258
        '#default_value' => isset($items[$delta]['rrule']) && !empty($items[$delta]['rrule']) ? 1 : 0,
259
      );
260
    }
261
  }
262
}
263

    
264
/**
265
 * Validation for date repeat form element.
266
 *
267
 * Create multiple values from the RRULE results.
268
 * Lots more work needed here.
269
 */
270
function date_repeat_field_widget_validate($element, &$form_state) {
271
  $field = field_widget_field($element, $form_state);
272
  if (empty($field['settings']['repeat'])) {
273
    return;
274
  }
275

    
276
  $field_name = $element['#field_name'];
277
  $delta = $element['#delta'];
278
  $langcode = $element['#language'];
279

    
280
  // If the widget has been hidden by #access, the RRULE will still be in its
281
  // original string form here. Nothing to process.
282
  if (date_hidden_element($element)) {
283

    
284
    // If this was a hidden repeating date, we lost all the repeating values in the widget processing.
285
    // Add them back here if that happened since we are skipping the re-creation of those values.
286
    if (!empty($form_state['storage']['date_items'][$field_name])) {
287
      array_pop($element['#parents']);
288
      form_set_value($element, $form_state['storage']['date_items'][$field_name][$langcode], $form_state);
289
    }
290
    return;
291
  }
292

    
293
  module_load_include('inc', 'date_repeat', 'date_repeat_form');
294
  $instance = field_widget_instance($element, $form_state);
295

    
296
  // Here 'values' returns an array of input values, which includes the original RRULE, as a string.
297
  // and 'input' returns an array of the form elements created by the repeating date widget, with
298
  // RRULE values as an array of the selected elements and their chosen values.
299
  $item = drupal_array_get_nested_value($form_state['values'], $element['#parents'], $input_exists);
300
  $input = drupal_array_get_nested_value($form_state['input'], $element['#parents'], $input_exists);
301

    
302
  $rrule_values = date_repeat_merge($input['rrule'], $element['rrule']);
303

    
304
  // If no repeat information was set, treat this as a normal, non-repeating value.
305
  if ($rrule_values['FREQ'] == 'NONE' || empty($input['show_repeat_settings'])) {
306
    $item['rrule'] = NULL;
307
    form_set_value($element, $item, $form_state);
308
    return;
309
  }
310

    
311
  // If no start date was set, clean up the form and return.
312
  if (empty($item['value'])) {
313
    form_set_value($element, NULL, $form_state);
314
    return;
315
  }
316

    
317
  // Require the UNTIL date for now.
318
  // The RRULE has already been created by this point, so go back
319
  // to the posted values to see if this was filled out.
320
  $error_field_base = implode('][', $element['#parents']);
321
  $error_field_until =  $error_field_base . '][rrule][until_child][datetime][';
322
  if (!empty($item['rrule']) && $rrule_values['range_of_repeat'] === 'UNTIL' && empty($rrule_values['UNTIL']['datetime'])) {
323
    switch ($instance['widget']['type']) {
324
      case 'date_text':
325
      case 'date_popup':
326
        form_set_error($error_field_until . 'date', t("Missing value in 'Range of repeat'. (UNTIL).", array(), array('context' => 'Date repeat')));
327
        break;
328
      case 'date_select':
329
        form_set_error($error_field_until . 'year', t("Missing value in 'Range of repeat': Year (UNTIL)", array(), array('context' => 'Date repeat')));
330
        form_set_error($error_field_until . 'month', t("Missing value in 'Range of repeat': Month (UNTIL)", array(), array('context' => 'Date repeat')));
331
        form_set_error($error_field_until . 'day', t("Missing value in 'Range of repeat': Day (UNTIL)", array(), array('context' => 'Date repeat')));
332
        break;
333
    }
334
  }
335

    
336
  $error_field_count = $error_field_base . '][rrule][count_child';
337
  if (!empty($item['rrule']) && $rrule_values['range_of_repeat'] === 'COUNT' && empty($rrule_values['COUNT'])) {
338
    form_set_error($error_field_count, t("Missing value in 'Range of repeat'. (COUNT).", array(), array('context' => 'Date repeat')));
339
  }
340

    
341
  if (form_get_errors()) {
342
    return;
343
  }
344

    
345
  // If the rule, the start date, or the end date have changed, re-calculate
346
  // the repeating dates, wipe out the previous values, and populate the
347
  // field with the new values.
348

    
349
  $rrule = $item['rrule'];
350
  if (!empty($rrule)) {
351

    
352
    // Avoid undefined index problems on dates that don't have all parts.
353
    $possible_items = array('value', 'value2', 'timezone', 'offset', 'offset2');
354
    foreach ($possible_items as $key) {
355
      if (empty($item[$key])) {
356
        $item[$key] = '';
357
      }
358
    }
359

    
360
    // We only collect a date for UNTIL, but we need it to be inclusive,
361
    // so force it to a full datetime element at the last possible second of the day.
362
    if (!empty($rrule_values['UNTIL'])) {
363
      $rrule_values['UNTIL']['datetime'] .= ' 23:59:59';
364
      $rrule_values['UNTIL']['granularity'] = serialize(drupal_map_assoc(array('year', 'month', 'day', 'hour', 'minute', 'second')));
365
      $rrule_values['UNTIL']['all_day'] = 0;
366
    }
367
    $value = date_repeat_build_dates($rrule, $rrule_values, $field, $item);
368
    // Unset the delta value of the parents.
369
    array_pop($element['#parents']);
370
    // Set the new delta values for this item to the array of values returned by the repeat rule.
371
    form_set_value($element, $value, $form_state);
372
  }
373
}
374

    
375
/**
376
 * Implements the form after_build().
377
 *
378
 * Remove the 'Add more' elements from a repeating date form.
379
 */
380
function date_repeat_after_build(&$element, &$form_state) {
381
  foreach ($form_state['storage']['repeat_fields'] as $field_name => $parents) {
382
    // Remove unnecessary items in the form added by the Add more handling.
383
    $value = drupal_array_get_nested_value($element, $parents);
384
    $langcode = $value['#language'];
385
    unset($value[$langcode]['add_more'], $value[$langcode]['#suffix'], $value[$langcode]['#prefix'], $value[$langcode][0]['_weight']);
386
    $value[$langcode]['#cardinality'] = 1;
387
    $value[$langcode]['#max_delta'] = 1;
388
    drupal_array_set_nested_value($element, $parents, $value);
389
  }
390
  return $element;
391
}
392

    
393
/**
394
 * Helper function to build repeating dates from a $node_field.
395
 *
396
 * Pass in either the RRULE or the $form_values array for the RRULE,
397
 * whichever is missing will be created when needed.
398
 */
399
function date_repeat_build_dates($rrule = NULL, $rrule_values = NULL, $field, $item) {
400

    
401
  include_once(DRUPAL_ROOT . '/' . drupal_get_path('module', 'date_api') . '/date_api_ical.inc');
402
  $field_name = $field['field_name'];
403

    
404
  if (empty($rrule)) {
405
    $rrule = date_api_ical_build_rrule($rrule_values);
406
  }
407
  elseif (empty($rrule_values)) {
408
    $rrule_values = date_ical_parse_rrule(NULL, $rrule);
409
  }
410

    
411
  // By the time we get here, the start and end dates have been
412
  // adjusted back to UTC, but we want localtime dates to do
413
  // things like '+1 Tuesday', so adjust back to localtime.
414
  $timezone = date_get_timezone($field['settings']['tz_handling'], $item['timezone']);
415
  $timezone_db = date_get_timezone_db($field['settings']['tz_handling']);
416
  $start = new DateObject($item['value'], $timezone_db, date_type_format($field['type']));
417
  $start->limitGranularity($field['settings']['granularity']);
418
  if ($timezone != $timezone_db) {
419
    date_timezone_set($start, timezone_open($timezone));
420
  }
421
  if (!empty($item['value2']) && $item['value2'] != $item['value']) {
422
    $end = new DateObject($item['value2'], date_get_timezone_db($field['settings']['tz_handling']), date_type_format($field['type']));
423
    $end->limitGranularity($field['settings']['granularity']);
424
    date_timezone_set($end, timezone_open($timezone));
425
  }
426
  else {
427
    $end = $start;
428
  }
429
  $duration = $start->difference($end);
430
  $start_datetime = date_format($start, DATE_FORMAT_DATETIME);
431

    
432
  if (!empty($rrule_values['UNTIL']['datetime'])) {
433
    $end = date_ical_date($rrule_values['UNTIL'], $timezone);
434
    $end_datetime = date_format($end, DATE_FORMAT_DATETIME);
435
  }
436
  elseif (!empty($rrule_values['COUNT'])) {
437
    $end_datetime = NULL;
438
  }
439
  else {
440
    // No UNTIL and no COUNT?
441
    return array();
442
  }
443

    
444
  // Split the RRULE into RRULE, EXDATE, and RDATE parts.
445
  $parts = date_repeat_split_rrule($rrule);
446
  $parsed_exceptions = (array) $parts[1];
447
  $exceptions = array();
448
  foreach ($parsed_exceptions as $exception) {
449
    $date = date_ical_date($exception, $timezone);
450
    $exceptions[] = date_format($date, 'Y-m-d');
451
  }
452

    
453
  $parsed_rdates = (array) $parts[2];
454
  $additions = array();
455
  foreach ($parsed_rdates as $rdate) {
456
    $date = date_ical_date($rdate, $timezone);
457
    $additions[] = date_format($date, 'Y-m-d');
458
  }
459

    
460
  $dates = date_repeat_calc($rrule, $start_datetime, $end_datetime, $exceptions, $timezone, $additions);
461
  $value = array();
462
  foreach ($dates as $delta => $date) {
463
    // date_repeat_calc always returns DATE_DATETIME dates, which is
464
    // not necessarily $field['type'] dates.
465
    // Convert returned dates back to db timezone before storing.
466
    $date_start = new DateObject($date, $timezone, DATE_FORMAT_DATETIME);
467
    $date_start->limitGranularity($field['settings']['granularity']);
468
    date_timezone_set($date_start, timezone_open($timezone_db));
469
    $date_end = clone($date_start);
470
    date_modify($date_end, '+' . $duration . ' seconds');
471
    $value[$delta] = array(
472
      'value' => date_format($date_start, date_type_format($field['type'])),
473
      'value2' => date_format($date_end, date_type_format($field['type'])),
474
      'offset' => date_offset_get($date_start),
475
      'offset2' => date_offset_get($date_end),
476
      'timezone' => $timezone,
477
      'rrule' => $rrule,
478
      );
479
  }
480
  return $value;
481
}
482

    
483
/**
484
 * Implements hook_date_combo_process_alter().
485
 *
486
 * This hook lets us make changes to the date_combo element.
487
 */
488
function date_repeat_field_date_combo_process_alter(&$element, &$form_state, $context) {
489

    
490
  $field = $context['field'];
491
  $instance = $context['instance'];
492
  $field_name = $element['#field_name'];
493
  $delta = $element['#delta'];
494

    
495
  // Add a date repeat form element, if needed.
496
  // We delayed until this point so we don't bother adding it to hidden fields.
497
  if (date_is_repeat_field($field, $instance)) {
498

    
499
    $item = $element['#value'];
500
    $element['rrule'] = array(
501
      '#type' => 'date_repeat_rrule',
502
      '#theme_wrappers' => array('date_repeat_rrule'),
503
      '#default_value' => isset($item['rrule']) ? $item['rrule'] : '',
504
      '#date_timezone' => $element['#date_timezone'],
505
      '#date_format'      => date_limit_format(date_input_format($element, $field, $instance), $field['settings']['granularity']),
506
      '#date_text_parts'  => (array) $instance['widget']['settings']['text_parts'],
507
      '#date_increment'   => $instance['widget']['settings']['increment'],
508
      '#date_year_range'  => $instance['widget']['settings']['year_range'],
509
      '#date_label_position' => $instance['widget']['settings']['label_position'],
510
      '#date_repeat_widget' => str_replace('_repeat', '', $instance['widget']['type']),
511
      '#date_repeat_collapsed' => $instance['widget']['settings']['repeat_collapsed'],
512
      '#date_flexible' => 0,
513
      '#weight' => $instance['widget']['weight'] + .4,
514
    );
515
  }
516

    
517
}
518

    
519
/**
520
 * Implements hook_date_combo_pre_validate_alter().
521
 *
522
 * This hook lets us alter the element or the form_state before the rest
523
 * of the date_combo validation gets fired.
524
 */
525
function date_repeat_field_date_combo_pre_validate_alter(&$element, &$form_state, $context) {
526
  // Just a placeholder for now.
527
}
528

    
529
/**
530
 * Implements hook_field_info_alter().
531
 *
532
 * This Field API hook lets us add a new setting to the fields.
533
 */
534
function date_repeat_field_field_info_alter(&$info) {
535

    
536
  $info['date']['settings'] += array(
537
    'repeat' => 0,
538
  );
539
  $info['datetime']['settings'] += array(
540
    'repeat' => 0,
541
  );
542
  $info['datestamp']['settings'] += array(
543
    'repeat' => 0,
544
  );
545
}
546

    
547
/**
548
 * Implements hook_field_formatter_info_alter().
549
 *
550
 * This hook lets us add settings to the formatters.
551
 */
552
function date_repeat_field_field_formatter_info_alter(&$info) {
553

    
554
  if (isset($info['date_default'])) {
555
    $info['date_default']['settings'] += array(
556
      'show_repeat_rule' => 'show',
557
    );
558
  }
559
}
560

    
561
/**
562
 * Implements hook_field_widget_info_alter().
563
 *
564
 * This Field API hook lets us add a new setting to the widgets.
565
 */
566
function date_repeat_field_field_widget_info_alter(&$info) {
567

    
568
  $info['date_text']['settings'] += array(
569
    'repeat_collapsed' => 0,
570
  );
571
  $info['date_select']['settings'] += array(
572
    'repeat_collapsed' => 0,
573
  );
574
  if (module_exists('date_popup')) {
575
    $info['date_popup']['settings'] += array(
576
      'repeat_collapsed' => 0,
577
    );
578
  }
579
}
580

    
581
/**
582
 * Implements hook_date_field_settings_form_alter().
583
 *
584
 * This hook lets us alter the field settings form.
585
 */
586
function date_repeat_field_date_field_settings_form_alter(&$form, $context) {
587

    
588
  $field = $context['field'];
589
  $instance = $context['instance'];
590
  $has_data = $context['has_data'];
591

    
592
  $form['repeat'] = array(
593
    '#type' => 'select',
594
    '#title' => t('Repeating date'),
595
    '#default_value' => $field['settings']['repeat'],
596
    '#options' => array(0 => t('No'), 1 => t('Yes')),
597
    '#attributes' => array('class' => array('container-inline')),
598
    '#description' => t("Repeating dates use an 'Unlimited' number of values. Instead of the 'Add more' button, they include a form to select when and how often the date should repeat."),
599
    '#disabled' => $has_data,
600
  );
601
}
602

    
603
/**
604
 * Implements hook_form_FORM_ID_alter() for field_ui_field_edit_form().
605
 */
606
function date_repeat_field_form_field_ui_field_edit_form_alter(&$form, &$form_state, $form_id) {
607
  $field = $form['#field'];
608
  $instance = $form['#instance'];
609

    
610
  if (!in_array($field['type'], array('date', 'datetime', 'datestamp'))) {
611
    return;
612
  }
613

    
614
  // If using repeating dates, override the Field module's handling of the multiple values option.
615
  if (date_is_repeat_field($field, $instance)) {
616
    $form['field']['cardinality']['#disabled'] = TRUE;
617
    $form['field']['cardinality']['#value'] = FIELD_CARDINALITY_UNLIMITED;
618
  }
619
  // Repeating dates need unlimited values, confirm that in element_validate.
620
  $form['field']['#element_validate'] = array('date_repeat_field_set_cardinality');
621
}
622

    
623
/**
624
 * Ensure the cardinality gets updated if the option to make a date repeating is checked.
625
 */
626
function date_repeat_field_set_cardinality($element, &$form_state) {
627
  if (!empty($form_state['values']['field']['settings']['repeat'])) {
628
    form_set_value($element['cardinality'], FIELD_CARDINALITY_UNLIMITED, $form_state);
629
  }
630
}
631

    
632
/**
633
 * Implements hook_date_field_instance_settings_form_alter().
634
 *
635
 * This hook lets us alter the field instance settings form.
636
 */
637
function date_repeat_field_date_field_instance_settings_form_alter(&$form, $context) {
638
  // Just a placeholder for now.
639
}
640

    
641
/**
642
 * Implements hook_date_field_widget_settings_form_alter().
643
 *
644
 * This hook lets us alter the field widget settings form.
645
 */
646
function date_repeat_field_date_field_widget_settings_form_alter(&$form, $context) {
647

    
648
  $field = $context['field'];
649
  $instance = $context['instance'];
650

    
651
  if (date_is_repeat_field($field, $instance)) {
652
    $form['repeat_collapsed'] = array(
653
      '#type' => 'value',
654
      '#default_value' => 1,
655
      '#options' => array(
656
        0 => t('Expanded', array(), array('context' => 'Date repeat')),
657
        1 => t('Collapsed', array(), array('context' => 'Date repeat'))
658
      ),
659
      '#title' => t('Repeat display', array(), array('context' => 'Date repeat')),
660
      '#description' => t("Should the repeat options form start out expanded or collapsed? Set to 'Collapsed' to make those options less obtrusive.", array(), array('context' => 'Date repeat')),
661
      '#fieldset' => 'date_format',
662
      );
663
  }
664

    
665
}
666

    
667
/**
668
 * Implements hook_date_field_foramatter_settings_form_alter().
669
 *
670
 * This hook lets us alter the field formatter settings form.
671
 */
672
function date_repeat_field_date_field_formatter_settings_form_alter(&$form, &$form_state, $context) {
673

    
674
  $field = $context['field'];
675
  $instance = $context['instance'];
676
  $view_mode = $context['view_mode'];
677
  $display = $instance['display'][$view_mode];
678
  $formatter = $display['type'];
679
  $settings = $display['settings'];
680
  if ($formatter == 'date_default') {
681
    $form['show_repeat_rule'] = array(
682
      '#title' => t('Repeat rule:'),
683
      '#type' => 'select',
684
      '#options' => array(
685
        'show' => t('Show repeat rule'),
686
        'hide' => t('Hide repeat rule')),
687
      '#default_value' => $settings['show_repeat_rule'],
688
      '#access' => $field['settings']['repeat'],
689
      '#weight' => 5,
690
    );
691
  }
692
}
693

    
694
/**
695
 * Implements hook_date_field_foramatter_settings_summary_alter().
696
 *
697
 * This hook lets us alter the field formatter settings summary.
698
 */
699
function date_repeat_field_date_field_formatter_settings_summary_alter(&$summary, $context) {
700

    
701
  $field = $context['field'];
702
  $instance = $context['instance'];
703
  $view_mode = $context['view_mode'];
704
  $display = $instance['display'][$view_mode];
705
  $formatter = $display['type'];
706
  $settings = $display['settings'];
707
  if (isset($settings['show_repeat_rule']) && !empty($field['settings']['repeat'])) {
708
    if ($settings['show_repeat_rule'] == 'show') {
709
      $summary[] = t('Show repeat rule');
710
    }
711
    else {
712
      $summary[] = t('Hide repeat rule');
713
    }
714
  }
715
}