date_views_fields.inc 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171
  1. <?php
  2. /**
  3. * @file
  4. * Helper for identifying Date API fields for views.
  5. */
  6. /**
  7. * Identify all potential date/timestamp fields.
  8. *
  9. * @return array
  10. * An array with fieldname, type, and table.
  11. * @see date_views_date_views_fields()
  12. */
  13. function _date_views_fields($base = 'node') {
  14. // Make sure $base is never empty.
  15. if (empty($base)) {
  16. $base = 'node';
  17. }
  18. $cid = 'date_views_fields_' . $base;
  19. cache_clear_all($cid, 'cache_views');
  20. // We use fields that provide filter handlers as our universe of possible
  21. // fields of interest.
  22. $all_fields = date_views_views_fetch_fields($base, 'filter');
  23. // Iterate over all the fields that Views knows about.
  24. $fields = array();
  25. foreach ((array) $all_fields as $alias => $val) {
  26. // Set up some default values.
  27. $granularity = array('year', 'month', 'day', 'hour', 'minute', 'second');
  28. $tz_handling = 'site';
  29. $related_fields = array();
  30. $timezone_field = '';
  31. $offset_field = '';
  32. $rrule_field = '';
  33. $delta_field = '';
  34. $sql_type = DATE_UNIX;
  35. $type = '';
  36. $name = $alias;
  37. $tmp = explode('.', $name);
  38. $field_name = $tmp[1];
  39. $table_name = $tmp[0];
  40. // Unset the date filter to avoid ugly recursion and broken values.
  41. if ($field_name == 'date_filter') {
  42. continue;
  43. }
  44. $fromto = array($name, $name);
  45. // If we don't have a filter handler, we don't need to do anything more.
  46. if (!$handler = views_get_handler($table_name, $field_name, 'filter')) {
  47. continue;
  48. }
  49. $handler = views_get_handler($table_name, $field_name, 'filter');
  50. $handler_name = $handler->definition['handler'];
  51. // We don't care about anything but date handlers.
  52. if (empty($handler->definition['is date'])) {
  53. continue;
  54. }
  55. $is_field = FALSE;
  56. // For Field module fields, get the date type.
  57. $custom = array();
  58. if (isset($handler->definition['field_name'])) {
  59. $field = field_info_field($handler->definition['field_name']);
  60. $is_field = TRUE;
  61. switch ($field['type']) {
  62. case 'date':
  63. $sql_type = DATE_ISO;
  64. break;
  65. case 'datestamp':
  66. break;
  67. case 'datetime':
  68. $sql_type = DATE_DATETIME;
  69. break;
  70. default:
  71. // If this is not a date field, nothing more to do.
  72. continue;
  73. }
  74. $revision = in_array($base, array('node_revision')) ? FIELD_LOAD_REVISION : FIELD_LOAD_CURRENT;
  75. $db_info = date_api_database_info($field, $revision);
  76. $name = $table_name . "." . $field_name;
  77. $grans = array('year', 'month', 'day', 'hour', 'minute', 'second');
  78. $granularity = !empty($field['granularity']) ? $field['granularity'] : $grans;
  79. $fromto = array(
  80. $table_name . '.' . $db_info['columns'][$table_name]['value'],
  81. $table_name . '.' . (!empty($field['settings']['todate']) ? $db_info['columns'][$table_name]['value2'] : $db_info['columns'][$table_name]['value']),
  82. );
  83. if (isset($field['settings']['tz_handling'])) {
  84. $tz_handling = $field['settings']['tz_handling'];
  85. $db_info = date_api_database_info($field, $revision);
  86. if ($tz_handling == 'date') {
  87. $offset_field = $table_name . '.' . $db_info['columns'][$table_name]['offset'];
  88. }
  89. $related_fields = array(
  90. $table_name . '.' . $db_info['columns'][$table_name]['value']
  91. );
  92. if (isset($db_info['columns'][$table_name]['value2'])) {
  93. $related_fields = array_merge($related_fields, array($table_name . '.' . $db_info['columns'][$table_name]['value2']));
  94. }
  95. if (isset($db_info['columns'][$table_name]['timezone'])) {
  96. $related_fields = array_merge($related_fields, array($table_name . '.' . $db_info['columns'][$table_name]['timezone']));
  97. $timezone_field = $table_name . '.' . $db_info['columns'][$table_name]['timezone'];
  98. }
  99. if (isset($db_info['columns'][$table_name]['rrule'])) {
  100. $related_fields = array_merge($related_fields, array($table_name . '.' . $db_info['columns'][$table_name]['rrule']));
  101. $rrule_field = $table_name . '.' . $db_info['columns'][$table_name]['rrule'];
  102. }
  103. }
  104. // Get the delta value into the query.
  105. if ($field['cardinality'] != 1) {
  106. array_push($related_fields, "$table_name.delta");
  107. $delta_field = $table_name . '_delta';
  108. }
  109. }
  110. // Allow custom modules to provide date fields.
  111. else {
  112. foreach (module_implements('date_views_fields') as $module) {
  113. $function = $module . '_date_views_fields';
  114. if ($custom = $function("$table_name.$field_name")) {
  115. $type = 'custom';
  116. break;
  117. }
  118. }
  119. }
  120. // Don't do anything if this is not a date field we can handle.
  121. if (!empty($type) || empty($custom)) {
  122. $alias = str_replace('.', '_', $alias);
  123. $fields['name'][$name] = array(
  124. 'is_field' => $is_field,
  125. 'sql_type' => $sql_type,
  126. 'label' => $val['group'] . ': ' . $val['title'],
  127. 'granularity' => $granularity,
  128. 'fullname' => $name,
  129. 'table_name' => $table_name,
  130. 'field_name' => $field_name,
  131. 'query_name' => $alias,
  132. 'fromto' => $fromto,
  133. 'tz_handling' => $tz_handling,
  134. 'offset_field' => $offset_field,
  135. 'timezone_field' => $timezone_field,
  136. 'rrule_field' => $rrule_field,
  137. 'related_fields' => $related_fields,
  138. 'delta_field' => $delta_field,
  139. );
  140. // Allow the custom fields to over-write values.
  141. if (!empty($custom)) {
  142. foreach ($custom as $key => $val) {
  143. $fields['name'][$name][$key] = $val;
  144. }
  145. }
  146. $fields['name'][$name]['real_field_name'] = $field_name;
  147. $fields['alias'][$alias] = $fields['name'][$name];
  148. }
  149. }
  150. cache_set($cid, $fields, 'cache_views');
  151. return $fields;
  152. }