Initial Drupal 11 with DDEV setup
This commit is contained in:
735
web/core/lib/Drupal/Component/Datetime/DateTimePlus.php
Normal file
735
web/core/lib/Drupal/Component/Datetime/DateTimePlus.php
Normal file
@ -0,0 +1,735 @@
|
||||
<?php
|
||||
|
||||
namespace Drupal\Component\Datetime;
|
||||
|
||||
use Drupal\Component\Utility\ToStringTrait;
|
||||
|
||||
/**
|
||||
* Wraps DateTime().
|
||||
*
|
||||
* This class wraps 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.
|
||||
*
|
||||
* This class is less lenient than the DateTime class. It changes
|
||||
* the default behavior for handling date values like '2011-00-00'.
|
||||
* The DateTime 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 DateTime 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().
|
||||
*
|
||||
* @method $this add(\DateInterval $interval)
|
||||
* @method static array getLastErrors()
|
||||
* @method $this modify(string $modify)
|
||||
* @method $this setDate(int $year, int $month, int $day)
|
||||
* @method $this setISODate(int $year, int $week, int $day = 1)
|
||||
* @method $this setTime(int $hour, int $minute, int $second = 0, int $microseconds = 0)
|
||||
* @method $this setTimestamp(int $unix_timestamp)
|
||||
* @method $this setTimezone(\DateTimeZone $timezone)
|
||||
* @method $this sub(\DateInterval $interval)
|
||||
* @method int getOffset()
|
||||
* @method int getTimestamp()
|
||||
* @method \DateTimeZone getTimezone()
|
||||
*/
|
||||
class DateTimePlus {
|
||||
|
||||
use ToStringTrait;
|
||||
|
||||
const FORMAT = 'Y-m-d H:i:s';
|
||||
|
||||
/**
|
||||
* A RFC7231 Compliant date.
|
||||
*
|
||||
* @see http://tools.ietf.org/html/rfc7231#section-7.1.1.1
|
||||
*
|
||||
* Example: Sun, 06 Nov 1994 08:49:37 GMT
|
||||
*/
|
||||
const RFC7231 = 'D, d M Y H:i:s \G\M\T';
|
||||
|
||||
/**
|
||||
* An array of possible date parts.
|
||||
*
|
||||
* @var string[]
|
||||
*/
|
||||
protected static $dateParts = [
|
||||
'year',
|
||||
'month',
|
||||
'day',
|
||||
'hour',
|
||||
'minute',
|
||||
'second',
|
||||
];
|
||||
|
||||
/**
|
||||
* The value of the time value passed to the constructor.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $inputTimeRaw = '';
|
||||
|
||||
/**
|
||||
* The prepared time, without timezone, for this date.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $inputTimeAdjusted = '';
|
||||
|
||||
/**
|
||||
* The value of the timezone passed to the constructor.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $inputTimeZoneRaw = '';
|
||||
|
||||
/**
|
||||
* The prepared timezone object used to construct this date.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $inputTimeZoneAdjusted = '';
|
||||
|
||||
/**
|
||||
* The value of the format passed to the constructor.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $inputFormatRaw = '';
|
||||
|
||||
/**
|
||||
* The prepared format, if provided.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $inputFormatAdjusted = '';
|
||||
|
||||
/**
|
||||
* The value of the language code passed to the constructor.
|
||||
*
|
||||
* @var string|null
|
||||
*/
|
||||
protected $langcode = NULL;
|
||||
|
||||
/**
|
||||
* An array of errors encountered when creating this date.
|
||||
*
|
||||
* @var string[]
|
||||
*/
|
||||
protected $errors = [];
|
||||
|
||||
/**
|
||||
* The DateTime object.
|
||||
*
|
||||
* @var \DateTime
|
||||
*/
|
||||
protected $dateTimeObject = NULL;
|
||||
|
||||
/**
|
||||
* Creates a date object from an input date object.
|
||||
*
|
||||
* @param \DateTimeInterface $datetime
|
||||
* A DateTime object.
|
||||
* @param array $settings
|
||||
* (optional) A keyed array for settings, suitable for passing on to
|
||||
* __construct().
|
||||
*
|
||||
* @return static
|
||||
* A new DateTimePlus object.
|
||||
*/
|
||||
public static function createFromDateTime(\DateTimeInterface $datetime, $settings = []) {
|
||||
return new static($datetime->format(static::FORMAT), $datetime->getTimezone(), $settings);
|
||||
}
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* @param array $date_parts
|
||||
* An array of date parts, like ('year' => 2014, 'month' => 4).
|
||||
* @param mixed $timezone
|
||||
* (optional) \DateTimeZone object, time zone string or NULL. NULL uses the
|
||||
* default system time zone. Defaults to NULL.
|
||||
* @param array $settings
|
||||
* (optional) A keyed array for settings, suitable for passing on to
|
||||
* __construct().
|
||||
*
|
||||
* @return static
|
||||
* A new DateTimePlus object.
|
||||
*
|
||||
* @throws \InvalidArgumentException
|
||||
* If the array date values or value combination is not correct.
|
||||
*/
|
||||
public static function createFromArray(array $date_parts, $timezone = NULL, $settings = []) {
|
||||
$date_parts = static::prepareArray($date_parts, TRUE);
|
||||
if (static::checkArray($date_parts)) {
|
||||
// Even with validation, we can end up with a value that the
|
||||
// DateTime 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.
|
||||
$iso_date = static::arrayToISO($date_parts);
|
||||
return new static($iso_date, $timezone, $settings);
|
||||
}
|
||||
else {
|
||||
throw new \InvalidArgumentException('The array contains invalid values.');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* @param int $timestamp
|
||||
* A UNIX timestamp.
|
||||
* @param mixed $timezone
|
||||
* (optional) \DateTimeZone object, time zone string or NULL. See
|
||||
* __construct() for more details.
|
||||
* @param array $settings
|
||||
* (optional) A keyed array for settings, suitable for passing on to
|
||||
* __construct().
|
||||
*
|
||||
* @return static
|
||||
* A new DateTimePlus object.
|
||||
*
|
||||
* @throws \InvalidArgumentException
|
||||
* If the timestamp is not numeric.
|
||||
*/
|
||||
public static function createFromTimestamp($timestamp, $timezone = NULL, $settings = []) {
|
||||
if (!is_numeric($timestamp)) {
|
||||
throw new \InvalidArgumentException('The timestamp must be numeric.');
|
||||
}
|
||||
$datetime = new static('', $timezone, $settings);
|
||||
$datetime->setTimestamp($timestamp);
|
||||
return $datetime;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a date object from an input format.
|
||||
*
|
||||
* @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.
|
||||
* phpcs:ignore Drupal.Commenting.FunctionComment.ParamCommentFullStop
|
||||
* @see http://php.net/manual/datetime.createfromformat.php
|
||||
* @param string $time
|
||||
* String representing the time.
|
||||
* @param mixed $timezone
|
||||
* (optional) \DateTimeZone object, time zone string or NULL. See
|
||||
* __construct() for more details.
|
||||
* @param array $settings
|
||||
* (optional) A keyed array for settings, suitable for passing on to
|
||||
* __construct(). Supports an additional key:
|
||||
* - 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.
|
||||
*
|
||||
* @return static
|
||||
* A new DateTimePlus object.
|
||||
*
|
||||
* @throws \InvalidArgumentException
|
||||
* If the a date cannot be created from the given format.
|
||||
* @throws \UnexpectedValueException
|
||||
* If the created date does not match the input value.
|
||||
*/
|
||||
public static function createFromFormat($format, $time, $timezone = NULL, $settings = []) {
|
||||
if (!isset($settings['validate_format'])) {
|
||||
$settings['validate_format'] = TRUE;
|
||||
}
|
||||
|
||||
// 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.
|
||||
$datetime_plus = new static('', $timezone, $settings);
|
||||
|
||||
$date = \DateTime::createFromFormat($format, $time, $datetime_plus->getTimezone());
|
||||
if (!$date instanceof \DateTime) {
|
||||
throw new \InvalidArgumentException('The date cannot be created from a format.');
|
||||
}
|
||||
else {
|
||||
$datetime_plus->setTimestamp($date->getTimestamp());
|
||||
$datetime_plus->setTimezone($date->getTimezone());
|
||||
|
||||
// Functions that parse date is forgiving, it might create a date that is
|
||||
// not exactly a match for the provided value, so test for that by
|
||||
// re-creating the date/time formatted string and comparing it to the
|
||||
// input. For instance, an input value of '11' using a format of Y (4
|
||||
// digits) gets created as '0011' instead of '2011'.
|
||||
if ($settings['validate_format'] && $date->format($format) != $time) {
|
||||
throw new \UnexpectedValueException('The created date does not match the input value.');
|
||||
}
|
||||
}
|
||||
return $datetime_plus;
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs a date object set to a requested date and timezone.
|
||||
*
|
||||
* @param string $time
|
||||
* (optional) A date/time string. Defaults to 'now'.
|
||||
* @param mixed $timezone
|
||||
* (optional) \DateTimeZone object, time zone string or NULL. NULL uses the
|
||||
* default system time zone. Defaults to NULL. Note that the $timezone
|
||||
* parameter and the current timezone are ignored when the $time parameter
|
||||
* either is a UNIX timestamp (e.g. @946684800) or specifies a timezone
|
||||
* (e.g. 2010-01-28T15:00:00+02:00).
|
||||
* phpcs:ignore Drupal.Commenting.FunctionComment.ParamCommentFullStop
|
||||
* @see http://php.net/manual/datetime.construct.php
|
||||
* @param array $settings
|
||||
* (optional) Keyed array of settings. Defaults to empty array.
|
||||
* - langcode: (optional) String two letter language code used to control
|
||||
* the result of the format(). Defaults to NULL.
|
||||
* - 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, $settings = []) {
|
||||
|
||||
// Unpack settings.
|
||||
$this->langcode = !empty($settings['langcode']) ? $settings['langcode'] : NULL;
|
||||
|
||||
// Massage the input values as necessary.
|
||||
$prepared_time = $this->prepareTime($time);
|
||||
$prepared_timezone = $this->prepareTimezone($timezone);
|
||||
|
||||
try {
|
||||
$this->errors = [];
|
||||
if (!empty($prepared_time)) {
|
||||
$test = date_parse($prepared_time);
|
||||
if (!empty($test['errors'])) {
|
||||
$this->errors = $test['errors'];
|
||||
}
|
||||
}
|
||||
|
||||
if (empty($this->errors)) {
|
||||
$this->dateTimeObject = new \DateTime($prepared_time, $prepared_timezone);
|
||||
}
|
||||
}
|
||||
catch (\Exception $e) {
|
||||
$this->errors[] = $e->getMessage();
|
||||
}
|
||||
|
||||
// Clean up the error messages.
|
||||
$this->checkErrors();
|
||||
}
|
||||
|
||||
/**
|
||||
* Renders the timezone name.
|
||||
*
|
||||
* @return string
|
||||
* The formatted value of the date including the name of the timezone.
|
||||
*/
|
||||
public function render() {
|
||||
return $this->format(static::FORMAT) . ' ' . $this->getTimeZone()->getName();
|
||||
}
|
||||
|
||||
/**
|
||||
* Implements the magic __call method.
|
||||
*
|
||||
* Passes through all unknown calls onto the DateTime object.
|
||||
*
|
||||
* @param string $method
|
||||
* The method to call on the decorated object.
|
||||
* @param array $args
|
||||
* Call arguments.
|
||||
*
|
||||
* @return mixed
|
||||
* The return value from the method on the decorated object. If the proxied
|
||||
* method call returns a DateTime object, then return the original
|
||||
* DateTimePlus object, which allows function chaining to work properly.
|
||||
* Otherwise, the value from the proxied method call is returned.
|
||||
*
|
||||
* @throws \Exception
|
||||
* Thrown when the DateTime object is not set.
|
||||
* @throws \BadMethodCallException
|
||||
* Thrown when there is no corresponding method on the DateTime object to
|
||||
* call.
|
||||
*/
|
||||
public function __call($method, array $args) {
|
||||
// @todo consider using assert() as per https://www.drupal.org/node/2451793.
|
||||
if (!isset($this->dateTimeObject)) {
|
||||
throw new \Exception('DateTime object not set.');
|
||||
}
|
||||
if (!method_exists($this->dateTimeObject, $method)) {
|
||||
throw new \BadMethodCallException(sprintf('Call to undefined method %s::%s()', static::class, $method));
|
||||
}
|
||||
|
||||
$result = call_user_func_array([$this->dateTimeObject, $method], $args);
|
||||
|
||||
return $result === $this->dateTimeObject ? $this : $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the difference between two DateTimePlus objects.
|
||||
*
|
||||
* @param \Drupal\Component\Datetime\DateTimePlus|\DateTime $datetime2
|
||||
* The date to compare to.
|
||||
* @param bool $absolute
|
||||
* Should the interval be forced to be positive?
|
||||
*
|
||||
* @return \DateInterval
|
||||
* A DateInterval object representing the difference between the two dates.
|
||||
*
|
||||
* @throws \BadMethodCallException
|
||||
* If the input isn't a DateTime or DateTimePlus object.
|
||||
*/
|
||||
public function diff($datetime2, $absolute = FALSE) {
|
||||
if ($datetime2 instanceof DateTimePlus) {
|
||||
$datetime2 = $datetime2->dateTimeObject;
|
||||
}
|
||||
if (!($datetime2 instanceof \DateTime)) {
|
||||
throw new \BadMethodCallException(sprintf('Method %s expects parameter 1 to be a \DateTime or \Drupal\Component\Datetime\DateTimePlus object', __METHOD__));
|
||||
}
|
||||
return $this->dateTimeObject->diff($datetime2, $absolute);
|
||||
}
|
||||
|
||||
/**
|
||||
* Implements the magic __callStatic method.
|
||||
*
|
||||
* Passes through all unknown static calls onto the DateTime object.
|
||||
*/
|
||||
public static function __callStatic($method, $args) {
|
||||
if (!method_exists('\DateTime', $method)) {
|
||||
throw new \BadMethodCallException(sprintf('Call to undefined method %s::%s()', static::class, $method));
|
||||
}
|
||||
return call_user_func_array(['\DateTime', $method], $args);
|
||||
}
|
||||
|
||||
/**
|
||||
* Implements the magic __clone method.
|
||||
*
|
||||
* Deep-clones the DateTime object we're wrapping.
|
||||
*/
|
||||
public function __clone() {
|
||||
$this->dateTimeObject = clone($this->dateTimeObject);
|
||||
}
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* @return mixed
|
||||
* The massaged time.
|
||||
*/
|
||||
protected function prepareTime($time) {
|
||||
return $time;
|
||||
}
|
||||
|
||||
/**
|
||||
* Prepares the input timezone value.
|
||||
*
|
||||
* Changes the timezone before trying to use it, if necessary.
|
||||
* Most importantly, makes sure there is a valid timezone
|
||||
* object before moving further.
|
||||
*
|
||||
* @param mixed $timezone
|
||||
* Either a timezone name or a timezone object or NULL.
|
||||
*
|
||||
* @return \DateTimeZone
|
||||
* The massaged time zone.
|
||||
*/
|
||||
protected function prepareTimezone($timezone) {
|
||||
// If the input timezone is a valid timezone object, use it.
|
||||
if ($timezone instanceof \DateTimezone) {
|
||||
$timezone_adjusted = $timezone;
|
||||
}
|
||||
|
||||
// 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.
|
||||
return $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.
|
||||
*
|
||||
* @return string
|
||||
* The massaged PHP format string.
|
||||
*/
|
||||
protected function prepareFormat($format) {
|
||||
return $format;
|
||||
}
|
||||
|
||||
/**
|
||||
* 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://php.net/manual/time.getlasterrors.php
|
||||
*/
|
||||
public function checkErrors() {
|
||||
$errors = \DateTime::getLastErrors();
|
||||
if (!empty($errors['errors'])) {
|
||||
$this->errors = array_merge($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.';
|
||||
}
|
||||
|
||||
$this->errors = array_values(array_unique($this->errors));
|
||||
}
|
||||
|
||||
/**
|
||||
* Detects if there were errors in the processing of this date.
|
||||
*
|
||||
* @return bool
|
||||
* TRUE if there were errors in the processing of this date, FALSE
|
||||
* otherwise.
|
||||
*/
|
||||
public function hasErrors() {
|
||||
return (bool) count($this->errors);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets error messages.
|
||||
*
|
||||
* Public function to return the error messages.
|
||||
*
|
||||
* @return array
|
||||
* An array of errors encountered when creating this date.
|
||||
*/
|
||||
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 += [
|
||||
'year' => $now->format('Y'),
|
||||
'month' => 1,
|
||||
'day' => 1,
|
||||
'hour' => 0,
|
||||
'minute' => 0,
|
||||
'second' => 0,
|
||||
];
|
||||
}
|
||||
else {
|
||||
$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 bool
|
||||
* 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. An empty value, either a string or a 0, is not
|
||||
// a valid value.
|
||||
if (!empty($array['year']) && !empty($array['month']) && !empty($array['day'])) {
|
||||
$valid_date = checkdate($array['month'], $array['day'], $array['year']);
|
||||
}
|
||||
// Testing for valid time is reversed. Missing time is OK,
|
||||
// but incorrect values are not.
|
||||
foreach (['hour', 'minute', 'second'] as $key) {
|
||||
if (array_key_exists($key, $array)) {
|
||||
$value = $array[$key];
|
||||
switch ($key) {
|
||||
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);
|
||||
}
|
||||
|
||||
/**
|
||||
* Formats the date for display.
|
||||
*
|
||||
* @param string $format
|
||||
* Format accepted by date().
|
||||
* @param array $settings
|
||||
* - timezone: (optional) String timezone name. Defaults to the timezone
|
||||
* of the date object.
|
||||
*
|
||||
* @return string|null
|
||||
* The formatted value of the date or NULL if there were construction
|
||||
* errors.
|
||||
*/
|
||||
public function format($format, $settings = []) {
|
||||
|
||||
// If there were construction errors, we can't format the date.
|
||||
if ($this->hasErrors()) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Format the date and catch errors.
|
||||
try {
|
||||
// Clone the date/time object so we can change the time zone without
|
||||
// disturbing the value stored in the object.
|
||||
$dateTimeObject = clone $this->dateTimeObject;
|
||||
if (isset($settings['timezone'])) {
|
||||
$dateTimeObject->setTimezone(new \DateTimeZone($settings['timezone']));
|
||||
}
|
||||
$value = $dateTimeObject->format($format);
|
||||
}
|
||||
catch (\Exception $e) {
|
||||
$this->errors[] = $e->getMessage();
|
||||
}
|
||||
|
||||
return $value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the default time for an object built from date-only data.
|
||||
*
|
||||
* 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.
|
||||
*/
|
||||
public function setDefaultDateTime() {
|
||||
$this->dateTimeObject->setTime(12, 0, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets a clone of the proxied PHP \DateTime object wrapped by this class.
|
||||
*
|
||||
* @return \DateTime
|
||||
* A clone of the wrapped PHP \DateTime object.
|
||||
*/
|
||||
public function getPhpDateTime() {
|
||||
return clone $this->dateTimeObject;
|
||||
}
|
||||
|
||||
}
|
||||
339
web/core/lib/Drupal/Component/Datetime/LICENSE.txt
Normal file
339
web/core/lib/Drupal/Component/Datetime/LICENSE.txt
Normal file
@ -0,0 +1,339 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 2, June 1991
|
||||
|
||||
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
|
||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The licenses for most software are designed to take away your
|
||||
freedom to share and change it. By contrast, the GNU General Public
|
||||
License is intended to guarantee your freedom to share and change free
|
||||
software--to make sure the software is free for all its users. This
|
||||
General Public License applies to most of the Free Software
|
||||
Foundation's software and to any other program whose authors commit to
|
||||
using it. (Some other Free Software Foundation software is covered by
|
||||
the GNU Lesser General Public License instead.) You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
this service if you wish), that you receive source code or can get it
|
||||
if you want it, that you can change the software or use pieces of it
|
||||
in new free programs; and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to make restrictions that forbid
|
||||
anyone to deny you these rights or to ask you to surrender the rights.
|
||||
These restrictions translate to certain responsibilities for you if you
|
||||
distribute copies of the software, or if you modify it.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must give the recipients all the rights that
|
||||
you have. You must make sure that they, too, receive or can get the
|
||||
source code. And you must show them these terms so they know their
|
||||
rights.
|
||||
|
||||
We protect your rights with two steps: (1) copyright the software, and
|
||||
(2) offer you this license which gives you legal permission to copy,
|
||||
distribute and/or modify the software.
|
||||
|
||||
Also, for each author's protection and ours, we want to make certain
|
||||
that everyone understands that there is no warranty for this free
|
||||
software. If the software is modified by someone else and passed on, we
|
||||
want its recipients to know that what they have is not the original, so
|
||||
that any problems introduced by others will not reflect on the original
|
||||
authors' reputations.
|
||||
|
||||
Finally, any free program is threatened constantly by software
|
||||
patents. We wish to avoid the danger that redistributors of a free
|
||||
program will individually obtain patent licenses, in effect making the
|
||||
program proprietary. To prevent this, we have made it clear that any
|
||||
patent must be licensed for everyone's free use or not licensed at all.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||
|
||||
0. This License applies to any program or other work which contains
|
||||
a notice placed by the copyright holder saying it may be distributed
|
||||
under the terms of this General Public License. The "Program", below,
|
||||
refers to any such program or work, and a "work based on the Program"
|
||||
means either the Program or any derivative work under copyright law:
|
||||
that is to say, a work containing the Program or a portion of it,
|
||||
either verbatim or with modifications and/or translated into another
|
||||
language. (Hereinafter, translation is included without limitation in
|
||||
the term "modification".) Each licensee is addressed as "you".
|
||||
|
||||
Activities other than copying, distribution and modification are not
|
||||
covered by this License; they are outside its scope. The act of
|
||||
running the Program is not restricted, and the output from the Program
|
||||
is covered only if its contents constitute a work based on the
|
||||
Program (independent of having been made by running the Program).
|
||||
Whether that is true depends on what the Program does.
|
||||
|
||||
1. You may copy and distribute verbatim copies of the Program's
|
||||
source code as you receive it, in any medium, provided that you
|
||||
conspicuously and appropriately publish on each copy an appropriate
|
||||
copyright notice and disclaimer of warranty; keep intact all the
|
||||
notices that refer to this License and to the absence of any warranty;
|
||||
and give any other recipients of the Program a copy of this License
|
||||
along with the Program.
|
||||
|
||||
You may charge a fee for the physical act of transferring a copy, and
|
||||
you may at your option offer warranty protection in exchange for a fee.
|
||||
|
||||
2. You may modify your copy or copies of the Program or any portion
|
||||
of it, thus forming a work based on the Program, and copy and
|
||||
distribute such modifications or work under the terms of Section 1
|
||||
above, provided that you also meet all of these conditions:
|
||||
|
||||
a) You must cause the modified files to carry prominent notices
|
||||
stating that you changed the files and the date of any change.
|
||||
|
||||
b) You must cause any work that you distribute or publish, that in
|
||||
whole or in part contains or is derived from the Program or any
|
||||
part thereof, to be licensed as a whole at no charge to all third
|
||||
parties under the terms of this License.
|
||||
|
||||
c) If the modified program normally reads commands interactively
|
||||
when run, you must cause it, when started running for such
|
||||
interactive use in the most ordinary way, to print or display an
|
||||
announcement including an appropriate copyright notice and a
|
||||
notice that there is no warranty (or else, saying that you provide
|
||||
a warranty) and that users may redistribute the program under
|
||||
these conditions, and telling the user how to view a copy of this
|
||||
License. (Exception: if the Program itself is interactive but
|
||||
does not normally print such an announcement, your work based on
|
||||
the Program is not required to print an announcement.)
|
||||
|
||||
These requirements apply to the modified work as a whole. If
|
||||
identifiable sections of that work are not derived from the Program,
|
||||
and can be reasonably considered independent and separate works in
|
||||
themselves, then this License, and its terms, do not apply to those
|
||||
sections when you distribute them as separate works. But when you
|
||||
distribute the same sections as part of a whole which is a work based
|
||||
on the Program, the distribution of the whole must be on the terms of
|
||||
this License, whose permissions for other licensees extend to the
|
||||
entire whole, and thus to each and every part regardless of who wrote it.
|
||||
|
||||
Thus, it is not the intent of this section to claim rights or contest
|
||||
your rights to work written entirely by you; rather, the intent is to
|
||||
exercise the right to control the distribution of derivative or
|
||||
collective works based on the Program.
|
||||
|
||||
In addition, mere aggregation of another work not based on the Program
|
||||
with the Program (or with a work based on the Program) on a volume of
|
||||
a storage or distribution medium does not bring the other work under
|
||||
the scope of this License.
|
||||
|
||||
3. You may copy and distribute the Program (or a work based on it,
|
||||
under Section 2) in object code or executable form under the terms of
|
||||
Sections 1 and 2 above provided that you also do one of the following:
|
||||
|
||||
a) Accompany it with the complete corresponding machine-readable
|
||||
source code, which must be distributed under the terms of Sections
|
||||
1 and 2 above on a medium customarily used for software interchange; or,
|
||||
|
||||
b) Accompany it with a written offer, valid for at least three
|
||||
years, to give any third party, for a charge no more than your
|
||||
cost of physically performing source distribution, a complete
|
||||
machine-readable copy of the corresponding source code, to be
|
||||
distributed under the terms of Sections 1 and 2 above on a medium
|
||||
customarily used for software interchange; or,
|
||||
|
||||
c) Accompany it with the information you received as to the offer
|
||||
to distribute corresponding source code. (This alternative is
|
||||
allowed only for noncommercial distribution and only if you
|
||||
received the program in object code or executable form with such
|
||||
an offer, in accord with Subsection b above.)
|
||||
|
||||
The source code for a work means the preferred form of the work for
|
||||
making modifications to it. For an executable work, complete source
|
||||
code means all the source code for all modules it contains, plus any
|
||||
associated interface definition files, plus the scripts used to
|
||||
control compilation and installation of the executable. However, as a
|
||||
special exception, the source code distributed need not include
|
||||
anything that is normally distributed (in either source or binary
|
||||
form) with the major components (compiler, kernel, and so on) of the
|
||||
operating system on which the executable runs, unless that component
|
||||
itself accompanies the executable.
|
||||
|
||||
If distribution of executable or object code is made by offering
|
||||
access to copy from a designated place, then offering equivalent
|
||||
access to copy the source code from the same place counts as
|
||||
distribution of the source code, even though third parties are not
|
||||
compelled to copy the source along with the object code.
|
||||
|
||||
4. You may not copy, modify, sublicense, or distribute the Program
|
||||
except as expressly provided under this License. Any attempt
|
||||
otherwise to copy, modify, sublicense or distribute the Program is
|
||||
void, and will automatically terminate your rights under this License.
|
||||
However, parties who have received copies, or rights, from you under
|
||||
this License will not have their licenses terminated so long as such
|
||||
parties remain in full compliance.
|
||||
|
||||
5. You are not required to accept this License, since you have not
|
||||
signed it. However, nothing else grants you permission to modify or
|
||||
distribute the Program or its derivative works. These actions are
|
||||
prohibited by law if you do not accept this License. Therefore, by
|
||||
modifying or distributing the Program (or any work based on the
|
||||
Program), you indicate your acceptance of this License to do so, and
|
||||
all its terms and conditions for copying, distributing or modifying
|
||||
the Program or works based on it.
|
||||
|
||||
6. Each time you redistribute the Program (or any work based on the
|
||||
Program), the recipient automatically receives a license from the
|
||||
original licensor to copy, distribute or modify the Program subject to
|
||||
these terms and conditions. You may not impose any further
|
||||
restrictions on the recipients' exercise of the rights granted herein.
|
||||
You are not responsible for enforcing compliance by third parties to
|
||||
this License.
|
||||
|
||||
7. If, as a consequence of a court judgment or allegation of patent
|
||||
infringement or for any other reason (not limited to patent issues),
|
||||
conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot
|
||||
distribute so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you
|
||||
may not distribute the Program at all. For example, if a patent
|
||||
license would not permit royalty-free redistribution of the Program by
|
||||
all those who receive copies directly or indirectly through you, then
|
||||
the only way you could satisfy both it and this License would be to
|
||||
refrain entirely from distribution of the Program.
|
||||
|
||||
If any portion of this section is held invalid or unenforceable under
|
||||
any particular circumstance, the balance of the section is intended to
|
||||
apply and the section as a whole is intended to apply in other
|
||||
circumstances.
|
||||
|
||||
It is not the purpose of this section to induce you to infringe any
|
||||
patents or other property right claims or to contest validity of any
|
||||
such claims; this section has the sole purpose of protecting the
|
||||
integrity of the free software distribution system, which is
|
||||
implemented by public license practices. Many people have made
|
||||
generous contributions to the wide range of software distributed
|
||||
through that system in reliance on consistent application of that
|
||||
system; it is up to the author/donor to decide if he or she is willing
|
||||
to distribute software through any other system and a licensee cannot
|
||||
impose that choice.
|
||||
|
||||
This section is intended to make thoroughly clear what is believed to
|
||||
be a consequence of the rest of this License.
|
||||
|
||||
8. If the distribution and/or use of the Program is restricted in
|
||||
certain countries either by patents or by copyrighted interfaces, the
|
||||
original copyright holder who places the Program under this License
|
||||
may add an explicit geographical distribution limitation excluding
|
||||
those countries, so that distribution is permitted only in or among
|
||||
countries not thus excluded. In such case, this License incorporates
|
||||
the limitation as if written in the body of this License.
|
||||
|
||||
9. The Free Software Foundation may publish revised and/or new versions
|
||||
of the General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the Program
|
||||
specifies a version number of this License which applies to it and "any
|
||||
later version", you have the option of following the terms and conditions
|
||||
either of that version or of any later version published by the Free
|
||||
Software Foundation. If the Program does not specify a version number of
|
||||
this License, you may choose any version ever published by the Free Software
|
||||
Foundation.
|
||||
|
||||
10. If you wish to incorporate parts of the Program into other free
|
||||
programs whose distribution conditions are different, write to the author
|
||||
to ask for permission. For software which is copyrighted by the Free
|
||||
Software Foundation, write to the Free Software Foundation; we sometimes
|
||||
make exceptions for this. Our decision will be guided by the two goals
|
||||
of preserving the free status of all derivatives of our free software and
|
||||
of promoting the sharing and reuse of software generally.
|
||||
|
||||
NO WARRANTY
|
||||
|
||||
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
|
||||
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
|
||||
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
|
||||
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
|
||||
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||||
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
|
||||
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
||||
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
|
||||
REPAIR OR CORRECTION.
|
||||
|
||||
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
||||
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
||||
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
|
||||
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
|
||||
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
|
||||
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
||||
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
||||
POSSIBILITY OF SUCH DAMAGES.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
convey the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software; you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation; either version 2 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License along
|
||||
with this program; if not, write to the Free Software Foundation, Inc.,
|
||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program is interactive, make it output a short notice like this
|
||||
when it starts in an interactive mode:
|
||||
|
||||
Gnomovision version 69, Copyright (C) year name of author
|
||||
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, the commands you use may
|
||||
be called something other than `show w' and `show c'; they could even be
|
||||
mouse-clicks or menu items--whatever suits your program.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or your
|
||||
school, if any, to sign a "copyright disclaimer" for the program, if
|
||||
necessary. Here is a sample; alter the names:
|
||||
|
||||
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
|
||||
`Gnomovision' (which makes passes at compilers) written by James Hacker.
|
||||
|
||||
<signature of Ty Coon>, 1 April 1989
|
||||
Ty Coon, President of Vice
|
||||
|
||||
This General Public License does not permit incorporating your program into
|
||||
proprietary programs. If your program is a subroutine library, you may
|
||||
consider it more useful to permit linking proprietary applications with the
|
||||
library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License.
|
||||
12
web/core/lib/Drupal/Component/Datetime/README.txt
Normal file
12
web/core/lib/Drupal/Component/Datetime/README.txt
Normal file
@ -0,0 +1,12 @@
|
||||
The Drupal Datetime Component
|
||||
|
||||
Thanks for using this Drupal component.
|
||||
|
||||
You can participate in its development on Drupal.org, through our issue system:
|
||||
https://www.drupal.org/project/issues/drupal
|
||||
|
||||
You can get the full Drupal repo here:
|
||||
https://www.drupal.org/project/drupal/git-instructions
|
||||
|
||||
You can browse the full Drupal repo here:
|
||||
https://git.drupalcode.org/project/drupal
|
||||
18
web/core/lib/Drupal/Component/Datetime/TESTING.txt
Normal file
18
web/core/lib/Drupal/Component/Datetime/TESTING.txt
Normal file
@ -0,0 +1,18 @@
|
||||
HOW-TO: Test this Drupal component
|
||||
|
||||
In order to test this component, you'll need to get the entire Drupal repo and
|
||||
run the tests there.
|
||||
|
||||
You'll find the tests under core/tests/Drupal/Tests/Component.
|
||||
|
||||
You can get the full Drupal repo here:
|
||||
https://www.drupal.org/project/drupal/git-instructions
|
||||
|
||||
You can find more information about running PHPUnit tests with Drupal here:
|
||||
https://www.drupal.org/node/2116263
|
||||
|
||||
Each component in the Drupal\Component namespace has its own annotated test
|
||||
group. You can use this group to run only the tests for this component. Like
|
||||
this:
|
||||
|
||||
$ ./vendor/bin/phpunit -c core --group Datetime
|
||||
104
web/core/lib/Drupal/Component/Datetime/Time.php
Normal file
104
web/core/lib/Drupal/Component/Datetime/Time.php
Normal file
@ -0,0 +1,104 @@
|
||||
<?php
|
||||
|
||||
namespace Drupal\Component\Datetime;
|
||||
|
||||
use Symfony\Component\HttpFoundation\RequestStack;
|
||||
|
||||
/**
|
||||
* Provides a class for obtaining system time.
|
||||
*
|
||||
* While the normal use case of this class expects that a Request object is
|
||||
* available from the RequestStack, it is still possible to use it without, for
|
||||
* example for early bootstrap containers or for unit tests. In those cases,
|
||||
* the class will access global variables or set a proxy request time in order
|
||||
* to return the request time.
|
||||
*/
|
||||
class Time implements TimeInterface {
|
||||
|
||||
/**
|
||||
* The request stack.
|
||||
*/
|
||||
protected ?RequestStack $requestStack;
|
||||
|
||||
/**
|
||||
* A proxied request time if the request time is not available.
|
||||
*/
|
||||
protected float $proxyRequestTime;
|
||||
|
||||
/**
|
||||
* Constructs a Time object.
|
||||
*
|
||||
* @param \Symfony\Component\HttpFoundation\RequestStack|null $request_stack
|
||||
* (Optional) The request stack.
|
||||
*/
|
||||
public function __construct(?RequestStack $request_stack = NULL) {
|
||||
$this->requestStack = $request_stack;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getRequestTime() {
|
||||
$request = $this->requestStack ? $this->requestStack->getCurrentRequest() : NULL;
|
||||
if ($request) {
|
||||
return $request->server->get('REQUEST_TIME');
|
||||
}
|
||||
// If this is called prior to the request being pushed to the stack fallback
|
||||
// to built-in globals (if available) or the system time.
|
||||
return $_SERVER['REQUEST_TIME'] ?? $this->getProxyRequestTime();
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getRequestMicroTime() {
|
||||
$request = $this->requestStack ? $this->requestStack->getCurrentRequest() : NULL;
|
||||
if ($request) {
|
||||
return $request->server->get('REQUEST_TIME_FLOAT');
|
||||
}
|
||||
// If this is called prior to the request being pushed to the stack fallback
|
||||
// to built-in globals (if available) or the system time.
|
||||
return $_SERVER['REQUEST_TIME_FLOAT'] ?? $this->getProxyRequestMicroTime();
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getCurrentTime() {
|
||||
return time();
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getCurrentMicroTime() {
|
||||
return microtime(TRUE);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a mimic of the timestamp of the current request.
|
||||
*
|
||||
* @return int
|
||||
* A value returned by time().
|
||||
*/
|
||||
protected function getProxyRequestTime(): int {
|
||||
if (!isset($this->proxyRequestTime)) {
|
||||
$this->proxyRequestTime = $this->getCurrentMicroTime();
|
||||
}
|
||||
return (int) $this->proxyRequestTime;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a mimic of the timestamp of the current request.
|
||||
*
|
||||
* @return float
|
||||
* A value returned by microtime().
|
||||
*/
|
||||
protected function getProxyRequestMicroTime(): float {
|
||||
if (!isset($this->proxyRequestTime)) {
|
||||
$this->proxyRequestTime = $this->getCurrentMicroTime();
|
||||
}
|
||||
return $this->proxyRequestTime;
|
||||
}
|
||||
|
||||
}
|
||||
154
web/core/lib/Drupal/Component/Datetime/TimeInterface.php
Normal file
154
web/core/lib/Drupal/Component/Datetime/TimeInterface.php
Normal file
@ -0,0 +1,154 @@
|
||||
<?php
|
||||
|
||||
namespace Drupal\Component\Datetime;
|
||||
|
||||
/**
|
||||
* Defines an interface for obtaining system time.
|
||||
*/
|
||||
interface TimeInterface {
|
||||
|
||||
/**
|
||||
* Returns the timestamp for the current request.
|
||||
*
|
||||
* This method should be used to obtain the current system time at the start
|
||||
* of the request. It will be the same value for the life of the request
|
||||
* (even for long execution times).
|
||||
*
|
||||
* If the request is not available it will fallback to the current system
|
||||
* time.
|
||||
*
|
||||
* This method can replace instances of
|
||||
* @code
|
||||
* $request_time = $_SERVER['REQUEST_TIME'];
|
||||
* $request_time = $requestStack->getCurrentRequest()->server->get('REQUEST_TIME');
|
||||
* $request_time = $request->server->get('REQUEST_TIME');
|
||||
* @endcode
|
||||
* and most instances of
|
||||
* @code
|
||||
* $time = time();
|
||||
* @endcode
|
||||
* with
|
||||
* @code
|
||||
* $request_time = \Drupal::time()->getRequestTime();
|
||||
* @endcode
|
||||
* or the equivalent using the injected service.
|
||||
*
|
||||
* Using the time service, rather than other methods, is especially important
|
||||
* when creating tests, which require predictable timestamps.
|
||||
*
|
||||
* @return int
|
||||
* A Unix timestamp.
|
||||
*
|
||||
* @see \Drupal\Component\Datetime\TimeInterface::getRequestMicroTime()
|
||||
* @see \Drupal\Component\Datetime\TimeInterface::getCurrentTime()
|
||||
* @see \Drupal\Component\Datetime\TimeInterface::getCurrentMicroTime()
|
||||
*/
|
||||
public function getRequestTime();
|
||||
|
||||
/**
|
||||
* Returns the timestamp for the current request with microsecond precision.
|
||||
*
|
||||
* This method should be used to obtain the current system time, with
|
||||
* microsecond precision, at the start of the request. It will be the same
|
||||
* value for the life of the request (even for long execution times).
|
||||
*
|
||||
* If the request is not available it will fallback to the current system
|
||||
* time with microsecond precision.
|
||||
*
|
||||
* This method can replace instances of
|
||||
* @code
|
||||
* $request_time_float = $_SERVER['REQUEST_TIME_FLOAT'];
|
||||
* $request_time_float = $requestStack->getCurrentRequest()->server->get('REQUEST_TIME_FLOAT');
|
||||
* $request_time_float = $request->server->get('REQUEST_TIME_FLOAT');
|
||||
* @endcode
|
||||
* and many instances of
|
||||
* @code
|
||||
* $microtime = microtime();
|
||||
* $microtime = microtime(TRUE);
|
||||
* @endcode
|
||||
* with
|
||||
* @code
|
||||
* $request_time = \Drupal::time()->getRequestMicroTime();
|
||||
* @endcode
|
||||
* or the equivalent using the injected service.
|
||||
*
|
||||
* Using the time service, rather than other methods, is especially important
|
||||
* when creating tests, which require predictable timestamps.
|
||||
*
|
||||
* @return float
|
||||
* A Unix timestamp with a fractional portion.
|
||||
*
|
||||
* @see \Drupal\Component\Datetime\TimeInterface::getRequestTime()
|
||||
* @see \Drupal\Component\Datetime\TimeInterface::getCurrentTime()
|
||||
* @see \Drupal\Component\Datetime\TimeInterface::getCurrentMicroTime()
|
||||
*/
|
||||
public function getRequestMicroTime();
|
||||
|
||||
/**
|
||||
* Returns the current system time as an integer.
|
||||
*
|
||||
* This method should be used to obtain the current system time, at the time
|
||||
* the method was called.
|
||||
*
|
||||
* This method can replace many instances of
|
||||
* @code
|
||||
* $time = time();
|
||||
* @endcode
|
||||
* with
|
||||
* @code
|
||||
* $request_time = \Drupal::time()->getCurrentTime();
|
||||
* @endcode
|
||||
* or the equivalent using the injected service.
|
||||
*
|
||||
* This method should only be used when the current system time is actually
|
||||
* needed, such as with timers or time interval calculations. If only the
|
||||
* time at the start of the request is needed,
|
||||
* use TimeInterface::getRequestTime().
|
||||
*
|
||||
* Using the time service, rather than other methods, is especially important
|
||||
* when creating tests, which require predictable timestamps.
|
||||
*
|
||||
* @return int
|
||||
* A Unix timestamp.
|
||||
*
|
||||
* @see \Drupal\Component\Datetime\TimeInterface::getRequestTime()
|
||||
* @see \Drupal\Component\Datetime\TimeInterface::getRequestMicroTime()
|
||||
* @see \Drupal\Component\Datetime\TimeInterface::getCurrentMicroTime()
|
||||
*/
|
||||
public function getCurrentTime();
|
||||
|
||||
/**
|
||||
* Returns the current system time with microsecond precision.
|
||||
*
|
||||
* This method should be used to obtain the current system time, with
|
||||
* microsecond precision, at the time the method was called.
|
||||
*
|
||||
* This method can replace many instances of
|
||||
* @code
|
||||
* $microtime = microtime();
|
||||
* $microtime = microtime(TRUE);
|
||||
* @endcode
|
||||
* with
|
||||
* @code
|
||||
* $request_time = \Drupal::time()->getCurrentMicroTime();
|
||||
* @endcode
|
||||
* or the equivalent using the injected service.
|
||||
*
|
||||
* This method should only be used when the current system time is actually
|
||||
* needed, such as with timers or time interval calculations. If only the
|
||||
* time at the start of the request and microsecond precision is needed,
|
||||
* use TimeInterface::getRequestMicroTime().
|
||||
*
|
||||
* Using the time service, rather than other methods, is especially important
|
||||
* when creating tests, which require predictable timestamps.
|
||||
*
|
||||
* @return float
|
||||
* A Unix timestamp with a fractional portion.
|
||||
*
|
||||
* @see \Drupal\Component\Datetime\TimeInterface::getRequestTime()
|
||||
* @see \Drupal\Component\Datetime\TimeInterface::getRequestMicroTime()
|
||||
* @see \Drupal\Component\Datetime\TimeInterface::getCurrentTime()
|
||||
*/
|
||||
public function getCurrentMicroTime();
|
||||
|
||||
}
|
||||
24
web/core/lib/Drupal/Component/Datetime/composer.json
Normal file
24
web/core/lib/Drupal/Component/Datetime/composer.json
Normal file
@ -0,0 +1,24 @@
|
||||
{
|
||||
"name": "drupal/core-datetime",
|
||||
"description": "This class wraps 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.",
|
||||
"keywords": [
|
||||
"drupal"
|
||||
],
|
||||
"homepage": "https://www.drupal.org/project/drupal",
|
||||
"license": "GPL-2.0-or-later",
|
||||
"require": {
|
||||
"php": ">=8.3.0",
|
||||
"drupal/core-utility": "^11.2"
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"Drupal\\Component\\Datetime\\": ""
|
||||
}
|
||||
},
|
||||
"extra": {
|
||||
"_readme": [
|
||||
"This file was partially generated automatically. See: https://www.drupal.org/node/3293830"
|
||||
]
|
||||
},
|
||||
"minimum-stability": "dev"
|
||||
}
|
||||
Reference in New Issue
Block a user