# The DateTimeInterface interface

(PHP 5 >= 5.5.0, PHP 7, PHP 8)

## 简介

创建 DateTimeInterface 是为了让参数、返回值、属性类型声明能够接受 DateTimeImmutable 或 DateTime 作为值。不可以使用用户定义的类实现该接口。

此接口也定义了公共常量，允许通过 DateTimeImmutable::format() 和 DateTime::format() 格式化 DateTimeImmutable 或 DateTime 对象。

## 接口摘要

interface DateTimeInterface {
/* 常量 */
public const string ATOM = "Y-m-d\\TH:i:sP";
public const string COOKIE = "l, d-M-Y H:i:s T";
public const string ISO8601 = "Y-m-d\\TH:i:sO";
public const string ISO8601_EXPANDED = "X-m-d\\TH:i:sP";
public const string RFC822 = "D, d M y H:i:s O";
public const string RFC850 = "l, d-M-y H:i:s T";
public const string RFC1036 = "D, d M y H:i:s O";
public const string RFC1123 = "D, d M Y H:i:s O";
public const string RFC7231 = "D, d M Y H:i:s \\G\\M\\T";
public const string RFC2822 = "D, d M Y H:i:s O";
public const string RFC3339 = "Y-m-d\\TH:i:sP";
public const string RFC3339_EXTENDED = "Y-m-d\\TH:i:s.vP";
public const string RSS = "D, d M Y H:i:s O";
public const string W3C = "Y-m-d\\TH:i:sP";
/* 方法 */
public function diff(DateTimeInterface `$targetObject`, bool `$absolute` = `false`): DateInterval
public function format(string `$format`): string
public function getMicrosecond(): int
public function getOffset(): int
public function getTimestamp(): int
public function getTimezone(): DateTimeZone|false
public function __serialize(): array
public function __unserialize(array `$data`): void
#[\Deprecated]
public function __wakeup(): void
}

## 预定义常量

DateTimeInterface::ATOM string
DATE_ATOM
  Atom 格式（示例：2005-08-15T15:52:01+00:00）；兼容 ISO-8601、RFC 3339 和 XML Schema
DateTimeInterface::COOKIE string
DATE_COOKIE
  HTTP Cookies 格式（示例：Monday, 15-Aug-2005 15:52:01 UTC）
DateTimeInterface::ISO8601 string
DATE_ISO8601
  类似 ISO-8601 格式（示例：2005-08-15T15:52:01+0000）

  > 注意: 这种格式和 ISO-8601 格式并不兼容，只是出于向后兼容的原因才保留的。 如果要使用和 ISO-8601 兼容的格式，请使用 DateTimeInterface::ISO8601_EXPANDED 和 DateTimeInterface::ATOM 两个常量。 （参见 ISO8601:2004 第 4.3.3 条 d 项）

DateTimeInterface::ISO8601_EXPANDED string
DATE_ISO8601_EXPANDED
  ISO-8601 扩大版（示例：+10191-07-26T08:59:52+01:00）

  > 注意: 通过始终包含符号字符，此格式允许超出 ISO-8601 正常范围（`0000`-`9999`）的年份。还确保时区部分（`+01:00`）与 ISO-8601 兼容。

DateTimeInterface::RFC822 string
DATE_RFC822
  RFC 822 格式（示例：Mon, 15 Aug 05 15:52:01 +0000）
DateTimeInterface::RFC850 string
DATE_RFC850
  RFC 850 格式（示例：Monday, 15-Aug-05 15:52:01 UTC）
DateTimeInterface::RFC1036 string
DATE_RFC1036
  RFC 1036（示例：Mon, 15 Aug 05 15:52:01 +0000）
DateTimeInterface::RFC1123 string
DATE_RFC1123
  RFC 1123 格式（示例：Mon, 15 Aug 2005 15:52:01 +0000）
DateTimeInterface::RFC7231 string
DATE_RFC7231
  RFC 7231 格式 (自 PHP 7.0.19 和 7.1.5 可用) (示例：Sat, 30 Apr 2016 17:52:13 GMT)
DateTimeInterface::RFC2822 string
DATE_RFC2822
  RFC 2822 格式（示例：Mon, 15 Aug 2005 15:52:01 +0000）
DateTimeInterface::RFC3339 string
DATE_RFC3339
  同 DATE_ATOM（自 PHP 5.1.3 版本可用）
DateTimeInterface::RFC3339_EXTENDED string
DATE_RFC3339_EXTENDED
  RFC 3339 EXTENDED 格式（示例：2005-08-15T15:52:01.000+00:00）
DateTimeInterface::RSS string
DATE_RSS
  RSS（示例：Mon, 15 Aug 2005 15:52:01 +0000）
DateTimeInterface::W3C string
DATE_W3C
  RSS 格式（示例：2005-08-15T15:52:01+00:00）

## 更新日志

版本 | 说明
--- | ---
8.4.0 | 类常量现已类型化。
8.2.0 | 新增常量 `DateTimeInterface::ISO8601_EXPANDED`。
7.2.0 | DateTime 的类常量现在定义在了 DateTimeInterface 上。

## 目录

- DateTimeInterface::diff — 返回两个 DateTime 之间的差值
- DateTimeInterface::format — 按照指定格式返回格式化后的日期
- DateTimeInterface::getMicrosecond — Gets the microsecond part of the Unix timestamp
- DateTimeInterface::getOffset — 返回时差
- DateTimeInterface::getTimestamp — 获取 Unix 时间戳
- DateTimeInterface::getTimezone — 返回相对于指定 DateTime 的时区
- DateTime::__serialize — Serialize a DateTime
- DateTime::__unserialize — Unserialize an Datetime
- DateTime::__wakeup — The __wakeup handler

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open