123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437 |
- <?php
- /**
- * @file
- * Webform module time component.
- */
- // Time depends on functions provided by date.
- webform_component_include('date');
- /**
- * Implements _webform_defaults_component().
- */
- function _webform_defaults_time() {
- return array(
- 'name' => '',
- 'form_key' => NULL,
- 'pid' => 0,
- 'weight' => 0,
- 'value' => '',
- 'mandatory' => 0,
- 'extra' => array(
- 'timezone' => 'user',
- 'hourformat' => '12-hour',
- 'minuteincrements' => 1,
- 'title_display' => 0,
- 'description' => '',
- 'private' => FALSE,
- ),
- );
- }
- /**
- * Implements _webform_theme_component().
- */
- function _webform_theme_time() {
- return array(
- 'webform_time' => array(
- 'render element' => 'element',
- 'file' => 'components/time.inc',
- ),
- 'webform_display_time' => array(
- 'render element' => 'element',
- 'file' => 'components/time.inc',
- ),
- );
- }
- /**
- * Implements _webform_edit_component().
- */
- function _webform_edit_time($component) {
- $form = array();
- $form['value'] = array(
- '#type' => 'textfield',
- '#title' => t('Default value'),
- '#default_value' => $component['value'],
- '#description' => t('The default value of the field.') . '<br />' . t('Accepts a time in any <a href="http://www.gnu.org/software/tar/manual/html_chapter/Date-input-formats.html">GNU Date Input Format</a>. Strings such as now, +2 hours, and 10:30pm are all valid.'),
- '#size' => 60,
- '#maxlength' => 127,
- '#weight' => 0,
- );
- $form['extra']['timezone'] = array(
- '#type' => 'radios',
- '#title' => t('Default value timezone'),
- '#default_value' => $component['extra']['timezone'],
- '#description' => t('If using relative dates for a default value (e.g. "now") base the current time on this timezone.'),
- '#options' => array('user' => t('User timezone'), 'site' => t('Website timezone')),
- '#weight' => 2,
- '#access' => variable_get('configurable_timezones', 1),
- );
- $form['display']['hourformat'] = array(
- '#type' => 'radios',
- '#title' => t('Time format'),
- '#default_value' => $component['extra']['hourformat'],
- '#options' => array('12-hour' => t('12-hour (am/pm)'), '24-hour' => t('24-hour')),
- '#weight' => 2,
- '#parents' => array('extra', 'hourformat'),
- );
- $form['display']['minuteincrements'] = array(
- '#type' => 'select',
- '#title' => t('Minute increments'),
- '#default_value' => $component['extra']['minuteincrements'],
- '#options' => array(
- 1 => t('1 minute'),
- 5 => t('5 minute'),
- 10 => t('10 minute'),
- 15 => t('15 minute'),
- 30 => t('30 minute'),
- ),
- '#weight' => 3,
- '#parents' => array('extra', 'minuteincrements'),
- );
- return $form;
- }
- /**
- * Implements _webform_render_component().
- */
- function _webform_render_time($component, $value = NULL, $filter = TRUE) {
- $node = isset($component['nid']) ? node_load($component['nid']) : NULL;
- $element = array(
- '#type' => 'webform_time',
- '#title' => $filter ? _webform_filter_xss($component['name']) : $component['name'],
- '#title_display' => $component['extra']['title_display'] ? $component['extra']['title_display'] : 'before',
- '#required' => $component['mandatory'],
- '#weight' => $component['weight'],
- '#description' => $filter ? _webform_filter_descriptions($component['extra']['description'], $node) : $component['extra']['description'],
- '#element_validate' => array('webform_validate_time'),
- '#hourformat' => $component['extra']['hourformat'],
- '#minuteincrements' => $component['extra']['minuteincrements'],
- '#default_value' => $filter ? _webform_filter_values($component['value'], $node, NULL, NULL, FALSE) : $component['value'],
- '#timezone' => $component['extra']['timezone'],
- '#process' => array('webform_expand_time'),
- '#theme' => 'webform_time',
- '#theme_wrappers' => array('webform_element'),
- '#translatable' => array('title', 'description'),
- );
- // Set the value from Webform if available.
- if (!empty($value[0])) {
- $element['#default_value'] = $value[0];
- }
- return $element;
- }
- /**
- * Form API #process function for Webform time fields.
- */
- function webform_expand_time($element) {
- // Expand the default value from a string into an array.
- if (!empty($element['#default_value'])) {
- // Adjust the time based on the user or site timezone.
- if (variable_get('configurable_timezones', 1) && $element['#timezone'] == 'user') {
- $timezone_name = isset($GLOBALS['user']->timezone) ? $GLOBALS['user']->timezone : 'UTC';
- }
- else {
- $timezone_name = variable_get('date_default_timezone', 'UTC');
- }
- $default_values = webform_date_array(webform_strtodate('c', $element['#default_value'], $timezone_name), 'time');
- }
- else {
- $default_values = array(
- 'hour' => '',
- 'minute' => '',
- 'second' => '',
- );
- }
- $first_hour = 0;
- $last_hour = 23;
- if ($element['#hourformat'] == '12-hour') {
- $first_hour = 1;
- $last_hour = 12;
- $default_values = webform_time_convert($default_values, '12-hour');
- $default_values['ampm'] = $default_values['ampm'] ? $default_values['ampm'] : 'am';
- }
- // Generate the choices for drop-down selects.
- $hours[''] = t('hour');
- $minutes[''] = t('minute');
- for ($i = $first_hour; $i <= $last_hour; $i++) {
- $hours[$i] = $i;
- }
- for ($i = 0; $i <= 59; $i += $element['#minuteincrements']) {
- $minutes[$i] = $i < 10 ? "0$i" : $i;
- }
- $ampms = array('am' => t('am'), 'pm' => t('pm'));
- // Adjust the default for minutes if needed, rounding up to the closest value.
- if (!isset($minutes[$default_values['minute']])) {
- foreach ($minutes as $minute => $padded_minute) {
- if ($minute > $default_values['minute']) {
- $default_values['minute'] = $minute;
- break;
- }
- }
- }
- // If the above loop didn't set a value, it's because rounding up would go to
- // the next hour. This gets quite a bit more complicated, since we need to
- // deal with looping around on hours, as well as flipping am/pm.
- if (!isset($minutes[$default_values['minute']])) {
- $default_values['minute'] = 0;
- $default_values['hour']++;
- // If the hour rolls over also, set hour to the first hour in the list.
- if (!isset($hours[$default_values['hour']])) {
- $default_values['hour'] = $element['#hourformat'] == '12-hour' ? 1 : 0;
- }
- // If the hour has been incremented to 12:00 in 12-hour format, flip am/pm.
- // Note that technically midnight and noon are neither am or pm, but common
- // convention (and US standard) is to represent 12:00am as midnight.
- // See http://en.wikipedia.org/wiki/Midnight#Start_and_end_of_day.
- if ($element['#hourformat'] == '12-hour' && $default_values['hour'] == 12) {
- $default_values['ampm'] = $default_values['ampm'] == 'am' ? 'pm' : 'am';
- }
- }
- $element['hour'] = array(
- '#prefix' => '',
- '#type' => 'select',
- '#title' => t('Hour'),
- '#title_display' => 'invisible',
- '#default_value' => $default_values['hour'],
- '#options' => $hours,
- );
- $element['minute'] = array(
- '#prefix' => ':',
- '#type' => 'select',
- '#title' => t('Minute'),
- '#title_display' => 'invisible',
- '#default_value' => $default_values['minute'],
- '#options' => $minutes,
- );
- if (strcmp($element['#hourformat'], '12-hour') == 0) {
- $element['ampm'] = array(
- '#type' => 'radios',
- '#default_value' => $default_values['ampm'],
- '#options' => $ampms,
- );
- }
- // Set the overall default value.
- if ($default_values['hour'] !== '') {
- $element['#default_value'] = webform_date_string($default_values);
- }
- return $element;
- }
- /**
- * Theme a webform time element.
- */
- function theme_webform_time($variables) {
- $element = $variables['element'];
- $element['hour']['#attributes']['class'][] = 'hour';
- $element['minute']['#attributes']['class'][] = 'minute';
- // Add error classes to all items within the element.
- if (form_get_error($element)) {
- $element['hour']['#attributes']['class'][] = 'error';
- $element['minute']['#attributes']['class'][] = 'error';
- }
- $output = '<div class="webform-container-inline">' . drupal_render($element['hour']) . drupal_render($element['minute']) . drupal_render($element['ampm']) . '</div>';
- return $output;
- }
- function webform_validate_time($element, $form_state) {
- $form_key = $element['#webform_component']['form_key'];
- $name = $element['#webform_component']['name'];
- // Check if the user filled the required fields.
- foreach ($element['#hourformat'] == '12-hour' ? array('hour', 'minute', 'ampm') : array('hour', 'minute') as $field_type) {
- if ($element[$field_type]['#value'] === '' && $element['#required']) {
- form_error($element, t('%field field is required.', array('%field' => $name)));
- return;
- }
- }
- // Check for a valid time.
- if ($element['hour']['#value'] !== '' || $element['minute']['#value'] !== '') {
- if (!is_numeric($element['hour']['#value']) || !is_numeric($element['minute']['#value']) || (isset($element['ampm']) && $element['ampm']['#value'] === '')) {
- form_error($element, t('Entered %name is not a valid time.', array('%name' => $name)));
- return;
- }
- }
- }
- /**
- * Implements _webform_submit_component().
- */
- function _webform_submit_time($component, $value) {
- // Convert to 24-hour time before string conversion.
- if ($component['extra']['hourformat'] == '12-hour') {
- $value = webform_time_convert($value, '24-hour');
- }
- // Convert the value into a ISO 8601 string.
- return $value['hour'] !== '' ? webform_date_string($value, 'time') : '';
- }
- /**
- * Implements _webform_display_component().
- */
- function _webform_display_time($component, $value, $format = 'html') {
- $value = webform_date_array(isset($value[0]) ? $value[0] : '', 'time');
- if ($component['extra']['hourformat'] == '12-hour') {
- $value = webform_time_convert($value, '12-hour');
- }
- return array(
- '#title' => $component['name'],
- '#weight' => $component['weight'],
- '#theme' => 'webform_display_time',
- '#theme_wrappers' => $format == 'html' ? array('webform_element') : array('webform_element_text'),
- '#format' => $format,
- '#hourformat' => $component['extra']['hourformat'],
- '#value' => $value,
- '#translatable' => array('title'),
- );
- }
- /**
- * Format the output of data for this component.
- */
- function theme_webform_display_time($variables) {
- $element = $variables['element'];
- $output = ' ';
- if (isset($element['#value']['hour']) && $element['#value']['hour'] !== '' && isset($element['#value']['minute']) && $element['#value']['minute'] !== '') {
- if ($element['#hourformat'] == '24-hour') {
- $output = sprintf('%02d', $element['#value']['hour']) . ':' . sprintf('%02d', $element['#value']['minute']);
- }
- else {
- $output = $element['#value']['hour'] . ':' . sprintf('%02d', $element['#value']['minute']) . ' ' . $element['#value']['ampm'];
- }
- }
- return $output;
- }
- /**
- * Implements _webform_analysis_component().
- */
- function _webform_analysis_time($component, $sids = array()) {
- $query = db_select('webform_submitted_data', 'wsd', array('fetch' => PDO::FETCH_ASSOC))
- ->fields('wsd', array('no', 'data'))
- ->condition('nid', $component['nid'])
- ->condition('cid', $component['cid'])
- ->orderBy('sid');
- if (count($sids)) {
- $query->condition('sid', $sids, 'IN');
- }
- $result = $query->execute();
- $times = array();
- $submissions = 0;
- foreach ($result as $row) {
- $submissions++;
- if ($row['data']) {
- $times[] = webform_date_array($row['data']);
- }
- }
- // Display stats.
- $nonblanks = count($times);
- $rows[0] = array(t('Left Blank'), ($submissions - $nonblanks));
- $rows[1] = array(t('User entered value'), $nonblanks);
- return $rows;
- }
- /**
- * Implements _webform_table_component().
- */
- function _webform_table_time($component, $value) {
- if ($value[0]) {
- $time = webform_date_array($value[0], 'time');
- if ($component['extra']['hourformat'] == '24-hour') {
- return sprintf('%02d', $time['hour']) . ':' . sprintf('%02d', $time['minute']);
- }
- else {
- $time = webform_time_convert($time, '12-hour');
- return $time['hour'] . ':' . sprintf('%02d', $time['minute']) . ' ' . $time['ampm'];
- }
- }
- else {
- return '';
- }
- }
- /**
- * Implements _webform_csv_headers_component().
- */
- function _webform_csv_headers_time($component, $export_options) {
- $header = array();
- $header[0] = '';
- $header[1] = '';
- $header[2] = $component['name'];
- return $header;
- }
- /**
- * Implements _webform_csv_data_component().
- */
- function _webform_csv_data_time($component, $export_options, $value) {
- if ($value[0]) {
- $time = webform_date_array($value[0], 'time');
- if ($component['extra']['hourformat'] == '24-hour') {
- return sprintf('%02d', $time['hour']) . ':' . sprintf('%02d', $time['minute']);
- }
- else {
- $time = webform_time_convert($time, '12-hour');
- return $time['hour'] . ':' . sprintf('%02d', $time['minute']) . ' ' . $time['ampm'];
- }
- }
- else {
- return '';
- }
- }
- /**
- * Convert a time between a 24-hour and a 12-hour value.
- *
- * @param $array
- * An array of hour, minute, second, and optionally ampm.
- * @param $format
- * Either 12-hour or 24-hour.
- * @return
- * An array with hour, minute, second, and ampm (if using "12-hour").
- */
- function webform_time_convert($array, $format) {
- if ($array['hour'] !== '') {
- if ($format == '12-hour') {
- $array['ampm'] = ($array['hour'] >= 12 && $array['hour'] < 24) ? 'pm' : 'am';
- $array['hour'] = ($array['hour'] > 12 || $array['hour'] == 0) ? abs($array['hour'] - 12) : (int) $array['hour'];
- }
- elseif ($format == '24-hour' && isset($array['ampm'])) {
- $array['hour'] = ($array['hour'] < 12 && $array['ampm'] == 'pm') ? $array['hour'] + 12 : (int) $array['hour'];
- $array['hour'] = ($array['hour'] == 12 && $array['ampm'] == 'am') ? 0 : $array['hour'];
- }
- }
- if ($format == '12-hour' && !isset($array['ampm'])) {
- $array['ampm'] = '';
- }
- elseif ($format == '24-hour' && isset($array['ampm'])) {
- unset($array['ampm']);
- }
- return $array;
- }
|