1 |
85ad3d82
|
Assos Assos
|
<?php
|
2 |
|
|
|
3 |
|
|
/**
|
4 |
|
|
* @file
|
5 |
|
|
* Date API elements themes and validation.
|
6 |
599a39cd
|
Assos Assos
|
*
|
7 |
85ad3d82
|
Assos Assos
|
* This file is only included during the edit process to reduce memory usage.
|
8 |
|
|
*/
|
9 |
|
|
|
10 |
|
|
/**
|
11 |
599a39cd
|
Assos Assos
|
* Wrapper for hook_element_info().
|
12 |
85ad3d82
|
Assos Assos
|
*
|
13 |
|
|
* Parameters for date form elements, designed to have sane defaults so any
|
14 |
|
|
* or all can be omitted.
|
15 |
|
|
*
|
16 |
|
|
* Fill the element #default_value with a date in datetime format,
|
17 |
|
|
* (YYYY-MM-DD HH:MM:SS), adjusted to the proper local timezone.
|
18 |
|
|
*
|
19 |
|
|
* NOTE - Converting a date stored in the database from UTC to the local zone
|
20 |
|
|
* and converting it back to UTC before storing it is not handled by this
|
21 |
|
|
* element and must be done in pre-form and post-form processing!!
|
22 |
|
|
*
|
23 |
|
|
* The date_select element will create a collection of form elements, with a
|
24 |
|
|
* separate select or textfield for each date part. The whole collection will
|
25 |
|
|
* get reformatted back to a date value of the requested type during validation.
|
26 |
|
|
*
|
27 |
|
|
* The date_text element will create a textfield that can contain a whole
|
28 |
|
|
* date or any part of a date as text. The user input value will be re-formatted
|
29 |
|
|
* back into a date value of the requested type during validation.
|
30 |
|
|
*
|
31 |
|
|
* The date_timezone element will create a drop-down selector to pick a
|
32 |
|
|
* timezone name.
|
33 |
|
|
*
|
34 |
|
|
* The date_year_range element will create two textfields (for users with
|
35 |
|
|
* JavaScript enabled they will appear as drop-down selectors with an option
|
36 |
|
|
* for custom text entry) to pick a range of years that will be passed to form
|
37 |
|
|
* submit handlers as a single string (e.g., -3:+3).
|
38 |
|
|
*
|
39 |
|
|
* #date_timezone
|
40 |
|
|
* The local timezone to be used to create this date.
|
41 |
|
|
*
|
42 |
|
|
* #date_format
|
43 |
|
|
* A format string that describes the format and order of date parts to
|
44 |
|
|
* display in the edit form for this element. This makes it possible
|
45 |
|
|
* to show date parts in a custom order, or to leave some of them out.
|
46 |
|
|
* Be sure to add 'A' or 'a' to get an am/pm selector. Defaults to the
|
47 |
|
|
* short site default format.
|
48 |
|
|
*
|
49 |
|
|
* #date_label_position
|
50 |
|
|
* Handling option for date part labels, like 'Year', 'Month', and 'Day',
|
51 |
|
|
* can be 'above' the date part, 'within' it, or 'none', default is 'above' .
|
52 |
|
|
* The 'within' option shows the label as the first option in a select list
|
53 |
|
|
* or the default value for an empty textfield, taking up less screen space.
|
54 |
|
|
*
|
55 |
|
|
* #date_increment
|
56 |
|
|
* Increment minutes and seconds by this amount, default is 1.
|
57 |
|
|
*
|
58 |
|
|
* #date_year_range
|
59 |
|
|
* The number of years to go back and forward in a year selector,
|
60 |
|
|
* default is -3:+3 (3 back and 3 forward).
|
61 |
|
|
*
|
62 |
|
|
* #date_text_parts
|
63 |
|
|
* Array of date parts that should use textfields instead of selects
|
64 |
|
|
* i.e. array('year') will format the year as a textfield and other
|
65 |
|
|
* date parts as drop-down selects.
|
66 |
|
|
*/
|
67 |
|
|
function _date_api_element_info() {
|
68 |
|
|
$date_base = array(
|
69 |
599a39cd
|
Assos Assos
|
'#input' => TRUE,
|
70 |
|
|
'#tree' => TRUE,
|
71 |
85ad3d82
|
Assos Assos
|
'#date_timezone' => date_default_timezone(),
|
72 |
|
|
'#date_flexible' => 0,
|
73 |
|
|
'#date_format' => variable_get('date_format_short', 'm/d/Y - H:i'),
|
74 |
|
|
'#date_text_parts' => array(),
|
75 |
|
|
'#date_increment' => 1,
|
76 |
|
|
'#date_year_range' => '-3:+3',
|
77 |
|
|
'#date_label_position' => 'above',
|
78 |
|
|
);
|
79 |
|
|
if (module_exists('ctools')) {
|
80 |
|
|
$date_base['#pre_render'] = array('ctools_dependent_pre_render');
|
81 |
|
|
}
|
82 |
|
|
$type['date_select'] = array_merge($date_base, array(
|
83 |
|
|
'#process' => array('date_select_element_process'),
|
84 |
|
|
'#theme_wrappers' => array('date_select'),
|
85 |
|
|
'#value_callback' => 'date_select_element_value_callback',
|
86 |
|
|
));
|
87 |
|
|
$type['date_text'] = array_merge($date_base, array(
|
88 |
|
|
'#process' => array('date_text_element_process'),
|
89 |
|
|
'#theme_wrappers' => array('date_text'),
|
90 |
|
|
'#value_callback' => 'date_text_element_value_callback',
|
91 |
|
|
));
|
92 |
|
|
$type['date_timezone'] = array(
|
93 |
599a39cd
|
Assos Assos
|
'#input' => TRUE,
|
94 |
|
|
'#tree' => TRUE,
|
95 |
85ad3d82
|
Assos Assos
|
'#process' => array('date_timezone_element_process'),
|
96 |
|
|
'#theme_wrappers' => array('date_text'),
|
97 |
|
|
'#value_callback' => 'date_timezone_element_value_callback',
|
98 |
|
|
);
|
99 |
|
|
$type['date_year_range'] = array(
|
100 |
|
|
'#input' => TRUE,
|
101 |
|
|
'#process' => array('date_year_range_element_process'),
|
102 |
|
|
'#value_callback' => 'date_year_range_element_value_callback',
|
103 |
|
|
'#element_validate' => array('date_year_range_validate'),
|
104 |
|
|
);
|
105 |
|
|
return $type;
|
106 |
|
|
}
|
107 |
|
|
|
108 |
|
|
/**
|
109 |
|
|
* Create a date object from a datetime string value.
|
110 |
|
|
*/
|
111 |
599a39cd
|
Assos Assos
|
function date_default_date(array $element) {
|
112 |
85ad3d82
|
Assos Assos
|
$granularity = date_format_order($element['#date_format']);
|
113 |
|
|
$default_value = $element['#default_value'];
|
114 |
|
|
$format = DATE_FORMAT_DATETIME;
|
115 |
|
|
|
116 |
|
|
// The text and popup widgets might return less than a full datetime string.
|
117 |
ee46a8ed
|
Assos Assos
|
if (is_string($element['#default_value']) && strlen($element['#default_value']) < 19) {
|
118 |
85ad3d82
|
Assos Assos
|
switch (strlen($element['#default_value'])) {
|
119 |
|
|
case 16:
|
120 |
|
|
$format = 'Y-m-d H:i';
|
121 |
|
|
break;
|
122 |
b720ea3e
|
Assos Assos
|
|
123 |
85ad3d82
|
Assos Assos
|
case 13:
|
124 |
|
|
$format = 'Y-m-d H';
|
125 |
|
|
break;
|
126 |
b720ea3e
|
Assos Assos
|
|
127 |
85ad3d82
|
Assos Assos
|
case 10:
|
128 |
|
|
$format = 'Y-m-d';
|
129 |
|
|
break;
|
130 |
b720ea3e
|
Assos Assos
|
|
131 |
85ad3d82
|
Assos Assos
|
case 7:
|
132 |
|
|
$format = 'Y-m';
|
133 |
|
|
break;
|
134 |
b720ea3e
|
Assos Assos
|
|
135 |
85ad3d82
|
Assos Assos
|
case 4:
|
136 |
|
|
$format = 'Y';
|
137 |
|
|
break;
|
138 |
|
|
}
|
139 |
|
|
}
|
140 |
|
|
$date = new DateObject($default_value, $element['#date_timezone'], $format);
|
141 |
|
|
if (is_object($date)) {
|
142 |
|
|
$date->limitGranularity($granularity);
|
143 |
|
|
if ($date->validGranularity($granularity, $element['#date_flexible'])) {
|
144 |
|
|
date_increment_round($date, $element['#date_increment']);
|
145 |
|
|
}
|
146 |
|
|
return $date;
|
147 |
|
|
}
|
148 |
|
|
return NULL;
|
149 |
|
|
}
|
150 |
|
|
|
151 |
|
|
/**
|
152 |
|
|
* Process callback which creates a date_year_range form element.
|
153 |
|
|
*/
|
154 |
|
|
function date_year_range_element_process($element, &$form_state, $form) {
|
155 |
|
|
// Year range is stored in the -3:+3 format, but collected as two separate
|
156 |
|
|
// textfields.
|
157 |
|
|
$element['years_back'] = array(
|
158 |
|
|
'#type' => 'textfield',
|
159 |
|
|
'#title' => t('Starting year'),
|
160 |
|
|
'#default_value' => $element['#value']['years_back'],
|
161 |
|
|
'#size' => 10,
|
162 |
|
|
'#maxsize' => 10,
|
163 |
|
|
'#attributes' => array('class' => array('select-list-with-custom-option', 'back')),
|
164 |
|
|
'#description' => t('Enter a relative value (-9, +9) or an absolute year such as 2015.'),
|
165 |
|
|
);
|
166 |
|
|
$element['years_forward'] = array(
|
167 |
|
|
'#type' => 'textfield',
|
168 |
|
|
'#title' => t('Ending year'),
|
169 |
|
|
'#default_value' => $element['#value']['years_forward'],
|
170 |
|
|
'#size' => 10,
|
171 |
|
|
'#maxsize' => 10,
|
172 |
|
|
'#attributes' => array('class' => array('select-list-with-custom-option', 'forward')),
|
173 |
|
|
'#description' => t('Enter a relative value (-9, +9) or an absolute year such as 2015.'),
|
174 |
|
|
);
|
175 |
|
|
|
176 |
|
|
$element['#tree'] = TRUE;
|
177 |
|
|
$element['#attached']['js'][] = drupal_get_path('module', 'date_api') . '/date_year_range.js';
|
178 |
|
|
|
179 |
|
|
$context = array(
|
180 |
b720ea3e
|
Assos Assos
|
'form' => $form,
|
181 |
85ad3d82
|
Assos Assos
|
);
|
182 |
|
|
drupal_alter('date_year_range_process', $element, $form_state, $context);
|
183 |
|
|
|
184 |
|
|
return $element;
|
185 |
|
|
}
|
186 |
|
|
|
187 |
|
|
/**
|
188 |
|
|
* Element value callback for the date_year_range form element.
|
189 |
|
|
*/
|
190 |
|
|
function date_year_range_element_value_callback($element, $input = FALSE, &$form_state = array()) {
|
191 |
|
|
// Convert the element's default value from a string to an array (to match
|
192 |
|
|
// what we will get from the two textfields when the form is submitted).
|
193 |
|
|
if ($input === FALSE) {
|
194 |
|
|
list($years_back, $years_forward) = explode(':', $element['#default_value']);
|
195 |
|
|
return array(
|
196 |
|
|
'years_back' => $years_back,
|
197 |
|
|
'years_forward' => $years_forward,
|
198 |
|
|
);
|
199 |
|
|
}
|
200 |
|
|
}
|
201 |
|
|
|
202 |
|
|
/**
|
203 |
|
|
* Element validation function for the date_year_range form element.
|
204 |
|
|
*/
|
205 |
|
|
function date_year_range_validate(&$element, &$form_state) {
|
206 |
|
|
// Recombine the two submitted form values into the -3:+3 format we will
|
207 |
|
|
// validate and save.
|
208 |
|
|
$year_range_submitted = drupal_array_get_nested_value($form_state['values'], $element['#parents']);
|
209 |
|
|
$year_range = $year_range_submitted['years_back'] . ':' . $year_range_submitted['years_forward'];
|
210 |
|
|
drupal_array_set_nested_value($form_state['values'], $element['#parents'], $year_range);
|
211 |
|
|
if (!date_range_valid($year_range)) {
|
212 |
|
|
form_error($element['years_back'], t('Starting year must be in the format -9, or an absolute year such as 1980.'));
|
213 |
|
|
form_error($element['years_forward'], t('Ending year must be in the format +9, or an absolute year such as 2030.'));
|
214 |
|
|
}
|
215 |
|
|
}
|
216 |
|
|
|
217 |
|
|
/**
|
218 |
|
|
* Element value callback for date_timezone element.
|
219 |
|
|
*/
|
220 |
|
|
function date_timezone_element_value_callback($element, $input = FALSE, &$form_state = array()) {
|
221 |
|
|
$return = '';
|
222 |
|
|
if ($input !== FALSE) {
|
223 |
|
|
$return = $input;
|
224 |
|
|
}
|
225 |
|
|
elseif (!empty($element['#default_value'])) {
|
226 |
|
|
$return = array('timezone' => $element['#default_value']);
|
227 |
|
|
}
|
228 |
|
|
return $return;
|
229 |
|
|
}
|
230 |
|
|
|
231 |
|
|
/**
|
232 |
|
|
* Creates a timezone form element.
|
233 |
|
|
*
|
234 |
|
|
* @param array $element
|
235 |
|
|
* The timezone form element.
|
236 |
|
|
*
|
237 |
|
|
* @return array
|
238 |
|
|
* the timezone form element
|
239 |
|
|
*/
|
240 |
|
|
function date_timezone_element_process($element, &$form_state, $form) {
|
241 |
|
|
if (date_hidden_element($element)) {
|
242 |
|
|
return $element;
|
243 |
|
|
}
|
244 |
|
|
|
245 |
|
|
$element['#tree'] = TRUE;
|
246 |
|
|
$label = theme('date_part_label_timezone', array('part_type' => 'select', 'element' => $element));
|
247 |
|
|
$element['timezone'] = array(
|
248 |
|
|
'#type' => 'select',
|
249 |
|
|
'#title' => $label,
|
250 |
|
|
'#title_display' => $element['#date_label_position'] == 'above' ? 'before' : 'invisible',
|
251 |
|
|
'#options' => date_timezone_names($element['#required']),
|
252 |
|
|
'#value' => $element['#value'],
|
253 |
|
|
'#weight' => $element['#weight'],
|
254 |
|
|
'#required' => $element['#required'],
|
255 |
|
|
'#theme' => 'date_select_element',
|
256 |
|
|
'#theme_wrappers' => array('form_element'),
|
257 |
|
|
);
|
258 |
|
|
if (isset($element['#element_validate'])) {
|
259 |
|
|
array_push($element['#element_validate'], 'date_timezone_validate');
|
260 |
|
|
}
|
261 |
|
|
else {
|
262 |
|
|
$element['#element_validate'] = array('date_timezone_validate');
|
263 |
|
|
}
|
264 |
|
|
|
265 |
|
|
$context = array(
|
266 |
b720ea3e
|
Assos Assos
|
'form' => $form,
|
267 |
85ad3d82
|
Assos Assos
|
);
|
268 |
|
|
drupal_alter('date_timezone_process', $element, $form_state, $context);
|
269 |
|
|
|
270 |
|
|
return $element;
|
271 |
|
|
}
|
272 |
|
|
|
273 |
|
|
/**
|
274 |
b720ea3e
|
Assos Assos
|
* Validation for timezone input.
|
275 |
85ad3d82
|
Assos Assos
|
*
|
276 |
599a39cd
|
Assos Assos
|
* Move the timezone value from the nested field back to the original field.
|
277 |
85ad3d82
|
Assos Assos
|
*/
|
278 |
|
|
function date_timezone_validate($element, &$form_state) {
|
279 |
|
|
if (date_hidden_element($element)) {
|
280 |
|
|
return;
|
281 |
|
|
}
|
282 |
|
|
|
283 |
|
|
form_set_value($element, $element['#value']['timezone'], $form_state);
|
284 |
|
|
}
|
285 |
|
|
|
286 |
|
|
/**
|
287 |
|
|
* Element value callback for date_text element.
|
288 |
|
|
*/
|
289 |
|
|
function date_text_element_value_callback($element, $input = FALSE, &$form_state = array()) {
|
290 |
|
|
$return = array('date' => '');
|
291 |
|
|
$date = NULL;
|
292 |
|
|
|
293 |
599a39cd
|
Assos Assos
|
// Normal input from submitting the form element. Check is_array() to skip
|
294 |
|
|
// the string input values created by Views pagers. Those string values, if
|
295 |
|
|
// present, should be interpreted as empty input.
|
296 |
|
|
if ($input !== FALSE && is_array($input) && !is_null($input['date'])) {
|
297 |
85ad3d82
|
Assos Assos
|
$return = $input;
|
298 |
|
|
$date = date_text_input_date($element, $input);
|
299 |
|
|
}
|
300 |
|
|
// No input? Try the default value.
|
301 |
|
|
elseif (!empty($element['#default_value'])) {
|
302 |
|
|
$date = date_default_date($element);
|
303 |
|
|
}
|
304 |
|
|
if (date_is_date($date)) {
|
305 |
|
|
$return['date'] = date_format_date($date, 'custom', $element['#date_format']);
|
306 |
|
|
}
|
307 |
|
|
return $return;
|
308 |
|
|
}
|
309 |
|
|
|
310 |
|
|
/**
|
311 |
|
|
* Text date input form.
|
312 |
|
|
*
|
313 |
|
|
* Display all or part of a date in a single textfield.
|
314 |
|
|
*
|
315 |
599a39cd
|
Assos Assos
|
* The exact parts displayed in the field are those in #date_granularity. The
|
316 |
|
|
* display of each part comes from #date_format.
|
317 |
85ad3d82
|
Assos Assos
|
*/
|
318 |
|
|
function date_text_element_process($element, &$form_state, $form) {
|
319 |
|
|
if (date_hidden_element($element)) {
|
320 |
|
|
return $element;
|
321 |
|
|
}
|
322 |
|
|
|
323 |
|
|
$element['#tree'] = TRUE;
|
324 |
|
|
$element['#theme_wrappers'] = array('date_text');
|
325 |
ee46a8ed
|
Assos Assos
|
$element['date']['#value'] = isset($element['#value']['date']) ? $element['#value']['date'] : '';
|
326 |
85ad3d82
|
Assos Assos
|
$element['date']['#type'] = 'textfield';
|
327 |
|
|
$element['date']['#weight'] = !empty($element['date']['#weight']) ? $element['date']['#weight'] : $element['#weight'];
|
328 |
|
|
$element['date']['#attributes'] = array('class' => isset($element['#attributes']['class']) ? $element['#attributes']['class'] += array('date-date') : array('date-date'));
|
329 |
|
|
$now = date_example_date();
|
330 |
|
|
$element['date']['#title'] = t('Date');
|
331 |
|
|
$element['date']['#title_display'] = 'invisible';
|
332 |
599a39cd
|
Assos Assos
|
$date_args = array(
|
333 |
|
|
'@date' => date_format_date(date_example_date(), 'custom', $element['#date_format']),
|
334 |
|
|
);
|
335 |
|
|
$element['date']['#description'] = ' ' . t('Format: @date', $date_args);
|
336 |
85ad3d82
|
Assos Assos
|
$element['date']['#ajax'] = !empty($element['#ajax']) ? $element['#ajax'] : FALSE;
|
337 |
|
|
|
338 |
b720ea3e
|
Assos Assos
|
// Make changes if instance is set to be rendered as a regular field.
|
339 |
|
|
if (!empty($element['#instance']['widget']['settings']['no_fieldset']) && $element['#field']['cardinality'] == 1) {
|
340 |
|
|
$element['date']['#title'] = check_plain($element['#instance']['label']);
|
341 |
|
|
$element['date']['#title_display'] = $element['#title_display'];
|
342 |
|
|
$element['date']['#required'] = $element['#required'];
|
343 |
|
|
}
|
344 |
|
|
|
345 |
599a39cd
|
Assos Assos
|
// Keep the system from creating an error message for the sub-element. We'll
|
346 |
|
|
// set our own message on the parent element.
|
347 |
85ad3d82
|
Assos Assos
|
$element['date']['#theme'] = 'date_textfield_element';
|
348 |
|
|
if (isset($element['#element_validate'])) {
|
349 |
|
|
array_push($element['#element_validate'], 'date_text_validate');
|
350 |
|
|
}
|
351 |
|
|
else {
|
352 |
|
|
$element['#element_validate'] = array('date_text_validate');
|
353 |
|
|
}
|
354 |
|
|
if (!empty($element['#force_value'])) {
|
355 |
|
|
$element['date']['#value'] = $element['date']['#default_value'];
|
356 |
|
|
}
|
357 |
|
|
|
358 |
|
|
$context = array(
|
359 |
b720ea3e
|
Assos Assos
|
'form' => $form,
|
360 |
85ad3d82
|
Assos Assos
|
);
|
361 |
|
|
drupal_alter('date_text_process', $element, $form_state, $context);
|
362 |
|
|
|
363 |
|
|
return $element;
|
364 |
|
|
}
|
365 |
|
|
|
366 |
|
|
/**
|
367 |
b720ea3e
|
Assos Assos
|
* Validation for text input.
|
368 |
85ad3d82
|
Assos Assos
|
*
|
369 |
599a39cd
|
Assos Assos
|
* When used as a Views widget, the validation step always gets triggered, even
|
370 |
|
|
* with no form submission. Before form submission $element['#value'] contains a
|
371 |
|
|
* string, after submission it contains an array.
|
372 |
85ad3d82
|
Assos Assos
|
*/
|
373 |
|
|
function date_text_validate($element, &$form_state) {
|
374 |
|
|
if (date_hidden_element($element)) {
|
375 |
|
|
return;
|
376 |
|
|
}
|
377 |
|
|
|
378 |
|
|
if (is_string($element['#value'])) {
|
379 |
|
|
return;
|
380 |
|
|
}
|
381 |
|
|
$input_exists = NULL;
|
382 |
|
|
$input = drupal_array_get_nested_value($form_state['values'], $element['#parents'], $input_exists);
|
383 |
|
|
|
384 |
b720ea3e
|
Assos Assos
|
// Trim extra spacing off user input of text fields.
|
385 |
|
|
if (isset($input['date'])) {
|
386 |
|
|
$input['date'] = trim($input['date']);
|
387 |
|
|
}
|
388 |
|
|
|
389 |
85ad3d82
|
Assos Assos
|
drupal_alter('date_text_pre_validate', $element, $form_state, $input);
|
390 |
|
|
|
391 |
|
|
$label = !empty($element['#date_title']) ? $element['#date_title'] : (!empty($element['#title']) ? $element['#title'] : '');
|
392 |
|
|
$date = date_text_input_date($element, $input);
|
393 |
|
|
|
394 |
599a39cd
|
Assos Assos
|
// If the field has errors, display them. If something was input but there is
|
395 |
|
|
// no date, the date is invalid. If the field is empty and required, set
|
396 |
|
|
// error message and return.
|
397 |
85ad3d82
|
Assos Assos
|
$error_field = implode('][', $element['#parents']);
|
398 |
|
|
if (empty($date) || !empty($date->errors)) {
|
399 |
|
|
if (is_object($date) && !empty($date->errors)) {
|
400 |
|
|
$message = t('The value input for field %field is invalid:', array('%field' => $label));
|
401 |
|
|
$message .= '<br />' . implode('<br />', $date->errors);
|
402 |
|
|
form_set_error($error_field, $message);
|
403 |
|
|
return;
|
404 |
|
|
}
|
405 |
|
|
if (!empty($element['#required'])) {
|
406 |
|
|
$message = t('A valid date is required for %title.', array('%title' => $label));
|
407 |
|
|
form_set_error($error_field, $message);
|
408 |
|
|
return;
|
409 |
|
|
}
|
410 |
|
|
// Fall through, some other error.
|
411 |
|
|
if (!empty($input['date'])) {
|
412 |
|
|
form_error($element, t('%title is invalid.', array('%title' => $label)));
|
413 |
|
|
return;
|
414 |
|
|
}
|
415 |
|
|
}
|
416 |
|
|
$value = !empty($date) ? $date->format(DATE_FORMAT_DATETIME) : NULL;
|
417 |
|
|
form_set_value($element, $value, $form_state);
|
418 |
|
|
}
|
419 |
|
|
|
420 |
|
|
/**
|
421 |
|
|
* Helper function for creating a date object out of user input.
|
422 |
|
|
*/
|
423 |
|
|
function date_text_input_date($element, $input) {
|
424 |
|
|
if (empty($input) || !is_array($input) || !array_key_exists('date', $input) || empty($input['date'])) {
|
425 |
|
|
return NULL;
|
426 |
|
|
}
|
427 |
|
|
$granularity = date_format_order($element['#date_format']);
|
428 |
|
|
$date = new DateObject($input['date'], $element['#date_timezone'], $element['#date_format']);
|
429 |
|
|
if (is_object($date)) {
|
430 |
|
|
$date->limitGranularity($granularity);
|
431 |
|
|
if ($date->validGranularity($granularity, $element['#date_flexible'])) {
|
432 |
|
|
date_increment_round($date, $element['#date_increment']);
|
433 |
|
|
}
|
434 |
|
|
return $date;
|
435 |
|
|
}
|
436 |
|
|
return NULL;
|
437 |
|
|
}
|
438 |
|
|
|
439 |
|
|
/**
|
440 |
|
|
* Element value callback for date_select element.
|
441 |
|
|
*/
|
442 |
|
|
function date_select_element_value_callback($element, $input = FALSE, &$form_state = array()) {
|
443 |
b720ea3e
|
Assos Assos
|
$return = array(
|
444 |
|
|
'year' => '',
|
445 |
|
|
'month' => '',
|
446 |
|
|
'day' => '',
|
447 |
|
|
'hour' => '',
|
448 |
|
|
'minute' => '',
|
449 |
|
|
'second' => '',
|
450 |
|
|
);
|
451 |
85ad3d82
|
Assos Assos
|
$date = NULL;
|
452 |
|
|
if ($input !== FALSE) {
|
453 |
|
|
$return = $input;
|
454 |
|
|
$date = date_select_input_date($element, $input);
|
455 |
|
|
}
|
456 |
|
|
elseif (!empty($element['#default_value'])) {
|
457 |
|
|
$date = date_default_date($element);
|
458 |
|
|
}
|
459 |
|
|
$granularity = date_format_order($element['#date_format']);
|
460 |
b720ea3e
|
Assos Assos
|
$formats = array(
|
461 |
|
|
'year' => 'Y',
|
462 |
|
|
'month' => 'n',
|
463 |
|
|
'day' => 'j',
|
464 |
|
|
'hour' => 'H',
|
465 |
|
|
'minute' => 'i',
|
466 |
|
|
'second' => 's',
|
467 |
|
|
);
|
468 |
85ad3d82
|
Assos Assos
|
foreach ($granularity as $field) {
|
469 |
|
|
if ($field != 'timezone') {
|
470 |
599a39cd
|
Assos Assos
|
if (date_is_date($date)) {
|
471 |
|
|
$return[$field] = $date->format($formats[$field]);
|
472 |
|
|
}
|
473 |
|
|
else {
|
474 |
|
|
$return = array();
|
475 |
|
|
}
|
476 |
85ad3d82
|
Assos Assos
|
}
|
477 |
|
|
}
|
478 |
|
|
return $return;
|
479 |
|
|
}
|
480 |
|
|
|
481 |
|
|
/**
|
482 |
|
|
* Flexible date/time drop-down selector.
|
483 |
|
|
*
|
484 |
|
|
* Splits date into a collection of date and time sub-elements, one
|
485 |
|
|
* for each date part. Each sub-element can be either a textfield or a
|
486 |
|
|
* select, based on the value of ['#date_settings']['text_fields'].
|
487 |
|
|
*
|
488 |
|
|
* The exact parts displayed in the field are those in #date_granularity.
|
489 |
|
|
* The display of each part comes from ['#date_settings']['format'].
|
490 |
|
|
*/
|
491 |
|
|
function date_select_element_process($element, &$form_state, $form) {
|
492 |
|
|
if (date_hidden_element($element)) {
|
493 |
|
|
return $element;
|
494 |
|
|
}
|
495 |
|
|
|
496 |
|
|
$date = NULL;
|
497 |
|
|
$granularity = date_format_order($element['#date_format']);
|
498 |
|
|
|
499 |
599a39cd
|
Assos Assos
|
if (array_key_exists('#default_value', $element) && is_array($element['#default_value'])) {
|
500 |
85ad3d82
|
Assos Assos
|
$date = date_select_input_date($element, $element['#default_value']);
|
501 |
|
|
}
|
502 |
|
|
elseif (!empty($element['#default_value'])) {
|
503 |
|
|
$date = date_default_date($element);
|
504 |
|
|
}
|
505 |
|
|
|
506 |
|
|
$element['#tree'] = TRUE;
|
507 |
|
|
$element['#theme_wrappers'] = array('date_select');
|
508 |
|
|
|
509 |
|
|
$element += (array) date_parts_element($element, $date, $element['#date_format']);
|
510 |
|
|
|
511 |
|
|
// Store a hidden value for all date parts not in the current display.
|
512 |
|
|
$granularity = date_format_order($element['#date_format']);
|
513 |
b720ea3e
|
Assos Assos
|
$formats = array(
|
514 |
|
|
'year' => 'Y',
|
515 |
|
|
'month' => 'n',
|
516 |
|
|
'day' => 'j',
|
517 |
|
|
'hour' => 'H',
|
518 |
|
|
'minute' => 'i',
|
519 |
|
|
'second' => 's',
|
520 |
|
|
);
|
521 |
85ad3d82
|
Assos Assos
|
foreach (date_nongranularity($granularity) as $field) {
|
522 |
|
|
if ($field != 'timezone') {
|
523 |
|
|
$element[$field] = array(
|
524 |
|
|
'#type' => 'value',
|
525 |
|
|
'#value' => 0,
|
526 |
|
|
);
|
527 |
|
|
}
|
528 |
|
|
}
|
529 |
|
|
if (isset($element['#element_validate'])) {
|
530 |
|
|
array_push($element['#element_validate'], 'date_select_validate');
|
531 |
|
|
}
|
532 |
|
|
else {
|
533 |
|
|
$element['#element_validate'] = array('date_select_validate');
|
534 |
|
|
}
|
535 |
|
|
|
536 |
|
|
$context = array(
|
537 |
b720ea3e
|
Assos Assos
|
'form' => $form,
|
538 |
85ad3d82
|
Assos Assos
|
);
|
539 |
|
|
drupal_alter('date_select_process', $element, $form_state, $context);
|
540 |
|
|
|
541 |
|
|
return $element;
|
542 |
|
|
}
|
543 |
|
|
|
544 |
|
|
/**
|
545 |
|
|
* Creates form elements for one or more date parts.
|
546 |
|
|
*
|
547 |
599a39cd
|
Assos Assos
|
* Get the order of date elements from the provided format. If the format order
|
548 |
|
|
* omits any date parts in the granularity, alter the granularity array to match
|
549 |
|
|
* the format, then flip the $order array to get the position for each element.
|
550 |
|
|
* Then iterate through the elements and create a sub-form for each part.
|
551 |
85ad3d82
|
Assos Assos
|
*
|
552 |
|
|
* @param array $element
|
553 |
|
|
* The date element.
|
554 |
|
|
* @param object $date
|
555 |
|
|
* The date object.
|
556 |
|
|
* @param string $format
|
557 |
|
|
* A date format string.
|
558 |
|
|
*
|
559 |
|
|
* @return array
|
560 |
|
|
* The form array for the submitted date parts.
|
561 |
|
|
*/
|
562 |
599a39cd
|
Assos Assos
|
function date_parts_element(array $element, $date, $format) {
|
563 |
85ad3d82
|
Assos Assos
|
$granularity = date_format_order($format);
|
564 |
|
|
$sub_element = array('#granularity' => $granularity);
|
565 |
|
|
$order = array_flip($granularity);
|
566 |
|
|
|
567 |
599a39cd
|
Assos Assos
|
$hours_format = strpos(strtolower($element['#date_format']), 'a') ? 'g' : 'G';
|
568 |
|
|
$month_function = strpos($element['#date_format'], 'F') !== FALSE ? 'date_month_names' : 'date_month_names_abbr';
|
569 |
85ad3d82
|
Assos Assos
|
$count = 0;
|
570 |
|
|
$increment = min(intval($element['#date_increment']), 1);
|
571 |
|
|
|
572 |
|
|
// Allow empty value as option if date is not required or there is no date.
|
573 |
|
|
$part_required = (bool) $element['#required'] && is_object($date);
|
574 |
|
|
foreach ($granularity as $field) {
|
575 |
|
|
$part_type = in_array($field, $element['#date_text_parts']) ? 'textfield' : 'select';
|
576 |
|
|
$sub_element[$field] = array(
|
577 |
|
|
'#weight' => $order[$field],
|
578 |
|
|
'#required' => $part_required,
|
579 |
|
|
'#attributes' => array('class' => isset($element['#attributes']['class']) ? $element['#attributes']['class'] += array('date-' . $field) : array('date-' . $field)),
|
580 |
|
|
'#ajax' => !empty($element['#ajax']) ? $element['#ajax'] : FALSE,
|
581 |
|
|
);
|
582 |
|
|
switch ($field) {
|
583 |
|
|
case 'year':
|
584 |
|
|
$range = date_range_years($element['#date_year_range'], $date);
|
585 |
b720ea3e
|
Assos Assos
|
$start_year = $range[0];
|
586 |
|
|
$end_year = $range[1];
|
587 |
85ad3d82
|
Assos Assos
|
|
588 |
|
|
$sub_element[$field]['#default_value'] = is_object($date) ? $date->format('Y') : '';
|
589 |
|
|
if ($part_type == 'select') {
|
590 |
b720ea3e
|
Assos Assos
|
$sub_element[$field]['#options'] = drupal_map_assoc(date_years($start_year, $end_year, $part_required));
|
591 |
85ad3d82
|
Assos Assos
|
}
|
592 |
|
|
break;
|
593 |
b720ea3e
|
Assos Assos
|
|
594 |
85ad3d82
|
Assos Assos
|
case 'month':
|
595 |
|
|
$sub_element[$field]['#default_value'] = is_object($date) ? $date->format('n') : '';
|
596 |
|
|
if ($part_type == 'select') {
|
597 |
|
|
$sub_element[$field]['#options'] = $month_function($part_required);
|
598 |
|
|
}
|
599 |
|
|
break;
|
600 |
b720ea3e
|
Assos Assos
|
|
601 |
85ad3d82
|
Assos Assos
|
case 'day':
|
602 |
|
|
$sub_element[$field]['#default_value'] = is_object($date) ? $date->format('j') : '';
|
603 |
|
|
if ($part_type == 'select') {
|
604 |
|
|
$sub_element[$field]['#options'] = drupal_map_assoc(date_days($part_required));
|
605 |
|
|
}
|
606 |
|
|
break;
|
607 |
b720ea3e
|
Assos Assos
|
|
608 |
85ad3d82
|
Assos Assos
|
case 'hour':
|
609 |
|
|
$sub_element[$field]['#default_value'] = is_object($date) ? $date->format($hours_format) : '';
|
610 |
|
|
if ($part_type == 'select') {
|
611 |
|
|
$sub_element[$field]['#options'] = drupal_map_assoc(date_hours($hours_format, $part_required));
|
612 |
|
|
}
|
613 |
|
|
$sub_element[$field]['#prefix'] = theme('date_part_hour_prefix', $element);
|
614 |
|
|
break;
|
615 |
b720ea3e
|
Assos Assos
|
|
616 |
85ad3d82
|
Assos Assos
|
case 'minute':
|
617 |
|
|
$sub_element[$field]['#default_value'] = is_object($date) ? $date->format('i') : '';
|
618 |
|
|
if ($part_type == 'select') {
|
619 |
|
|
$sub_element[$field]['#options'] = drupal_map_assoc(date_minutes('i', $part_required, $element['#date_increment']));
|
620 |
|
|
}
|
621 |
|
|
$sub_element[$field]['#prefix'] = theme('date_part_minsec_prefix', $element);
|
622 |
|
|
break;
|
623 |
b720ea3e
|
Assos Assos
|
|
624 |
85ad3d82
|
Assos Assos
|
case 'second':
|
625 |
|
|
$sub_element[$field]['#default_value'] = is_object($date) ? $date->format('s') : '';
|
626 |
|
|
if ($part_type == 'select') {
|
627 |
|
|
$sub_element[$field]['#options'] = drupal_map_assoc(date_seconds('s', $part_required, $element['#date_increment']));
|
628 |
|
|
}
|
629 |
|
|
$sub_element[$field]['#prefix'] = theme('date_part_minsec_prefix', $element);
|
630 |
|
|
break;
|
631 |
|
|
}
|
632 |
|
|
|
633 |
|
|
// Add handling for the date part label.
|
634 |
|
|
$label = theme('date_part_label_' . $field, array('part_type' => $part_type, 'element' => $element));
|
635 |
|
|
if (in_array($field, $element['#date_text_parts'])) {
|
636 |
|
|
$sub_element[$field]['#type'] = 'textfield';
|
637 |
|
|
$sub_element[$field]['#theme'] = 'date_textfield_element';
|
638 |
|
|
$sub_element[$field]['#size'] = 7;
|
639 |
|
|
$sub_element[$field]['#title'] = $label;
|
640 |
|
|
$sub_element[$field]['#title_display'] = in_array($element['#date_label_position'], array('within', 'none')) ? 'invisible' : 'before';
|
641 |
|
|
if ($element['#date_label_position'] == 'within') {
|
642 |
|
|
if (!empty($sub_element[$field]['#options']) && is_array($sub_element[$field]['#options'])) {
|
643 |
|
|
$sub_element[$field]['#options'] = array(
|
644 |
599a39cd
|
Assos Assos
|
'-' . $label => '-' . $label,
|
645 |
|
|
) + $sub_element[$field]['#options'];
|
646 |
85ad3d82
|
Assos Assos
|
}
|
647 |
|
|
if (empty($sub_element[$field]['#default_value'])) {
|
648 |
|
|
$sub_element[$field]['#default_value'] = '-' . $label;
|
649 |
|
|
}
|
650 |
|
|
}
|
651 |
|
|
}
|
652 |
|
|
else {
|
653 |
|
|
$sub_element[$field]['#type'] = 'select';
|
654 |
|
|
$sub_element[$field]['#theme'] = 'date_select_element';
|
655 |
|
|
$sub_element[$field]['#title'] = $label;
|
656 |
|
|
$sub_element[$field]['#title_display'] = in_array($element['#date_label_position'], array('within', 'none')) ? 'invisible' : 'before';
|
657 |
|
|
if ($element['#date_label_position'] == 'within') {
|
658 |
|
|
$sub_element[$field]['#options'] = array(
|
659 |
599a39cd
|
Assos Assos
|
'' => '-' . $label,
|
660 |
|
|
) + $sub_element[$field]['#options'];
|
661 |
85ad3d82
|
Assos Assos
|
}
|
662 |
|
|
}
|
663 |
|
|
}
|
664 |
|
|
|
665 |
599a39cd
|
Assos Assos
|
// Views exposed filters are treated as submitted even if not, so force the
|
666 |
|
|
// #default value in that case. Make sure we set a default that is in the
|
667 |
|
|
// option list.
|
668 |
85ad3d82
|
Assos Assos
|
if (!empty($element['#force_value'])) {
|
669 |
|
|
$options = $sub_element[$field]['#options'];
|
670 |
|
|
$default = !empty($sub_element[$field]['#default_value']) ? $sub_element[$field]['#default_value'] : array_shift($options);
|
671 |
|
|
$sub_element[$field]['#value'] = $default;
|
672 |
|
|
}
|
673 |
|
|
|
674 |
|
|
if (($hours_format == 'g' || $hours_format == 'h') && date_has_time($granularity)) {
|
675 |
|
|
$label = theme('date_part_label_ampm', array('part_type' => 'ampm', 'element' => $element));
|
676 |
|
|
$sub_element['ampm'] = array(
|
677 |
|
|
'#type' => 'select',
|
678 |
|
|
'#theme' => 'date_select_element',
|
679 |
|
|
'#title' => $label,
|
680 |
|
|
'#title_display' => in_array($element['#date_label_position'], array('within', 'none')) ? 'invisible' : 'before',
|
681 |
|
|
'#default_value' => is_object($date) ? (date_format($date, 'G') >= 12 ? 'pm' : 'am') : '',
|
682 |
|
|
'#options' => drupal_map_assoc(date_ampm($part_required)),
|
683 |
|
|
'#required' => $part_required,
|
684 |
|
|
'#weight' => 8,
|
685 |
|
|
'#attributes' => array('class' => array('date-ampm')),
|
686 |
|
|
);
|
687 |
|
|
if ($element['#date_label_position'] == 'within') {
|
688 |
|
|
$sub_element['ampm']['#options'] = array('' => '-' . $label) + $sub_element['ampm']['#options'];
|
689 |
|
|
}
|
690 |
|
|
}
|
691 |
|
|
|
692 |
|
|
return $sub_element;
|
693 |
|
|
}
|
694 |
|
|
|
695 |
|
|
/**
|
696 |
|
|
* Validation function for date selector.
|
697 |
|
|
*
|
698 |
599a39cd
|
Assos Assos
|
* When used as a Views widget, the validation step always gets triggered, even
|
699 |
|
|
* with no form submission. Before form submission $element['#value'] contains a
|
700 |
|
|
* string, after submission it contains an array.
|
701 |
85ad3d82
|
Assos Assos
|
*/
|
702 |
|
|
function date_select_validate($element, &$form_state) {
|
703 |
|
|
if (date_hidden_element($element)) {
|
704 |
|
|
return;
|
705 |
|
|
}
|
706 |
|
|
|
707 |
|
|
if (is_string($element['#value'])) {
|
708 |
|
|
return;
|
709 |
|
|
}
|
710 |
|
|
|
711 |
|
|
$input_exists = NULL;
|
712 |
|
|
$input = drupal_array_get_nested_value($form_state['values'], $element['#parents'], $input_exists);
|
713 |
|
|
|
714 |
|
|
// Strip field labels out of the results.
|
715 |
|
|
foreach ($element['#value'] as $field => $field_value) {
|
716 |
|
|
if (substr($field_value, 0, 1) == '-') {
|
717 |
|
|
$input[$field] = '';
|
718 |
|
|
}
|
719 |
|
|
}
|
720 |
|
|
|
721 |
|
|
drupal_alter('date_select_pre_validate', $element, $form_state, $input);
|
722 |
|
|
|
723 |
|
|
$label = !empty($element['#date_title']) ? $element['#date_title'] : (!empty($element['#title']) ? $element['#title'] : '');
|
724 |
|
|
if (isset($input['ampm'])) {
|
725 |
|
|
if ($input['ampm'] == 'pm' && $input['hour'] < 12) {
|
726 |
|
|
$input['hour'] += 12;
|
727 |
|
|
}
|
728 |
|
|
elseif ($input['ampm'] == 'am' && $input['hour'] == 12) {
|
729 |
|
|
$input['hour'] -= 12;
|
730 |
|
|
}
|
731 |
|
|
}
|
732 |
|
|
unset($input['ampm']);
|
733 |
|
|
$date = date_select_input_date($element, $input);
|
734 |
|
|
|
735 |
|
|
// If the field has errors, display them.
|
736 |
|
|
$error_field = implode('][', $element['#parents']);
|
737 |
|
|
$entered = array_values(array_filter($input));
|
738 |
|
|
if (empty($date) || !empty($date->errors)) {
|
739 |
|
|
// The input created a date but it has errors.
|
740 |
|
|
if (is_object($date) && !empty($date->errors)) {
|
741 |
|
|
$message = t('The value input for field %field is invalid:', array('%field' => $label));
|
742 |
|
|
$message .= '<br />' . implode('<br />', $date->errors);
|
743 |
|
|
form_set_error($error_field, $message);
|
744 |
|
|
return;
|
745 |
|
|
}
|
746 |
|
|
// Nothing was entered but the date is required.
|
747 |
|
|
elseif (empty($entered) && $element['#required']) {
|
748 |
|
|
$message = t('A valid date is required for %title.', array('%title' => $label));
|
749 |
|
|
form_set_error($error_field, $message);
|
750 |
|
|
return;
|
751 |
|
|
}
|
752 |
|
|
// Something was input but it wasn't enough to create a valid date.
|
753 |
|
|
elseif (!empty($entered)) {
|
754 |
|
|
$message = t('The value input for field %field is invalid.', array('%field' => $label));
|
755 |
|
|
form_set_error($error_field, $message);
|
756 |
|
|
return;
|
757 |
|
|
}
|
758 |
|
|
}
|
759 |
|
|
$value = !empty($date) ? $date->format(DATE_FORMAT_DATETIME) : NULL;
|
760 |
|
|
form_set_value($element, $value, $form_state);
|
761 |
|
|
}
|
762 |
|
|
|
763 |
|
|
/**
|
764 |
|
|
* Helper function for creating a date object out of user input.
|
765 |
|
|
*/
|
766 |
|
|
function date_select_input_date($element, $input) {
|
767 |
|
|
// Was anything entered? If not, we have no date.
|
768 |
|
|
if (!is_array($input)) {
|
769 |
|
|
return NULL;
|
770 |
|
|
}
|
771 |
|
|
else {
|
772 |
|
|
$entered = array_values(array_filter($input));
|
773 |
|
|
if (empty($entered)) {
|
774 |
|
|
return NULL;
|
775 |
|
|
}
|
776 |
|
|
}
|
777 |
|
|
$granularity = date_format_order($element['#date_format']);
|
778 |
|
|
if (isset($input['ampm'])) {
|
779 |
|
|
if ($input['ampm'] == 'pm' && $input['hour'] < 12) {
|
780 |
|
|
$input['hour'] += 12;
|
781 |
|
|
}
|
782 |
|
|
elseif ($input['ampm'] == 'am' && $input['hour'] == 12) {
|
783 |
|
|
$input['hour'] -= 12;
|
784 |
|
|
}
|
785 |
|
|
}
|
786 |
|
|
unset($input['ampm']);
|
787 |
|
|
|
788 |
|
|
// Make the input match the granularity.
|
789 |
|
|
foreach (date_nongranularity($granularity) as $part) {
|
790 |
|
|
unset($input[$part]);
|
791 |
|
|
}
|
792 |
|
|
|
793 |
|
|
$date = new DateObject($input, $element['#date_timezone']);
|
794 |
|
|
if (is_object($date)) {
|
795 |
|
|
$date->limitGranularity($granularity);
|
796 |
|
|
if ($date->validGranularity($granularity, $element['#date_flexible'])) {
|
797 |
|
|
date_increment_round($date, $element['#date_increment']);
|
798 |
|
|
}
|
799 |
|
|
return $date;
|
800 |
|
|
}
|
801 |
599a39cd
|
Assos Assos
|
|
802 |
85ad3d82
|
Assos Assos
|
return NULL;
|
803 |
|
|
} |