Projet

Général

Profil

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

root / drupal7 / sites / all / modules / date / date.field.inc @ 599a39cd

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
        'custom_date_format' => '',
19
        'fromto' => 'both',
20
        'multiple_number' => '',
21
        'multiple_from' => '',
22
        'multiple_to' => '',
23
        'show_remaining_days' => FALSE,
24
      ),
25
    ),
26
    'format_interval' => array(
27
      'label' => t('Time ago'),
28
      'field types' => array('date', 'datestamp', 'datetime'),
29
      'settings' => array(
30
        'interval' => 2,
31
        'interval_display' => 'time ago',
32
        'use_end_date' => FALSE,
33
      ),
34
    ),
35
    'date_plain' => array(
36
      'label' => t('Plain'),
37
      'field types' => array('date', 'datestamp', 'datetime'),
38
    ),
39
  );
40
  return $formatters;
41
}
42

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

    
55
    default:
56
      $form = date_default_formatter_settings_form($field, $instance, $view_mode, $form, $form_state);
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
  }
82
  $context = array(
83
    'field' => $field,
84
    'instance' => $instance,
85
    'view_mode' => $view_mode,
86
  );
87
  drupal_alter('date_field_formatter_settings_summary', $summary, $context);
88

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

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

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

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

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

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

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

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

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

    
216
  // Add the CSS stylesheet only if we have something to display.
217
  if (!empty($element)) {
218
    $element['#attached']['css'][] = drupal_get_path('module', 'date_api') . '/date.css';
219
  }
220

    
221
  return $element;
222
}
223

    
224
/**
225
 * Implements hook_field_is_empty().
226
 */
227
function date_field_is_empty($item, $field) {
228
  // Sometimes a $item is a date object. 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
        $timezone = date_get_timezone($field['settings']['tz_handling'], isset($item['timezone']) ? $item['timezone'] : '');
377
        $date1 = new DateObject($item['value'], $timezone, date_type_format($field['type']));
378
        if (count($process) === 1 || (empty($item['value2']) && $item['value2'] !== 0)) {
379
          $date2 = clone $date1;
380
        }
381
        else {
382
          $date2 = new DateObject($item['value2'], $timezone, date_type_format($field['type']));
383
        }
384
        $valid1 = $date1->validGranularity($field['settings']['granularity'], $flexible);
385
        $valid2 = $date2->validGranularity($field['settings']['granularity'], $flexible);
386

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

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

    
412
  if (empty($items)) {
413
    return;
414
  }
415

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

    
429
/**
430
 * Implements hook_field_insert().
431
 */
432
function date_field_insert($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_insert', $items, $context);
441
}
442

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

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

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

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

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

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

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

    
507
/**
508
 * Implements hook_content_migrate_field_alter().
509
 */
510
function date_content_migrate_field_alter(&$field_value, $instance_value) {
511
  // Use this to tweak the conversion of field settings from the D6 style to the
512
  // D7 style for specific situations not handled by basic conversion, as when
513
  // field types or settings are changed.
514
  //
515
  // $field_value['widget_type'] is available to see what widget type was
516
  // originally used.
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
function date_content_migrate_instance_alter(&$instance_value, $field_value) {
531
  // Use this to tweak the conversion of instance or widget settings from the D6
532
  // style to the D7 style for specific situations not handled by basic
533
  // conversion, as when formatter or widget names or settings are changed.
534
  switch ($instance_value['widget']['module']) {
535
    case 'date':
536
      // Some settings have been moved from field to instance.
537
      $instance_value['widget']['settings']['repeat_collapsed'] = $field_value['settings']['repeat_collapsed'];
538

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

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

    
563
      break;
564
  }
565
}
566

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