如何在PHP中检测不明确和无效的DateTime?

How to detect Ambiguous and Invalid DateTime in PHP?

处理用户提供的本地DateTime值时,由于夏令时转换,很可能会产生无效或不明确的时间。

在其他语言和框架中,在时区的某些表示上通常有诸如isAmbiguousisValid之类的方法。 例如,在.NET中,有TimeZoneInfo.IsAmbiguousTimeTimeZoneInfo.IsInvalidTime

许多其他时区实现具有类似的方法或功能来解决这个问题。 例如,在Python中,pytz库将抛出一个可以捕获的AmbiguousTimeErrorInvalidTimeError异常。

PHP有很好的时区支持,但我似乎找不到任何解决这个问题的方法。 我能找到的最接近的东西是DateTimeZone :: getTransitions。 这提供了原始数据,因此我可以看到一些方法可以在此基础上编写。 但他们已经存在于某个地方吗? 如果没有,任何人都可以提供良好的实施吗? 我希望他们的工作方式如下:

1
2
3
$tz = new DateTimeZone('America/New_York');
echo $tz->isValidTime(new DateTime('2013-03-10 02:00:00'));       # false
echo $tz->isAmbiguousTime(new DateTime('2013-11-03 01:00:00'));   # true

我不知道任何现有的实现,我还没有理由使用这些高级日期/时间功能,所以这里是一个干净的房间实现。

为了启用问题中说明的语法,我们将扩展DateTimeZone,如下所示:

1
2
3
4
5
6
7
8
9
class DateTimeZoneEx extends DateTimeZone
{
    const MAX_DST_SHIFT = 7200; // let's be generous

    // DateTime instead of DateTimeInterface for PHP < 5.5
    public function isValidTime(DateTimeInterface $date);

    public function isAmbiguousTime(DateTimeInterface $date);
}

为了让分散注意力的细节不会使实现变得混乱,我将假设$date参数是使用适当的时区创建的;这与问题中给出的示例代码形成对比。

也就是说,这样不会产生正确的结果:

1
2
$tz = new DateTimeZoneEx('America/New_York');
echo $tz->isValidTime(new DateTime('2013-03-10 02:00:00'));

而是由此:

1
2
$tz = new DateTimeZoneEx('America/New_York');
echo $tz->isValidTime(new DateTime('2013-03-10 02:00:00', $tz));

当然,由于$tz已经被对象称为$this,因此应该很容易扩展方法以便删除此要求。在任何情况下,使界面超级用户友好是超出了这个答案的范围;今后我将重点关注技术细节。

isValidTime

这里的想法是使用getTransitions来查看我们感兴趣的日期/时间周围是否有任何转换。getTransitions将返回一个包含一个或两个元素的数组;"开始"时间戳的时区情况将始终存在,如果在其后不久发生转换,则将存在另一个元素。 MAX_DST_SHIFT的值足够小,没有机会获得第二个过渡/第三个元素。

我们来看看代码:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
public function isValidTime(DateTime $date)
{
    $ts = $date->getTimestamp();
    $transitions = $this->getTransitions(
        $ts - self::MAX_DST_SHIFT,
        $ts + self::MAX_DST_SHIFT
    );

    if (count($transitions) == 1) {
        // No DST changes around here, so obviously $date is valid
        return true;
    }

    $shift = $transitions[1]['offset'] - $transitions[0]['offset'];

    if ($shift < 0) {
        // The clock moved backward, so obviously $date is valid
        // (although it might be ambiguous)
        return true;
    }

    $compare = new DateTime($date->format('Y-m-d H:i:s'), $this);

    return $compare->modify("$shift seconds")->getTimestamp() != $ts;
}

代码的最后一点取决于PHP的日期函数计算无效日期/时间的时间戳这一事实,就像挂钟时间没有移位一样。也就是说,在纽约时区,为2013-03-10 02:30:002013-03-10 03:30:00计算的时间戳将是相同的。

不难看出如何利用这一事实:创建一个等于输入$date的新DateTime实例,然后在挂钟时间条件中向前移动一个等于DST移位的数量(以秒为单位)(这是必要的)进行此调整时不考虑DST)。如果结果的时间戳(这里是DST规则发挥作用)等于输入的时间戳,则输入是无效的日期/时间。

isAmbiguousTime

实现非常类似于isValidTime,只有一些细节发生了变化:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
public function isAmbiguousTime(DateTime $date)
{
    $ts = $date->getTimestamp();
    $transitions = $this->getTransitions(
        $ts - self::MAX_DST_SHIFT,
        $ts + self::MAX_DST_SHIFT);

    if (count($transitions) == 1) {
        return false;
    }

    $shift = $transitions[1]['offset'] - $transitions[0]['offset'];

    if ($shift > 0) {
        // The clock moved forward, so obviously $date is not ambiguous
        // (although it might be invalid)
        return false;
    }

    $shift = -$shift;
    $compare = new DateTime($date->format('Y-m-d H:i:s'), $this);
    return $compare->modify("$shift seconds")->getTimestamp() - $ts > $shift;
}

最后一点取决于PHP日期函数的另一个实现细节:当被要求生成模糊日期/时间的时间戳时,PHP会生成第一个(绝对时间项)出现的时间戳。这意味着最新模糊时间的时间戳和给定DST变化的最早非模糊时间将相差大于DST偏移的量(具体地,差异将在[offset + 12 * offset范围内) ],其中offset是绝对值)。

该实现通过再次向前执行"挂钟转换"并检查结果与输入$date之间的时间戳差异来利用此功能。

查看实际代码。