Projet

Général

Profil

Paste
Télécharger (20,2 ko) Statistiques
| Branche: | Révision:

root / drupal7 / sites / all / modules / date / date.field.inc @ ee46a8ed

1
<?php
2

    
3
/**
4
 * @file
5
 * Field hooks to implement a date field.
6
 */
7

    
8
/**
9
 * Implements hook_field_formatter_info().
10
 */
11
function date_field_formatter_info() {
12
  $formatters = array(
13
    'date_default' => array(
14
      'label' => t('Date and time'),
15
      'field types' => array('date', 'datestamp', 'datetime'),
16
      'settings' => array(
17
        'format_type' => 'long',
18
        'multiple_number' => '',
19
        'multiple_from' => '',
20
        'multiple_to' => '',
21
        'fromto' => 'both',
22
        'show_remaining_days' => FALSE,
23
      ),
24
    ),
25
    'format_interval' => array(
26
      'label' => t('Time ago'),
27
      'field types' => array('date', 'datestamp', 'datetime'),
28
      'settings' => array(
29
        'interval' => 2,
30
        'interval_display' => 'time ago',
31
        'use_end_date' => false,
32
      ),
33
    ),
34
    'date_plain' => array(
35
      'label' => t('Plain'),
36
      'field types' => array('date', 'datestamp', 'datetime'),
37
    ),
38
  );
39
  return $formatters;
40
}
41

    
42
/**
43
 * Implements hook_field_formatter_settings_form().
44
 */
45
function date_field_formatter_settings_form($field, $instance, $view_mode, $form, &$form_state) {
46
  $display = $instance['display'][$view_mode];
47
  $formatter = $display['type'];
48
  module_load_include('inc', 'date', 'date_admin');
49
  switch ($formatter) {
50
    case 'format_interval':
51
      $form = date_interval_formatter_settings_form($field, $instance, $view_mode, $form, $form_state);
52
      break;
53

    
54
    default:
55
      $form = date_default_formatter_settings_form($field, $instance, $view_mode, $form, $form_state);
56
      break;
57
  }
58
  $context = array(
59
    'field' => $field,
60
    'instance' => $instance,
61
    'view_mode' => $view_mode,
62
  );
63
  drupal_alter('date_field_formatter_settings_form', $form, $form_state, $context);
64
  return $form;
65
}
66

    
67
/**
68
 * Implements hook_field_formatter_settings_summary().
69
 */
70
function date_field_formatter_settings_summary($field, $instance, $view_mode) {
71
  $display = $instance['display'][$view_mode];
72
  $formatter = $display['type'];
73
  module_load_include('inc', 'date', 'date_admin');
74
  switch ($formatter) {
75
    case 'format_interval':
76
      $summary = date_interval_formatter_settings_summary($field, $instance, $view_mode);
77
      break;
78

    
79
    default:
80
      $summary = date_default_formatter_settings_summary($field, $instance, $view_mode);
81
      break;
82
  }
83
  $context = array(
84
    'field' => $field,
85
    'instance' => $instance,
86
    'view_mode' => $view_mode,
87
  );
88
  drupal_alter('date_field_formatter_settings_summary', $summary, $context);
89

    
90
  return implode('<br />', $summary);
91
}
92

    
93
/**
94
 * Implements hook_field_formatter_view().
95
 *
96
 * Useful values:
97
 *
98
 *   $entity->date_id
99
 *     If set, this will show only an individual date on a field with
100
 *     multiple dates. The value should be a string that contains
101
 *     the following values, separated with periods:
102
 *     - module name of the module adding the item
103
 *     - node nid
104
 *     - field name
105
 *     - delta value of the field to be displayed
106
 *     - other information the module's custom theme might need
107
 *
108
 *     Used by the calendar module and available for other uses.
109
 *     example: 'date:217:field_date:3:test'
110
 *
111
 *   $entity->date_repeat_show
112
 *     If true, tells the theme to show all the computed values
113
 *     of a repeating date. If not true or not set, only the
114
 *     start date and the repeat rule will be displayed.
115
 */
116
function date_field_formatter_view($entity_type, $entity, $field, $instance, $langcode, $items, $display) {
117
  $element = array();
118
  $settings = $display['settings'];
119
  $formatter = $display['type'];
120
  $variables = array(
121
    'entity' => $entity,
122
    'entity_type' => $entity_type,
123
    'field' => $field,
124
    'instance' => $instance,
125
    'langcode' => $langcode,
126
    'items' => $items,
127
    'display' => $display,
128
    'dates' => array(),
129
    'attributes' => array(),
130
    'rdf_mapping' => array(),
131
    'add_rdf' => module_exists('rdf'),
132
    'microdata' => array(),
133
    'add_microdata' => module_exists('microdata'),
134
  );
135

    
136
  // If the microdata module is enabled, the microdata mapping will have been
137
  // passed in via the entity.
138
  if ($variables['add_microdata'] && isset($entity->microdata[$field['field_name']])) {
139
    $variables['microdata'] = $entity->microdata[$field['field_name']];
140
  }
141

    
142
  // If there is an RDf mapping for this date field, pass it down to the theme.
143
  $rdf_mapping = array();
144
  if (!empty($entity->rdf_mapping) && function_exists('rdf_rdfa_attributes')) {
145
    if (!empty($entity->rdf_mapping[$field['field_name']])) {
146
      $variables['rdf_mapping'] = $rdf_mapping = $entity->rdf_mapping[$field['field_name']];
147
    }
148
  }
149

    
150
  // Give other modules a chance to prepare the entity before formatting it.
151
  drupal_alter('date_formatter_pre_view', $entity, $variables);
152

    
153
  // See if we are only supposed to display a selected
154
  // item from multiple value date fields.
155
  $selected_deltas = array();
156
  if (!empty($entity->date_id)) {
157
    foreach ((array) $entity->date_id as $key => $id) {
158
      list($module, $nid, $field_name, $selected_delta, $other) = explode('.', $id . '.');
159
      if ($field_name == $field['field_name']) {
160
        $selected_deltas[] = $selected_delta;
161
      }
162
    }
163
  }
164

    
165
  switch ($display['type']) {
166
    case 'date_plain':
167
      foreach ($items as $delta => $item) {
168
        if (!empty($entity->date_id) && !in_array($delta, $selected_deltas)) {
169
          continue;
170
        }
171
        else {
172
          if (empty($item['value2']) || $item['value'] == $item['value2']) {
173
            $element[$delta] = array('#markup' => $item['value']);
174
          }
175
          else {
176
            $element[$delta] = array(
177
              '#markup' => t('!start-date to !end-date', array(
178
                '!start-date' => $item['value'],
179
                '!end-date' => $item['value2']
180
              )));
181
          }
182
        }
183
      }
184
      break;
185

    
186
    case 'format_interval':
187
      foreach ($items as $delta => $item) {
188
        if (!empty($entity->date_id) && !in_array($delta, $selected_deltas)) {
189
          continue;
190
        }
191
        else {
192
          $variables['delta'] = $delta;
193
          $variables['item'] = $item;
194
          $variables['dates'] = date_formatter_process($formatter, $entity_type, $entity, $field, $instance, $langcode, $item, $display);
195
          $variables['attributes'] = !empty($rdf_mapping) ? rdf_rdfa_attributes($rdf_mapping, $item['value']) : array();
196
          $element[$delta] = array('#markup' => theme('date_display_interval', $variables));
197
        }
198
      }
199
      break;
200

    
201
    default:
202
      foreach ($items as $delta => $item) {
203
        if (!empty($entity->date_id) && !in_array($delta, $selected_deltas)) {
204
          continue;
205
        }
206
        else {
207
          $variables['delta'] = $delta;
208
          $variables['item'] = $item;
209
          $variables['dates'] = date_formatter_process($formatter, $entity_type, $entity, $field, $instance, $langcode, $item, $display);
210
          $variables['attributes'] = !empty($rdf_mapping) ? rdf_rdfa_attributes($rdf_mapping, $item['value']) : array();
211
          $variables['show_remaining_days'] = isset($display['settings']['show_remaining_days']) ? $display['settings']['show_remaining_days'] : FALSE;
212
          $output = theme('date_display_combination', $variables);
213
          if (!empty($output)) {
214
            $element[$delta] = array('#markup' => $output);
215
          }
216
        }
217
      }
218
      break;
219
  }
220
  return $element;
221
}
222

    
223
/**
224
 * Implements hook_field_is_empty().
225
 */
226
function date_field_is_empty($item, $field) {
227
  // Sometimes a $item is a date object.
228
  // Coming from repeating dates. Why??
229
  if (!is_array($item)) {
230
    return FALSE;
231
  }
232
  if (empty($item['value'])) {
233
    return TRUE;
234
  }
235
  elseif ($field['settings']['todate'] == 'required' && empty($item['value2'])) {
236
    return TRUE;
237
  }
238
  return FALSE;
239
}
240

    
241
/**
242
 * Implements hook_field_info().
243
 */
244
function date_field_info() {
245
  $granularity = array('year', 'month', 'day', 'hour', 'minute');
246
  $settings = array(
247
    'settings' => array(
248
      'todate' => '',
249
      'granularity' => drupal_map_assoc($granularity),
250
      'tz_handling' => 'site',
251
      'timezone_db' => 'UTC',
252
    ),
253
    'instance_settings' => array(
254
      'default_value' => 'now',
255
      'default_value_code' => '',
256
      'default_value2' => 'same',
257
      'default_value_code2' => '',
258
    ),
259
    // Integrate with the Entity Metadata module.
260
    'property_type' => 'date',
261
    'property_callbacks' => array('date_entity_metadata_property_info_alter'),
262
  );
263
  return array(
264
    'datetime' => array(
265
      'label' => t('Date'),
266
      'description' => t('Store a date in the database as a datetime field, recommended for complete dates and times that may need timezone conversion.'),
267
      'default_widget' => 'date_select',
268
      'default_formatter' => 'date_default',
269
      'default_token_formatter' => 'date_plain',
270
    ) + $settings,
271
    'date' => array(
272
      'label' => t('Date (ISO format)'),
273
      'description' => t('Store a date in the database as an ISO date, recommended for historical or partial dates.'),
274
      'default_widget' => 'date_select',
275
      'default_formatter' => 'date_default',
276
      'default_token_formatter' => 'date_plain',
277
    ) + $settings,
278
    'datestamp' => array(
279
      'label' => t('Date (Unix timestamp)'),
280
      'description' => t('Store a date in the database as a timestamp, deprecated format to support legacy data.'),
281
      'default_widget' => 'date_select',
282
      'default_formatter' => 'date_default',
283
      'default_token_formatter' => 'date_plain',
284
    ) + $settings,
285
  );
286
}
287

    
288
/**
289
 * Implements hook_field_widget_info().
290
 */
291
function date_field_widget_info() {
292
  $settings = array(
293
    'settings' => array(
294
      'input_format' => date_default_format('date_select'),
295
      'input_format_custom' => '',
296
      'increment' => 15,
297
      'text_parts' => array(),
298
      'year_range' => '-3:+3',
299
      'label_position' => 'above',
300
    ),
301
    'behaviors' => array(
302
      'multiple values' => FIELD_BEHAVIOR_DEFAULT,
303
      'default value' => FIELD_BEHAVIOR_NONE,
304
    ),
305
  );
306

    
307
  $info = array(
308
    'date_select' => array(
309
      'label' => t('Select list'),
310
      'field types' => array('date', 'datestamp', 'datetime'),
311
    ) + $settings,
312
    'date_text' => array(
313
      'label' => t('Text field'),
314
      'field types' => array('date', 'datestamp', 'datetime'),
315
    ) + $settings,
316
  );
317

    
318
  if (module_exists('date_popup')) {
319
    $info['date_popup'] = array(
320
      'label' => t('Pop-up calendar'),
321
      'field types' => array('date', 'datestamp', 'datetime'),
322
    ) + $settings;
323
  }
324

    
325
  // The date text widget should use an increment of 1.
326
  $info['date_text']['settings']['increment'] = 1;
327

    
328
  return $info;
329
}
330

    
331
/**
332
 * Implements hook_field_load().
333
 */
334
function date_field_load($entity_type, $entities, $field, $instances, $langcode, &$items, $age) {
335
  $timezone_db = date_get_timezone_db($field['settings']['tz_handling']);
336
  $db_format = date_type_format($field['type']);
337
  $process = date_process_values($field);
338
  foreach ($entities as $id => $entity) {
339
    foreach ($items[$id] as $delta => &$item) {
340
      // If the file does not exist, mark the entire item as empty.
341
      if (is_array($item)) {
342
        $timezone = isset($item['timezone']) ? $item['timezone'] : '';
343
        $item['timezone'] = date_get_timezone($field['settings']['tz_handling'], $timezone);
344
        $item['timezone_db'] = $timezone_db;
345
        $item['date_type'] = $field['type'];
346
        if (!empty($field['settings']['cache_enabled']) && ($delta < $field['settings']['cache_count'] || $field['settings']['cache_count'] == 0)) {
347
          foreach ($process as $processed) {
348
            if (!empty($item[$processed])) {
349
              $date = new DateObject($item[$processed], $item['timezone_db'], $db_format);
350
              $date->limitGranularity($field['settings']['granularity']);
351
              $item['db'][$processed] = $date;
352
            }
353
          }
354
          if (!empty($item['db']['value']) && empty($item['db']['value2'])) {
355
            $item['db']['value2'] = $item['db']['value'];
356
          }
357
        }
358
      }
359
    }
360
  }
361
}
362

    
363
/**
364
 * Implements hook_field_validate().
365
 */
366
function date_field_validate($entity_type, $entity, $field, $instance, $langcode, $items, &$errors) {
367
  $field_name = $field['field_name'];
368
  $flexible = 0;
369

    
370
  // Don't try to validate if there were any errors before this point
371
  // since the element won't have been munged back into a date.
372
  if (!form_get_errors()) {
373
    foreach ($items as $delta => $item) {
374
      if (is_array($item) && isset($item['value'])) {
375
        $process = date_process_values($field, $instance);
376
        $date1 = new DateObject($item['value'], $item['timezone'], date_type_format($field['type']));
377
        if (count($process) == 1 || (empty($item['value2']) && $item['value2'] !== 0)) {
378
          $date2 = clone($date1);
379
        }
380
        else {
381
          $date2 = new DateObject($item['value2'], $item['timezone'], date_type_format($field['type']));
382
        }
383
        $valid1 = $date1->validGranularity($field['settings']['granularity'], $flexible);
384
        $valid2 = $date2->validGranularity($field['settings']['granularity'], $flexible);
385

    
386
        foreach ($process as $processed) {
387
          if ($processed == 'value' && $field['settings']['todate'] && !$valid1 && $valid2) {
388
            $errors[$field['field_name']][$langcode][$delta][] = array(
389
              'error' => 'value',
390
              'message' => t("A 'Start date' date is required for field %field #%delta.", array('%delta' => $field['cardinality'] ? intval($delta + 1) : '', '%field' => $instance['label'])),
391
            );
392
          }
393
          if ($processed == 'value2' && $field['settings']['todate'] == 'required' && ($instance['required'] && $valid1 && !$valid2)) {
394
            $errors[$field['field_name']][$langcode][$delta][] = array(
395
              'error' => 'value2',
396
              'message' => t("An 'End date' is required for field %field #%delta.", array('%delta' => $field['cardinality'] ? intval($delta + 1) : '', '%field' => $instance['label'])),
397
            );
398
          }
399
        }
400
      }
401
    }
402
  }
403
}
404

    
405
/**
406
 * Implements hook_field_insert().
407
 */
408
function date_field_presave($entity_type, $entity, $field, $instance, $langcode, &$items) {
409
  $field_name = $field['field_name'];
410

    
411
  if (empty($items)) {
412
    return;
413
  }
414
  // Add some information needed to interpret token values.
415
  $values = $items;
416
  foreach ($values as $delta => $item) {
417
    $timezone = isset($item['timezone']) ? $item['timezone'] : '';
418
    if (is_array($item)) {
419
      $items[$delta]['timezone'] = date_get_timezone($field['settings']['tz_handling'], $timezone);
420
      $items[$delta]['timezone_db'] = date_get_timezone_db($field['settings']['tz_handling']);
421
      $items[$delta]['date_type'] = $field['type'];
422
    }
423
  }
424
  $entity->{$field['field_name']}[$langcode] = $items;
425
}
426

    
427
/**
428
 * Implements hook_field_insert().
429
 */
430
function date_field_insert($entity_type, $entity, $field, $instance, $langcode, &$items) {
431
  $context = array(
432
    'entity_type' => $entity_type,
433
    'entity' => $entity,
434
    'field' => $field,
435
    'instance' => $instance,
436
    'langcode' => $langcode,
437
  );
438
  drupal_alter('date_field_insert', $items, $context);
439
}
440

    
441
/**
442
 * Implements hook_field_update().
443
 */
444
function date_field_update($entity_type, $entity, $field, $instance, $langcode, &$items) {
445
  $context = array(
446
    'entity_type' => $entity_type,
447
    'entity' => $entity,
448
    'field' => $field,
449
    'instance' => $instance,
450
    'langcode' => $langcode,
451
  );
452
  drupal_alter('date_field_update', $items, $context);
453
}
454

    
455
/**
456
 * Implements hook_field_instance_settings_form().
457
 *
458
 * Wrapper functions for date administration, included only when processing
459
 * field settings.
460
 */
461
function date_field_instance_settings_form($field, $instance) {
462
  module_load_include('inc', 'date', 'date_admin');
463
  return _date_field_instance_settings_form($field, $instance);
464
}
465

    
466
/**
467
 * Form validation handler for _date_field_instance_settings_form().
468
 */
469
function date_field_instance_settings_form_validate(&$form, &$form_state) {
470
  module_load_include('inc', 'date', 'date_admin');
471
  return _date_field_instance_settings_form_validate($form, $form_state);
472
}
473

    
474
/**
475
 * Implements hook_field_widget_settings_form().
476
 */
477
function date_field_widget_settings_form($field, $instance) {
478
  module_load_include('inc', 'date', 'date_admin');
479
  return _date_field_widget_settings_form($field, $instance);
480
}
481

    
482
/**
483
 * Form validation handler for _date_field_widget_settings_form().
484
 */
485
function date_field_widget_settings_form_validate(&$form, &$form_state) {
486
  module_load_include('inc', 'date', 'date_admin');
487
  return _date_field_widget_settings_form_validate($form, $form_state);
488
}
489

    
490
/**
491
 * Implements hook_field_settings_form().
492
 */
493
function date_field_settings_form($field, $instance, $has_data) {
494
  module_load_include('inc', 'date', 'date_admin');
495
  return _date_field_settings_form($field, $instance, $has_data);
496
}
497

    
498
/**
499
 * Form validation handler for _date_field_settings_form().
500
 */
501
function date_field_settings_validate(&$form, &$form_state) {
502
  module_load_include('inc', 'date', 'date_admin');
503
  return _date_field_settings_validate($form, $form_state);
504
}
505

    
506
/**
507
 * Implements hook_content_migrate_field_alter().
508
 *
509
 * Use this to tweak the conversion of field settings from the D6 style to the
510
 * D7 style for specific situations not handled by basic conversion, as when
511
 * field types or settings are changed.
512
 *
513
 * $field_value['widget_type'] is available to see what widget type was
514
 * originally used.
515
 */
516
function date_content_migrate_field_alter(&$field_value, $instance_value) {
517
  switch ($field_value['module']) {
518
    case 'date':
519
      // Those settings do not exist anymore, or have been moved to the instance
520
      // level.
521
      unset($field_value['settings']['default_format']);
522
      unset($field_value['settings']['repeat_collapsed']);
523
      break;
524
  }
525
}
526

    
527
/**
528
 * Implements hook_content_migrate_instance_alter().
529
 *
530
 * Use this to tweak the conversion of instance or widget settings from the D6
531
 * style to the D7 style for specific situations not handled by basic
532
 * conversion, as when formatter or widget names or settings are changed.
533
 */
534
function date_content_migrate_instance_alter(&$instance_value, $field_value) {
535
  switch ($instance_value['widget']['module']) {
536
    case 'date':
537

    
538
      // Some settings have been moved from field to instance.
539
      $instance_value['widget']['settings']['repeat_collapsed'] = $field_value['settings']['repeat_collapsed'];
540

    
541
      // Some settings were moved from widget settings to instance settings.
542
      $instance_value['settings']['default_value'] = $instance_value['default_value'];
543
      unset($instance_value['default_value']);
544
      $instance_value['settings']['default_value_code'] = $instance_value['widget']['settings']['default_value_code'];
545
      unset($instance_value['widget']['settings']['default_value_code']);
546
      $instance_value['settings']['default_value2'] = $instance_value['widget']['settings']['default_value2'];
547
      unset($instance_value['widget']['settings']['default_value2']);
548
      $instance_value['settings']['default_value_code2'] = $instance_value['widget']['settings']['default_value_code2'];
549
      unset($instance_value['widget']['settings']['default_value_code2']);
550

    
551
      // We need to retrieve formatter settings from the variables and store
552
      // them in the instance.
553
      foreach ($instance_value['display'] as $context => &$display) {
554
        if ($display['type'] != 'format_interval') {
555
          $old_settings = date_old_formatter_get_settings($instance_value['field_name'], $instance_value['bundle'], $context);
556
          $display['settings'] = array_merge($display['settings'], $old_settings);
557
          // If the formatter was the 'default', then use the old
558
          // 'default_format' field property.
559
          $format = ($display['type'] == 'default') ? $field_value['settings']['default_format'] : $display['type'];
560
          $display['settings']['format_type'] = $format;
561
          $display['type'] = 'date_default';
562
        }
563
      }
564

    
565
      break;
566
  }
567
}
568

    
569
/**
570
 * Constructs an array of old formatter settings.
571
 */
572
function date_old_formatter_get_settings($field_name, $type_name, $context) {
573
  $options = array();
574
  $value = 'date:' . $type_name . ':' . $context . ':' . $field_name;
575
  $options['show_repeat_rule'] = variable_get($value . '_show_repeat_rule', 'show');
576
  $options['multiple_number'] = variable_get($value . '_multiple_number', '');
577
  $options['multiple_from'] = variable_get($value . '_multiple_from', '');
578
  $options['multiple_to'] = variable_get($value . '_multiple_to', '');
579
  $options['fromto'] = variable_get($value . '_fromto', 'both');
580
  return $options;
581
}