|
1
|
<?php
|
|
2
|
|
|
3
|
/**
|
|
4
|
* @file
|
|
5
|
* Creates the option of Repeating Date fields and manages Date Repeat fields.
|
|
6
|
*
|
|
7
|
* The Repeating functionality is pretty tightly intermingled with other code,
|
|
8
|
* so the process of pulling it out into this module will happen gradually.
|
|
9
|
*
|
|
10
|
* The current implementation adds a repeat form to the date field so the user
|
|
11
|
* can select the repeat rules. That selection is built into an RRULE
|
|
12
|
* which is stored in the zero position of the field values. During widget
|
|
13
|
* validation, the rule is parsed to see what dates it will create,
|
|
14
|
* and multiple values are added to the field, one for each repeat date.
|
|
15
|
* That update only happens when the rule, the start date, or the end date
|
|
16
|
* change, no need to waste processing cycles for other changes to the node
|
|
17
|
* values.
|
|
18
|
*
|
|
19
|
* Lots of possible TODOs, the biggest one is figuring out the best
|
|
20
|
* way to handle dates with no UNTIL date since we can't add an infinite
|
|
21
|
* number of values to the field. For now, we require the UNTIL date.
|
|
22
|
*/
|
|
23
|
|
|
24
|
/**
|
|
25
|
* Implements hook_theme().
|
|
26
|
*/
|
|
27
|
function date_repeat_field_theme() {
|
|
28
|
$themes = array(
|
|
29
|
'date_repeat_display' => array(
|
|
30
|
'variables' => array(
|
|
31
|
'field' => NULL,
|
|
32
|
'item' => NULL,
|
|
33
|
'entity_type' => NULL,
|
|
34
|
'entity' => NULL,
|
|
35
|
'dates' => NULL,
|
|
36
|
),
|
|
37
|
'function' => 'theme_date_repeat_display',
|
|
38
|
),
|
|
39
|
);
|
|
40
|
|
|
41
|
return $themes;
|
|
42
|
}
|
|
43
|
|
|
44
|
/**
|
|
45
|
* Theme the human-readable description for a Date Repeat rule.
|
|
46
|
*
|
|
47
|
* @todo Add in ways to store the description in the date so it isn't
|
|
48
|
* regenerated over and over and find a way to allow description to be shown or
|
|
49
|
* hidden.
|
|
50
|
*/
|
|
51
|
function theme_date_repeat_display($vars) {
|
|
52
|
$field = $vars['field'];
|
|
53
|
$item = $vars['item'];
|
|
54
|
$entity = !empty($vars['node']) ? $vars['node'] : NULL;
|
|
55
|
$output = '';
|
|
56
|
if (!empty($item['rrule'])) {
|
|
57
|
$output = date_repeat_rrule_description($item['rrule']);
|
|
58
|
$output = '<div class="date-repeat-rule">' . $output . '</div>';
|
|
59
|
}
|
|
60
|
return $output;
|
|
61
|
}
|
|
62
|
|
|
63
|
/**
|
|
64
|
* Implements hook_menu().
|
|
65
|
*/
|
|
66
|
function date_repeat_field_menu() {
|
|
67
|
// Add menu tabs to display pages with details about repeating date values.
|
|
68
|
$items = array();
|
|
69
|
|
|
70
|
$values = date_repeat_field_bundles();
|
|
71
|
foreach ($values as $entity_type => $bundles) {
|
|
72
|
if (module_exists('field_collection') && $entity_type == 'field_collection_item') {
|
|
73
|
foreach ($bundles as $bundle => $fields) {
|
|
74
|
$field = field_info_field($bundle);
|
|
75
|
if ($field['type'] == 'field_collection') {
|
|
76
|
$path = field_collection_field_get_path($field);
|
|
77
|
$count = count(explode('/', $path));
|
|
78
|
$items[$path . '/%field_collection_item/repeats'] = array(
|
|
79
|
'title' => 'Repeats',
|
|
80
|
'page callback' => 'date_repeat_field_page',
|
|
81
|
'page arguments' => array($entity_type, $count),
|
|
82
|
'access callback' => 'date_repeat_field_show',
|
|
83
|
'access arguments' => array($entity_type, $count),
|
|
84
|
'type' => MENU_LOCAL_TASK,
|
|
85
|
'context' => MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE,
|
|
86
|
);
|
|
87
|
}
|
|
88
|
}
|
|
89
|
}
|
|
90
|
else {
|
|
91
|
$path = $entity_type . '/%' . $entity_type;
|
|
92
|
$items[$path . '/repeats'] = array(
|
|
93
|
'title' => 'Repeats',
|
|
94
|
'page callback' => 'date_repeat_field_page',
|
|
95
|
'page arguments' => array($entity_type, 1),
|
|
96
|
'access callback' => 'date_repeat_field_show',
|
|
97
|
'access arguments' => array($entity_type, 1),
|
|
98
|
'type' => MENU_LOCAL_TASK,
|
|
99
|
'context' => MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE,
|
|
100
|
);
|
|
101
|
}
|
|
102
|
}
|
|
103
|
return $items;
|
|
104
|
}
|
|
105
|
|
|
106
|
/**
|
|
107
|
* Implements hook_permission().
|
|
108
|
*/
|
|
109
|
function date_repeat_field_permission() {
|
|
110
|
return array(
|
|
111
|
'view date repeats' => array(
|
|
112
|
'title' => t('View Repeating Dates'),
|
|
113
|
'description' => t('Allow user to see a page with all the times a date repeats.'),
|
|
114
|
),
|
|
115
|
);
|
|
116
|
}
|
|
117
|
|
|
118
|
/**
|
|
119
|
* See if the user can access repeat date info for this entity.
|
|
120
|
*
|
|
121
|
* @param string $entity_type
|
|
122
|
* The entity type.
|
|
123
|
* @param string $entity
|
|
124
|
* The specific entity to check (optional).
|
|
125
|
*
|
|
126
|
* @return bool
|
|
127
|
* Return TRUE if there is at least one date field attached to this entity,
|
|
128
|
* and the current user has the permission 'view date repeats'.
|
|
129
|
*/
|
|
130
|
function date_repeat_field_show($entity_type = 'node', $entity = NULL) {
|
|
131
|
if (!user_access('view date repeats')) {
|
|
132
|
return FALSE;
|
|
133
|
}
|
|
134
|
|
|
135
|
$bundle = date_get_entity_bundle($entity_type, $entity);
|
|
136
|
|
|
137
|
// In Drupal 7.22 the field_info_field_map() function was added, which is more
|
|
138
|
// memory-efficient in certain cases than field_info_fields().
|
|
139
|
// @see https://drupal.org/node/1915646
|
|
140
|
$field_map_available = version_compare(VERSION, '7.22', '>=');
|
|
141
|
$field_list = $field_map_available ? field_info_field_map() : field_info_fields();
|
|
142
|
|
|
143
|
foreach ($field_list as $field_name => $data) {
|
|
144
|
if (in_array($data['type'], array('date', 'datestamp', 'datetime'))
|
|
145
|
&& array_key_exists($entity_type, $data['bundles'])
|
|
146
|
&& in_array($bundle, $data['bundles'][$entity_type])) {
|
|
147
|
$field_info = $field_map_available ? field_info_field($field_name) : $data;
|
|
148
|
if (date_is_repeat_field($field_info)) {
|
|
149
|
return TRUE;
|
|
150
|
}
|
|
151
|
}
|
|
152
|
}
|
|
153
|
return FALSE;
|
|
154
|
}
|
|
155
|
|
|
156
|
/**
|
|
157
|
* A page to list all values for a repeating date.
|
|
158
|
*/
|
|
159
|
function date_repeat_field_page($entity_type = 'node', $entity = NULL) {
|
|
160
|
$bundle = date_get_entity_bundle($entity_type, $entity);
|
|
161
|
$info = entity_get_info($entity_type);
|
|
162
|
$key = $info['entity keys']['id'];
|
|
163
|
drupal_set_title(t('Repeats'));
|
|
164
|
$entity->date_repeat_show_all = TRUE;
|
|
165
|
$entity->content = array();
|
|
166
|
$output = '';
|
|
167
|
foreach (field_info_fields() as $field_name => $field) {
|
|
168
|
if (in_array($field['type'], array('date', 'datestamp', 'datetime')) && date_is_repeat_field($field)) {
|
|
169
|
foreach ($field['bundles'] as $field_entity_type => $bundles) {
|
|
170
|
foreach ($bundles as $field_bundle) {
|
|
171
|
if ($entity_type == $field_entity_type && $bundle == $field_bundle) {
|
|
172
|
$data = field_view_field($entity_type, $entity, $field_name);
|
|
173
|
$output .= drupal_render($data);
|
|
174
|
}
|
|
175
|
}
|
|
176
|
}
|
|
177
|
}
|
|
178
|
}
|
|
179
|
return $output;
|
|
180
|
}
|
|
181
|
|
|
182
|
/**
|
|
183
|
* All entity types and bundles that have repeating date fields.
|
|
184
|
*/
|
|
185
|
function date_repeat_field_bundles() {
|
|
186
|
$values = array();
|
|
187
|
foreach (field_info_fields() as $field_name => $field) {
|
|
188
|
if (in_array($field['type'], array('date', 'datestamp', 'datetime')) && $field['settings']['repeat']) {
|
|
189
|
foreach ($field['bundles'] as $entity_type => $bundles) {
|
|
190
|
foreach ($bundles as $bundle) {
|
|
191
|
$values[$entity_type][$bundle][] = $field_name;
|
|
192
|
}
|
|
193
|
}
|
|
194
|
}
|
|
195
|
}
|
|
196
|
return $values;
|
|
197
|
}
|
|
198
|
|
|
199
|
/**
|
|
200
|
* Check field is repeat.
|
|
201
|
*/
|
|
202
|
function date_is_repeat_field($field, $instance = NULL) {
|
|
203
|
if (is_string($field)) {
|
|
204
|
$field = field_info_field($field);
|
|
205
|
}
|
|
206
|
|
|
207
|
if (!isset($field['settings']['repeat'])) {
|
|
208
|
return FALSE;
|
|
209
|
}
|
|
210
|
|
|
211
|
$value = $field['settings']['repeat'];
|
|
212
|
|
|
213
|
// This might be either a field form or a real field.
|
|
214
|
if (is_array($value)) {
|
|
215
|
return $value['#value'];
|
|
216
|
}
|
|
217
|
else {
|
|
218
|
return $value;
|
|
219
|
}
|
|
220
|
}
|
|
221
|
|
|
222
|
/**
|
|
223
|
* Implements hook_date_field_insert_alter().
|
|
224
|
*/
|
|
225
|
function date_repeat_field_date_field_insert_alter(&$items, $context) {
|
|
226
|
$entity = $context['entity'];
|
|
227
|
$field = $context['field'];
|
|
228
|
$instance = $context['instance'];
|
|
229
|
$langcode = $context['langcode'];
|
|
230
|
|
|
231
|
// If an RRULE with a frequency of NONE made it this far, unset it.
|
|
232
|
if (!empty($items[0]['rrule']) && strpos($items[0]['rrule'], 'FREQ=NONE')) {
|
|
233
|
$items[0]['rrule'] = NULL;
|
|
234
|
}
|
|
235
|
|
|
236
|
// We can't use hook_devel_generate() because we need custom handling for
|
|
237
|
// repeating date fields. So we wait until the entity is inserted, then
|
|
238
|
// intervene here to fix it.
|
|
239
|
if (!empty($entity->devel_generate) && !empty($field['settings']['repeat'])) {
|
|
240
|
module_load_include('inc', 'date_repeat_field', 'date_repeat_field.devel_generate');
|
|
241
|
date_repeat_field_date_field_insert($items, $context);
|
|
242
|
}
|
|
243
|
}
|
|
244
|
|
|
245
|
/**
|
|
246
|
* Implements hook_date_field_update_alter().
|
|
247
|
*/
|
|
248
|
function date_repeat_field_date_field_update_alter(&$items, $context) {
|
|
249
|
// If an RRULE with a frequency of NONE made it this far, unset it.
|
|
250
|
if (!empty($items[0]['rrule']) && strpos($items[0]['rrule'], 'FREQ=NONE')) {
|
|
251
|
$items[0]['rrule'] = NULL;
|
|
252
|
}
|
|
253
|
|
|
254
|
// If you have a repeating date field on a user and don't check the box to
|
|
255
|
// repeat it, we end up with $items[0]['rrule'] = array('additions' => '',
|
|
256
|
// 'exceptions' => '')); This will clean it up by getting rid of those bogus
|
|
257
|
// values.
|
|
258
|
// @todo Figure out where that's coming from. It doesn't happen on nodes.
|
|
259
|
if (!empty($items[0]['rrule']) && is_array($items[0]['rrule'])) {
|
|
260
|
$items[0]['rrule'] = NULL;
|
|
261
|
}
|
|
262
|
}
|
|
263
|
|
|
264
|
/**
|
|
265
|
* Implements hook_field_widget_form_alter().
|
|
266
|
*/
|
|
267
|
function date_repeat_field_field_widget_form_alter(&$element, &$form_state, $context) {
|
|
268
|
$field = $context['field'];
|
|
269
|
$instance = $context['instance'];
|
|
270
|
$items = $context['items'];
|
|
271
|
$delta = $context['delta'];
|
|
272
|
|
|
273
|
if (in_array($field['type'], array('date', 'datetime', 'datestamp'))) {
|
|
274
|
if (!empty($field['settings']['repeat'])) {
|
|
275
|
$element['#element_validate'][] = 'date_repeat_field_widget_validate';
|
|
276
|
$element['show_repeat_settings'] = array(
|
|
277
|
'#type' => 'checkbox',
|
|
278
|
'#title' => t('Repeat'),
|
|
279
|
'#weight' => $instance['widget']['weight'] + .3,
|
|
280
|
'#prefix' => '<div class="date-clear">',
|
|
281
|
'#suffix' => '</div>',
|
|
282
|
'#default_value' => isset($items[$delta]['rrule']) && !empty($items[$delta]['rrule']) ? 1 : 0,
|
|
283
|
);
|
|
284
|
|
|
285
|
// Make changes if instance is set to be rendered as a regular field.
|
|
286
|
if (!empty($instance['widget']['settings']['no_fieldset'])) {
|
|
287
|
$element['#title'] = check_plain($instance['label']);
|
|
288
|
$element['#description'] = field_filter_xss($instance['description']);
|
|
289
|
$element['#theme_wrappers'] = array('date_form_element');
|
|
290
|
}
|
|
291
|
}
|
|
292
|
}
|
|
293
|
}
|
|
294
|
|
|
295
|
/**
|
|
296
|
* Validation for date repeat form element.
|
|
297
|
*
|
|
298
|
* Create multiple values from the RRULE results. Lots more work needed here.
|
|
299
|
*/
|
|
300
|
function date_repeat_field_widget_validate($element, &$form_state) {
|
|
301
|
$field = field_widget_field($element, $form_state);
|
|
302
|
if (empty($field['settings']['repeat'])) {
|
|
303
|
return;
|
|
304
|
}
|
|
305
|
|
|
306
|
$field_name = $element['#field_name'];
|
|
307
|
$delta = $element['#delta'];
|
|
308
|
$langcode = $element['#language'];
|
|
309
|
|
|
310
|
// If the widget has been hidden by #access, the RRULE will still be in its
|
|
311
|
// original string form here. Nothing to process.
|
|
312
|
if (date_hidden_element($element)) {
|
|
313
|
// If this was a hidden repeating date, we lost all the repeating values in
|
|
314
|
// the widget processing. Add them back here if that happened since we are
|
|
315
|
// skipping the re-creation of those values.
|
|
316
|
if (!empty($form_state['storage']['date_items'][$field_name])) {
|
|
317
|
array_pop($element['#parents']);
|
|
318
|
form_set_value($element, $form_state['storage']['date_items'][$field_name][$langcode], $form_state);
|
|
319
|
}
|
|
320
|
return;
|
|
321
|
}
|
|
322
|
|
|
323
|
module_load_include('inc', 'date_repeat', 'date_repeat_form');
|
|
324
|
$instance = field_widget_instance($element, $form_state);
|
|
325
|
|
|
326
|
// Here 'values' returns an array of input values, which includes the
|
|
327
|
// original RRULE, as a string. and 'input' returns an array of the form
|
|
328
|
// elements created by the repeating date widget, with RRULE values as an
|
|
329
|
// array of the selected elements and their chosen values.
|
|
330
|
$item = drupal_array_get_nested_value($form_state['values'], $element['#parents'], $input_exists);
|
|
331
|
$input = drupal_array_get_nested_value($form_state['input'], $element['#parents'], $input_exists);
|
|
332
|
|
|
333
|
$rrule_values = date_repeat_merge($input['rrule'], $element['rrule']);
|
|
334
|
|
|
335
|
// If no repeat information was set, treat this as a normal, non-repeating
|
|
336
|
// value.
|
|
337
|
if ($rrule_values['FREQ'] == 'NONE' || empty($input['show_repeat_settings'])) {
|
|
338
|
$item['rrule'] = NULL;
|
|
339
|
form_set_value($element, $item, $form_state);
|
|
340
|
return;
|
|
341
|
}
|
|
342
|
|
|
343
|
// If no start date was set, clean up the form and return.
|
|
344
|
if (empty($item['value'])) {
|
|
345
|
form_set_value($element, NULL, $form_state);
|
|
346
|
return;
|
|
347
|
}
|
|
348
|
|
|
349
|
// Require the UNTIL date for now.
|
|
350
|
// The RRULE has already been created by this point, so go back
|
|
351
|
// to the posted values to see if this was filled out.
|
|
352
|
$error_field_base = implode('][', $element['#parents']);
|
|
353
|
$error_field_until = $error_field_base . '][rrule][until_child][datetime][';
|
|
354
|
if (!empty($item['rrule']) && $rrule_values['range_of_repeat'] === 'UNTIL' && empty($rrule_values['UNTIL']['datetime'])) {
|
|
355
|
switch ($instance['widget']['type']) {
|
|
356
|
case 'date_text':
|
|
357
|
case 'date_popup':
|
|
358
|
form_set_error($error_field_until . 'date', t("Missing value in 'Range of repeat'. (UNTIL).", array(), array('context' => 'Date repeat')));
|
|
359
|
break;
|
|
360
|
|
|
361
|
case 'date_select':
|
|
362
|
form_set_error($error_field_until . 'year', t("Missing value in 'Range of repeat': Year (UNTIL)", array(), array('context' => 'Date repeat')));
|
|
363
|
form_set_error($error_field_until . 'month', t("Missing value in 'Range of repeat': Month (UNTIL)", array(), array('context' => 'Date repeat')));
|
|
364
|
form_set_error($error_field_until . 'day', t("Missing value in 'Range of repeat': Day (UNTIL)", array(), array('context' => 'Date repeat')));
|
|
365
|
break;
|
|
366
|
}
|
|
367
|
}
|
|
368
|
|
|
369
|
$error_field_count = $error_field_base . '][rrule][count_child';
|
|
370
|
if (!empty($item['rrule']) && $rrule_values['range_of_repeat'] === 'COUNT' && empty($rrule_values['COUNT'])) {
|
|
371
|
form_set_error($error_field_count, t("Missing value in 'Range of repeat'. (COUNT).", array(), array('context' => 'Date repeat')));
|
|
372
|
}
|
|
373
|
|
|
374
|
$error_field_count = $error_field_base . '][rrule][weekly][INTERVAL';
|
|
375
|
if (isset($rrule_values['INTERVAL']) && isset($rrule_values['FREQ']) && !empty($item['rrule']) && $rrule_values['FREQ'] == 'WEEKLY' && $rrule_values['INTERVAL'] == '') {
|
|
376
|
form_set_error($error_field_count, t('Missing value in Repeats Every # of weeks. (INTERVAL).', array(), array('context' => 'Date repeat')));
|
|
377
|
}
|
|
378
|
|
|
379
|
$error_field_count = $error_field_base . '][rrule][daily][INTERVAL_child';
|
|
380
|
if (isset($rrule_values['INTERVAL']) && isset($rrule_values['FREQ']) && !empty($item['rrule']) && $rrule_values['FREQ'] == 'DAILY' && $rrule_values['INTERVAL'] == '') {
|
|
381
|
form_set_error($error_field_count, t('Missing value in Repeats Every # of days. (INTERVAL).', array(), array('context' => 'Date repeat')));
|
|
382
|
}
|
|
383
|
|
|
384
|
if (form_get_errors()) {
|
|
385
|
return;
|
|
386
|
}
|
|
387
|
|
|
388
|
// If the rule, the start date, or the end date have changed, re-calculate
|
|
389
|
// the repeating dates, wipe out the previous values, and populate the
|
|
390
|
// field with the new values.
|
|
391
|
$rrule = $item['rrule'];
|
|
392
|
if (!empty($rrule)) {
|
|
393
|
// Avoid undefined index problems on dates that don't have all parts.
|
|
394
|
$possible_items = array('value', 'value2', 'timezone', 'offset', 'offset2');
|
|
395
|
foreach ($possible_items as $key) {
|
|
396
|
if (empty($item[$key])) {
|
|
397
|
$item[$key] = '';
|
|
398
|
}
|
|
399
|
}
|
|
400
|
|
|
401
|
// We only collect a date for UNTIL, but we need it to be inclusive, so
|
|
402
|
// force it to a full datetime element at the last possible second of the
|
|
403
|
// day.
|
|
404
|
if (!empty($rrule_values['UNTIL'])) {
|
|
405
|
$gran = array('year', 'month', 'day', 'hour', 'minute', 'second');
|
|
406
|
$rrule_values['UNTIL']['datetime'] .= ' 23:59:59';
|
|
407
|
$rrule_values['UNTIL']['granularity'] = serialize(drupal_map_assoc($gran));
|
|
408
|
$rrule_values['UNTIL']['all_day'] = 0;
|
|
409
|
}
|
|
410
|
$value = date_repeat_build_dates($rrule, $rrule_values, $field, $item);
|
|
411
|
// Unset the delta value of the parents.
|
|
412
|
array_pop($element['#parents']);
|
|
413
|
// Set the new delta values for this item to the array of values returned
|
|
414
|
// by the repeat rule.
|
|
415
|
form_set_value($element, $value, $form_state);
|
|
416
|
}
|
|
417
|
}
|
|
418
|
|
|
419
|
/**
|
|
420
|
* Implements the form after_build().
|
|
421
|
*/
|
|
422
|
function date_repeat_after_build(&$element, &$form_state) {
|
|
423
|
// Remove the 'Add more' elements from a repeating date form.
|
|
424
|
foreach ($form_state['storage']['repeat_fields'] as $field_name => $parents) {
|
|
425
|
// Remove unnecessary items in the form added by the Add more handling.
|
|
426
|
$value = drupal_array_get_nested_value($element, $parents);
|
|
427
|
$langcode = $value['#language'];
|
|
428
|
unset($value[$langcode]['add_more'], $value[$langcode]['#suffix'], $value[$langcode]['#prefix'], $value[$langcode][0]['_weight']);
|
|
429
|
$value[$langcode]['#cardinality'] = 1;
|
|
430
|
$value[$langcode]['#max_delta'] = 1;
|
|
431
|
drupal_array_set_nested_value($element, $parents, $value);
|
|
432
|
}
|
|
433
|
return $element;
|
|
434
|
}
|
|
435
|
|
|
436
|
/**
|
|
437
|
* Helper function to build repeating dates from a $node_field.
|
|
438
|
*
|
|
439
|
* Pass in either the RRULE or the $form_values array for the RRULE, whichever
|
|
440
|
* is missing will be created when needed.
|
|
441
|
*/
|
|
442
|
function date_repeat_build_dates($rrule = NULL, $rrule_values = NULL, $field, $item) {
|
|
443
|
include_once DRUPAL_ROOT . '/' . drupal_get_path('module', 'date_api') . '/date_api_ical.inc';
|
|
444
|
$field_name = $field['field_name'];
|
|
445
|
|
|
446
|
if (empty($rrule)) {
|
|
447
|
$rrule = date_api_ical_build_rrule($rrule_values);
|
|
448
|
}
|
|
449
|
elseif (empty($rrule_values)) {
|
|
450
|
$rrule_values = date_ical_parse_rrule(NULL, $rrule);
|
|
451
|
}
|
|
452
|
|
|
453
|
// By the time we get here, the start and end dates have been adjusted back to
|
|
454
|
// UTC, but we want localtime dates to do things like '+1 Tuesday', so adjust
|
|
455
|
// back to localtime.
|
|
456
|
$timezone = date_get_timezone($field['settings']['tz_handling'], $item['timezone']);
|
|
457
|
$timezone_db = date_get_timezone_db($field['settings']['tz_handling']);
|
|
458
|
$start = new DateObject($item['value'], $timezone_db, date_type_format($field['type']));
|
|
459
|
$start->limitGranularity($field['settings']['granularity']);
|
|
460
|
if ($timezone != $timezone_db) {
|
|
461
|
date_timezone_set($start, timezone_open($timezone));
|
|
462
|
}
|
|
463
|
if (!empty($item['value2']) && $item['value2'] != $item['value']) {
|
|
464
|
$end = new DateObject($item['value2'], date_get_timezone_db($field['settings']['tz_handling']), date_type_format($field['type']));
|
|
465
|
$end->limitGranularity($field['settings']['granularity']);
|
|
466
|
date_timezone_set($end, timezone_open($timezone));
|
|
467
|
}
|
|
468
|
else {
|
|
469
|
$end = $start;
|
|
470
|
}
|
|
471
|
$duration = $start->difference($end);
|
|
472
|
$start_datetime = date_format($start, DATE_FORMAT_DATETIME);
|
|
473
|
|
|
474
|
if (!empty($rrule_values['UNTIL']['datetime'])) {
|
|
475
|
$end = date_ical_date($rrule_values['UNTIL'], $timezone);
|
|
476
|
$end_datetime = date_format($end, DATE_FORMAT_DATETIME);
|
|
477
|
}
|
|
478
|
elseif (!empty($rrule_values['COUNT'])) {
|
|
479
|
$end_datetime = NULL;
|
|
480
|
}
|
|
481
|
else {
|
|
482
|
// No UNTIL and no COUNT?
|
|
483
|
return array();
|
|
484
|
}
|
|
485
|
|
|
486
|
// Split the RRULE into RRULE, EXDATE, and RDATE parts.
|
|
487
|
$parts = date_repeat_split_rrule($rrule);
|
|
488
|
$parsed_exceptions = (array) $parts[1];
|
|
489
|
$exceptions = array();
|
|
490
|
foreach ($parsed_exceptions as $exception) {
|
|
491
|
$date = date_ical_date($exception, $timezone);
|
|
492
|
$exceptions[] = date_format($date, 'Y-m-d');
|
|
493
|
}
|
|
494
|
|
|
495
|
$parsed_rdates = (array) $parts[2];
|
|
496
|
$additions = array();
|
|
497
|
foreach ($parsed_rdates as $rdate) {
|
|
498
|
$date = date_ical_date($rdate, $timezone);
|
|
499
|
$additions[] = date_format($date, 'Y-m-d');
|
|
500
|
}
|
|
501
|
|
|
502
|
$dates = date_repeat_calc($rrule, $start_datetime, $end_datetime, $exceptions, $timezone, $additions);
|
|
503
|
$value = array();
|
|
504
|
foreach ($dates as $delta => $date) {
|
|
505
|
// date_repeat_calc always returns DATE_DATETIME dates, which is not
|
|
506
|
// necessarily $field['type'] dates. Convert returned dates back to db
|
|
507
|
// timezone before storing.
|
|
508
|
$date_start = new DateObject($date, $timezone, DATE_FORMAT_DATETIME);
|
|
509
|
$date_start->limitGranularity($field['settings']['granularity']);
|
|
510
|
date_timezone_set($date_start, timezone_open($timezone_db));
|
|
511
|
$date_end = clone $date_start;
|
|
512
|
date_modify($date_end, '+' . $duration . ' seconds');
|
|
513
|
$value[$delta] = array(
|
|
514
|
'value' => date_format($date_start, date_type_format($field['type'])),
|
|
515
|
'value2' => date_format($date_end, date_type_format($field['type'])),
|
|
516
|
'offset' => date_offset_get($date_start),
|
|
517
|
'offset2' => date_offset_get($date_end),
|
|
518
|
'timezone' => $timezone,
|
|
519
|
'rrule' => $rrule,
|
|
520
|
);
|
|
521
|
}
|
|
522
|
|
|
523
|
return $value;
|
|
524
|
}
|
|
525
|
|
|
526
|
/**
|
|
527
|
* Implements hook_date_combo_process_alter().
|
|
528
|
*/
|
|
529
|
function date_repeat_field_date_combo_process_alter(&$element, &$form_state, $context) {
|
|
530
|
// This hook lets us make changes to the date_combo element.
|
|
531
|
$field = $context['field'];
|
|
532
|
$instance = $context['instance'];
|
|
533
|
$field_name = $element['#field_name'];
|
|
534
|
$delta = $element['#delta'];
|
|
535
|
|
|
536
|
// Add a date repeat form element, if needed. We delayed until this point so
|
|
537
|
// we don't bother adding it to hidden fields.
|
|
538
|
if (date_is_repeat_field($field, $instance)) {
|
|
539
|
$item = $element['#value'];
|
|
540
|
$element['rrule'] = array(
|
|
541
|
'#type' => 'date_repeat_rrule',
|
|
542
|
'#theme_wrappers' => array('date_repeat_rrule'),
|
|
543
|
'#default_value' => isset($item['rrule']) ? $item['rrule'] : '',
|
|
544
|
'#date_timezone' => $element['#date_timezone'],
|
|
545
|
'#date_format' => date_limit_format(date_input_format($element, $field, $instance), $field['settings']['granularity']),
|
|
546
|
'#date_text_parts' => (array) $instance['widget']['settings']['text_parts'],
|
|
547
|
'#date_increment' => $instance['widget']['settings']['increment'],
|
|
548
|
'#date_year_range' => $instance['widget']['settings']['year_range'],
|
|
549
|
'#date_label_position' => $instance['widget']['settings']['label_position'],
|
|
550
|
'#date_repeat_widget' => str_replace('_repeat', '', $instance['widget']['type']),
|
|
551
|
'#date_repeat_collapsed' => $instance['widget']['settings']['repeat_collapsed'],
|
|
552
|
'#date_flexible' => 0,
|
|
553
|
'#weight' => $instance['widget']['weight'] + .4,
|
|
554
|
);
|
|
555
|
}
|
|
556
|
}
|
|
557
|
|
|
558
|
/**
|
|
559
|
* Implements hook_date_combo_pre_validate_alter().
|
|
560
|
*/
|
|
561
|
function date_repeat_field_date_combo_pre_validate_alter(&$element, &$form_state, $context) {
|
|
562
|
// This hook lets us alter the element or the form_state before the rest of
|
|
563
|
// the date_combo validation gets fired.
|
|
564
|
// Just a placeholder for now.
|
|
565
|
}
|
|
566
|
|
|
567
|
/**
|
|
568
|
* Implements hook_field_info_alter().
|
|
569
|
*/
|
|
570
|
function date_repeat_field_field_info_alter(&$info) {
|
|
571
|
// This Field API hook lets us add a new setting to the fields.
|
|
572
|
$info['date']['settings'] += array(
|
|
573
|
'repeat' => 0,
|
|
574
|
);
|
|
575
|
$info['datetime']['settings'] += array(
|
|
576
|
'repeat' => 0,
|
|
577
|
);
|
|
578
|
$info['datestamp']['settings'] += array(
|
|
579
|
'repeat' => 0,
|
|
580
|
);
|
|
581
|
}
|
|
582
|
|
|
583
|
/**
|
|
584
|
* Implements hook_field_formatter_info_alter().
|
|
585
|
*/
|
|
586
|
function date_repeat_field_field_formatter_info_alter(&$info) {
|
|
587
|
// This hook lets us add settings to the formatters.
|
|
588
|
if (isset($info['date_default'])) {
|
|
589
|
$info['date_default']['settings'] += array(
|
|
590
|
'show_repeat_rule' => 'show',
|
|
591
|
);
|
|
592
|
}
|
|
593
|
}
|
|
594
|
|
|
595
|
/**
|
|
596
|
* Implements hook_field_widget_info_alter().
|
|
597
|
*/
|
|
598
|
function date_repeat_field_field_widget_info_alter(&$info) {
|
|
599
|
// This Field API hook lets us add a new setting to the widgets.
|
|
600
|
$info['date_text']['settings'] += array(
|
|
601
|
'repeat_collapsed' => 0,
|
|
602
|
);
|
|
603
|
$info['date_select']['settings'] += array(
|
|
604
|
'repeat_collapsed' => 0,
|
|
605
|
);
|
|
606
|
if (module_exists('date_popup')) {
|
|
607
|
$info['date_popup']['settings'] += array(
|
|
608
|
'repeat_collapsed' => 0,
|
|
609
|
);
|
|
610
|
}
|
|
611
|
}
|
|
612
|
|
|
613
|
/**
|
|
614
|
* Implements hook_date_field_settings_form_alter().
|
|
615
|
*/
|
|
616
|
function date_repeat_field_date_field_settings_form_alter(&$form, $context) {
|
|
617
|
// This hook lets us alter the field settings form.
|
|
618
|
$field = $context['field'];
|
|
619
|
$instance = $context['instance'];
|
|
620
|
$has_data = $context['has_data'];
|
|
621
|
|
|
622
|
$form['repeat'] = array(
|
|
623
|
'#type' => 'select',
|
|
624
|
'#title' => t('Repeating date'),
|
|
625
|
'#default_value' => $field['settings']['repeat'],
|
|
626
|
'#options' => array(0 => t('No'), 1 => t('Yes')),
|
|
627
|
'#attributes' => array('class' => array('container-inline')),
|
|
628
|
'#description' => t("Repeating dates use an 'Unlimited' number of values. Instead of the 'Add more' button, they include a form to select when and how often the date should repeat."),
|
|
629
|
'#disabled' => $has_data,
|
|
630
|
);
|
|
631
|
}
|
|
632
|
|
|
633
|
/**
|
|
634
|
* Implements hook_form_FORM_ID_alter() for field_ui_field_edit_form().
|
|
635
|
*/
|
|
636
|
function date_repeat_field_form_field_ui_field_edit_form_alter(&$form, &$form_state, $form_id) {
|
|
637
|
$field = $form['#field'];
|
|
638
|
$instance = $form['#instance'];
|
|
639
|
|
|
640
|
if (!in_array($field['type'], array('date', 'datetime', 'datestamp'))) {
|
|
641
|
return;
|
|
642
|
}
|
|
643
|
|
|
644
|
// If using repeating dates, override the Field module's handling of the
|
|
645
|
// multiple values option.
|
|
646
|
if (date_is_repeat_field($field, $instance)) {
|
|
647
|
$form['field']['cardinality']['#disabled'] = TRUE;
|
|
648
|
$form['field']['cardinality']['#value'] = FIELD_CARDINALITY_UNLIMITED;
|
|
649
|
}
|
|
650
|
// Repeating dates need unlimited values, confirm that in element_validate.
|
|
651
|
$form['field']['#element_validate'] = array('date_repeat_field_set_cardinality');
|
|
652
|
}
|
|
653
|
|
|
654
|
/**
|
|
655
|
* Ensure the cardinality is updated if the date can repeat.
|
|
656
|
*/
|
|
657
|
function date_repeat_field_set_cardinality($element, &$form_state) {
|
|
658
|
if (!empty($form_state['values']['field']['settings']['repeat'])) {
|
|
659
|
form_set_value($element['cardinality'], FIELD_CARDINALITY_UNLIMITED, $form_state);
|
|
660
|
}
|
|
661
|
}
|
|
662
|
|
|
663
|
/**
|
|
664
|
* Implements hook_date_field_instance_settings_form_alter().
|
|
665
|
*/
|
|
666
|
function date_repeat_field_date_field_instance_settings_form_alter(&$form, $context) {
|
|
667
|
// This hook lets us alter the field instance settings form. Just a
|
|
668
|
// placeholder for now.
|
|
669
|
}
|
|
670
|
|
|
671
|
/**
|
|
672
|
* Implements hook_date_field_widget_settings_form_alter().
|
|
673
|
*/
|
|
674
|
function date_repeat_field_date_field_widget_settings_form_alter(&$form, $context) {
|
|
675
|
// This hook lets us alter the field widget settings form.
|
|
676
|
$field = $context['field'];
|
|
677
|
$instance = $context['instance'];
|
|
678
|
|
|
679
|
if (date_is_repeat_field($field, $instance)) {
|
|
680
|
$form['repeat_collapsed'] = array(
|
|
681
|
'#type' => 'value',
|
|
682
|
'#default_value' => 1,
|
|
683
|
'#options' => array(
|
|
684
|
0 => t('Expanded', array(), array('context' => 'Date repeat')),
|
|
685
|
1 => t('Collapsed', array(), array('context' => 'Date repeat')),
|
|
686
|
),
|
|
687
|
'#title' => t('Repeat display', array(), array('context' => 'Date repeat')),
|
|
688
|
'#description' => t("Should the repeat options form start out expanded or collapsed? Set to 'Collapsed' to make those options less obtrusive.", array(), array('context' => 'Date repeat')),
|
|
689
|
'#fieldset' => 'date_format',
|
|
690
|
);
|
|
691
|
}
|
|
692
|
}
|
|
693
|
|
|
694
|
/**
|
|
695
|
* Implements hook_date_field_foramatter_settings_form_alter().
|
|
696
|
*/
|
|
697
|
function date_repeat_field_date_field_formatter_settings_form_alter(&$form, &$form_state, $context) {
|
|
698
|
// This hook lets us alter the field formatter settings form.
|
|
699
|
$field = $context['field'];
|
|
700
|
$instance = $context['instance'];
|
|
701
|
$view_mode = $context['view_mode'];
|
|
702
|
$display = $instance['display'][$view_mode];
|
|
703
|
$formatter = $display['type'];
|
|
704
|
$settings = $display['settings'];
|
|
705
|
if ($formatter == 'date_default') {
|
|
706
|
$form['show_repeat_rule'] = array(
|
|
707
|
'#title' => t('Repeat rule:'),
|
|
708
|
'#type' => 'select',
|
|
709
|
'#options' => array(
|
|
710
|
'show' => t('Show repeat rule'),
|
|
711
|
'hide' => t('Hide repeat rule')),
|
|
712
|
'#default_value' => $settings['show_repeat_rule'],
|
|
713
|
'#access' => $field['settings']['repeat'],
|
|
714
|
'#weight' => 5,
|
|
715
|
);
|
|
716
|
}
|
|
717
|
}
|
|
718
|
|
|
719
|
/**
|
|
720
|
* Implements hook_date_field_foramatter_settings_summary_alter().
|
|
721
|
*/
|
|
722
|
function date_repeat_field_date_field_formatter_settings_summary_alter(&$summary, $context) {
|
|
723
|
// This hook lets us alter the field formatter settings summary.
|
|
724
|
$field = $context['field'];
|
|
725
|
$instance = $context['instance'];
|
|
726
|
$view_mode = $context['view_mode'];
|
|
727
|
$display = $instance['display'][$view_mode];
|
|
728
|
$formatter = $display['type'];
|
|
729
|
$settings = $display['settings'];
|
|
730
|
if (isset($settings['show_repeat_rule']) && !empty($field['settings']['repeat'])) {
|
|
731
|
if ($settings['show_repeat_rule'] == 'show') {
|
|
732
|
$summary[] = t('Show repeat rule');
|
|
733
|
}
|
|
734
|
else {
|
|
735
|
$summary[] = t('Hide repeat rule');
|
|
736
|
}
|
|
737
|
}
|
|
738
|
}
|
