Projet

Général

Profil

Paste
Télécharger (19,1 ko) Statistiques
| Branche: | Révision:

root / drupal7 / sites / all / modules / date / date.field.inc @ 87dbc3bf

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
      ),
23
    ),
24
    'format_interval' => array(
25
      'label' => t('Time ago'),
26
      'field types' => array('date', 'datestamp', 'datetime'),
27
      'settings' => array(
28
        'interval' => 2,
29
        'interval_display' => 'time ago',
30
      ),
31
    ),
32
    'date_plain' => array(
33
      'label' => t('Plain'),
34
      'field types' => array('date', 'datestamp', 'datetime'),
35
    ),
36
  );
37
  return $formatters;
38
}
39

    
40
/**
41
 * Implements hook_field_formatter_settings_form().
42
 */
43
function date_field_formatter_settings_form($field, $instance, $view_mode, $form, &$form_state) {
44
  $display = $instance['display'][$view_mode];
45
  $formatter = $display['type'];
46
  module_load_include('inc', 'date', 'date_admin');
47
  switch ($formatter) {
48
    case 'format_interval':
49
      $form = date_interval_formatter_settings_form($field, $instance, $view_mode, $form, $form_state);
50
      break;
51
    default:
52
      $form = date_default_formatter_settings_form($field, $instance, $view_mode, $form, $form_state);
53
      break;
54
  }
55
  $context = array(
56
    'field' => $field,
57
    'instance' => $instance,
58
    'view_mode' => $view_mode,
59
  );
60
  drupal_alter('date_field_formatter_settings_form', $form, $form_state, $context);
61
  return $form;
62
}
63

    
64
/**
65
 * Implements hook_field_formatter_settings_summary().
66
 */
67
function date_field_formatter_settings_summary($field, $instance, $view_mode) {
68
  $display = $instance['display'][$view_mode];
69
  $formatter = $display['type'];
70
  module_load_include('inc', 'date', 'date_admin');
71
  switch ($formatter) {
72
    case 'format_interval':
73
      $summary = date_interval_formatter_settings_summary($field, $instance, $view_mode);
74
      break;
75
    default:
76
      $summary = date_default_formatter_settings_summary($field, $instance, $view_mode);
77
      break;
78
  }
79
  $context = array(
80
    'field' => $field,
81
    'instance' => $instance,
82
    'view_mode' => $view_mode,
83
  );
84
  drupal_alter('date_field_formatter_settings_summary', $summary, $context);
85

    
86
  return implode('<br />', $summary);
87
}
88

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

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

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

    
146
  // Give other modules a chance to prepare the entity before formatting it.
147
  drupal_alter('date_formatter_pre_view', $entity, $variables);
148

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

    
161
  switch ($display['type']) {
162
    case 'date_plain':
163
      foreach ($items as $delta => $item) {
164
        if (!empty($entity->date_id) && !in_array($delta, $selected_deltas)) {
165
          continue;
166
        }
167
        else {
168
          if (empty($item['value2']) || $item['value'] == $item['value2']) {
169
            $element[$delta] = array('#markup' => $item['value']);
170
          }
171
          else {
172
            $element[$delta] = array('#markup' => t('!start-date to !end-date', array('!start-date' => $item['value'], '!end-date' => $item['value2'])));
173
          }
174
        }
175
      }
176
      break;
177
    case 'format_interval':
178
      foreach ($items as $delta => $item) {
179
        if (!empty($entity->date_id) && !in_array($delta, $selected_deltas)) {
180
          continue;
181
        }
182
        else {
183
          $variables['delta'] = $delta;
184
          $variables['item'] = $item;
185
          $variables['dates'] = date_formatter_process($formatter, $entity_type, $entity, $field, $instance, $langcode, $item, $display);
186
          $variables['attributes'] = !empty($rdf_mapping) ? rdf_rdfa_attributes($rdf_mapping, $item['value']) : array();
187
          $element[$delta] = array('#markup' => theme('date_display_interval', $variables));
188
        }
189
      }
190
      break;
191
    default:
192
      foreach ($items as $delta => $item) {
193
        if (!empty($entity->date_id) && !in_array($delta, $selected_deltas)) {
194
          continue;
195
        }
196
        else {
197
          $variables['delta'] = $delta;
198
          $variables['item'] = $item;
199
          $variables['dates'] = date_formatter_process($formatter, $entity_type, $entity, $field, $instance, $langcode, $item, $display);
200
          $variables['attributes'] = !empty($rdf_mapping) ? rdf_rdfa_attributes($rdf_mapping, $item['value']) : array();
201
          $output = theme('date_display_combination', $variables);
202
          if (!empty($output)) {
203
            $element[$delta] = array('#markup' => $output);
204
          }
205
        }
206
      }
207
      break;
208
  }
209
  return $element;
210
}
211

    
212
/**
213
 * Implements hook_field_is_empty().
214
 */
215
function date_field_is_empty($item, $field) {
216
  // Sometimes a $item is a date object.
217
  // Coming from repeating dates. Why??
218
  if (!is_array($item)) {
219
    return FALSE;
220
  }
221
  if (empty($item['value'])) {
222
    return TRUE;
223
  }
224
  elseif ($field['settings']['todate'] == 'required' && empty($item['value2'])) {
225
    return TRUE;
226
  }
227
  return FALSE;
228
}
229

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

    
276
/**
277
 * Implements hook_field_widget_info().
278
 */
279
function date_field_widget_info() {
280
  $settings = array(
281
    'settings' => array(
282
      'input_format' => date_default_format('date_select'),
283
      'input_format_custom' => '',
284
      'increment' => 15,
285
      'text_parts' => array(),
286
      'year_range' => '-3:+3',
287
      'label_position' => 'above',
288
    ),
289
    'behaviors' => array(
290
      'multiple values' => FIELD_BEHAVIOR_DEFAULT,
291
      'default value' => FIELD_BEHAVIOR_NONE,
292
    ),
293
  );
294

    
295
  $info = array(
296
    'date_select' => array(
297
      'label' =>  t('Select list'),
298
      'field types' => array('date', 'datestamp', 'datetime'),
299
    ) + $settings,
300
    'date_text' => array(
301
      'label' =>  t('Text field'),
302
      'field types' => array('date', 'datestamp', 'datetime'),
303
     ) + $settings,
304
  );
305

    
306
  if (module_exists('date_popup')) {
307
    $info['date_popup'] = array(
308
      'label' =>  t('Pop-up calendar'),
309
      'field types' => array('date', 'datestamp', 'datetime'),
310
    ) + $settings;
311
  }
312

    
313
  // The date text widget should use an increment of 1.
314
  $info['date_text']['increment'] = 1;
315

    
316
  return $info;
317
}
318

    
319
/**
320
 * Implements hook_field_load().
321
 */
322
function date_field_load($entity_type, $entities, $field, $instances, $langcode, &$items, $age) {
323
  $timezone_db = date_get_timezone_db($field['settings']['tz_handling']);
324
  $db_format = date_type_format($field['type']);
325
  $process = date_process_values($field);
326
  foreach ($entities as $id => $entity) {
327
    foreach ($items[$id] as $delta => &$item) {
328
      // If the file does not exist, mark the entire item as empty.
329
      if (is_array($item)) {
330
        $timezone = isset($item['timezone']) ? $item['timezone'] : '';
331
        $item['timezone'] = date_get_timezone($field['settings']['tz_handling'], $timezone);
332
        $item['timezone_db'] = $timezone_db;
333
        $item['date_type'] = $field['type'];
334
        if (!empty($field['settings']['cache_enabled']) && ($delta < $field['settings']['cache_count'] || $field['settings']['cache_count'] == 0)) {
335
          foreach ($process as $processed) {
336
            if (!empty($item[$processed])) {
337
              $date = new DateObject($item[$processed], $item['timezone_db'], $db_format);
338
              $date->limitGranularity($field['settings']['granularity']);
339
              $item['db'][$processed] = $date;
340
            }
341
          }
342
          if (!empty($item['db']['value']) && empty($item['db']['value2'])) {
343
            $item['db']['value2'] = $item['db']['value'];
344
          }
345
        }
346
      }
347
    }
348
  }
349
}
350

    
351
/**
352
 * Implements hook_field_validate().
353
 */
354
function date_field_validate($entity_type, $entity, $field, $instance, $langcode, $items, &$errors) {
355
  $field_name = $field['field_name'];
356
  $flexible = 0;
357

    
358
  // Don't try to validate if there were any errors before this point
359
  // since the element won't have been munged back into a date.
360
  if (!form_get_errors()) {
361
    foreach ($items as $delta => $item) {
362
      if (is_array($item) && isset($item['value'])) {
363
        $process = date_process_values($field, $instance);
364
        $date1 = new DateObject($item['value'], $item['timezone'], date_type_format($field['type']));
365
        if (count($process) == 1 || (empty($item['value2']) && $item['value2'] !== 0)) {
366
          $date2 = clone($date1);
367
        }
368
        else {
369
          $date2 = new DateObject($item['value2'], $item['timezone'], date_type_format($field['type']));
370
        }
371
        $valid1 = $date1->validGranularity($field['settings']['granularity'], $flexible);
372
        $valid2 = $date2->validGranularity($field['settings']['granularity'], $flexible);
373

    
374
        foreach ($process as $processed) {
375
          if ($processed == 'value' && $field['settings']['todate'] && !$valid1 && $valid2) {
376
            $errors[$field['field_name']][$langcode][$delta][] = array(
377
              'error' => 'value',
378
              'message' => t("A 'Start date' date is required for field %field #%delta.", array('%delta' => $field['cardinality'] ? intval($delta + 1) : '', '%field' => $instance['label'])),
379
            );
380
          }
381
          if ($processed == 'value2' && $field['settings']['todate'] == 'required' && ($instance['required'] && $valid1 && !$valid2)) {
382
            $errors[$field['field_name']][$langcode][$delta][] = array(
383
              'error' => 'value2',
384
              'message' => t("An 'End date' is required for field %field #%delta.", array('%delta' => $field['cardinality'] ? intval($delta + 1) : '', '%field' => $instance['label'])),
385
            );
386
          }
387
        }
388
      }
389
    }
390
  }
391
}
392

    
393
/**
394
 * Implements hook_field_insert().
395
 */
396
function date_field_presave($entity_type, $entity, $field, $instance, $langcode, &$items) {
397
  $field_name = $field['field_name'];
398

    
399
  if (empty($items)) {
400
    return;
401
  }
402
  // Add some information needed to interpret token values.
403
  $values = $items;
404
  foreach ($values as $delta => $item) {
405
    $timezone = isset($item['timezone']) ? $item['timezone'] : '';
406
    if (is_array($item)) {
407
      $items[$delta]['timezone'] = date_get_timezone($field['settings']['tz_handling'], $timezone);
408
      $items[$delta]['timezone_db'] = date_get_timezone_db($field['settings']['tz_handling']);
409
      $items[$delta]['date_type'] = $field['type'];
410
    }
411
  }
412
  $entity->{$field['field_name']}[$langcode] = $items;
413
}
414

    
415
/**
416
 * Implements hook_field_insert().
417
 */
418
function date_field_insert($entity_type, $entity, $field, $instance, $langcode, &$items) {
419
  $context = array(
420
    'entity_type' => $entity_type,
421
    'entity' => $entity,
422
    'field' => $field,
423
    'instance' => $instance,
424
    'langcode' => $langcode,
425
  );
426
  drupal_alter('date_field_insert', $items, $context);
427
}
428

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

    
443
/**
444
 * Implements hook_field_instance_settings_form().
445
 *
446
 * Wrapper functions for date administration, included only when processing
447
 * field settings.
448
 */
449
function date_field_instance_settings_form($field, $instance) {
450
  module_load_include('inc', 'date', 'date_admin');
451
  return _date_field_instance_settings_form($field, $instance);
452
}
453

    
454
/**
455
 * Implements hook_field_widget_settings_form().
456
 */
457
function date_field_widget_settings_form($field, $instance) {
458
  module_load_include('inc', 'date', 'date_admin');
459
  return _date_field_widget_settings_form($field, $instance);
460
}
461

    
462
/**
463
 * Implements hook_field_settings_form().
464
 */
465
function date_field_settings_form($field, $instance, $has_data) {
466
  module_load_include('inc', 'date', 'date_admin');
467
  return _date_field_settings_form($field, $instance, $has_data);
468
}
469

    
470
/**
471
 * Implements hook_content_migrate_field_alter().
472
 *
473
 * Use this to tweak the conversion of field settings from the D6 style to the
474
 * D7 style for specific situations not handled by basic conversion, as when
475
 * field types or settings are changed.
476
 *
477
 * $field_value['widget_type'] is available to see what widget type was
478
 * originally used.
479
 */
480
function date_content_migrate_field_alter(&$field_value, $instance_value) {
481
  switch ($field_value['module']) {
482
    case 'date':
483
      // Those settings do not exist anymore, or have been moved to the instance
484
      // level.
485
      unset($field_value['settings']['default_format']);
486
      unset($field_value['settings']['repeat_collapsed']);
487
      break;
488
  }
489
}
490

    
491
/**
492
 * Implements hook_content_migrate_instance_alter().
493
 *
494
 * Use this to tweak the conversion of instance or widget settings from the D6
495
 * style to the D7 style for specific situations not handled by basic
496
 * conversion, as when formatter or widget names or settings are changed.
497
 */
498
function date_content_migrate_instance_alter(&$instance_value, $field_value) {
499
  switch ($instance_value['widget']['module']) {
500
    case 'date':
501

    
502
      // Some settings have been moved from field to instance.
503
      $instance_value['widget']['settings']['repeat_collapsed'] = $field_value['settings']['repeat_collapsed'];
504

    
505
      // Some settings were moved from widget settings to instance settings.
506
      $instance_value['settings']['default_value'] = $instance_value['default_value'];
507
      unset($instance_value['default_value']);
508
      $instance_value['settings']['default_value_code'] = $instance_value['widget']['settings']['default_value_code'];
509
      unset($instance_value['widget']['settings']['default_value_code']);
510
      $instance_value['settings']['default_value2'] = $instance_value['widget']['settings']['default_value2'];
511
      unset($instance_value['widget']['settings']['default_value2']);
512
      $instance_value['settings']['default_value_code2'] = $instance_value['widget']['settings']['default_value_code2'];
513
      unset($instance_value['widget']['settings']['default_value_code2']);
514

    
515
      // We need to retrieve formatter settings from the variables and store
516
      // them in the instance.
517
      foreach ($instance_value['display'] as $context => &$display) {
518
        if ($display['type'] != 'format_interval') {
519
          $old_settings = date_old_formatter_get_settings($instance_value['field_name'], $instance_value['bundle'], $context);
520
          $display['settings'] = array_merge($display['settings'], $old_settings);
521
          // If the formatter was the 'default', then use the old
522
          // 'default_format' field property.
523
          $format = ($display['type'] == 'default') ? $field_value['settings']['default_format'] : $display['type'];
524
          $display['settings']['format_type'] = $format;
525
          $display['type'] = 'date_default';
526
        }
527
      }
528

    
529
      break;
530
  }
531
}
532

    
533
/**
534
 * Constructs an array of old formatter settings.
535
 */
536
function date_old_formatter_get_settings($field_name, $type_name, $context) {
537
  $options = array();
538
  $value = 'date:' . $type_name . ':' . $context . ':' . $field_name;
539
  $options['show_repeat_rule'] = variable_get($value . '_show_repeat_rule', 'show');
540
  $options['multiple_number'] = variable_get($value . '_multiple_number', '');
541
  $options['multiple_from'] = variable_get($value . '_multiple_from', '');
542
  $options['multiple_to'] = variable_get($value . '_multiple_to', '');
543
  $options['fromto'] = variable_get($value . '_fromto', 'both');
544
  return $options;
545
}