date_api_elements.inc 27 KB

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