www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/datetime/datetime.module

   1 <?php
   2
   3 /**
   4  * @file
   5  * Field hooks to implement a simple datetime field.
   6  */
   7
   8 use Drupal\Core\Routing\RouteMatchInterface;
   9
  10 /**
  11  * Defines the timezone that dates should be stored in.
  12  */
  13 const DATETIME_STORAGE_TIMEZONE = 'UTC';
  14
  15 /**
  16  * Defines the format that date and time should be stored in.
  17  */
  18 const DATETIME_DATETIME_STORAGE_FORMAT = 'Y-m-d\TH:i:s';
  19
  20 /**
  21  * Defines the format that dates should be stored in.
  22  */
  23 const DATETIME_DATE_STORAGE_FORMAT = 'Y-m-d';
  24
  25 /**
  26  * Implements hook_help().
  27  */
  28 function datetime_help($route_name, RouteMatchInterface $route_match) {
  29   switch ($route_name) {
  30     case 'help.page.datetime':
  31       $output = '';
  32       $output .= '<h3>' . t('About') . '</h3>';
  33       $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>.', [':field' => \Drupal::url('help.page', ['name' => 'field']), ':field_ui' => (\Drupal::moduleHandler()->moduleExists('field_ui')) ? \Drupal::url('help.page', ['name' => 'field_ui']) : '#', ':datetime_do' => 'https://www.drupal.org/documentation/modules/datetime']) . '</p>';
  34       $output .= '<h3>' . t('Uses') . '</h3>';
  35       $output .= '<dl>';
  36       $output .= '<dt>' . t('Managing and displaying date fields') . '</dt>';
  37       $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.', [':field_ui' => (\Drupal::moduleHandler()->moduleExists('field_ui')) ? \Drupal::url('help.page', ['name' => 'field_ui']) : '#']) . '</dd>';
  38       $output .= '<dt>' . t('Displaying dates') . '</dt>';
  39       $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.', [':date_format_list' => \Drupal::url('entity.date_format.collection')]) . '</dd>';
  40       $output .= '</dl>';
  41       return $output;
  42   }
  43 }
  44
  45 /**
  46  * Sets a consistent time on a date without time.
  47  *
  48  * The default time for a date without time can be anything, so long as it is
  49  * consistently applied. If we use noon, dates in most timezones will have the
  50  * same value for in both the local timezone and UTC.
  51  *
  52  * @param $date
  53  */
  54 function datetime_date_default_time($date) {
  55   $date->setTime(12, 0, 0);
  56 }