-
Notifications
You must be signed in to change notification settings - Fork 3
/
partial_date.module
1813 lines (1648 loc) · 62.1 KB
/
partial_date.module
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* @file
* Defines a date element that allows for any combination of date granularity
* settings.
*
* Some of the core time handling code was inspired by the zend framework's
* Zend_Date class:
*
* @see
* http://framework.zend.com/code/filedetails.php?repname=Zend+Framework&path=%2Ftrunk%2Flibrary%2FZend%2FDate%2FDateObject.php&peg=22321
*/
/**
* TODO, account for that fact that there is no year 0 in the Gregorian calendar
* AD 1 = year 1, 1 BC = year 0, 2 BC = year −1,
*/
/**
* Implements hook_menu().
*/
function partial_date_menu() {
$counter = 0;
foreach (partial_date_format_types() as $type => $label) {
if (!$counter) {
$items['admin/config/regional/date-time/partial-date-formats'] = array(
'title' => t('Partial date formats'),
'page callback' => 'drupal_get_form',
'page arguments' => array('partial_date_format_settings_form', $type),
'access arguments' => array('administer site configuration'),
'type' => MENU_LOCAL_TASK,
'file' => 'partial_date.pages.inc',
);
$items['admin/config/regional/date-time/partial-date-formats/' . $type] = array(
'title' => $label,
'type' => MENU_DEFAULT_LOCAL_TASK,
'weight' => $counter++,
);
}
else {
$items['admin/config/regional/date-time/partial-date-formats/' . $type] = array(
'title' => $label,
'page callback' => 'drupal_get_form',
'page arguments' => array('partial_date_format_settings_form', $type),
'access arguments' => array('administer site configuration'),
'type' => $counter ? MENU_LOCAL_TASK : MENU_DEFAULT_LOCAL_TASK,
'file' => 'partial_date.pages.inc',
'weight' => $counter++,
);
}
}
return $items;
}
################################################################################
# #
# Field API Hooks & Helpers: Fields #
# #
# -------------------------------------------------------------------------- #
# #
# Implements: #
# * hook_field_info() #
# * hook_field_settings_form() #
# * hook_field_instance_settings_form() #
# * hook_field_load() #
# * hook_field_validate() #
# * hook_field_is_empty() #
# * hook_field_presave() #
# #
# Helpers: #
# * partial_date_field_estimates_default_settings() #
# #
# Provides the default lists for some of the date range lists. #
# #
# * partial_date_field_estimates_settings_form() #
# #
# Shared field and instance FAPI elements for for date range lists. #
# #
# * partial_date_field_estimates_validate_parse_options() #
# #
# Shared field and instance setting for for date component range lists. #
# #
# * partial_date_field_estimates() #
# #
# Helper function to load the estimate options from the field #
# #
# * partial_date_field_populate_components() #
# #
# Helper for hook_field_presave() to populate any missing values prior to #
# generating the float date value estimates. (The fake timestamp columns). #
# #
# * partial_date_field_presave_generate_storage_date() #
# #
# Helper for hook_field_presave() to ensure that all of the columns are #
# set in the correct position and names for the storage engine. #
# #
# * partial_date_field_validate_year() #
# #
# Helper for hook_field_validate() to test that the year in within range. #
# #
################################################################################
/**
* Implements hook_field_info().
*/
function partial_date_field_info() {
module_load_include('admin.inc', 'partial_date');
return _partial_date_field_info();
}
/**
* Implements hook_field_settings_form().
*/
function partial_date_field_settings_form($field, $instance, $has_data) {
module_load_include('admin.inc', 'partial_date');
// Badly name, includes minimal components too.
return partial_date_field_estimates_settings_form($field['settings'], $field, $instance, $has_data);
}
/**
* Implements hook_field_load().
*/
function partial_date_field_load($entity_type, $entities, $field, $instances, $langcode, &$items, $age) {
$has_range = strpos($field['type'], '_range');
$estimates = partial_date_field_estimates($field);
foreach ($entities as $id => $entity) {
foreach ($items[$id] as $delta => &$item) {
$settings = $instances[$id]['widget']['settings'];
// Generate a cleaner array based storage of the values.
$item['data'] = empty($item['data']) ? array() : unserialize($item['data']);
$item['from'] = array();
if ($has_range) {
$item['to'] = array();
}
$item['check_approximate'] = empty($item['data']['check_approximate']) ? 0 : 1;
foreach (partial_date_components() as $key => $title) {
$item['from'][$key] = $item[$key];
// Clear auto-populated estimate values.
if (!empty($item['data'][$key . '_estimate_from_used'])) {
$item['from'][$key] = '';
}
unset($item[$key]);
if ($key != 'timezone') {
$item['from'][$key . '_estimate'] = isset($item['data'][$key . '_estimate']) ? $item['data'][$key . '_estimate'] : '';
_partial_date_expand_estimate($key, $item['from'], $estimates);
}
if ($has_range) {
$item['to'][$key] = $item[$key . '_to'];
unset($item[$key . '_to']);
// Clear auto-populated estimate values.
if (!empty($item['data'][$key . '_estimate_to_used'])) {
$item['to'][$key] = '';
}
if ($key != 'timezone') {
$item['to'][$key . '_estimate'] = isset($item['data'][$key . '_to_estimate']) ? $item['data'][$key . '_to_estimate'] : '';
_partial_date_expand_estimate($key, $item['to'], $estimates, FALSE);
}
}
}
}
}
}
function _partial_date_expand_estimate($key, &$item, $estimates, $is_start = TRUE) {
$item[$key . '_estimate_label'] = '';
$item[$key . '_estimate_value'] = NULL;
$value = $item[$key . '_estimate'];
if (!empty($value)) {
if (!empty($estimates[$key][$value])) {
$item[$key . '_estimate_label'] = $estimates[$key][$value];
}
list($start, $end) = explode('|', $value);
$item[$key . '_estimate_value'] = $is_start ? $start : $end;
}
}
/**
* Helper function to load the estimate options from the field or instance
* settings.
*/
function partial_date_field_estimates($field) {
if (!empty($field['settings']['estimates'])) {
return $field['settings']['estimates'];
}
return FALSE;
}
/**
* Implements hook_field_presave().
*/
function partial_date_field_presave($entity_type, $entity, $field, $instance, $langcode, &$items) {
module_load_include('admin.inc', 'partial_date');
_partial_date_field_presave($entity_type, $entity, $field, $instance, $langcode, $items);
}
/**
* Implements hook_field_validate().
*
* Possible error codes:
* - 'xxxx': The partial_date year is not valid
*
* @see partial_date_field_widget_error().
*/
function partial_date_field_validate($obj_type, $object, $field, $instance, $langcode, $items, &$errors) {
module_load_include('admin.inc', 'partial_date');
_partial_date_field_validate($obj_type, $object, $field, $instance, $langcode, $items, $errors);
}
/**
* Implements hook_field_is_empty().
*/
function partial_date_field_is_empty($item, $field) {
if ((isset($item['_remove']) && $item['_remove']) || !is_array($item)) {
return TRUE;
}
foreach (array('from', 'to') as $base) {
if (empty($item[$base])) {
continue;
}
foreach (partial_date_components() as $key => $label) {
if ($key == 'timezone') {
continue;
}
if (isset($item[$base][$key]) && strlen($item[$base][$key])) {
return FALSE;
}
if (isset($item[$base][$key . '_estimate']) && strlen($item[$base][$key . '_estimate'])) {
return FALSE;
}
}
}
return !((isset($item['txt_short']) && strlen($item['txt_short'])) ||
(isset($item['txt_long']) && strlen($item['txt_long'])));
}
################################################################################
# --------------------------------- #
# Field API Hooks & Helpers: Widget #
# --------------------------------- #
# #
# Implements: #
# * hook_field_widget_info() #
# * hook_field_widget_settings_form() #
# * hook_field_widget_form() #
# * hook_field_widget_error() #
# #
# Helpers: #
# * partial_date_field_widget_reduce_date_components() #
# This reduces all possible widget components into a singular array of #
# components. Returns FALSE if empty. #
# #
################################################################################
/**
* Implements hook_field_widget_info().
*/
function partial_date_field_widget_info() {
return array(
'partial_date' => array(
'label' => t('Partial date'),
'field types' => array('partial_date', 'partial_date_range'),
'settings' => array(
'tz_handling' => 'none',
'theme_overrides' => array(
'check_approximate' => 0,
'txt_short' => 0,
'txt_long' => 0,
'range_inline' => 0,
),
'granularity' => array(
'from' => drupal_map_assoc(array_keys(partial_date_components())),
'to' => drupal_map_assoc(array_keys(partial_date_components())),
),
'estimates' => array(
'from' => array_combine(array_keys(partial_date_components(array('timezone'))), array_fill(0, 6, '')),
'to' => array_combine(array_keys(partial_date_components(array('timezone'))), array_fill(0, 6, '')),
),
'increments' => array(
'second' => 1,
'minute' => 1,
),
'hide_remove' > 0,
// @todo: i18n support here.
'help_txt' => array(),
),
),
);
}
/**
* Implements hook_field_widget_settings_form().
*/
function partial_date_field_widget_settings_form($field, $instance) {
module_load_include('admin.inc', 'partial_date');
return _partial_date_field_widget_settings_form($field, $instance);
}
/**
* Implements hook_field_widget_form().
*/
function partial_date_field_widget_form(&$form, &$form_state, $field, $instance, $langcode, $items, $delta, $base) {
module_load_include('admin.inc', 'partial_date');
return _partial_date_field_widget_form($form, $form_state, $field, $instance, $langcode, $items, $delta, $base);
}
/**
* Implements hook_field_widget_error().
*
* @see partial_date_field_validate().
*/
function partial_date_field_widget_error($element, $error, $form, &$form_state) {
switch ($error['error']) {
case 'partial_date_incomplete_from':
case 'partial_date_incomplete_to':
$base_key = strpos($error['error'], 'from') ? 'from' : 'to';
if (isset($error['partial_date_component']) && isset($element[$base_key][$error['partial_date_component']])) {
form_error($element[$base_key][$error['partial_date_component']], $error['message']);
}
else {
form_error($element[$base_key], $error['message']);
}
break;
case 'partial_date_incomplete_txt_short':
case 'partial_date_incomplete_txt_long':
$base_key = strpos($error['error'], 'from') ? 'from' : 'to';
form_error($element['year_to'], $error['message']);
break;
default:
form_error($element['from'], $error['message']);
break;
}
}
/**
* Helper function to assign the correct components into an array that the
* formatters can use.
*/
function partial_date_field_widget_reduce_date_components($item, $is_start = TRUE, $is_approx = FALSE) {
if (empty($item)) {
return FALSE;
}
$components = array();
foreach (partial_date_components() as $key => $title) {
if (!empty($item[$key . '_estimate'])) {
list($start, $end) = explode('|', $item[$key . '_estimate']);
$components[$key] = $is_start ? $start : $end;
$components[$key . '_estimate'] = $item[$key . '_estimate'];
// We hit this on save, so we can not rely on the load set.
if (isset($item[$key . '_estimate_label'])) {
$components[$key . '_estimate_label'] = $item[$key . '_estimate_label'];
$components[$key . '_estimate_value'] = $item[$key . '_estimate_value'];
}
if (isset($item[$key . '_estimate_value'])) {
$components[$key . '_estimate_value'] = $item[$key . '_estimate_value'];
}
}
else {
$components[$key] = isset($item[$key]) && strlen($item[$key]) ? $item[$key] : NULL;;
}
}
// No easy way to test a 0 value :{
$has_data = FALSE;
foreach ($components as $key => $value) {
if (strlen($value)) {
$has_data = TRUE;
break;
}
}
if (!$has_data) {
return FALSE;
}
return $components;
}
################################################################################
# ------------------------------------ #
# Field API Hooks & Helpers: Formatter #
# ------------------------------------ #
# #
# Implements: #
# * hook_field_formatter_info() #
# * hook_field_formatter_settings_form() #
# * hook_field_formatter_settings_summary() #
# * hook_field_formatter_view() #
# #
# Helpers: #
# * partial_date_format_default_options() #
# Default formatter options for the supported format types. #
# #
# * partial_date_format_types() #
# The core format types implemented by the module. Since we are not with #
# complete dates, we can not fallback on the standard PHP formatters. #
# #
# * partial_date_generate_date() #
# Generates an example date item for deminstration of format only. #
# This may not represent the parameters that are passed in. #
# #
# * partial_date_txt_override_options() #
# Formatter options on how to use the date descriptions. #
# #
# * partial_date_estimate_handling_options() #
# Formatter options on how to display the estimate values. #
# #
################################################################################
/**
* Implements hook_field_formatter_info().
*/
function partial_date_field_formatter_info() {
module_load_include('admin.inc', 'partial_date');
return _partial_date_field_formatter_info();
}
/**
* Implements hook_field_formatter_settings_form().
*/
function partial_date_field_formatter_settings_form($field, $instance, $view_mode, $form, &$form_state) {
module_load_include('pages.inc', 'partial_date');
return _partial_date_field_formatter_settings_form($field, $instance, $view_mode, $form, $form_state);
}
/**
* Implements hook_field_formatter_settings_summary().
*/
function partial_date_field_formatter_settings_summary($field, $instance, $view_mode) {
module_load_include('admin.inc', 'partial_date');
return _partial_date_field_formatter_settings_summary($field, $instance, $view_mode);
}
/**
* Implements hook_field_formatter_view().
*
* This handles any text override options before passing the values onto the
* partial_date_render() or partial_date_render_range().
*/
function partial_date_field_formatter_view($object_type, $object, $field, $instance, $langcode, $items, $display) {
$has_range = strpos($field['type'], 'range');
$widget_settings = $instance['widget']['settings'];
$element = array();
foreach ($items as $delta => $item) {
$override = FALSE;
if (!is_array($item)) {
continue;
}
$item += array(
'txt_short' => NULL,
'txt_long' => NULL,
'check_approximate' => 0,
);
switch ($display['settings']['use_override']) {
case 'short':
if (strlen($item['txt_short'])) {
$override = $item['txt_short'];
}
break;
case 'long':
if (strlen($item['txt_long'])) {
$override = $item['txt_long'];
}
break;
case 'long_short':
if (strlen($item['txt_long'])) {
$override = $item['txt_long'];
}
elseif (strlen($item['txt_short'])) {
$override = $item['txt_short'];
}
case 'short_long':
if (strlen($item['txt_short'])) {
$override = $item['txt_short'];
}
elseif (strlen($item['txt_long'])) {
$override = $item['txt_long'];
}
break;
}
if ($override !== FALSE) {
$element[$delta] = array('#markup' => check_plain($override));
}
else {
$to = $from = FALSE;
// The additonal "Approximate only" checkbox.
$display['settings']['is_approximate'] = FALSE;
if (!empty($widget_settings['theme_overrides']['check_approximate'])) {
$display['settings']['is_approximate'] = !empty($item['check_approximate']);
}
if (isset($item['from'])) {
$from = partial_date_field_widget_reduce_date_components($item['from'], TRUE);
}
if (isset($item['to'])) {
$to = partial_date_field_widget_reduce_date_components($item['to'], FALSE);
}
$markup = '';
if ($to && $from) {
$markup = partial_date_render_range($from, $to, $display['settings']);
}
elseif ($to xor $from) {
$markup = partial_date_render($from ? $from : $to, $display['settings']);
}
unset($display['settings']['is_approximate']);
if ($markup) {
$element[$delta] = array('#markup' => $markup);
}
}
}
return $element;
}
function partial_date_render_range($from = NULL, $to = NULL, $settings = array()) {
if (empty($from) && empty($to)) {
return '';
}
// TODO: Make this configurable.
$settings += array(
'reduce' => TRUE,
'format' => 'short',
);
$settings['component_settings'] += partial_date_format_settings($settings['format']);
if ($settings['reduce']) {
partial_date_reduce_range_values($from, $to);
}
$from = partial_date_render($from, $settings);
$to = partial_date_render($to, $settings);
if ($to && $from) {
return theme('partial_date_range', array('from' => $from, 'to' => $to, 'settings' => $settings));
}
// One or both will be empty.
return $from . $to;
}
function partial_date_render($item, $settings = array()) {
if (empty($item)) {
return '';
}
$settings += array(
'format' => 'short',
'component_settings' => array(),
'is_approximate' => 0,
);
if ($settings['format'] != 'custom') {
$settings['component_settings'] = partial_date_format_settings($settings['format']);
}
return theme('partial_date', array(
'item' => $item,
'settings' => $settings['component_settings'],
'format' => $settings['format'],
'is_approximate' => $settings['is_approximate'],
));
}
function partial_date_format_types($add_custom = FALSE) {
$formats = &drupal_static(__FUNCTION__);
if (!$formats) {
$formats = variable_get('partial_date_format_types', array(
'short' => t('Short', array(), array('context' => 'datetime')),
'medium' => t('Medium', array(), array('context' => 'datetime')),
'long' => t('Long', array(), array('context' => 'datetime')),
));
$formats['custom'] = t('Custom', array(), array('context' => 'datetime'));
}
if (!$add_custom) {
$clone = $formats;
unset($formats['custom']);
return $clone;
}
return $formats;
}
function partial_date_format_settings($type) {
$settings = &drupal_static(__FUNCTION__, array());
if (!isset($settings[$type])) {
$settings[$type] = variable_get('partial_date_format_' . $type, partial_date_format_default_options($type));
}
return $settings[$type];
}
/**
* Provides the default settiings for the partial date formats.
*/
function partial_date_format_default_options($format) {
$formats = array(
'short' => array(
'display' => array(
'year' => 'estimate_label',
'month' => 'estimate_label',
'day' => 'estimate_label',
'hour' => 'estimate_label',
'minute' => 'estimate_label',
'second' => 'none',
'timezone' => 'none',
),
'components' => array(
'approx' => array('value' => '', 'weight' => -1),
'year' => array('format' => 'y-ce', 'weight' => 0, 'empty' => ''),
'month' => array('format' => 'm', 'weight' => 1, 'empty' => ''),
'day' => array('format' => 'j', 'weight' => 2, 'empty' => ''),
'hour' => array('format' => 'H', 'weight' => 3, 'empty' => ''),
'minute' => array('format' => 'i', 'weight' => 4, 'empty' => ''),
'second' => array('format' => 's', 'weight' => 5, 'empty' => ''),
'timezone' => array('format' => 'T', 'weight' => 6, 'empty' => ''),
'c1' => array('value' => '', 'weight' => 7),
'c2' => array('value' => '', 'weight' => 8),
'c3' => array('value' => '', 'weight' => 9),
),
'separator' => array(
'date' => '/',
'time' => ':',
'datetime' => ' ',
'other' => ' ',
'range' => '',
),
'meridiem' => 'a',
'year_designation' => 'ce',
),
'medium' => array(
'display' => array(
'year' => 'estimate_label',
'month' => 'estimate_label',
'day' => 'estimate_label',
'hour' => 'estimate_label',
'minute' => 'estimate_label',
'second' => 'estimate_label',
'timezone' => 'date_only',
),
'components' => array(
'approx' => array('value' => '', 'weight' => -1),
'year' => array('format' => 'Y-ce', 'weight' => 0, 'empty' => ''),
'month' => array('format' => 'M', 'weight' => 1, 'empty' => ''),
'day' => array('format' => 'j-S', 'weight' => 2, 'empty' => ''),
'hour' => array('format' => 'h', 'weight' => 3, 'empty' => ''),
'minute' => array('format' => 'i', 'weight' => 4, 'empty' => ''),
'second' => array('format' => 's', 'weight' => 5, 'empty' => ''),
'timezone' => array('format' => 'T', 'weight' => 6, 'empty' => ''),
'c1' => array('value' => '', 'weight' => 7),
'c2' => array('value' => '', 'weight' => 8),
'c3' => array('value' => '', 'weight' => 9),
),
'separator' => array(
'date' => ' ',
'time' => ':',
'datetime' => ' ',
'other' => ' ',
'range' => '',
),
'meridiem' => 'a',
'year_designation' => 'ce',
),
'long' => array(
'display' => array(
'year' => 'estimate_label',
'month' => 'estimate_label',
'day' => 'estimate_label',
'hour' => 'estimate_label',
'minute' => 'estimate_label',
'second' => 'estimate_label',
'timezone' => 'date_only',
),
'components' => array(
'approx' => array('value' => '', 'weight' => -1),
'year' => array('format' => 'Y-ce', 'weight' => 0, 'empty' => ''),
'month' => array('format' => 'F', 'weight' => 1, 'empty' => ''),
'day' => array('format' => 'j-S', 'weight' => 2, 'empty' => ''),
'hour' => array('format' => 'h', 'weight' => 3, 'empty' => ''),
'minute' => array('format' => 'i', 'weight' => 4, 'empty' => ''),
'second' => array('format' => 's', 'weight' => 5, 'empty' => ''),
'timezone' => array('format' => 'e', 'weight' => 6, 'empty' => ''),
'c1' => array('value' => '', 'weight' => 7),
'c2' => array('value' => '', 'weight' => 8),
'c3' => array('value' => '', 'weight' => 9),
),
'separator' => array(
'date' => ' ',
'time' => ':',
'datetime' => ', ',
'other' => ' ',
'range' => '',
),
'meridiem' => 'a',
'year_designation' => 'ce',
),
);
if (isset($formats[$format])) {
return $formats[$format];
}
return $formats['short'];
}
function partial_date_txt_override_options() {
return array(
'none' => t('Use date only', array(), array('context' => 'datetime')),
'short' => t('Use short description', array(), array('context' => 'datetime')),
'long' => t('Use long description', array(), array('context' => 'datetime')),
'long_short' => t('Use long or short description', array(), array('context' => 'datetime')),
'short_long' => t('Use short or long description', array(), array('context' => 'datetime')),
);
}
################################################################################
# -------------------------- #
# Theming related functions: #
# -------------------------- #
# #
# Implements: #
# * hook_theme() #
# #
# Theming functions: #
# * theme_partial_date() #
# * theme_partial_date_long_date_format() #
# * theme_partial_date_medium_date_format() #
# * theme_partial_date_short_date_format() #
# #
# Helpers: #
# * partial_date_reduce_range_values() #
# Reduces the from date component array so that individual components that #
# are common to both are not repeated. #
# #
################################################################################
/**
* Implements hook_theme().
*/
function partial_date_theme() {
return array(
'partial_date_element' => array(
'render element' => 'element',
),
'partial_date_range_inline_element' => array(
'render element' => 'element',
'file' => 'partial_date.theme.inc',
),
'partial_date' => array(
'variables' => array('item' => NULL, 'format' => 'short', 'settings' => array()),
),
'partial_date_range' => array(
'variables' => array('from' => NULL, 'to' => NULL, 'settings' => array()),
),
'partial_date_format_settings_form' => array(
'render element' => 'form',
'file' => 'partial_date.pages.inc',
),
'partial_date_inline_form_element' => array(
'render element' => 'element',
'file' => 'partial_date.theme.inc',
),
);
}
/**
* The theme wrapper for a single date component.
* todo: floating support.
*/
function theme_partial_date_element($variables) {
$element = $variables['element'];
return '<div class="partial-date-element clearfix">' . drupal_render_children($element) . '</div>';
}
function theme_partial_date_range($variables) {
$to = $variables['to'];
$from = $variables['from'];
$settings = $variables['settings'];
$separator = '';
if (!empty($settings['component_settings'])
&& !empty($settings['component_settings']['separator'])
&& !empty($settings['component_settings']['separator']['range'])) {
$separator = $settings['component_settings']['separator']['range'];
}
if (!strlen($separator)) {
$separator = t(' to ', array(), array('context' => 'datetime'));
}
return t('@from@separator@to', array('@from' => $from, '@to' => $to, '@separator' => $separator));
}
/**
* TODO
*
* Template preprocess function to add theme suggestions for the various
* partial date format types.
*/
/**
* The partial date theme callback.
*
* Allows easy override of the format if required.
*/
function theme_partial_date($variables) {
$item = $variables['item'];
$settings = $variables['settings'];
$settings['format'] = $variables['format'];
$settings['is_approximate'] = !empty($variables['is_approximate']);
return partial_date_format($item, $settings);
}
function partial_date_reduce_range_values(&$from, &$to) {
// Reduce dates on granularity values.
foreach (array_keys(partial_date_components()) as $key) {
// Excat match as we need to compare '' to 0.
if (!isset($from[$key]) && !isset($to[$key])) {
continue;
}
elseif ((isset($from[$key]) || !isset($to[$key])) || $from[$key] !== $to[$key]) {
break;
}
$from[$key] = NULL;
}
}
################################################################################
# -------------------------- #
# Element Related Functions: #
# -------------------------- #
# #
# Implements: #
# * hook_element_info() #
# #
# Helpers: #
# * partial_date_element_validate() #
# Element #element_validate callback. #
# #
# * partial_date_element_process() #
# Element #process callback. #
# #
################################################################################
/**
* Implements hook_element_info().
*
* Provides a singular element that can handle all of the implemented partial
* date components; datetime granularility and timezone components.
*/
function partial_date_element_info() {
$types = array();
$types['partial_datetime_element'] = array(
'#input' => TRUE,
'#element_validate' => array('partial_date_element_validate'),
'#process' => array('partial_date_element_process'),
'#theme' => 'partial_date_element',
'#theme_wrappers' => array('form_element'),
);
return $types;
}
/**
* TODO: Validates the date type to stop dates like February 30, 2006.
*/
function partial_date_element_validate($element, $form_state) {
module_load_include('admin.inc', 'partial_date');
_partial_date_element_validate($element);
}
/**
* Roll out a single date element.
*/
function partial_date_element_process($element) {
module_load_include('admin.inc', 'partial_date');
return _partial_date_element_process($element);
}
################################################################################
# ------------------ #
# Views Integration: #
# ------------------ #
################################################################################
/**
* Implements hook_views_api().
*/
function partial_date_views_api() {
return array(
'api' => 3,
'path' => drupal_get_path('module', 'partial_date') . '/includes',
);
}
################################################################################
# ---------------------- #
# API related functions: #
# ---------------------- #
# #
# Note: It would be great to move these to the date_api. #
# #
# Main functions include: #
# * partial_date_components() #
# Returns the date and time values used by the module. #
# This controls almost everything, from defining the schema to controlling #
# the output of the formatters. #
# #
# * partial_date_day_ordinal_suffix() #
# Returns the translated English ordinal suffix for a given day. #
# #
# * partial_date_granularity_field_options() #
# Returns select options for various components. #
# #
# * partial_date_is_leap_year() #
# Checks to see if the specified year is a leap year. #
# #
# * partial_date_mktime() #
# Returns a timestamp (int / float) based on the available components. #
# #
# * partial_date_month_abbreviations() #
# Returns an option list of month abbreviations. #
# #
# * partial_date_month_matrix() #
# Returns the valid month lengths based of the specified year. #
# #
# * partial_date_timezone_handling_correlation() #
# Forces a given timezone into the specified timezone handling option. #
# #
# * partial_date_timezone_option_is_selectable() #
# Determines if the timezone component should be rendered. #
# #
# * partial_date_timezone_handling_options() #
# Returns an option list of supported timezone handling options. #
# #
# * partial_date_year_designation_decorator() #
# Returns the year with the appropriative designation added. #
# #
# * partial_date_year_designation_options() #
# Returns an option list of supported year designations. #
# #
################################################################################
/**
* The minimum year that the module supports.
*
* Modifying this will alter how new timestamps are stored in the database.
*
* Setting to the something huge like 999999999999 should be OK, which would
* be needed for things like the scienific age of the universe. +/- 2000 years
* do not calculate leap years etc, and use a fixed number of seconds per year
* based on the length of the tropical year in 2000.
*
* @var int
*/
define('PD2_YEAR_MIN', -999999999999);
/**
* The maximum year that the module supports.
*
* Modifying this will alter how new timestamps are stored in the database.
*
* @var int
*/
define('PD2_YEAR_MAX', 999999999999);
/**
* The number of seconds for a tropical year in 2000.
*
* Outside of the 1AD to 3999AD, leap years are ignored and a set number of
* seconds per year are used to calculate the number seconds per year for the
* timestamp estimations. This is a float column, so the percision of this
* should be calculated to decide if this can be reduced even more.
*
* @var int
*/
define('PD2_SEC_PER_YEAR', 31556925);
/**
* These are the core components that always exist, but are shown or hidden
* depending on the selected field settings.
*/
function partial_date_components(array $excluded_components = NULL) {
static $components = NULL;
if (!isset($components)) {
$components = array(
'year' => t('Year', array(), array('context' => 'datetime')),
'month' => t('Month', array(), array('context' => 'datetime')),
'day' => t('Day', array(), array('context' => 'datetime')),
'hour' => t('Hour', array(), array('context' => 'datetime')),
'minute' => t('Minute', array(), array('context' => 'datetime')),
'second' => t('Second', array(), array('context' => 'datetime')),
'timezone' => t('Timezone', array(), array('context' => 'datetime')),
);
}
if ($excluded_components) {
return array_diff_key($components, array_flip($excluded_components));
}
return $components;