datetime.module in Zircon Profile 8.0

Field hooks to implement a simple datetime field.

File

core/modules/datetime/datetime.module

<?php

/**
 * @file
 * Field hooks to implement a simple datetime field.
 */
use Drupal\Core\Routing\RouteMatchInterface;

/**
 * Defines the timezone that dates should be stored in.
 */
const DATETIME_STORAGE_TIMEZONE = 'UTC';

/**
 * Defines the format that date and time should be stored in.
 */
const DATETIME_DATETIME_STORAGE_FORMAT = 'Y-m-d\\TH:i:s';

/**
 * Defines the format that dates should be stored in.
 */
const DATETIME_DATE_STORAGE_FORMAT = 'Y-m-d';

/**
 * Implements hook_help().
 */
function datetime_help($route_name, RouteMatchInterface $route_match) {
  switch ($route_name) {
    case 'help.page.datetime':
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('The Datetime module provides a Date field that stores dates and times. It also provides the Form API elements <em>datetime</em> and <em>datelist</em> for use in programming modules. See the <a href=":field">Field module help</a> and the <a href=":field_ui">Field UI module help</a> pages for general information on fields and how to create and manage them. For more information, see the <a href=":datetime_do">online documentation for the Datetime module</a>.', array(
        ':field' => \Drupal::url('help.page', array(
          'name' => 'field',
        )),
        ':field_ui' => \Drupal::moduleHandler()
          ->moduleExists('field_ui') ? \Drupal::url('help.page', array(
          'name' => 'field_ui',
        )) : '#',
        ':datetime_do' => 'https://www.drupal.org/documentation/modules/datetime',
      )) . '</p>';
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Managing and displaying date fields') . '</dt>';
      $output .= '<dd>' . t('The <em>settings</em> and the <em>display</em> of the Date field can be configured separately. See the <a href=":field_ui">Field UI help</a> for more information on how to manage fields and their display.', array(
        ':field_ui' => \Drupal::moduleHandler()
          ->moduleExists('field_ui') ? \Drupal::url('help.page', array(
          'name' => 'field_ui',
        )) : '#',
      )) . '</dd>';
      $output .= '<dt>' . t('Displaying dates') . '</dt>';
      $output .= '<dd>' . t('Dates can be displayed using the <em>Plain</em> or the <em>Default</em> formatter. The <em>Plain</em> formatter displays the date in the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a> format. If you choose the <em>Default</em> formatter, you can choose a format from a predefined list that can be managed on the <a href=":date_format_list">Date and time formats</a> page.', array(
        ':date_format_list' => \Drupal::url('entity.date_format.collection'),
      )) . '</dd>';
      $output .= '</dl>';
      return $output;
  }
}

/**
 * Sets a consistent time on a date without time.
 *
 * The default time for a date without time can be anything, so long as it is
 * consistently applied. If we use noon, dates in most timezones will have the
 * same value for in both the local timezone and UTC.
 *
 * @param $date
 *
 */
function datetime_date_default_time($date) {
  $date
    ->setTime(12, 0, 0);
}

Functions

Name	Description
datetime_date_default_time	Sets a consistent time on a date without time.
datetime_help	Implements hook_help().

Constants

Name	Description
DATETIME_DATETIME_STORAGE_FORMAT	Defines the format that date and time should be stored in.
DATETIME_DATE_STORAGE_FORMAT	Defines the format that dates should be stored in.
DATETIME_STORAGE_TIMEZONE	Defines the timezone that dates should be stored in.