Drupal
/
drupal
mirror of https://git.drupalcode.org/project/drupal.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Issue #1802278 by KarenS, andypost: Added a Date component to core.

8.0.x
webchick 2012-11-06 01:45:17 -08:00
parent 58ed8c89c7
commit 26bd9acba1
10 changed files with 1465 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
core/includes/common.inc
View File

@ -5,6 +5,7 @@ use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Drupal\Component\Utility\NestedArray; use Drupal\Component\Utility\NestedArray;
use Drupal\Core\Cache\CacheBackendInterface; use Drupal\Core\Cache\CacheBackendInterface;
use Drupal\Core\Datetime\DrupalDateTime;
use Drupal\Core\Database\Database; use Drupal\Core\Database\Database;
use Drupal\Core\Template\Attribute; use Drupal\Core\Template\Attribute;
@ -1997,26 +1998,12 @@ function format_date($timestamp, $type = 'medium', $format = '', $timezone = NUL
break; break;
} }
// Create a DateTime object from the timestamp. // Create a DrupalDateTime object from the timestamp and timezone.
$date_time = date_create('@' . $timestamp); $date_time = new DrupalDateTime($timestamp, $timezones[$timezone]);
// Set the time zone for the DateTime object.
date_timezone_set($date_time, $timezones[$timezone]);
// Encode markers that should be translated. 'A' becomes '\xEF\AA\xFF'.
// xEF and xFF are invalid UTF-8 sequences, and we assume they are not in the
// input string.
// Paired backslashes are isolated to prevent errors in read-ahead evaluation.
// The read-ahead expression ensures that A matches, but not \A.
$format = preg_replace(array('/\\\\\\\\/', '/(?<!\\\\)([AaeDlMTF])/'), array("\xEF\\\\\\\\\xFF", "\xEF\\\\\$1\$1\xFF"), $format);
// Call date_format(). // Call date_format().
$format = date_format($date_time, $format); $settings = array('langcode' => $langcode);
return $date_time->format($format, $settings);
// Pass the langcode to _format_date_callback().
_format_date_callback(NULL, $langcode);
// Translate the marked sequences.
return preg_replace_callback('/\xEF([AaeDlMTF]?)(.*?)\xFF/', '_format_date_callback', $format);
} }
/** /**
@ -4996,7 +4983,8 @@ function drupal_page_set_cache($body) {
$cache->data['headers'][$header_names[$name_lower]] = $value; $cache->data['headers'][$header_names[$name_lower]] = $value;
if ($name_lower == 'expires') { if ($name_lower == 'expires') {
// Use the actual timestamp from an Expires header if available. // Use the actual timestamp from an Expires header if available.
$cache->expire = strtotime($value); $date = new DrupalDateTime($value);
$cache->expire = $date->getTimestamp();
} }
} }

734
core/lib/Drupal/Component/Datetime/DateTimePlus.php Normal file
View File

@ -0,0 +1,734 @@
<?php
/**
* @file
* Definition of Drupal\Component\Datetime\DateTimePlus
*/
namespace Drupal\Component\Datetime;
/**
* Extends DateTime().
*
* This class extends the PHP DateTime class with more flexible initialization
* parameters, allowing a date to be created from an existing date object,
* a timestamp, a string with an unknown format, a string with a known
* format, or an array of date parts. It also adds an errors array
* and a __toString() method to the date object.
*
* In addition, it swaps the IntlDateFormatter into the format() method,
* if it is available. The format() method is also extended with a settings
* array to provide settings needed by the IntlDateFormatter. It will
* will only be used if the class is available, a langcode, country, and
* calendar have been set, and the format is in the right pattern, otherwise
* the parent format() method is used in the usual way. These values can
* either be set globally in the object and reused over and over as the date
* is repeatedly formatted, or set specifically in the format() method
* for the requested format.
*
* This class is less lenient than the parent DateTime class. It changes
* the default behavior for handling date values like '2011-00-00'.
* The parent class would convert that value to '2010-11-30' and report
* a warning but not an error. This extension treats that as an error.
*
* As with the base class, a date object may be created even if it has
* errors. It has an errors array attached to it that explains what the
* errors are. This is less disruptive than allowing datetime exceptions
* to abort processing. The calling script can decide what to do about
* errors using hasErrors() and getErrors().
*/
class DateTimePlus extends \DateTime {
const FORMAT = 'Y-m-d H:i:s';
const CALENDAR = 'gregorian';
const PHP = 'php';
const INTL = 'intl';
/**
* An array of possible date parts.
*/
protected static $dateParts = array(
'year',
'month',
'day',
'hour',
'minute',
'second',
);
/**
* The value of the time value passed to the constructor.
*/
protected $inputTimeRaw = '';
/**
* The prepared time, without timezone, for this date.
*/
protected $inputTimeAdjusted = '';
/**
* The value of the timezone passed to the constructor.
*/
protected $inputTimeZoneRaw = '';
/**
* The prepared timezone object used to construct this date.
*/
protected $inputTimeZoneAdjusted = '';
/**
* The value of the format passed to the constructor.
*/
protected $inputFormatRaw = '';
/**
* The prepared format, if provided.
*/
protected $inputFormatAdjusted = '';
/**
* The value of the language code passed to the constructor.
*/
protected $langcode = NULL;
/**
* The value of the country code passed to the constructor.
*/
protected $country = NULL;
/**
* The value of the calendar setting passed to the constructor.
*/
protected $calendar = NULL;
/**
* An array of errors encountered when creating this date.
*/
protected $errors = array();
/**
* Constructs a date object set to a requested date and timezone.
*
* @param mixed $time
* A DateTime object, a date/time string, a unix timestamp,
* or an array of date parts, like ('year' => 2014, 'month => 4).
* Defaults to 'now'.
* @param mixed $timezone
* PHP DateTimeZone object, string or NULL allowed.
* Defaults to NULL.
* @param string $format
* PHP date() type format for parsing the input. This is recommended
* for specialized input with a known format. If provided the
* date will be created using the createFromFormat() method.
* Defaults to NULL.
* @see http://us3.php.net/manual/en/datetime.createfromformat.php
* @param array $settings
* - validate_format: (optional) Boolean choice to validate the
* created date using the input format. The format used in
* createFromFormat() allows slightly different values than format().
* Using an input format that works in both functions makes it
* possible to a validation step to confirm that the date created
* from a format string exactly matches the input. This option
* indicates the format can be used for validation. Defaults to TRUE.
* - langcode: (optional) String two letter language code to construct
* the locale string by the intlDateFormatter class. Used to control
* the result of the format() method if that class is available.
* Defaults to NULL.
* - country: (optional) String two letter country code to construct
* the locale string by the intlDateFormatter class. Used to control
* the result of the format() method if that class is available.
* Defaults to NULL.
* - calendar: (optional) String calendar name to use for the date.
* Defaults to DateTimePlus::CALENDAR.
* - debug: (optional) Boolean choice to leave debug values in the
* date object for debugging purposes. Defaults to FALSE.
*/
public function __construct($time = 'now', $timezone = NULL, $format = NULL, $settings = array()) {
// Unpack settings.
$this->validateFormat = !empty($settings['validate_format']) ? $settings['validate_format'] : TRUE;
$this->langcode = !empty($settings['langcode']) ? $settings['langcode'] : NULL;
$this->country = !empty($settings['country']) ? $settings['country'] : NULL;
$this->calendar = !empty($settings['calendar']) ? $settings['calendar'] : static::CALENDAR;
// Store the original input so it is available for validation.
$this->inputTimeRaw = $time;
$this->inputTimeZoneRaw = $timezone;
$this->inputFormatRaw = $format;
// Massage the input values as necessary.
$this->prepareTime($time);
$this->prepareTimezone($timezone);
$this->prepareFormat($format);
// Create a date as a clone of an input DateTime object.
if ($this->inputIsObject()) {
$this->constructFromObject();
}
// Create date from array of date parts.
elseif ($this->inputIsArray()) {
$this->constructFromArray();
}
// Create a date from a Unix timestamp.
elseif ($this->inputIsTimestamp()) {
$this->constructFromTimestamp();
}
// Create a date from a time string and an expected format.
elseif ($this->inputIsFormat()) {
$this->constructFromFormat();
}
// Create a date from any other input.
else {
$this->constructFallback();
}
// Clean up the error messages.
$this->checkErrors();
$this->errors = array_unique($this->errors);
// Now that we've validated the input, clean up the extra values.
if (empty($settings['debug'])) {
unset(
$this->inputTimeRaw,
$this->inputTimeAdjusted,
$this->inputTimeZoneRaw,
$this->inputTimeZoneAdjusted,
$this->inputFormatRaw,
$this->inputFormatAdjusted,
$this->validateFormat
);
}
}
/**
* Implements __toString() for dates.
*
* The base DateTime class does not implement this.
*
* @see https://bugs.php.net/bug.php?id=62911
* @see http://www.serverphorums.com/read.php?7,555645
*/
public function __toString() {
$format = static::FORMAT;
return $this->format($format) . ' ' . $this->getTimeZone()->getName();
}
/**
* Prepares the input time value.
*
* Changes the input value before trying to use it, if necessary.
* Can be overridden to handle special cases.
*
* @param mixed $time
* An input value, which could be a timestamp, a string,
* or an array of date parts.
*/
protected function prepareTime($time) {
$this->inputTimeAdjusted = $time;
}
/**
* Prepares the input timezone value.
*
* Changes the timezone before trying to use it, if necessary.
* Most imporantly, makes sure there is a valid timezone
* object before moving further.
*
* @param mixed $timezone
* Either a timezone name or a timezone object or NULL.
*/
protected function prepareTimezone($timezone) {
// If the input timezone is a valid timezone object, use it.
if ($timezone instanceOf \DateTimezone) {
$timezone_adjusted = $timezone;
}
// When the passed-in time is a DateTime object with its own
// timezone, try to use the date's timezone.
elseif (empty($timezone) && $this->inputTimeAdjusted instanceOf \DateTime) {
$timezone_adjusted = $this->inputTimeAdjusted->getTimezone();
}
// Allow string timezone input, and create a timezone from it.
elseif (!empty($timezone) && is_string($timezone)) {
$timezone_adjusted = new \DateTimeZone($timezone);
}
// Default to the system timezone when not explicitly provided.
// If the system timezone is missing, use 'UTC'.
if (empty($timezone_adjusted) || !$timezone_adjusted instanceOf \DateTimezone) {
$system_timezone = date_default_timezone_get();
$timezone_name = !empty($system_timezone) ? $system_timezone : 'UTC';
$timezone_adjusted = new \DateTimeZone($timezone_name);
}
// We are finally certain that we have a usable timezone.
$this->inputTimeZoneAdjusted = $timezone_adjusted;
}
/**
* Prepares the input format value.
*
* Changes the input format before trying to use it, if necessary.
* Can be overridden to handle special cases.
*
* @param string $format
* A PHP format string.
*/
protected function prepareFormat($format) {
$this->inputFormatAdjusted = $format;
}
/**
* Checks whether input is a DateTime object.
*
* @return boolean
* TRUE if the input time is a DateTime object.
*/
public function inputIsObject() {
return $this->inputTimeAdjusted instanceOf \DateTime;
}
/**
* Creates a date object from an input date object.
*/
protected function constructFromObject() {
try {
$this->inputTimeAdjusted = $this->inputTimeAdjusted->format(static::FORMAT);
parent::__construct($this->inputTimeAdjusted, $this->inputTimeZoneAdjusted);
}
catch (\Exception $e) {
$this->errors[] = $e->getMessage();
}
}
/**
* Checks whether input time seems to be a timestamp.
*
* Providing an input format will prevent ISO values without separators
* from being mis-interpreted as timestamps. Providing a format can also
* avoid interpreting a value like '2010' with a format of 'Y' as a
* timestamp. The 'U' format indicates this is a timestamp.
*
* @return boolean
* TRUE if the input time is a timestamp.
*/
public function inputIsTimestamp() {
return is_numeric($this->inputTimeAdjusted) && (empty($this->inputFormatAdjusted) || $this->inputFormatAdjusted == 'U');
}
/**
* Creates a date object from timestamp input.
*
* The timezone of a timestamp is always UTC. The timezone for a
* timestamp indicates the timezone used by the format() method.
*/
protected function constructFromTimestamp() {
try {
parent::__construct('', $this->inputTimeZoneAdjusted);
$this->setTimestamp($this->inputTimeAdjusted);
}
catch (\Exception $e) {
$this->errors[] = $e->getMessage();
}
}
/**
* Checks if input is an array of date parts.
*
* @return boolean
* TRUE if the input time is a DateTime object.
*/
public function inputIsArray() {
return is_array($this->inputTimeAdjusted);
}
/**
* Creates a date object from an array of date parts.
*
* Converts the input value into an ISO date, forcing a full ISO
* date even if some values are missing.
*/
protected function constructFromArray() {
try {
parent::__construct('', $this->inputTimeZoneAdjusted);
$this->inputTimeAdjusted = static::prepareArray($this->inputTimeAdjusted, TRUE);
if (static::checkArray($this->inputTimeAdjusted)) {
// Even with validation, we can end up with a value that the
// parent class won't handle, like a year outside the range
// of -9999 to 9999, which will pass checkdate() but
// fail to construct a date object.
$this->inputTimeAdjusted = static::arrayToISO($this->inputTimeAdjusted);
parent::__construct($this->inputTimeAdjusted, $this->inputTimeZoneAdjusted);
}
else {
throw new \Exception('The array contains invalid values.');
}
}
catch (\Exception $e) {
$this->errors[] = $e->getMessage();
}
}
/**
* Checks if input is a string with an expected format.
*
* @return boolean
* TRUE if the input time is a string with an expected format.
*/
public function inputIsFormat() {
return is_string($this->inputTimeAdjusted) && !empty($this->inputFormatAdjusted);
}
/**
* Creates a date object from an input format.
*/
protected function constructFromFormat() {
// Tries to create a date from the format and use it if possible.
// A regular try/catch won't work right here, if the value is
// invalid it doesn't return an exception.
try {
parent::__construct('', $this->inputTimeZoneAdjusted);
$date = parent::createFromFormat($this->inputFormatAdjusted, $this->inputTimeAdjusted, $this->inputTimeZoneAdjusted);
if (!$date instanceOf \DateTime) {
throw new \Exception('The date cannot be created from a format.');
}
else {
$this->setTimestamp($date->getTimestamp());
$this->setTimezone($date->getTimezone());
try {
// The createFromFormat function is forgiving, it might
// create a date that is not exactly a match for the provided
// value, so test for that. For instance, an input value of
// '11' using a format of Y (4 digits) gets created as
// '0011' instead of '2011'.
// Use the parent::format() because we do not want to use
// the IntlDateFormatter here.
if ($this->validateFormat && parent::format($this->inputFormatAdjusted) != $this->inputTimeRaw) {
throw new \Exception('The created date does not match the input value.');
}
}
catch (\Exception $e) {
$this->errors[] = $e->getMessage();
}
}
}
catch (\Exception $e) {
$this->errors[] = $e->getMessage();
}
}
/**
* Creates a date when none of the other methods are appropriate.
*
* Fallback construction for values that don't match any of the
* other patterns. Lets the parent dateTime attempt to turn this string
* into a valid date.
*/
protected function constructFallback() {
try {
// One last test for invalid input before we try to construct
// a date. If the input contains totally bogus information
// it will blow up badly if we pass it to the constructor.
// The date_parse() function will tell us if the input
// makes sense.
if (!empty($this->inputTimeAdjusted)) {
$test = date_parse($this->inputTimeAdjusted);
if (!empty($test['errors'])) {
$this->errors[] = $test['errors'];
}
}
if (empty($this->errors)) {
parent::__construct($this->inputTimeAdjusted, $this->inputTimeZoneAdjusted);
}
}
catch (\Exception $e) {
$this->errors[] = $e->getMessage();
}
}
/**
* Examines getLastErrors() to see what errors to report.
*
* Two kinds of errors are important: anything that DateTime
* considers an error, and also a warning that the date was invalid.
* PHP creates a valid date from invalid data with only a warning,
* 2011-02-30 becomes 2011-03-03, for instance, but we don't want that.
*
* @see http://us3.php.net/manual/en/time.getlasterrors.php
*/
public function checkErrors() {
$errors = $this->getLastErrors();
if (!empty($errors['errors'])) {
$this->errors += $errors['errors'];
}
// Most warnings are messages that the date could not be parsed
// which causes it to be altered. For validation purposes, a warning
// as bad as an error, because it means the constructed date does
// not match the input value.
if (!empty($errors['warnings'])) {
$this->errors[] = 'The date is invalid.';
}
}
/**
* Detects if there were errors in the processing of this date.
*/
public function hasErrors() {
return (boolean) count($this->errors);
}
/**
* Retrieves error messages.
*
* Public function to return the error messages.
*/
public function getErrors() {
return $this->errors;
}
/**
* Creates an ISO date from an array of values.
*
* @param array $array
* An array of date values keyed by date part.
* @param bool $force_valid_date
* (optional) Whether to force a full date by filling in missing
* values. Defaults to FALSE.
*
* @return string
* The date as an ISO string.
*/
public static function arrayToISO($array, $force_valid_date = FALSE) {
$array = static::prepareArray($array, $force_valid_date);
$input_time = '';
if ($array['year'] !== '') {
$input_time = static::datePad(intval($array['year']), 4);
if ($force_valid_date || $array['month'] !== '') {
$input_time .= '-' . static::datePad(intval($array['month']));
if ($force_valid_date || $array['day'] !== '') {
$input_time .= '-' . static::datePad(intval($array['day']));
}
}
}
if ($array['hour'] !== '') {
$input_time .= $input_time ? 'T' : '';
$input_time .= static::datePad(intval($array['hour']));
if ($force_valid_date || $array['minute'] !== '') {
$input_time .= ':' . static::datePad(intval($array['minute']));
if ($force_valid_date || $array['second'] !== '') {
$input_time .= ':' . static::datePad(intval($array['second']));
}
}
}
return $input_time;
}
/**
* Creates a complete array from a possibly incomplete array of date parts.
*
* @param array $array
* An array of date values keyed by date part.
* @param bool $force_valid_date
* (optional) Whether to force a valid date by filling in missing
* values with valid values or just to use empty values instead.
* Defaults to FALSE.
*
* @return array
* A complete array of date parts.
*/
public static function prepareArray($array, $force_valid_date = FALSE) {
if ($force_valid_date) {
$now = new \DateTime();
$array += array(
'year' => $now->format('Y'),
'month' => 1,
'day' => 1,
'hour' => 0,
'minute' => 0,
'second' => 0,
);
}
else {
$array += array(
'year' => '',
'month' => '',
'day' => '',
'hour' => '',
'minute' => '',
'second' => '',
);
}
return $array;
}
/**
* Checks that arrays of date parts will create a valid date.
*
* Checks that an array of date parts has a year, month, and day,
* and that those values create a valid date. If time is provided,
* verifies that the time values are valid. Sort of an
* equivalent to checkdate().
*
* @param array $array
* An array of datetime values keyed by date part.
*
* @return boolean
* TRUE if the datetime parts contain valid values, otherwise FALSE.
*/
public static function checkArray($array) {
$valid_date = FALSE;
$valid_time = TRUE;
// Check for a valid date using checkdate(). Only values that
// meet that test are valid.
if (array_key_exists('year', $array) && array_key_exists('month', $array) && array_key_exists('day', $array)) {
if (@checkdate($array['month'], $array['day'], $array['year'])) {
$valid_date = TRUE;
}
}
// Testing for valid time is reversed. Missing time is OK,
// but incorrect values are not.
foreach (array('hour', 'minute', 'second') as $key) {
if (array_key_exists($key, $array)) {
$value = $array[$key];
switch ($value) {
case 'hour':
if (!preg_match('/^([1-2][0-3]|[01]?[0-9])$/', $value)) {
$valid_time = FALSE;
}
break;
case 'minute':
case 'second':
default:
if (!preg_match('/^([0-5][0-9]|[0-9])$/', $value)) {
$valid_time = FALSE;
}
break;
}
}
}
return $valid_date && $valid_time;
}
/**
* Pads date parts with zeros.
*
* Helper function for a task that is often required when working with dates.
*
* @param int $value
* The value to pad.
* @param int $size
* (optional) Size expected, usually 2 or 4. Defaults to 2.
*
* @return string
* The padded value.
*/
public static function datePad($value, $size = 2) {
return sprintf("%0" . $size . "d", $value);
}
/**
* Tests whether the IntlDateFormatter can be used.
*/
public function canUseIntl() {
return class_exists('IntlDateFormatter') && !empty($this->calendar) && !empty($this->langcode) && !empty($this->country);
}
/**
* Formats the date for display.
*
* Uses the IntlDateFormatter to display the format, if possible.
* Adds an optional array of settings that provides the information
* the IntlDateFormatter will need.
*
* @param string $format
* A format string using either PHP's date() or the
* IntlDateFormatter() format.
* @param array $settings
* - format_string_type: (optional) DateTimePlus::PHP or
* DateTimePlus::INTL. Identifies the pattern used by the format
* string. When using the Intl formatter, the format string must
* use the Intl pattern, which is different from the pattern used
* by the DateTime format function. Defaults to DateTimePlus::PHP.
* - timezone: (optional) String timezone name. Defaults to the timezone
* of the date object.
* - langcode: (optional) String two letter language code to construct the
* locale string by the intlDateFormatter class. Used to control the
* result of the format() method if that class is available. Defaults
* to NULL.
* - country: (optional) String two letter country code to construct the
* locale string by the intlDateFormatter class. Used to control the
* result of the format() method if that class is available. Defaults
* to NULL.
* - calendar: (optional) String calendar name to use for the date,
* Defaults to DateTimePlus::CALENDAR.
* - date_type: (optional) Integer date type to use in the formatter,
* defaults to IntlDateFormatter::FULL.
* - time_type: (optional) Integer date type to use in the formatter,
* defaults to IntlDateFormatter::FULL.
* - lenient: (optional) Boolean choice of whether or not to use lenient
* processing in the intl formatter. Defaults to FALSE;
*
* @return string
* The formatted value of the date.
*/
public function format($format, $settings = array()) {
// If there were construction errors, we can't format the date.
if ($this->hasErrors()) {
return;
}
$format_string_type = isset($settings['format_string_type']) ? $settings['format_string_type'] : static::PHP;
$langcode = !empty($settings['langcode']) ? $settings['langcode'] : $this->langcode;
$country = !empty($settings['country']) ? $settings['country'] : $this->country;
$calendar = !empty($settings['calendar']) ? $settings['calendar'] : $this->calendar;
$timezone = !empty($settings['timezone']) ? $settings['timezone'] : $this->getTimezone()->getName();
$lenient = !empty($settings['lenient']) ? $settings['lenient'] : FALSE;
// Format the date and catch errors.
try {
// If we have what we need to use the IntlDateFormatter, do so.
if ($this->canUseIntl() && $format_string_type == static::INTL) {
// Construct the $locale variable needed by the IntlDateFormatter.
$locale = $langcode . '_' . $country;
// If we have information about a calendar, add it.
if (!empty($calendar) && $calendar != static::CALENDAR) {
$locale .= '@calendar=' . $calendar;
}
// If we're working with a non-gregorian calendar, indicate that.
$calendar_type = \IntlDateFormatter::GREGORIAN;
if ($calendar != SELF::CALENDAR) {
$calendar_type = \IntlDateFormatter::TRADITIONAL;
}
$date_type = !empty($settings['date_type']) ? $settings['date_type'] : \IntlDateFormatter::FULL;
$time_type = !empty($settings['time_type']) ? $settings['time_type'] : \IntlDateFormatter::FULL;
$formatter = new \IntlDateFormatter($locale, $date_type, $time_type, $timezone, $calendar_type);
$formatter->setLenient($lenient);
$value = $formatter->format($format);
}
// Otherwise, use the parent method.
else {
$value = parent::format($format);
}
}
catch (\Exception $e) {
$this->errors[] = $e->getMessage();
}
return $value;
}
}

163
core/lib/Drupal/Core/Datetime/DrupalDateTime.php Normal file
View File

@ -0,0 +1,163 @@
<?php
/**
* @file
* Definition of Drupal\Core\Datetime\DrupalDateTime.
*/
namespace Drupal\Core\Datetime;
use Drupal\Component\Datetime\DateTimePlus;
/**
* Extends DateTimePlus().
*
* This class extends the basic component and adds in Drupal-specific
* handling, like translation of the format() method.
*
* @see Drupal/Component/Datetime/DateTimePlus.php
*/
class DrupalDateTime extends DateTimePlus {
/**
* Constructs a date object.
*
* @param mixed $time
* A DateTime object, a date/input_time_adjusted string, a unix timestamp,
* or an array of date parts, like ('year' => 2014, 'month => 4).
* Defaults to 'now'.
* @param mixed $timezone
* PHP DateTimeZone object, string or NULL allowed.
* Defaults to NULL.
* @param string $format
* PHP date() type format for parsing the input. This is recommended
* to use things like negative years, which php's parser fails on, or
* any other specialized input with a known format. If provided the
* date will be created using the createFromFormat() method.
* Defaults to NULL.
* @see http://us3.php.net/manual/en/datetime.createfromformat.php
* @param array $settings
* - validate_format: (optional) Boolean choice to validate the
* created date using the input format. The format used in
* createFromFormat() allows slightly different values than format().
* Using an input format that works in both functions makes it
* possible to a validation step to confirm that the date created
* from a format string exactly matches the input. This option
* indicates the format can be used for validation. Defaults to TRUE.
* - langcode: (optional) String two letter language code to construct
* the locale string by the intlDateFormatter class. Used to control
* the result of the format() method if that class is available.
* Defaults to NULL.
* - country: (optional) String two letter country code to construct
* the locale string by the intlDateFormatter class. Used to control
* the result of the format() method if that class is available.
* Defaults to NULL.
* - calendar: (optional) String calendar name to use for the date.
* Defaults to DateTimePlus::CALENDAR.
* - debug: (optional) Boolean choice to leave debug values in the
* date object for debugging purposes. Defaults to FALSE.
*/
public function __construct($time = 'now', $timezone = NULL, $format = NULL, $settings = array()) {
// We can set the langcode and country using Drupal values.
$settings['langcode'] = !empty($settings['langcode']) ? $settings['langcode'] : language(LANGUAGE_TYPE_INTERFACE)->langcode;
$settings['country'] = !empty($settings['country']) ? $settings['country'] : variable_get('site_default_country');
// Instantiate the parent class.
parent::__construct($time, $timezone, $format, $settings);
}
/**
* Overrides prepareTimezone().
*
* Override basic component timezone handling to use Drupal's
* knowledge of the preferred user timezone.
*/
protected function prepareTimezone($timezone) {
$user_timezone = drupal_get_user_timezone();
if (empty($timezone) && !empty($user_timezone)) {
$timezone = $user_timezone;
}
parent::prepareTimezone($timezone);
}
/**
* Overrides format().
*
* Uses the IntlDateFormatter to display the format, if possible.
* Adds an optional array of settings that provides the information
* the IntlDateFormatter will need.
*
* @param string $format
* A format string using either PHP's date() or the
* IntlDateFormatter() format.
* @param array $settings
* - format_string_type: (optional) DateTimePlus::PHP or
* DateTimePlus::INTL. Identifies the pattern used by the format
* string. When using the Intl formatter, the format string must
* use the Intl pattern, which is different from the pattern used
* by the DateTime format function. Defaults to DateTimePlus::PHP.
* - timezone: (optional) String timezone name. Defaults to the timezone
* of the date object.
* - langcode: (optional) String two letter language code to construct the
* locale string by the intlDateFormatter class. Used to control the
* result of the format() method if that class is available. Defaults
* to NULL.
* - country: (optional) String two letter country code to construct the
* locale string by the intlDateFormatter class. Used to control the
* result of the format() method if that class is available. Defaults
* to NULL.
* - calendar: (optional) String calendar name to use for the date,
* Defaults to DateTimePlus::CALENDAR.
* - date_type: (optional) Integer date type to use in the formatter,
* defaults to IntlDateFormatter::FULL.
* - time_type: (optional) Integer date type to use in the formatter,
* defaults to IntlDateFormatter::FULL.
* - lenient: (optional) Boolean choice of whether or not to use lenient
* processing in the intl formatter. Defaults to FALSE;
*
* @return string
* The formatted value of the date.
*/
public function format($format, $settings = array()) {
$format_string_type = isset($settings['format_string_type']) ? $settings['format_string_type'] : static::PHP;
$settings['langcode'] = !empty($settings['langcode']) ? $settings['langcode'] : $this->langcode;
$settings['country'] = !empty($settings['country']) ? $settings['country'] : $this->country;
// Format the date and catch errors.
try {
// If we have what we need to use the IntlDateFormatter, do so.
if ($this->canUseIntl() && $format_string_type == parent::INTL) {
$value = parent::format($format, $settings);
}
// Otherwise, use the default Drupal method.
else {
// Encode markers that should be translated. 'A' becomes
// '\xEF\AA\xFF'. xEF and xFF are invalid UTF-8 sequences,
// and we assume they are not in the input string.
// Paired backslashes are isolated to prevent errors in
// read-ahead evaluation. The read-ahead expression ensures that
// A matches, but not \A.
$format = preg_replace(array('/\\\\\\\\/', '/(?<!\\\\)([AaeDlMTF])/'), array("\xEF\\\\\\\\\xFF", "\xEF\\\\\$1\$1\xFF"), $format);
// Call date_format().
$format = parent::format($format);
// Pass the langcode to _format_date_callback().
_format_date_callback(NULL, $settings['langcode']);
// Translate the marked sequences.
$value = preg_replace_callback('/\xEF([AaeDlMTF]?)(.*?)\xFF/', '_format_date_callback', $format);
}
}
catch (\Exception $e) {
$this->errors[] = $e->getMessage();
}
return $value;
}
}

28
core/lib/Drupal/Core/TypedData/Type/Date.php
View File

@ -7,16 +7,17 @@
namespace Drupal\Core\TypedData\Type; namespace Drupal\Core\TypedData\Type;
use Drupal\Core\Datetime\DrupalDateTime;
use Drupal\Core\TypedData\TypedDataInterface; use Drupal\Core\TypedData\TypedDataInterface;
use DateTime;
use InvalidArgumentException; use InvalidArgumentException;
/** /**
* The date data type. * The date data type.
* *
* The plain value of a date is an instance of the DateTime class. For setting * The plain value of a date is an instance of the DrupalDateTime class. For setting
* the value an instance of the DateTime class, any string supported by * the value any value supported by the __construct() of the DrupalDateTime
* DateTime::__construct(), or a timestamp as integer may be passed. * class will work, including a DateTime object, a timestamp, a string
* date, or an array of date parts.
*/ */
class Date extends TypedData implements TypedDataInterface { class Date extends TypedData implements TypedDataInterface {
@ -31,18 +32,17 @@ class Date extends TypedData implements TypedDataInterface {
* Implements TypedDataInterface::setValue(). * Implements TypedDataInterface::setValue().
*/ */
public function setValue($value) { public function setValue($value) {
if ($value instanceof DateTime || !isset($value)) {
// Don't try to create a date from an empty value.
// It would default to the current time.
if (!isset($value)) {
$this->value = $value; $this->value = $value;
} }
// Treat integer values as timestamps, even if supplied as PHP string.
elseif ((string) (int) $value === (string) $value) {
$this->value = new DateTime('@' . $value);
}
elseif (is_string($value)) {
$this->value = new DateTime($value);
}
else { else {
throw new InvalidArgumentException("Invalid date format given."); $this->value = $value instanceOf DrupalDateTime ? $value : new DrupalDateTime($value);
if ($this->value->hasErrors()) {
throw new InvalidArgumentException("Invalid date format given.");
}
} }
} }
@ -50,7 +50,7 @@ class Date extends TypedData implements TypedDataInterface {
* Implements TypedDataInterface::getString(). * Implements TypedDataInterface::getString().
*/ */
public function getString() { public function getString() {
return (string) $this->getValue()->format(DateTime::ISO8601); return (string) $this->getValue();
} }
/** /**

7
core/modules/comment/lib/Drupal/comment/CommentFormController.php
View File

@ -7,6 +7,7 @@
namespace Drupal\comment; namespace Drupal\comment;
use Drupal\Core\Datetime\DrupalDateTime;
use Drupal\Core\Entity\EntityInterface; use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityFormController; use Drupal\Core\Entity\EntityFormController;
@ -234,7 +235,8 @@ class CommentFormController extends EntityFormController {
$account = user_load_by_name($form_state['values']['name']); $account = user_load_by_name($form_state['values']['name']);
$form_state['values']['uid'] = $account ? $account->uid : 0; $form_state['values']['uid'] = $account ? $account->uid : 0;
if ($form_state['values']['date'] && strtotime($form_state['values']['date']) === FALSE) { $date = new DrupalDateTime($form_state['values']['date']);
if ($date->hasErrors()) {
form_set_error('date', t('You have to specify a valid date.')); form_set_error('date', t('You have to specify a valid date.'));
} }
if ($form_state['values']['name'] && !$form_state['values']['is_anonymous'] && !$account) { if ($form_state['values']['name'] && !$form_state['values']['is_anonymous'] && !$account) {
@ -269,7 +271,8 @@ class CommentFormController extends EntityFormController {
if (empty($comment->date)) { if (empty($comment->date)) {
$comment->date = 'now'; $comment->date = 'now';
} }
$comment->created = strtotime($comment->date); $date = new DrupalDateTime($comment->date);
$comment->created = $date->getTimestamp();
$comment->changed = REQUEST_TIME; $comment->changed = REQUEST_TIME;
// If the comment was posted by a registered user, assign the author's ID. // If the comment was posted by a registered user, assign the author's ID.

4
core/modules/node/lib/Drupal/node/NodeFormController.php
View File

@ -7,6 +7,7 @@
namespace Drupal\node; namespace Drupal\node;
use Drupal\Core\Datetime\DrupalDateTime;
use Drupal\Core\Entity\EntityInterface; use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityFormController; use Drupal\Core\Entity\EntityFormController;
@ -288,7 +289,8 @@ class NodeFormController extends EntityFormController {
} }
// Validate the "authored on" field. // Validate the "authored on" field.
if (!empty($node->date) && strtotime($node->date) === FALSE) { $date = new DrupalDateTime($node->date);
if ($date->hasErrors()) {
form_set_error('date', t('You have to specify a valid date.')); form_set_error('date', t('You have to specify a valid date.'));
} }

10
core/modules/node/node.module
View File

@ -14,6 +14,7 @@ use Drupal\Core\Cache\CacheBackendInterface;
use Drupal\Core\Database\Query\AlterableInterface; use Drupal\Core\Database\Query\AlterableInterface;
use Drupal\Core\Database\Query\SelectExtender; use Drupal\Core\Database\Query\SelectExtender;
use Drupal\Core\Database\Query\SelectInterface; use Drupal\Core\Database\Query\SelectInterface;
use Drupal\Core\Datetime\DrupalDateTime;
use Drupal\Core\Template\Attribute; use Drupal\Core\Template\Attribute;
use Drupal\node\Plugin\Core\Entity\Node; use Drupal\node\Plugin\Core\Entity\Node;
use Drupal\file\Plugin\Core\Entity\File; use Drupal\file\Plugin\Core\Entity\File;
@ -1027,7 +1028,14 @@ function node_submit(Node $node) {
$node->revision_uid = $user->uid; $node->revision_uid = $user->uid;
} }
$node->created = !empty($node->date) ? strtotime($node->date) : REQUEST_TIME; if (!empty($node->date)) {
$node_created = new DrupalDateTime($node->date);
$node->created = $node_created->getTimestamp();
}
else {
$node->created = REQUEST_TIME;
}
$node->validated = TRUE; $node->validated = TRUE;
return $node; return $node;

418
core/modules/system/lib/Drupal/system/Tests/Datetime/DateTimePlusTest.php Normal file
View File

@ -0,0 +1,418 @@
<?php
/**
* @file
* Definition of Drupal\system\Tests\Datetime\DateTimePlusTest.
*/
namespace Drupal\system\Tests\Datetime;
use Drupal\simpletest\UnitTestBase;
use Drupal\Component\Datetime\DateTimePlus;
use DateTimeZone;
class DateTimePlusTest extends UnitTestBase {
/**
* Test information.
*/
public static function getInfo() {
return array(
'name' => 'DateTimePlus',
'description' => 'Test DateTimePlus functionality.',
'group' => 'Datetime',
);
}
/**
* Set up required modules.
*/
public static $modules = array();
/**
* Test creating dates from string input.
*/
public function testDateStrings() {
// Create date object from datetime string.
$input = '2009-03-07 10:30';
$timezone = 'America/Chicago';
$date = new DateTimePlus($input, $timezone);
$value = $date->format('c');
$expected = '2009-03-07T10:30:00-06:00';
$this->assertEqual($expected, $value, "Test new DateTimePlus($input, $timezone): should be $expected, found $value.");
// Same during daylight savings time.
$input = '2009-06-07 10:30';
$timezone = 'America/Chicago';
$date = new DateTimePlus($input, $timezone);
$value = $date->format('c');
$expected = '2009-06-07T10:30:00-05:00';
$this->assertEqual($expected, $value, "Test new DateTimePlus($input, $timezone): should be $expected, found $value.");
// Create date object from date string.
$input = '2009-03-07';
$timezone = 'America/Chicago';
$date = new DateTimePlus($input, $timezone);
$value = $date->format('c');
$expected = '2009-03-07T00:00:00-06:00';
$this->assertEqual($expected, $value, "Test new DateTimePlus($input, $timezone): should be $expected, found $value.");
// Same during daylight savings time.
$input = '2009-06-07';
$timezone = 'America/Chicago';
$date = new DateTimePlus($input, $timezone);
$value = $date->format('c');
$expected = '2009-06-07T00:00:00-05:00';
$this->assertEqual($expected, $value, "Test new DateTimePlus($input, $timezone): should be $expected, found $value.");
// Create date object from date string.
$input = '2009-03-07 10:30';
$timezone = 'Australia/Canberra';
$date = new DateTimePlus($input, $timezone);
$value = $date->format('c');
$expected = '2009-03-07T10:30:00+11:00';
$this->assertEqual($expected, $value, "Test new DateTimePlus($input, $timezone): should be $expected, found $value.");
// Same during daylight savings time.
$input = '2009-06-07 10:30';
$timezone = 'Australia/Canberra';
$date = new DateTimePlus($input, $timezone);
$value = $date->format('c');
$expected = '2009-06-07T10:30:00+10:00';
$this->assertEqual($expected, $value, "Test new DateTimePlus($input, $timezone): should be $expected, found $value.");
}
/**
* Test creating dates from arrays of date parts.
*/
function testDateArrays() {
// Create date object from date array, date only.
$input = array('year' => 2010, 'month' => 2, 'day' => 28);
$timezone = 'America/Chicago';
$date = new DateTimePlus($input, $timezone);
$value = $date->format('c');
$expected = '2010-02-28T00:00:00-06:00';
$this->assertEqual($expected, $value, "Test new DateTimePlus(array('year' => 2010, 'month' => 2, 'day' => 28), $timezone): should be $expected, found $value.");
// Create date object from date array with hour.
$input = array('year' => 2010, 'month' => 2, 'day' => 28, 'hour' => 10);
$timezone = 'America/Chicago';
$date = new DateTimePlus($input, $timezone);
$value = $date->format('c');
$expected = '2010-02-28T10:00:00-06:00';
$this->assertEqual($expected, $value, "Test new DateTimePlus(array('year' => 2010, 'month' => 2, 'day' => 28, 'hour' => 10), $timezone): should be $expected, found $value.");
// Create date object from date array, date only.
$input = array('year' => 2010, 'month' => 2, 'day' => 28);
$timezone = 'Europe/Berlin';
$date = new DateTimePlus($input, $timezone);
$value = $date->format('c');
$expected = '2010-02-28T00:00:00+01:00';
$this->assertEqual($expected, $value, "Test new DateTimePlus(array('year' => 2010, 'month' => 2, 'day' => 28), $timezone): should be $expected, found $value.");
// Create date object from date array with hour.
$input = array('year' => 2010, 'month' => 2, 'day' => 28, 'hour' => 10);
$timezone = 'Europe/Berlin';
$date = new DateTimePlus($input, $timezone);
$value = $date->format('c');
$expected = '2010-02-28T10:00:00+01:00';
$this->assertEqual($expected, $value, "Test new DateTimePlus(array('year' => 2010, 'month' => 2, 'day' => 28, 'hour' => 10), $timezone): should be $expected, found $value.");
}
/**
* Test creating dates from timestamps.
*/
function testDateTimestamp() {
// Create date object from a unix timestamp and display it in
// local time.
$input = 0;
$timezone = 'UTC';
$date = new DateTimePlus($input, $timezone);
$value = $date->format('c');
$expected = '1970-01-01T00:00:00+00:00';
$this->assertEqual($expected, $value, "Test new DateTimePlus($input, $timezone): should be $expected, found $value.");
$expected = 'UTC';
$value = $date->getTimeZone()->getName();
$this->assertEqual($expected, $value, "The current timezone is $value: should be $expected.");
$expected = 0;
$value = $date->getOffset();
$this->assertEqual($expected, $value, "The current offset is $value: should be $expected.");
$timezone = 'America/Los_Angeles';
$date->setTimezone(new DateTimeZone($timezone));
$value = $date->format('c');
$expected = '1969-12-31T16:00:00-08:00';
$this->assertEqual($expected, $value, "Test \$date->setTimezone(new DateTimeZone($timezone)): should be $expected, found $value.");
$expected = 'America/Los_Angeles';
$value = $date->getTimeZone()->getName();
$this->assertEqual($expected, $value, "The current timezone should be $expected, found $value.");
$expected = '-28800';
$value = $date->getOffset();
$this->assertEqual($expected, $value, "The current offset should be $expected, found $value.");
// Create a date using the timestamp of zero, then display its
// value both in UTC and the local timezone.
$input = 0;
$timezone = 'America/Los_Angeles';
$date = new DateTimePlus($input, $timezone);
$offset = $date->getOffset();
$value = $date->format('c');
$expected = '1969-12-31T16:00:00-08:00';
$this->assertEqual($expected, $value, "Test new DateTimePlus($input, $timezone): should be $expected, found $value.");
$expected = 'America/Los_Angeles';
$value = $date->getTimeZone()->getName();
$this->assertEqual($expected, $value, "The current timezone should be $expected, found $value.");
$expected = '-28800';
$value = $date->getOffset();
$this->assertEqual($expected, $value, "The current offset should be $expected, found $value.");
$timezone = 'UTC';
$date->setTimezone(new DateTimeZone($timezone));
$value = $date->format('c');
$expected = '1970-01-01T00:00:00+00:00';
$this->assertEqual($expected, $value, "Test \$date->setTimezone(new DateTimeZone($timezone)): should be $expected, found $value.");
$expected = 'UTC';
$value = $date->getTimeZone()->getName();
$this->assertEqual($expected, $value, "The current timezone should be $expected, found $value.");
$expected = '0';
$value = $date->getOffset();
$this->assertEqual($expected, $value, "The current offset should be $expected, found $value.");
}
/**
* Test timezone manipulation.
*/
function testTimezoneConversion() {
// Create date object from datetime string in UTC, and convert
// it to a local date.
$input = '1970-01-01 00:00:00';
$timezone = 'UTC';
$date = new DateTimePlus($input, $timezone);
$value = $date->format('c');
$expected = '1970-01-01T00:00:00+00:00';
$this->assertEqual($expected, $value, "Test new DateTimePlus('$input', '$timezone'): should be $expected, found $value.");
$expected = 'UTC';
$value = $date->getTimeZone()->getName();
$this->assertEqual($expected, $value, "The current timezone is $value: should be $expected.");
$expected = 0;
$value = $date->getOffset();
$this->assertEqual($expected, $value, "The current offset is $value: should be $expected.");
$timezone = 'America/Los_Angeles';
$date->setTimezone(new DateTimeZone($timezone));
$value = $date->format('c');
$expected = '1969-12-31T16:00:00-08:00';
$this->assertEqual($expected, $value, "Test \$date->setTimezone(new DateTimeZone($timezone)): should be $expected, found $value.");
$expected = 'America/Los_Angeles';
$value = $date->getTimeZone()->getName();
$this->assertEqual($expected, $value, "The current timezone should be $expected, found $value.");
$expected = '-28800';
$value = $date->getOffset();
$this->assertEqual($expected, $value, "The current offset should be $expected, found $value.");
// Convert the local time to UTC using string input.
$input = '1969-12-31 16:00:00';
$timezone = 'America/Los_Angeles';
$date = new DateTimePlus($input, $timezone);
$offset = $date->getOffset();
$value = $date->format('c');
$expected = '1969-12-31T16:00:00-08:00';
$this->assertEqual($expected, $value, "Test new DateTimePlus('$input', '$timezone'): should be $expected, found $value.");
$expected = 'America/Los_Angeles';
$value = $date->getTimeZone()->getName();
$this->assertEqual($expected, $value, "The current timezone should be $expected, found $value.");
$expected = '-28800';
$value = $date->getOffset();
$this->assertEqual($expected, $value, "The current offset should be $expected, found $value.");
$timezone = 'UTC';
$date->setTimezone(new DateTimeZone($timezone));
$value = $date->format('c');
$expected = '1970-01-01T00:00:00+00:00';
$this->assertEqual($expected, $value, "Test \$date->setTimezone(new DateTimeZone($timezone)): should be $expected, found $value.");
$expected = 'UTC';
$value = $date->getTimeZone()->getName();
$this->assertEqual($expected, $value, "The current timezone should be $expected, found $value.");
$expected = '0';
$value = $date->getOffset();
$this->assertEqual($expected, $value, "The current offset should be $expected, found $value.");
// Convert the local time to UTC using string input.
$input = '1969-12-31 16:00:00';
$timezone = 'Europe/Warsaw';
$date = new DateTimePlus($input, $timezone);
$offset = $date->getOffset();
$value = $date->format('c');
$expected = '1969-12-31T16:00:00+01:00';
$this->assertEqual($expected, $value, "Test new DateTimePlus('$input', '$timezone'): should be $expected, found $value.");
$expected = 'Europe/Warsaw';
$value = $date->getTimeZone()->getName();
$this->assertEqual($expected, $value, "The current timezone should be $expected, found $value.");
$expected = '+3600';
$value = $date->getOffset();
$this->assertEqual($expected, $value, "The current offset should be $expected, found $value.");
}
/**
* Test creating dates from format strings.
*/
function testDateFormat() {
// Create a year-only date.
$input = '2009';
$timezone = NULL;
$format = 'Y';
$date = new DateTimePlus($input, $timezone, $format);
$value = $date->format('Y');
$expected = '2009';
$this->assertEqual($expected, $value, "Test new DateTimePlus($input, $timezone, $format): should be $expected, found $value.");
// Create a month and year-only date.
$input = '2009-10';
$timezone = NULL;
$format = 'Y-m';
$date = new DateTimePlus($input, $timezone, $format);
$value = $date->format('Y-m');
$expected = '2009-10';
$this->assertEqual($expected, $value, "Test new DateTimePlus($input, $timezone, $format): should be $expected, found $value.");
// Create a time-only date.
$input = 'T10:30:00';
$timezone = NULL;
$format = '\TH:i:s';
$date = new DateTimePlus($input, $timezone, $format);
$value = $date->format('H:i:s');
$expected = '10:30:00';
$this->assertEqual($expected, $value, "Test new DateTimePlus($input, $timezone, $format): should be $expected, found $value.");
// Create a time-only date.
$input = '10:30:00';
$timezone = NULL;
$format = 'H:i:s';
$date = new DateTimePlus($input, $timezone, $format);
$value = $date->format('H:i:s');
$expected = '10:30:00';
$this->assertEqual($expected, $value, "Test new DateTimePlus($input, $timezone, $format): should be $expected, found $value.");
}
/**
* Test invalid date handling.
*/
function testInvalidDates() {
// Test for invalid month names when we are using a short version
// of the month.
$input = '23 abc 2012';
$timezone = NULL;
$format = 'd M Y';
$date = new DateTimePlus($input, $timezone, $format);
$this->assertNotEqual(count($date->getErrors()), 0, "$input contains an invalid month name and produces errors.");
// Test for invalid hour.
$input = '0000-00-00T45:30:00';
$timezone = NULL;
$format = 'Y-m-d\TH:i:s';
$date = new DateTimePlus($input, $timezone, $format);
$this->assertNotEqual(count($date->getErrors()), 0, "$input contains an invalid hour and produces errors.");
// Test for invalid day.
$input = '0000-00-99T05:30:00';
$timezone = NULL;
$format = 'Y-m-d\TH:i:s';
$date = new DateTimePlus($input, $timezone, $format);
$this->assertNotEqual(count($date->getErrors()), 0, "$input contains an invalid day and produces errors.");
// Test for invalid month.
$input = '0000-75-00T15:30:00';
$timezone = NULL;
$format = 'Y-m-d\TH:i:s';
$date = new DateTimePlus($input, $timezone, $format);
$this->assertNotEqual(count($date->getErrors()), 0, "$input contains an invalid month and produces errors.");
// Test for invalid year.
$input = '11-08-01T15:30:00';
$timezone = NULL;
$format = 'Y-m-d\TH:i:s';
$date = new DateTimePlus($input, $timezone, $format);
$this->assertNotEqual(count($date->getErrors()), 0, "$input contains an invalid year and produces errors.");
// Test for invalid year from date array. 10000 as a year will
// create an exception error in the PHP DateTime object.
$input = array('year' => 10000, 'month' => 7, 'day' => 8, 'hour' => 8, 'minute' => 0, 'second' => 0);
$timezone = 'America/Chicago';
$date = new DateTimePlus($input, $timezone);
$this->assertNotEqual(count($date->getErrors()), 0, "array('year' => 10000, 'month' => 7, 'day' => 8, 'hour' => 8, 'minute' => 0, 'second' => 0) contains an invalid year and produces errors.");
// Test for invalid month from date array.
$input = array('year' => 2010, 'month' => 27, 'day' => 8, 'hour' => 8, 'minute' => 0, 'second' => 0);
$timezone = 'America/Chicago';
$date = new DateTimePlus($input, $timezone);
$this->assertNotEqual(count($date->getErrors()), 0, "array('year' => 2010, 'month' => 27, 'day' => 8, 'hour' => 8, 'minute' => 0, 'second' => 0) contains an invalid month and produces errors.");
// Test for invalid hour from date array.
$input = array('year' => 2010, 'month' => 2, 'day' => 28, 'hour' => 80, 'minute' => 0, 'second' => 0);
$timezone = 'America/Chicago';
$date = new DateTimePlus($input, $timezone);
$this->assertNotEqual(count($date->getErrors()), 0, "array('year' => 2010, 'month' => 2, 'day' => 28, 'hour' => 80, 'minute' => 0, 'second' => 0) contains an invalid hour and produces errors.");
// Test for invalid minute from date array.
$input = array('year' => 2010, 'month' => 7, 'day' => 8, 'hour' => 8, 'minute' => 88, 'second' => 0);
$timezone = 'America/Chicago';
$date = new DateTimePlus($input, $timezone);
$this->assertNotEqual(count($date->getErrors()), 0, "array('year' => 2010, 'month' => 7, 'day' => 8, 'hour' => 8, 'minute' => 88, 'second' => 0) contains an invalid minute and produces errors.");
}
/**
* Test that DrupalDateTime can detect the right timezone to use.
* When specified or not.
*/
public function testDateTimezone() {
global $user;
$date_string = '2007-01-31 21:00:00';
// Detect the system timezone.
$system_timezone = date_default_timezone_get();
// Create a date object with an unspecified timezone, which should
// end up using the system timezone.
$date = new DateTimePlus($date_string);
$timezone = $date->getTimezone()->getName();
$this->assertTrue($timezone == $system_timezone, 'DateTimePlus uses the system timezone when there is no site timezone.');
// Create a date object with a specified timezone name.
$date = new DateTimePlus($date_string, 'America/Yellowknife');
$timezone = $date->getTimezone()->getName();
$this->assertTrue($timezone == 'America/Yellowknife', 'DateTimePlus uses the specified timezone if provided.');
// Create a date object with a timezone object.
$date = new DateTimePlus($date_string, new \DateTimeZone('Australia/Canberra'));
$timezone = $date->getTimezone()->getName();
$this->assertTrue($timezone == 'Australia/Canberra', 'DateTimePlus uses the specified timezone if provided.');
// Create a date object with another date object.
$new_date = new DateTimePlus('now', 'Pacific/Midway');
$date = new DateTimePlus($new_date);
$timezone = $date->getTimezone()->getName();
$this->assertTrue($timezone == 'Pacific/Midway', 'DateTimePlus uses the specified timezone if provided.');
}
}

110
core/modules/system/lib/Drupal/system/Tests/Datetime/DrupalDateTimeTest.php Normal file
View File

@ -0,0 +1,110 @@
<?php
/**
* @file
* Definition of Drupal\system\Tests\Datetime\DateTimePlusTest.
*/
namespace Drupal\system\Tests\Datetime;
use Drupal\simpletest\WebTestBase;
use Drupal\Core\Datetime\DrupalDateTime;
class DrupalDateTimeTest extends WebTestBase {
/**
* Test information.
*/
public static function getInfo() {
return array(
'name' => 'DrupalDateTime',
'description' => 'Test DrupalDateTime functionality.',
'group' => 'Datetime',
);
}
/**
* Set up required modules.
*/
public static $modules = array();
/**
* Test setup.
*/
public function setUp() {
parent::setUp();
}
/**
* Test that DrupalDateTime can detect the right timezone to use.
* Test with a variety of less commonly used timezone names to
* help ensure that the system timezone will be different than the
* stated timezones.
*/
public function testDateTimezone() {
global $user;
$date_string = '2007-01-31 21:00:00';
// Make sure no site timezone has been set.
variable_set('date_default_timezone', NULL);
variable_set('configurable_timezones', 0);
// Detect the system timezone.
$system_timezone = date_default_timezone_get();
// Create a date object with an unspecified timezone, which should
// end up using the system timezone.
$date = new DrupalDateTime($date_string);
$timezone = $date->getTimezone()->getName();
$this->assertTrue($timezone == $system_timezone, 'DrupalDateTime uses the system timezone when there is no site timezone.');
// Create a date object with a specified timezone.
$date = new DrupalDateTime($date_string, 'America/Yellowknife');
$timezone = $date->getTimezone()->getName();
$this->assertTrue($timezone == 'America/Yellowknife', 'DrupalDateTime uses the specified timezone if provided.');
// Set a site timezone.
variable_set('date_default_timezone', 'Europe/Warsaw');
// Create a date object with an unspecified timezone, which should
// end up using the site timezone.
$date = new DrupalDateTime($date_string);
$timezone = $date->getTimezone()->getName();
$this->assertTrue($timezone == 'Europe/Warsaw', 'DrupalDateTime uses the site timezone if provided.');
// Create user.
variable_set('configurable_timezones', 1);
$test_user = $this->drupalCreateUser(array());
$this->drupalLogin($test_user);
// Set up the user with a different timezone than the site.
$edit = array('mail' => $test_user->mail, 'timezone' => 'Asia/Manila');
$this->drupalPost('user/' . $test_user->uid . '/edit', $edit, t('Save'));
// Disable session saving as we are about to modify the global $user.
drupal_save_session(FALSE);
// Save the original user and then replace it with the test user.
$real_user = $user;
$user = user_load($test_user->uid, TRUE);
// Simulate a Drupal bootstrap with the logged-in user.
date_default_timezone_set(drupal_get_user_timezone());
// Create a date object with an unspecified timezone, which should
// end up using the user timezone.
$date = new DrupalDateTime($date_string);
$timezone = $date->getTimezone()->getName();
$this->assertTrue($timezone == 'Asia/Manila', 'DrupalDateTime uses the user timezone, if configurable timezones are used and it is set.');
// Restore the original user, and enable session saving.
$user = $real_user;
// Restore default time zone.
date_default_timezone_set(drupal_get_user_timezone());
drupal_save_session(TRUE);
}
}

4
core/modules/system/lib/Drupal/system/Tests/TypedData/TypedDataTest.php
View File

@ -8,7 +8,7 @@
namespace Drupal\system\Tests\TypedData; namespace Drupal\system\Tests\TypedData;
use Drupal\simpletest\WebTestBase; use Drupal\simpletest\WebTestBase;
use DateTime; use Drupal\Core\Datetime\DrupalDateTime;
use DateInterval; use DateInterval;
/** /**
@ -72,7 +72,7 @@ class TypedDataTest extends WebTestBase {
$this->assertNull($wrapper->getValue(), 'Float wrapper is null-able.'); $this->assertNull($wrapper->getValue(), 'Float wrapper is null-able.');
// Date type. // Date type.
$value = new DateTime('@' . REQUEST_TIME); $value = new DrupalDateTime(REQUEST_TIME);
$wrapper = $this->createTypedData(array('type' => 'date'), $value); $wrapper = $this->createTypedData(array('type' => 'date'), $value);
$this->assertTrue($wrapper->getValue() === $value, 'Date value was fetched.'); $this->assertTrue($wrapper->getValue() === $value, 'Date value was fetched.');
$new_value = REQUEST_TIME + 1; $new_value = REQUEST_TIME + 1;