date_elements.inc in Date 5.2
Same filename and directory in other branches
Date forms and form themes and validation.
All code used in form editing and processing is in this file, included only during form editing.
File
date/date_elements.incView source
<?php
/**
* @file
* Date forms and form themes and validation.
*
* All code used in form editing and processing is in this file,
* included only during form editing.
*/
/**
* Private implementation of hook_field validate operation.
*/
function _date_field_validate($op, &$node, $field, &$items, $teaser, $page) {
$field_name = $field['field_name'];
if (empty($items)) {
return;
}
// Don't try to validate if there were any errors before this point
// since the element won't have been munged back into a date.
if (!form_get_errors()) {
foreach ($items as $delta => $item) {
$process = date_process_values($field);
foreach ($process as $processed) {
$error_field = $field['field_name'] . '][' . $delta . '][' . $processed;
$error_field .= $field['widget']['type'] == 'date_select' ? '][year' : '';
if ($processed == 'value' && $field['todate'] && !date_is_valid($item['value'], $field['type'], $field['granularity']) && date_is_valid($item['value2'], $field['type'], $field['granularity'])) {
form_set_error($error_field, t("A 'From date' date is required for %field %delta", array(
'%delta' => $field['multiple'] ? intval($delta + 1) : '',
'%field' => t($field['widget']['label']),
)));
}
if ($processed == 'value2' && $field['todate'] == 'required' && ($field['required'] && date_is_valid($item['value'], $field['type'], $field['granularity']) && !date_is_valid($item['value2'], $field['type'], $field['granularity']))) {
form_set_error($error_field, t("A 'To date' is required for %field %delta", array(
'%delta' => $field['multiple'] ? intval($delta + 1) : '',
'%field' => t($field['widget']['label']),
)));
}
}
}
}
}
/**
* Private implementation of hook_field update and insert operations.
*/
function _date_field_update($op, &$node, $field, &$items, $teaser, $page) {
$field_name = $field['field_name'];
$format = $field['type'] == DATE_ISO ? DATE_FORMAT_ISO : DATE_FORMAT_UNIX;
$timezone = date_get_timezone($field['tz_handling'], $items[0]['timezone']);
$db_info = content_database_info($field);
$columns = array_keys($db_info['columns']);
$values = $items;
foreach ($values as $delta => $item) {
// Don't save empty values.
if (empty($item['value']) && $delta !== 0) {
unset($items[$delta]);
continue;
}
// For convenience, we process all possible columns in the element,
// but now we need to remove columns not used by this field.
// This unsets values needed by token handling, can't do it.
// TODO remove this or find another way? It may not hurt anything
// to leave these values here.
if (is_array($item)) {
$keys = array_keys($item);
foreach ($keys as $column => $value) {
if (!in_array($column, $columns)) {
//unset($items[$delta][$column]);
}
}
}
// Special case for ISO dates which may have been given artificial values for
// some date parts to make them into valid dates.
if ($field['type'] == DATE_ISO) {
$items[$delta]['value'] = date_limit_value($items[$delta]['value'], date_granularity($field), $field['type']);
if ($field['todate']) {
$items[$delta]['value2'] = date_limit_value($items[$delta]['value2'], date_granularity($field), $field['type']);
}
}
}
$node->{$field}['field_name'] = $items;
}
/**
* Private implementation of hook_widget().
*
* The widget builds out a complex date element in the following way:
*
* - A field is pulled out of the database which is comprised of one or
* more collections of from/to dates.
*
* - The dates in this field are all converted from the UTC values stored
* in the database back to the local time before passing their values
* to FAPI.
*
* - If values are empty, the field settings rules are used to determine
* if the default_values should be empty, now, the same, or use strtotime.
*
* - Each from/to combination is created using the date_combo element type
* defined by the date module. If the timezone is date-specific, a
* timezone selector is added to the first combo element.
*
* - If repeating dates are defined, a form to create a repeat rule is
* added to the field element.
*
* - The date combo element creates two individual date elements, one each
* for the from and to field, using the appropriate individual Date API
* date elements, like selects, textfields, or popups.
*
* - In the individual element validation, the data supplied by the user is
* used to update the individual date values.
*
* - In the combo date validation, the timezone is updated, if necessary,
* then the user input date values are used with that timezone to create
* date objects, which are used update combo date timezone and offset values.
*
* - In the field's submission processing, the new date values, which are in
* the local timezone, are converted back to their UTC values and stored.
*
*/
function _date_widget($op, &$node, $field, &$items) {
switch ($op) {
case 'default value':
return array(
0 => array(
'value' => NULL,
'value2' => NULL,
),
);
case 'form':
require_once './' . drupal_get_path('module', 'date_api') . '/date_api_elements.inc';
$db_info = content_database_info($field);
$columns = $db_info['columns'];
if (isset($columns['rrule'])) {
unset($columns['rrule']);
}
$columns = array_keys($columns);
$timezone = date_get_timezone($field['tz_handling'], $items[0]['timezone']);
// Convert UTC dates to their local values in DATETIME format,
// and adjust the default values as specified in the field settings.
// It would seem to make sense to do this conversion when the data
// is loaded instead of when the form is created, but the loaded
// field data is cached and we can't cache dates that have been converted
// to the timezone of an individual user, so we cache the UTC values
// instead and do our conversion to local dates in the form and
// in the formatters.
$process = date_process_values($field);
foreach ($items as $delta => $item) {
foreach ($process as $processed) {
$date = date_local_date($node, $delta, $item, $timezone, $field, $processed);
$items[$delta][$processed] = is_object($date) ? date_format($date, DATE_FORMAT_DATETIME) : '';
}
}
// Iterate through the available items, adding as many new ones as needed,
// to build out the complete multi-valued field form element.
$element = array(
$field['field_name'] => array(
'#tree' => TRUE,
'#weight' => $field['widget']['weight'],
'#validate' => array(
'date_widget_validate' => array(),
),
),
);
$max = $field['multiple'] == 1 && !$field['repeat'] ? 2 + sizeof($items) : 0;
foreach (range(0, $max) as $delta) {
$element[$field['field_name']][$delta] = array(
'#type' => 'date_combo',
'#field' => $field,
'#columns' => $columns,
'#delta' => $delta,
'#weight' => $delta,
'#default_value' => isset($items[$delta]) ? $items[$delta] : '',
'#date_timezone' => $timezone,
);
if ($field['tz_handling'] == 'date') {
$element[$field['field_name']][$delta]['timezone'] = array(
'#type' => 'date_timezone',
'#field' => $field,
'#columns' => $columns,
'#delta' => $delta,
'#default_value' => $timezone,
'#weight' => $delta + 0.2,
);
}
}
// Add a date repeat form element, if needed.
if (module_exists('date_repeat') && $field['repeat'] == 1) {
require_once './' . drupal_get_path('module', 'date') . '/date_repeat.inc';
_date_repeat_widget($element, $node, $field, $items);
}
return $element;
}
}
/**
* Create local date object.
*
* Create a date object set to local time from the field and
* widget settings and item values, using field settings to
* determine what to do with empty values.
*/
function date_local_date($node, $delta, $item, $timezone, $field, $part = 'value') {
$timezone_db = date_get_timezone_db($field['tz_handling']);
$granularity = $field['granularity'];
if (!empty($node->nid)) {
$default_value = '';
$default_value_code = '';
}
elseif ($part == 'value') {
$default_value = $field['widget']['default_value'];
$default_value_code = $field['widget']['default_value_code'];
}
else {
$default_value = $field['widget']['default_value2'];
$default_value_code = $field['widget']['default_value_code2'];
}
if (empty($item[$part])) {
if (empty($default_value) || $default_value == 'blank' || $delta > 0) {
return NULL;
}
elseif ($part == 'value2' && $default_value == 'same') {
if ($field['widget']['default_value'] == 'blank' || empty($item['value'])) {
return NULL;
}
else {
$date = date_make_date($item['value'], $timezone, DATE_DATETIME, $granularity);
}
}
elseif ($field['tz_handling'] == 'none') {
$date = date_now();
}
else {
$date = date_now($timezone);
}
}
else {
$value = $item[$part];
// Special case for ISO dates to create a valid date object for formatting.
if ($field['type'] == DATE_ISO) {
$value = date_fuzzy_datetime($value);
}
else {
$db_timezone = date_get_timezone_db($field['tz_handling']);
$value = date_convert($value, $field['type'], DATE_DATETIME, $db_timezone);
}
$date = date_make_date($value, $timezone_db, DATE_DATETIME, $field['granularity']);
date_timezone_set($date, timezone_open($timezone));
}
if (is_object($date) && empty($item[$part]) && $default_value == 'strtotime' && !empty($default_value_code)) {
date_modify($date, $default_value_code);
}
return $date;
}
/**
* Implementation of hook_elements().
*
* date_combo will create a 'from' and optional 'to' date, along with
* an optional 'timezone' column for date-specific timezones. Each
* 'from' and 'to' date will be constructed from date_select or date_text.
*/
function _date_elements() {
$type['date_combo'] = array(
'#input' => TRUE,
'#tree' => TRUE,
'#field' => array(),
'#delta' => 0,
'#columns' => array(
'value',
'value2',
'timezone',
'offset',
'offset2',
),
'#process' => array(
'date_combo_process' => array(),
),
'#validate' => array(
'date_combo_validate' => array(),
),
);
return $type;
}
/**
* Process an individual date element.
*/
function date_combo_process($element, $edit = NULL) {
if (isset($element['#access']) && empty($element['#access'])) {
return;
}
$field = $element['#field'];
$delta = $element['#delta'];
$from_field = $element['#columns'][0];
$to_field = $element['#columns'][1];
$tz_field = $element['#columns'][2];
if ($field['todate'] != 'required' && !empty($element['#default_value'][$to_field]) && $element['#default_value'][$to_field] == $element['#default_value'][$from_field]) {
unset($element['#default_value'][$to_field]);
}
$element[$from_field] = array(
'#field' => $field,
'#title' => !$field['multiple'] || $delta == 0 ? t($field['widget']['label']) : '',
'#weight' => $field['widget']['weight'],
'#required' => $field['required'] && $delta == 0 ? 1 : 0,
'#default_value' => $element['#value'][$from_field],
'#field' => $field,
'#delta' => $delta,
'#date_timezone' => $element['#date_timezone'],
'#date_format' => date_limit_format(date_input_format($element), $field['granularity']),
'#date_text_parts' => (array) $field['widget']['text_parts'],
'#date_increment' => $field['widget']['increment'],
'#date_year_range' => $field['widget']['year_range'],
'#date_label_position' => $field['widget']['label_position'],
);
$description = !empty($field['widget']['description']) ? t($field['widget']['description']) : '';
// Give this element the right type, using a Date API
// or a Date Popup element type.
switch ($field['widget']['type']) {
case 'date_select':
// From/to selectors with lots of parts will look better if displayed
// on two rows instead of in a single row.
if (!empty($field['todate']) && count($field['granularity']) > 3) {
$element[$from_field]['#attributes'] = array(
'class' => 'date-clear',
);
}
$element[$from_field]['#type'] = 'date_select';
break;
case 'date_popup':
$element[$from_field]['#type'] = 'date_popup';
break;
default:
$element[$from_field]['#type'] = 'date_text';
break;
}
// If this field uses the 'To', add matching element
// for the 'To' date, and adapt titles to make it clear which
// is the 'From' and which is the 'To'.
if (!empty($field['todate'])) {
$element['#date_float'] = TRUE;
$element[$from_field]['#title'] = t($field['widget']['label']) . ' ' . t('From date');
$element[$to_field] = $element[$from_field];
$element[$to_field]['#title'] = t($field['widget']['label']) . ' ' . t('To date');
$element[$to_field]['#default_value'] = $element['#value'][$to_field];
$element[$to_field]['#required'] = false;
$element[$to_field]['#weight'] += 0.1;
if ($field['widget']['type'] == 'date_select') {
$description .= ' ' . t('Empty \'To date\' values will use the \'From date\' values.');
}
$element['#fieldset_description'] = $description;
}
else {
$element[$from_field]['#description'] = $description;
}
$element['#validate'] = array(
'date_combo_validate' => array(),
);
return $element;
}
function date_element_empty($element) {
$item = array();
$item['value'] = NULL;
$item['value2'] = NULL;
$item['timezone'] = NULL;
$item['offset'] = NULL;
$item['offset2'] = NULL;
$item['rrule'] = NULL;
form_set_value($element, $item);
return $item;
}
/**
* Validate and update a combo element.
* Don't try this if there were errors before reaching this point.
*/
function date_combo_validate($element) {
global $form_values;
$field_name = $element['#parents'][0];
$delta = $element['#parents'][1];
$item = $form_values[$field_name][$delta];
// If the whole field is empty and that's OK, stop now.
if (empty($element['#post'][$field_name]) && !$element['#required']) {
return;
}
$field = $element['#field'];
$delta = $element['#delta'];
$from_field = 'value';
$to_field = 'value2';
$tz_field = 'timezone';
$offset_field = 'offset';
$offset_field2 = 'offset2';
// Check for empty 'From date', which could either be an empty
// value or an array of empty values, depending on the widget.
$empty = TRUE;
if (!empty($item[$from_field])) {
if (!is_array($item[$from_field])) {
$empty = FALSE;
}
else {
foreach ($item[$from_field] as $key => $value) {
if (!empty($value)) {
$empty = FALSE;
break;
}
}
}
}
if ($empty) {
$item = date_element_empty($element);
if (!$element['#required']) {
return;
}
}
elseif (!form_get_errors()) {
// Check todate input for blank values and substitute in fromdate
// values where needed, then re-compute the todate with those values.
if ($field['todate']) {
$merged_date = array();
$to_date_empty = TRUE;
foreach ($element['#post'][$field_name][$delta][$to_field] as $part => $value) {
$to_date_empty = $to_date_empty && empty($value);
$merged_date[$part] = empty($value) ? $element['#post'][$field_name][$delta][$from_field][$part] : $value;
if ($part == 'ampm' && $merged_date['ampm'] == 'pm' && $merged_date['hour'] < 12) {
$merged_date['hour'] += 12;
}
elseif ($part == 'ampm' && $merged_date['ampm'] == 'am' && $merged_date['hour'] == 12) {
$merged_date['hour'] -= 12;
}
}
// If all date values were empty and a date is required, throw
// an error on the first element. We don't want to create
// duplicate messages on every date part, so the error will
// only go on the first.
if ($to_date_empty && $field['todate'] == 'required') {
$error_field = implode('][', $element['#parents']) . '][value2][' . array_shift(array_keys($merged_date));
form_set_error($error_field, t('Some value must be entered in the To date.'));
}
$element[$to_field]['#value'] = $merged_date;
// Call the right function to turn this altered user input into
// a new value for the todate.
$item[$to_field] = $merged_date;
}
else {
$item[$to_field] = $item[$from_field];
}
$from_date = date_input_value($field, $element[$from_field]);
if (!empty($field['todate'])) {
$to_date = date_input_value($field, $element[$to_field]);
}
else {
$to_date = $from_date;
}
// Neither the from date nor the to date should be empty at this point
// unless they held values that couldn't be evaluated.
if (!$field['required'] && (empty($from_date) || empty($to_date))) {
$item = date_element_empty($element);
form_set_error(implode('][', $element['#parents']), t('The dates are invalid.'));
return;
}
elseif (!empty($field['todate']) && $from_date > $to_date) {
$error_field = implode('][', $element['#parents']) . '][value2][' . array_shift(array_keys($merged_date));
$element[$to_field]['#value'] = $merged_date;
form_set_value($element[$to_field], $to_date, $form_state);
form_set_error(implode('][', $element['#parents']), t('The To date must be greater than the From date.'));
}
else {
// Convert input dates back to their UTC values and re-format to ISO
// or UNIX instead of the DATETIME format used in element processing.
$timezone = !empty($item[$tz_field]) ? $item[$tz_field] : $element['#date_timezone'];
$timezone_db = date_get_timezone_db($field['tz_handling']);
$item[$tz_field] = $timezone;
$from_date = date_make_date($from_date, $timezone);
$item[$offset_field] = date_offset_get($from_date);
$to_date = date_make_date($to_date, $timezone);
$item[$offset_field2] = date_offset_get($to_date);
date_timezone_set($from_date, timezone_open($timezone_db));
date_timezone_set($to_date, timezone_open($timezone_db));
$item[$from_field] = date_format($from_date, date_type_format($field['type']));
$item[$to_field] = date_format($to_date, date_type_format($field['type']));
// TODO get RRULE working.
//$item['rrule'] = $rrule;
form_set_value($element, $item);
}
}
}
/**
* Handle widget processing.
*/
function date_widget_validate($element) {
global $form_values;
$field_name = $element['#parents'][0];
$field = $element[0]['#field'];
if (module_exists('date_repeat') && array_key_exists('rrule', $form_values[$field_name])) {
require_once './' . drupal_get_path('module', 'date') . '/date_repeat.inc';
return _date_repeat_widget_validate($element);
}
}
/**
* Determine the input format for this element.
*/
function date_input_format($element) {
$field = $element['#field'];
if (!empty($field['widget']['input_format_custom'])) {
return $field['widget']['input_format_custom'];
}
elseif (!empty($field['widget']['input_format']) && $field['widget']['input_format'] != 'site-wide') {
return $field['widget']['input_format'];
}
return variable_get('date_format_short', 'm/d/Y - H:i');
}
/**
* Theme from/to date combination on form.
*/
function theme_date_combo($element) {
if (!$element['#field']['todate']) {
return $element['#children'];
}
// Group from/to items together in fieldset.
$fieldset = array(
'#title' => $element['#field']['widget']['label'] . ' ' . ($element['#delta'] > 0 ? intval($element['#delta'] + 1) : ''),
'#value' => $element['#children'],
'#collapsible' => TRUE,
'#collapsed' => empty($element['#value']) && $element['#delta'] > 0 ? TRUE : FALSE,
'#description' => $element['#fieldset_description'],
);
return theme('fieldset', $fieldset);
}Functions
Name |
Description |
|---|---|
| date_combo_process | Process an individual date element. |
| date_combo_validate | Validate and update a combo element. Don't try this if there were errors before reaching this point. |
| date_element_empty | |
| date_input_format | Determine the input format for this element. |
| date_local_date | Create local date object. |
| date_widget_validate | Handle widget processing. |
| theme_date_combo | Theme from/to date combination on form. |
| _date_elements | Implementation of hook_elements(). |
| _date_field_update | Private implementation of hook_field update and insert operations. |
| _date_field_validate | Private implementation of hook_field validate operation. |
| _date_widget | Private implementation of hook_widget(). |