Projet

Général

Profil

Paste
Télécharger (25,7 ko) Statistiques
| Branche: | Révision:

root / drupal7 / sites / all / modules / date / date_repeat_field / date_repeat_field.module @ db9ffd17

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 entity.
119
 *
120
 * @param string $entity_type
121
 *   The entity type.
122
 * @param string $entity
123
 *   The specific entity to check (optional).
124
 *
125
 * @return bool
126
 *   Return TRUE if there is at least one date field attached to this entity,
127
 *   and the current user has the permission 'view date repeats'; FALSE otherwise.
128
 */
129
function date_repeat_field_show($entity_type = 'node', $entity = NULL) {
130
  if (!user_access('view date repeats')) {
131
    return FALSE;
132
  }
133

    
134
  $bundle = date_get_entity_bundle($entity_type, $entity);
135

    
136
  // In Drupal 7.22 the field_info_field_map() function was added, which is more
137
  // memory-efficient in certain cases than field_info_fields().
138
  // @see https://drupal.org/node/1915646
139
  $field_map_available = version_compare(VERSION, '7.22', '>=');
140
  $field_list = $field_map_available ? field_info_field_map() : field_info_fields();
141

    
142
  foreach ($field_list as $field_name => $data) {
143
    if (in_array($data['type'], array('date', 'datestamp', 'datetime'))
144
        && array_key_exists($entity_type, $data['bundles'])
145
        && in_array($bundle, $data['bundles'][$entity_type])) {
146
      $field_info = $field_map_available ? field_info_field($field_name) : $data;
147
      if (date_is_repeat_field($field_info)) {
148
        return TRUE;
149
      }
150
    }
151
  }
152
  return FALSE;
153
}
154

    
155
/**
156
 * A page to list all values for a repeating date.
157
 */
158
function date_repeat_field_page($entity_type = 'node', $entity = NULL) {
159
  $bundle = date_get_entity_bundle($entity_type, $entity);
160
  $info = entity_get_info($entity_type);
161
  $key = $info['entity keys']['id'];
162
  drupal_set_title(t('Repeats'));
163
  $entity->date_repeat_show_all = TRUE;
164
  $entity->content = array();
165
  $output = '';
166
  foreach (field_info_fields() as $field_name => $field) {
167
    if (in_array($field['type'], array('date', 'datestamp', 'datetime')) && date_is_repeat_field($field)) {
168
      foreach ($field['bundles'] as $field_entity_type => $bundles) {
169
        foreach ($bundles as $field_bundle) {
170
          if ($entity_type == $field_entity_type && $bundle == $field_bundle) {
171
            $data = field_view_field($entity_type, $entity, $field_name);
172
            $output .= drupal_render($data);
173
          }
174
        }
175
      }
176
    }
177
  }
178
  return $output;
179
}
180

    
181
/**
182
 * Return an array of all entity types and bundles that have repeating date fields.
183
 */
184
function date_repeat_field_bundles() {
185
  $values = array();
186
  foreach (field_info_fields() as $field_name => $field) {
187
    if (in_array($field['type'], array('date', 'datestamp', 'datetime')) && $field['settings']['repeat']) {
188
      foreach ($field['bundles'] as $entity_type => $bundles) {
189
        foreach ($bundles as $bundle) {
190
          $values[$entity_type][$bundle][] = $field_name;
191
        }
192
      }
193
    }
194
  }
195
  return $values;
196
}
197

    
198
function date_is_repeat_field($field, $instance = NULL) {
199
  if (is_string($field)) {
200
    $field = field_info_field($field);
201
  }
202

    
203
  if (!isset($field['settings']['repeat'])) {
204
    return FALSE;
205
  }
206

    
207
  $value = $field['settings']['repeat'];
208

    
209
  // This might be either a field form or a real field.
210
  if (is_array($value)) {
211
    return $value['#value'];
212
  }
213
  else {
214
    return $value;
215
  }
216
}
217

    
218
/*
219
 * Implements hook_date_field_insert_alter().
220
 */
221
function date_repeat_field_date_field_insert_alter(&$items, $context) {
222

    
223
  $entity = $context['entity'];
224
  $field = $context['field'];
225
  $instance = $context['instance'];
226
  $langcode = $context['langcode'];
227

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

    
233
  // We can't use hook_devel_generate() because we need custom handling for
234
  // repeating date fields. So we wait until the entity is inserted, then
235
  // intervene here to fix it.
236
  if (!empty($entity->devel_generate) && !empty($field['settings']['repeat'])) {
237
    module_load_include('inc', 'date_repeat_field', 'date_repeat_field.devel_generate');
238
    date_repeat_field_date_field_insert($items, $context);
239
  }
240
}
241

    
242
/*
243
 * Implements hook_date_field_update_alter().
244
 */
245
function date_repeat_field_date_field_update_alter(&$items, $context) {
246

    
247
  // If an RRULE with a frequency of NONE made it this far, unset it.
248
  if (!empty($items[0]['rrule']) && strpos($items[0]['rrule'], 'FREQ=NONE')) {
249
    $items[0]['rrule'] = NULL;
250
  }
251

    
252
  // If you have a repeating date field on a user and don't check the box to repeat it,
253
  // we end up with $items[0]['rrule'] = array('additions' => '', 'exceptions' => ''));
254
  // This will clean it up by getting rid of those bogus values.
255
  // @TODO Figure out where that's coming from. It doesn't happen on nodes.
256
  if (!empty($items[0]['rrule']) && is_array($items[0]['rrule'])) {
257
    $items[0]['rrule'] = NULL;
258
  }
259
}
260

    
261
/**
262
 * Implements hook_field_widget_form_alter().
263
 */
264
function date_repeat_field_field_widget_form_alter(&$element, &$form_state, $context) {
265

    
266
  $field = $context['field'];
267
  $instance = $context['instance'];
268
  $items = $context['items'];
269
  $delta = $context['delta'];
270

    
271
  if (in_array($field['type'], array('date', 'datetime', 'datestamp'))) {
272
    if (!empty($field['settings']['repeat'])) {
273
      $element['#element_validate'][] = 'date_repeat_field_widget_validate';
274
      $element['show_repeat_settings'] = array(
275
        '#type' => 'checkbox',
276
        '#title' => t('Repeat'),
277
        '#weight' => $instance['widget']['weight'] + .3,
278
        '#prefix' => '<div class="date-clear">',
279
        '#suffix' => '</div>',
280
        '#default_value' => isset($items[$delta]['rrule']) && !empty($items[$delta]['rrule']) ? 1 : 0,
281
      );
282
    }
283
  }
284
}
285

    
286
/**
287
 * Validation for date repeat form element.
288
 *
289
 * Create multiple values from the RRULE results.
290
 * Lots more work needed here.
291
 */
292
function date_repeat_field_widget_validate($element, &$form_state) {
293
  $field = field_widget_field($element, $form_state);
294
  if (empty($field['settings']['repeat'])) {
295
    return;
296
  }
297

    
298
  $field_name = $element['#field_name'];
299
  $delta = $element['#delta'];
300
  $langcode = $element['#language'];
301

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

    
306
    // If this was a hidden repeating date, we lost all the repeating values in the widget processing.
307
    // Add them back here if that happened since we are skipping the re-creation of those values.
308
    if (!empty($form_state['storage']['date_items'][$field_name])) {
309
      array_pop($element['#parents']);
310
      form_set_value($element, $form_state['storage']['date_items'][$field_name][$langcode], $form_state);
311
    }
312
    return;
313
  }
314

    
315
  module_load_include('inc', 'date_repeat', 'date_repeat_form');
316
  $instance = field_widget_instance($element, $form_state);
317

    
318
  // Here 'values' returns an array of input values, which includes the original RRULE, as a string.
319
  // and 'input' returns an array of the form elements created by the repeating date widget, with
320
  // RRULE values as an array of the selected elements and their chosen values.
321
  $item = drupal_array_get_nested_value($form_state['values'], $element['#parents'], $input_exists);
322
  $input = drupal_array_get_nested_value($form_state['input'], $element['#parents'], $input_exists);
323

    
324
  $rrule_values = date_repeat_merge($input['rrule'], $element['rrule']);
325

    
326
  // If no repeat information was set, treat this as a normal, non-repeating value.
327
  if ($rrule_values['FREQ'] == 'NONE' || empty($input['show_repeat_settings'])) {
328
    $item['rrule'] = NULL;
329
    form_set_value($element, $item, $form_state);
330
    return;
331
  }
332

    
333
  // If no start date was set, clean up the form and return.
334
  if (empty($item['value'])) {
335
    form_set_value($element, NULL, $form_state);
336
    return;
337
  }
338

    
339
  // Require the UNTIL date for now.
340
  // The RRULE has already been created by this point, so go back
341
  // to the posted values to see if this was filled out.
342
  $error_field_base = implode('][', $element['#parents']);
343
  $error_field_until =  $error_field_base . '][rrule][until_child][datetime][';
344
  if (!empty($item['rrule']) && $rrule_values['range_of_repeat'] === 'UNTIL' && empty($rrule_values['UNTIL']['datetime'])) {
345
    switch ($instance['widget']['type']) {
346
      case 'date_text':
347
      case 'date_popup':
348
        form_set_error($error_field_until . 'date', t("Missing value in 'Range of repeat'. (UNTIL).", array(), array('context' => 'Date repeat')));
349
        break;
350
      case 'date_select':
351
        form_set_error($error_field_until . 'year', t("Missing value in 'Range of repeat': Year (UNTIL)", array(), array('context' => 'Date repeat')));
352
        form_set_error($error_field_until . 'month', t("Missing value in 'Range of repeat': Month (UNTIL)", array(), array('context' => 'Date repeat')));
353
        form_set_error($error_field_until . 'day', t("Missing value in 'Range of repeat': Day (UNTIL)", array(), array('context' => 'Date repeat')));
354
        break;
355
    }
356
  }
357

    
358
  $error_field_count = $error_field_base . '][rrule][count_child';
359
  if (!empty($item['rrule']) && $rrule_values['range_of_repeat'] === 'COUNT' && empty($rrule_values['COUNT'])) {
360
    form_set_error($error_field_count, t("Missing value in 'Range of repeat'. (COUNT).", array(), array('context' => 'Date repeat')));
361
  }
362

    
363
  if (form_get_errors()) {
364
    return;
365
  }
366

    
367
  // If the rule, the start date, or the end date have changed, re-calculate
368
  // the repeating dates, wipe out the previous values, and populate the
369
  // field with the new values.
370

    
371
  $rrule = $item['rrule'];
372
  if (!empty($rrule)) {
373

    
374
    // Avoid undefined index problems on dates that don't have all parts.
375
    $possible_items = array('value', 'value2', 'timezone', 'offset', 'offset2');
376
    foreach ($possible_items as $key) {
377
      if (empty($item[$key])) {
378
        $item[$key] = '';
379
      }
380
    }
381

    
382
    // We only collect a date for UNTIL, but we need it to be inclusive,
383
    // so force it to a full datetime element at the last possible second of the day.
384
    if (!empty($rrule_values['UNTIL'])) {
385
      $rrule_values['UNTIL']['datetime'] .= ' 23:59:59';
386
      $rrule_values['UNTIL']['granularity'] = serialize(drupal_map_assoc(array('year', 'month', 'day', 'hour', 'minute', 'second')));
387
      $rrule_values['UNTIL']['all_day'] = 0;
388
    }
389
    $value = date_repeat_build_dates($rrule, $rrule_values, $field, $item);
390
    // Unset the delta value of the parents.
391
    array_pop($element['#parents']);
392
    // Set the new delta values for this item to the array of values returned by the repeat rule.
393
    form_set_value($element, $value, $form_state);
394
  }
395
}
396

    
397
/**
398
 * Implements the form after_build().
399
 *
400
 * Remove the 'Add more' elements from a repeating date form.
401
 */
402
function date_repeat_after_build(&$element, &$form_state) {
403
  foreach ($form_state['storage']['repeat_fields'] as $field_name => $parents) {
404
    // Remove unnecessary items in the form added by the Add more handling.
405
    $value = drupal_array_get_nested_value($element, $parents);
406
    $langcode = $value['#language'];
407
    unset($value[$langcode]['add_more'], $value[$langcode]['#suffix'], $value[$langcode]['#prefix'], $value[$langcode][0]['_weight']);
408
    $value[$langcode]['#cardinality'] = 1;
409
    $value[$langcode]['#max_delta'] = 1;
410
    drupal_array_set_nested_value($element, $parents, $value);
411
  }
412
  return $element;
413
}
414

    
415
/**
416
 * Helper function to build repeating dates from a $node_field.
417
 *
418
 * Pass in either the RRULE or the $form_values array for the RRULE,
419
 * whichever is missing will be created when needed.
420
 */
421
function date_repeat_build_dates($rrule = NULL, $rrule_values = NULL, $field, $item) {
422

    
423
  include_once(DRUPAL_ROOT . '/' . drupal_get_path('module', 'date_api') . '/date_api_ical.inc');
424
  $field_name = $field['field_name'];
425

    
426
  if (empty($rrule)) {
427
    $rrule = date_api_ical_build_rrule($rrule_values);
428
  }
429
  elseif (empty($rrule_values)) {
430
    $rrule_values = date_ical_parse_rrule(NULL, $rrule);
431
  }
432

    
433
  // By the time we get here, the start and end dates have been
434
  // adjusted back to UTC, but we want localtime dates to do
435
  // things like '+1 Tuesday', so adjust back to localtime.
436
  $timezone = date_get_timezone($field['settings']['tz_handling'], $item['timezone']);
437
  $timezone_db = date_get_timezone_db($field['settings']['tz_handling']);
438
  $start = new DateObject($item['value'], $timezone_db, date_type_format($field['type']));
439
  $start->limitGranularity($field['settings']['granularity']);
440
  if ($timezone != $timezone_db) {
441
    date_timezone_set($start, timezone_open($timezone));
442
  }
443
  if (!empty($item['value2']) && $item['value2'] != $item['value']) {
444
    $end = new DateObject($item['value2'], date_get_timezone_db($field['settings']['tz_handling']), date_type_format($field['type']));
445
    $end->limitGranularity($field['settings']['granularity']);
446
    date_timezone_set($end, timezone_open($timezone));
447
  }
448
  else {
449
    $end = $start;
450
  }
451
  $duration = $start->difference($end);
452
  $start_datetime = date_format($start, DATE_FORMAT_DATETIME);
453

    
454
  if (!empty($rrule_values['UNTIL']['datetime'])) {
455
    $end = date_ical_date($rrule_values['UNTIL'], $timezone);
456
    $end_datetime = date_format($end, DATE_FORMAT_DATETIME);
457
  }
458
  elseif (!empty($rrule_values['COUNT'])) {
459
    $end_datetime = NULL;
460
  }
461
  else {
462
    // No UNTIL and no COUNT?
463
    return array();
464
  }
465

    
466
  // Split the RRULE into RRULE, EXDATE, and RDATE parts.
467
  $parts = date_repeat_split_rrule($rrule);
468
  $parsed_exceptions = (array) $parts[1];
469
  $exceptions = array();
470
  foreach ($parsed_exceptions as $exception) {
471
    $date = date_ical_date($exception, $timezone);
472
    $exceptions[] = date_format($date, 'Y-m-d');
473
  }
474

    
475
  $parsed_rdates = (array) $parts[2];
476
  $additions = array();
477
  foreach ($parsed_rdates as $rdate) {
478
    $date = date_ical_date($rdate, $timezone);
479
    $additions[] = date_format($date, 'Y-m-d');
480
  }
481

    
482
  $dates = date_repeat_calc($rrule, $start_datetime, $end_datetime, $exceptions, $timezone, $additions);
483
  $value = array();
484
  foreach ($dates as $delta => $date) {
485
    // date_repeat_calc always returns DATE_DATETIME dates, which is
486
    // not necessarily $field['type'] dates.
487
    // Convert returned dates back to db timezone before storing.
488
    $date_start = new DateObject($date, $timezone, DATE_FORMAT_DATETIME);
489
    $date_start->limitGranularity($field['settings']['granularity']);
490
    date_timezone_set($date_start, timezone_open($timezone_db));
491
    $date_end = clone($date_start);
492
    date_modify($date_end, '+' . $duration . ' seconds');
493
    $value[$delta] = array(
494
      'value' => date_format($date_start, date_type_format($field['type'])),
495
      'value2' => date_format($date_end, date_type_format($field['type'])),
496
      'offset' => date_offset_get($date_start),
497
      'offset2' => date_offset_get($date_end),
498
      'timezone' => $timezone,
499
      'rrule' => $rrule,
500
      );
501
  }
502
  return $value;
503
}
504

    
505
/**
506
 * Implements hook_date_combo_process_alter().
507
 *
508
 * This hook lets us make changes to the date_combo element.
509
 */
510
function date_repeat_field_date_combo_process_alter(&$element, &$form_state, $context) {
511

    
512
  $field = $context['field'];
513
  $instance = $context['instance'];
514
  $field_name = $element['#field_name'];
515
  $delta = $element['#delta'];
516

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

    
521
    $item = $element['#value'];
522
    $element['rrule'] = array(
523
      '#type' => 'date_repeat_rrule',
524
      '#theme_wrappers' => array('date_repeat_rrule'),
525
      '#default_value' => isset($item['rrule']) ? $item['rrule'] : '',
526
      '#date_timezone' => $element['#date_timezone'],
527
      '#date_format'      => date_limit_format(date_input_format($element, $field, $instance), $field['settings']['granularity']),
528
      '#date_text_parts'  => (array) $instance['widget']['settings']['text_parts'],
529
      '#date_increment'   => $instance['widget']['settings']['increment'],
530
      '#date_year_range'  => $instance['widget']['settings']['year_range'],
531
      '#date_label_position' => $instance['widget']['settings']['label_position'],
532
      '#date_repeat_widget' => str_replace('_repeat', '', $instance['widget']['type']),
533
      '#date_repeat_collapsed' => $instance['widget']['settings']['repeat_collapsed'],
534
      '#date_flexible' => 0,
535
      '#weight' => $instance['widget']['weight'] + .4,
536
    );
537
  }
538

    
539
}
540

    
541
/**
542
 * Implements hook_date_combo_pre_validate_alter().
543
 *
544
 * This hook lets us alter the element or the form_state before the rest
545
 * of the date_combo validation gets fired.
546
 */
547
function date_repeat_field_date_combo_pre_validate_alter(&$element, &$form_state, $context) {
548
  // Just a placeholder for now.
549
}
550

    
551
/**
552
 * Implements hook_field_info_alter().
553
 *
554
 * This Field API hook lets us add a new setting to the fields.
555
 */
556
function date_repeat_field_field_info_alter(&$info) {
557

    
558
  $info['date']['settings'] += array(
559
    'repeat' => 0,
560
  );
561
  $info['datetime']['settings'] += array(
562
    'repeat' => 0,
563
  );
564
  $info['datestamp']['settings'] += array(
565
    'repeat' => 0,
566
  );
567
}
568

    
569
/**
570
 * Implements hook_field_formatter_info_alter().
571
 *
572
 * This hook lets us add settings to the formatters.
573
 */
574
function date_repeat_field_field_formatter_info_alter(&$info) {
575

    
576
  if (isset($info['date_default'])) {
577
    $info['date_default']['settings'] += array(
578
      'show_repeat_rule' => 'show',
579
    );
580
  }
581
}
582

    
583
/**
584
 * Implements hook_field_widget_info_alter().
585
 *
586
 * This Field API hook lets us add a new setting to the widgets.
587
 */
588
function date_repeat_field_field_widget_info_alter(&$info) {
589

    
590
  $info['date_text']['settings'] += array(
591
    'repeat_collapsed' => 0,
592
  );
593
  $info['date_select']['settings'] += array(
594
    'repeat_collapsed' => 0,
595
  );
596
  if (module_exists('date_popup')) {
597
    $info['date_popup']['settings'] += array(
598
      'repeat_collapsed' => 0,
599
    );
600
  }
601
}
602

    
603
/**
604
 * Implements hook_date_field_settings_form_alter().
605
 *
606
 * This hook lets us alter the field settings form.
607
 */
608
function date_repeat_field_date_field_settings_form_alter(&$form, $context) {
609

    
610
  $field = $context['field'];
611
  $instance = $context['instance'];
612
  $has_data = $context['has_data'];
613

    
614
  $form['repeat'] = array(
615
    '#type' => 'select',
616
    '#title' => t('Repeating date'),
617
    '#default_value' => $field['settings']['repeat'],
618
    '#options' => array(0 => t('No'), 1 => t('Yes')),
619
    '#attributes' => array('class' => array('container-inline')),
620
    '#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."),
621
    '#disabled' => $has_data,
622
  );
623
}
624

    
625
/**
626
 * Implements hook_form_FORM_ID_alter() for field_ui_field_edit_form().
627
 */
628
function date_repeat_field_form_field_ui_field_edit_form_alter(&$form, &$form_state, $form_id) {
629
  $field = $form['#field'];
630
  $instance = $form['#instance'];
631

    
632
  if (!in_array($field['type'], array('date', 'datetime', 'datestamp'))) {
633
    return;
634
  }
635

    
636
  // If using repeating dates, override the Field module's handling of the multiple values option.
637
  if (date_is_repeat_field($field, $instance)) {
638
    $form['field']['cardinality']['#disabled'] = TRUE;
639
    $form['field']['cardinality']['#value'] = FIELD_CARDINALITY_UNLIMITED;
640
  }
641
  // Repeating dates need unlimited values, confirm that in element_validate.
642
  $form['field']['#element_validate'] = array('date_repeat_field_set_cardinality');
643
}
644

    
645
/**
646
 * Ensure the cardinality gets updated if the option to make a date repeating is checked.
647
 */
648
function date_repeat_field_set_cardinality($element, &$form_state) {
649
  if (!empty($form_state['values']['field']['settings']['repeat'])) {
650
    form_set_value($element['cardinality'], FIELD_CARDINALITY_UNLIMITED, $form_state);
651
  }
652
}
653

    
654
/**
655
 * Implements hook_date_field_instance_settings_form_alter().
656
 *
657
 * This hook lets us alter the field instance settings form.
658
 */
659
function date_repeat_field_date_field_instance_settings_form_alter(&$form, $context) {
660
  // Just a placeholder for now.
661
}
662

    
663
/**
664
 * Implements hook_date_field_widget_settings_form_alter().
665
 *
666
 * This hook lets us alter the field widget settings form.
667
 */
668
function date_repeat_field_date_field_widget_settings_form_alter(&$form, $context) {
669

    
670
  $field = $context['field'];
671
  $instance = $context['instance'];
672

    
673
  if (date_is_repeat_field($field, $instance)) {
674
    $form['repeat_collapsed'] = array(
675
      '#type' => 'value',
676
      '#default_value' => 1,
677
      '#options' => array(
678
        0 => t('Expanded', array(), array('context' => 'Date repeat')),
679
        1 => t('Collapsed', array(), array('context' => 'Date repeat'))
680
      ),
681
      '#title' => t('Repeat display', array(), array('context' => 'Date repeat')),
682
      '#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')),
683
      '#fieldset' => 'date_format',
684
      );
685
  }
686

    
687
}
688

    
689
/**
690
 * Implements hook_date_field_foramatter_settings_form_alter().
691
 *
692
 * This hook lets us alter the field formatter settings form.
693
 */
694
function date_repeat_field_date_field_formatter_settings_form_alter(&$form, &$form_state, $context) {
695

    
696
  $field = $context['field'];
697
  $instance = $context['instance'];
698
  $view_mode = $context['view_mode'];
699
  $display = $instance['display'][$view_mode];
700
  $formatter = $display['type'];
701
  $settings = $display['settings'];
702
  if ($formatter == 'date_default') {
703
    $form['show_repeat_rule'] = array(
704
      '#title' => t('Repeat rule:'),
705
      '#type' => 'select',
706
      '#options' => array(
707
        'show' => t('Show repeat rule'),
708
        'hide' => t('Hide repeat rule')),
709
      '#default_value' => $settings['show_repeat_rule'],
710
      '#access' => $field['settings']['repeat'],
711
      '#weight' => 5,
712
    );
713
  }
714
}
715

    
716
/**
717
 * Implements hook_date_field_foramatter_settings_summary_alter().
718
 *
719
 * This hook lets us alter the field formatter settings summary.
720
 */
721
function date_repeat_field_date_field_formatter_settings_summary_alter(&$summary, $context) {
722

    
723
  $field = $context['field'];
724
  $instance = $context['instance'];
725
  $view_mode = $context['view_mode'];
726
  $display = $instance['display'][$view_mode];
727
  $formatter = $display['type'];
728
  $settings = $display['settings'];
729
  if (isset($settings['show_repeat_rule']) && !empty($field['settings']['repeat'])) {
730
    if ($settings['show_repeat_rule'] == 'show') {
731
      $summary[] = t('Show repeat rule');
732
    }
733
    else {
734
      $summary[] = t('Hide repeat rule');
735
    }
736
  }
737
}