143 lines
4.9 KiB
PHP
143 lines
4.9 KiB
PHP
<?php
|
|
declare(strict_types=1);
|
|
|
|
/**
|
|
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
|
|
*
|
|
* Licensed under The MIT License
|
|
* Redistributions of files must retain the above copyright notice.
|
|
*
|
|
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
|
|
* @link http://cakephp.org CakePHP(tm) Project
|
|
* @license http://www.opensource.org/licenses/mit-license.php MIT License
|
|
*/
|
|
|
|
namespace Cake\Chronos;
|
|
|
|
use DateTimeImmutable;
|
|
use DateTimeZone;
|
|
|
|
/**
|
|
* An immutable date object that converts all time components into 00:00:00.
|
|
*
|
|
* This class is useful when you want to represent a calendar date and ignore times.
|
|
* This means that timezone changes take no effect as a calendar date exists in all timezones
|
|
* in each respective date.
|
|
*
|
|
* @property-read int $year
|
|
* @property-read int $yearIso
|
|
* @property-read int $month
|
|
* @property-read int $day
|
|
* @property-read int $hour
|
|
* @property-read int $minute
|
|
* @property-read int $second
|
|
* @property-read int $micro
|
|
* @property-read int $microsecond
|
|
* @property-read int $timestamp seconds since the Unix Epoch
|
|
* @property-read \DateTimeZone $timezone the current timezone
|
|
* @property-read \DateTimeZone $tz alias of timezone
|
|
* @property-read int $dayOfWeek 1 (for Monday) through 7 (for Sunday)
|
|
* @property-read int $dayOfYear 0 through 365
|
|
* @property-read int $weekOfMonth 1 through 5
|
|
* @property-read int $weekOfYear ISO-8601 week number of year, weeks starting on Monday
|
|
* @property-read int $daysInMonth number of days in the given month
|
|
* @property-read int $age does a diffInYears() with default parameters
|
|
* @property-read int $quarter the quarter of this instance, 1 - 4
|
|
* @property-read int $offset the timezone offset in seconds from UTC
|
|
* @property-read int $offsetHours the timezone offset in hours from UTC
|
|
* @property-read bool $dst daylight savings time indicator, true if DST, false otherwise
|
|
* @property-read bool $local checks if the timezone is local, true if local, false otherwise
|
|
* @property-read bool $utc checks if the timezone is UTC, true if UTC, false otherwise
|
|
* @property-read string $timezoneName
|
|
* @property-read string $tzName
|
|
*/
|
|
class Date extends DateTimeImmutable implements ChronosInterface
|
|
{
|
|
use Traits\ComparisonTrait;
|
|
use Traits\DifferenceTrait;
|
|
use Traits\FactoryTrait;
|
|
use Traits\FormattingTrait;
|
|
use Traits\FrozenTimeTrait;
|
|
use Traits\MagicPropertyTrait;
|
|
use Traits\ModifierTrait;
|
|
use Traits\TestingAidTrait;
|
|
|
|
/**
|
|
* Format to use for __toString method when type juggling occurs.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected static $toStringFormat = 'Y-m-d';
|
|
|
|
/**
|
|
* Create a new Immutable Date instance.
|
|
*
|
|
* You can specify the timezone for the $time parameter. This timezone will
|
|
* not be used in any future modifications to the Date instance.
|
|
*
|
|
* The $timezone parameter is ignored if $time is a DateTimeInterface
|
|
* instance.
|
|
*
|
|
* Please see the testing aids section (specifically static::setTestNow())
|
|
* for more on the possibility of this constructor returning a test instance.
|
|
*
|
|
* Date instances lack time components, however due to limitations in PHP's
|
|
* internal Datetime object the time will always be set to 00:00:00, and the
|
|
* timezone will always be the server local time. Normalizing the timezone allows for
|
|
* subtraction/addition to have deterministic results.
|
|
*
|
|
* @param \DateTime|\DateTimeImmutable|string|int|null $time Fixed or relative time
|
|
* @param \DateTimeZone|string|null $tz The timezone in which the date is taken
|
|
*/
|
|
public function __construct($time = 'now', $tz = null)
|
|
{
|
|
if ($tz !== null) {
|
|
$tz = $tz instanceof DateTimeZone ? $tz : new DateTimeZone($tz);
|
|
}
|
|
|
|
$testNow = Chronos::getTestNow();
|
|
if ($testNow === null || !static::isRelativeOnly($time)) {
|
|
$time = $this->stripTime($time, $tz);
|
|
parent::__construct($time);
|
|
|
|
return;
|
|
}
|
|
|
|
$testNow = clone $testNow;
|
|
if ($tz !== $testNow->getTimezone()) {
|
|
$testNow = $testNow->setTimezone($tz ?? date_default_timezone_get());
|
|
}
|
|
if (!empty($time)) {
|
|
$testNow = $testNow->modify($time);
|
|
}
|
|
|
|
$time = $testNow->format('Y-m-d 00:00:00');
|
|
parent::__construct($time);
|
|
}
|
|
|
|
/**
|
|
* Create a new mutable instance from current immutable instance.
|
|
*
|
|
* @return \Cake\Chronos\MutableDate
|
|
*/
|
|
public function toMutable(): MutableDate
|
|
{
|
|
return MutableDate::instance($this);
|
|
}
|
|
|
|
/**
|
|
* Return properties for debugging.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function __debugInfo(): array
|
|
{
|
|
$properties = [
|
|
'hasFixedNow' => static::hasTestNow(),
|
|
'date' => $this->format('Y-m-d'),
|
|
];
|
|
|
|
return $properties;
|
|
}
|
|
}
|